diff --git a/providers/src/oci/v00.00.00000/provider.yaml b/providers/src/oci/v00.00.00000/provider.yaml new file mode 100644 index 00000000..d27011bd --- /dev/null +++ b/providers/src/oci/v00.00.00000/provider.yaml @@ -0,0 +1,211 @@ +id: oci +name: oci +version: v00.00.00000 +providerServices: + audit: + id: audit:v00.00.00000 + name: audit + preferred: true + service: + $ref: oci/v00.00.00000/services/audit.yaml + title: audit API + version: v00.00.00000 + description: oci audit API + block_storage: + id: block_storage:v00.00.00000 + name: block_storage + preferred: true + service: + $ref: oci/v00.00.00000/services/block_storage.yaml + title: block_storage API + version: v00.00.00000 + description: oci block_storage API + budgets: + id: budgets:v00.00.00000 + name: budgets + preferred: true + service: + $ref: oci/v00.00.00000/services/budgets.yaml + title: budgets API + version: v00.00.00000 + description: oci budgets API + compute: + id: compute:v00.00.00000 + name: compute + preferred: true + service: + $ref: oci/v00.00.00000/services/compute.yaml + title: compute API + version: v00.00.00000 + description: oci compute API + container_engine: + id: container_engine:v00.00.00000 + name: container_engine + preferred: true + service: + $ref: oci/v00.00.00000/services/container_engine.yaml + title: container_engine API + version: v00.00.00000 + description: oci container_engine API + database: + id: database:v00.00.00000 + name: database + preferred: true + service: + $ref: oci/v00.00.00000/services/database.yaml + title: database API + version: v00.00.00000 + description: oci database API + dns: + id: dns:v00.00.00000 + name: dns + preferred: true + service: + $ref: oci/v00.00.00000/services/dns.yaml + title: dns API + version: v00.00.00000 + description: oci dns API + events: + id: events:v00.00.00000 + name: events + preferred: true + service: + $ref: oci/v00.00.00000/services/events.yaml + title: events API + version: v00.00.00000 + description: oci events API + functions: + id: functions:v00.00.00000 + name: functions + preferred: true + service: + $ref: oci/v00.00.00000/services/functions.yaml + title: functions API + version: v00.00.00000 + description: oci functions API + identity: + id: identity:v00.00.00000 + name: identity + preferred: true + service: + $ref: oci/v00.00.00000/services/identity.yaml + title: identity API + version: v00.00.00000 + description: oci identity API + kms: + id: kms:v00.00.00000 + name: kms + preferred: true + service: + $ref: oci/v00.00.00000/services/kms.yaml + title: kms API + version: v00.00.00000 + description: oci kms API + load_balancer: + id: load_balancer:v00.00.00000 + name: load_balancer + preferred: true + service: + $ref: oci/v00.00.00000/services/load_balancer.yaml + title: load_balancer API + version: v00.00.00000 + description: oci load_balancer API + logging: + id: logging:v00.00.00000 + name: logging + preferred: true + service: + $ref: oci/v00.00.00000/services/logging.yaml + title: logging API + version: v00.00.00000 + description: oci logging API + monitoring: + id: monitoring:v00.00.00000 + name: monitoring + preferred: true + service: + $ref: oci/v00.00.00000/services/monitoring.yaml + title: monitoring API + version: v00.00.00000 + description: oci monitoring API + network: + id: network:v00.00.00000 + name: network + preferred: true + service: + $ref: oci/v00.00.00000/services/network.yaml + title: network API + version: v00.00.00000 + description: oci network API + object_storage: + id: object_storage:v00.00.00000 + name: object_storage + preferred: true + service: + $ref: oci/v00.00.00000/services/object_storage.yaml + title: object_storage API + version: v00.00.00000 + description: oci object_storage API + resource_manager: + id: resource_manager:v00.00.00000 + name: resource_manager + preferred: true + service: + $ref: oci/v00.00.00000/services/resource_manager.yaml + title: resource_manager API + version: v00.00.00000 + description: oci resource_manager API + secrets: + id: secrets:v00.00.00000 + name: secrets + preferred: true + service: + $ref: oci/v00.00.00000/services/secrets.yaml + title: secrets API + version: v00.00.00000 + description: Use this API to retrieve secrets and secret versions from vaults. + streaming: + id: streaming:v00.00.00000 + name: streaming + preferred: true + service: + $ref: oci/v00.00.00000/services/streaming.yaml + title: streaming API + version: v00.00.00000 + description: oci streaming API + usage: + id: usage:v00.00.00000 + name: usage + preferred: true + service: + $ref: oci/v00.00.00000/services/usage.yaml + title: usage API + version: v00.00.00000 + description: oci usage API + vault: + id: vault:v00.00.00000 + name: vault + preferred: true + service: + $ref: oci/v00.00.00000/services/vault.yaml + title: vault API + version: v00.00.00000 + description: oci vault API + work_requests: + id: work_requests:v00.00.00000 + name: work_requests + preferred: true + service: + $ref: oci/v00.00.00000/services/work_requests.yaml + title: work_requests API + version: v00.00.00000 + description: oci work_requests API +config: + auth: + type: oci_signing_v1 + tenancy_ocid_envvar: OCI_TENANCY + user_ocid_envvar: OCI_USER + oci_fingerprint_envvar: OCI_FINGERPRINT + oci_private_key_path_envvar: OCI_KEY_FILE + oci_passphrase_envvar: OCI_PASSPHRASE + snake_case_aliases: true diff --git a/providers/src/oci/v00.00.00000/services/audit.yaml b/providers/src/oci/v00.00.00000/services/audit.yaml new file mode 100644 index 00000000..3fd26263 --- /dev/null +++ b/providers/src/oci/v00.00.00000/services/audit.yaml @@ -0,0 +1,1231 @@ +openapi: 3.0.0 +info: + title: audit API + description: oci audit API + version: '20190901' +paths: + /auditEvents: + get: + description: | + Returns all the audit events processed for the specified compartment within the specified + time range. + operationId: ListEvents + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/StartWithQueryParam' + - $ref: '#/components/parameters/EndBeforeQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The list of audit events matching the specified time range. + headers: + opc-next-page: + description: | + For pagination of a list of audit events. When this header appears in the response, + it means you received a partial list and there are more results. Include this value as the `page` + parameter for the subsequent ListEvents request to get the next batch of events. 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/ListEventsResponse' + '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/DefaultError' + summary: ListEvents + tags: + - Audit + x-example: | + Syntax: + + GET /20190901/auditEvents?compartmentId=<compartment_OCID>&endTime=<end_timestamp>&startTime=<start_timestamp> + + Sample: + + GET /20190901/auditEvents?compartmentId=ocid1.compartment.region1..aaaaaaaaexample5gsmzi3hnumfjzstsgkzha74uc6jzpcxlxhx33hewsq&endTime=2017-01-06T00:22:00Z&startTime=2017-01-07T00:00:00Z HTTP/1.1 + + Host: audit.us-phoenix-1.oraclecloud.com + User-Agent: Apache-HttpClient/4.5.1 (Java/1.8.0_111) + Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + Accept-Language: en-US,en;q=0.5 + Accept-Encoding: gzip, deflate + Opc-Client-Info: Oracle-HgConsole/0.0.1 + X-Date: Wed, 01 Feb 2017 18:09:22 GMT + Opc-Request-Id: 4a0d1960-7929-4e00-b84e-5440a007ae09 + Authorization: <authorization string> + Connection: keep-alive + x-related-resource: '#/definitions/AuditEvent' + /configuration: + get: + description: Get the configuration + operationId: GetConfiguration + parameters: + - $ref: '#/components/parameters/ConfigurationCompartmentIdQueryParam' + responses: + '200': + description: The configuration properties + content: + application/json: + schema: + $ref: '#/components/schemas/Configuration' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetConfiguration + tags: + - Audit + x-example: | + Syntax: + + GET /20190901/configuration?compartmentId=<compartment_OCID> + + Sample: + + GET /20190901/configuration?compartmentId=ocidv1.tenancy.oc1.phx.1457636318783.examplea3lagrhwsljxg6mk55eo2tfvxwy + + Host: audit.us-phoenix-1.oraclecloud.com + Accept: */* + Accept-Encoding: gzip, deflate, br + Accept-Language: en-US,en;q=0.9 + Authorization: <authorization string> + Connection: keep-alive + opc-request-id: d42a4df0-9c36-45f9-b980-example94486 + User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.99 Safari/537.36 + x-date: Mon, 09 Jul 2018 22:59:27 GMT + put: + description: Update the configuration + operationId: UpdateConfiguration + parameters: + - $ref: '#/components/parameters/ConfigurationCompartmentIdQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateConfigurationDetails' + description: The configuration properties + required: true + responses: + '202': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateConfiguration + tags: + - Audit + x-example: | + Syntax: + + PUT /20190901/configuration?compartmentId=<compartment_OCID> + + { + "retentionPeriodDays": 90 + } + + Sample: + + PUT /20190901/configuration?compartmentId=ocidv1.tenancy.oc1.phx.1457636318783.examplea3lagrhwsljxg6mk55eo2tfvxwy + + Host: audit.us-phoenix-1.oraclecloud.com + User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.99 Safari/537.36 + Accept: */* + Accept-Encoding: gzip, deflate, br + Accept-Language: en-US,en;q=0.9 + Authorization: <authorization string> + Connection: keep-alive + Content-Length: 27 + Content-Type: application/json + opc-request-id: 8b801765-e63d-4fb4-a3a9-example684c3a4 + x-date: Mon, 09 Jul 2018 22:55:13 GMT + + { + "retentionPeriodDays": 90 + } + x-related-resource: '#/definitions/Configuration' +components: + schemas: + AuditEvent: + description: | + All the attributes of an audit event. For more information, see [Viewing Audit Log Events](/iaas/Content/Audit/Tasks/viewinglogevents.htm). + properties: + cloudEventsVersion: + description: | + The version of the CloudEvents specification. The structure of the envelope follows the + [CloudEvents](https://github.com/cloudevents/spec) industry standard format hosted by the + [Cloud Native Computing Foundation ( CNCF)](https://www.cncf.io/). + + Audit uses version 0.1 specification of the CloudEvents event envelope. + + Example: `0.1` + maxLength: 255 + minLength: 1 + type: string + contentType: + description: | + The content type of the data contained in `data`. + + Example: `application/json` + maxLength: 255 + minLength: 1 + type: string + data: + $ref: '#/components/schemas/data' + eventId: + description: | + The GUID of the event. + maxLength: 255 + minLength: 1 + type: string + eventTime: + description: | + The time the event occurred, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + + Example: `2019-09-18T00:10:59.252Z` + format: date-time + type: string + eventType: + description: | + The type of event that happened. + + The service that produces the event can also add, remove, or change the meaning of a field. + A service implementing these type changes would publish a new version of an `eventType` and + revise the `eventTypeVersion` field. + + Example: `com.oraclecloud.ComputeApi.GetInstance` + maxLength: 1024 + minLength: 1 + type: string + eventTypeVersion: + description: | + The version of the event type. This version applies to the payload of the event, not the envelope. + Use `cloudEventsVersion` to determine the version of the envelope. + + Example: `2.0` + maxLength: 255 + minLength: 1 + type: string + source: + description: | + The source of the event. + + Example: `ComputeApi` + maxLength: 1024 + minLength: 1 + type: string + required: + - eventType + - cloudEventsVersion + - eventTypeVersion + - source + - eventId + - eventTime + - contentType + - data + type: object + x-example: | + { + "eventType": "com.oraclecloud.ComputeApi.GetInstance", + "cloudEventsVersion": "0.1", + "eventTypeVersion": "2.0", + "source": "ComputeApi", + "eventId": "<unique_ID>", + "eventTime": "2019-09-18T00:10:59.252Z", + "contentType": "application/json", + "data": { + "eventGroupingId": null, + "eventName": "GetInstance", + "compartmentId": "ocid1.tenancy.oc1..<unique_ID>", + "compartmentName": "compartmentA", + "resourceName": "my_instance", + "resourceId": "ocid1.instance.oc1.phx.<unique_ID>", + "availabilityDomain": "", + "freeformTags": null, + "definedTags": null, + "identity": { + "principalName": "ExampleName", + "principalId": "ocid1.user.oc1..<unique_ID>", + "authType": "natv", + "callerName": null, + "callerId": null, + "tenantId": "ocid1.tenancy.oc1..<unique_ID>", + "ipAddress": "172.24.80.88", + "credentials": null, + "userAgent": "Jersey/2.23 (HttpUrlConnection 1.8.0_212)", + "consoleSessionId": null + }, + "request": { + "id": "<unique_ID>", + "path": "/20160918/instances/ocid1.instance.oc1.phx.<unique_ID>", + "action": "GET", + "parameters": {}, + "headers": { + "opc-principal": [ + "{\"tenantId\":\"ocid1.tenancy.oc1..<unique_ID>\",\"subjectId\":\"ocid1.user.oc1..<unique_ID>\",\"claims\":[{\"key\":\"pstype\",\"value\":\"natv\",\"issuer\":\"authService.oracle.com\"},{\"key\":\"h_host\",\"value\":\"iaas.r2.oracleiaas.com\",\"issuer\":\"h\"},{\"key\":\"h_opc-request-id\",\"value\":\"<unique_ID>\",\"issuer\":\"h\"},{\"key\":\"ptype\",\"value\":\"user\",\"issuer\":\"authService.oracle.com\"},{\"key\":\"h_date\",\"value\":\"Wed, 18 Sep 2019 00:10:58 UTC\",\"issuer\":\"h\"},{\"key\":\"h_accept\",\"value\":\"application/json\",\"issuer\":\"h\"},{\"key\":\"authorization\",\"value\":\"Signature headers=\\\"date (request-target) host accept opc-request-id\\\",keyId=\\\"ocid1.tenancy.oc1..<unique_ID>/ocid1.user.oc1..<unique_ID>/8c:b4:5f:18:e7:ec:db:08:b8:fa:d2:2a:7d:11:76:ac\\\",algorithm=\\\"rsa-pss-sha256\\\",signature=\\\"<unique_ID>\\\",version=\\\"1\\\"\",\"issuer\":\"h\"},{\"key\":\"h_(request-target)\",\"value\":\"get /20160918/instances/ocid1.instance.oc1.phx.<unique_ID>\",\"issuer\":\"h\"}]}" + ], + "Accept": [ + "application/json" + ], + "X-Oracle-Auth-Client-CN": [ + "splat-proxy-se-02302.node.ad2.r2" + ], + "X-Forwarded-Host": [ + "compute-api.svc.ad1.r2" + ], + "Connection": [ + "close" + ], + "User-Agent": [ + "Jersey/2.23 (HttpUrlConnection 1.8.0_212)" + ], + "X-Forwarded-For": [ + "172.24.80.88" + ], + "X-Real-IP": [ + "172.24.80.88" + ], + "oci-original-url": [ + "https://iaas.r2.oracleiaas.com/20160918/instances/ocid1.instance.oc1.phx.<unique_ID>" + ], + "opc-request-id": [ + "<unique_ID>" + ], + "Date": [ + "Wed, 18 Sep 2019 00:10:58 UTC" + ] + } + }, + "response": { + "status": "200", + "responseTime": "2019-09-18T00:10:59.278Z", + "headers": { + "ETag": [ + "<unique_ID>" + ], + "Connection": [ + "close" + ], + "Content-Length": [ + "1828" + ], + "opc-request-id": [ + "<unique_ID>" + ], + "Date": [ + "Wed, 18 Sep 2019 00:10:59 GMT" + ], + "Content-Type": [ + "application/json" + ] + }, + "payload": { + "resourceName": "my_instance", + "id": "ocid1.instance.oc1.phx.<unique_ID>" + }, + "message": null + }, + "stateChange": { + "previous": null, + "current": null + }, + "additionalDetails": { + "imageId": "ocid1.image.oc1.phx.<unique_ID>", + "shape": "VM.Standard1.1", + "type": "CustomerVmi" + } + } + } + Configuration: + description: | + The retention period setting, specified in days. For more information, see [Setting Audit + Log Retention Period](/iaas/Content/Audit/Tasks/settingretentionperiod.htm). + properties: + retentionPeriodDays: + description: | + The retention period setting, specified in days. The minimum is 90, the maximum 365. + + Example: `90` + type: integer + type: object + x-example: | + { + "retentionPeriodDays": 90 + } + UpdateConfigurationDetails: + description: | + The configuration details for the retention period setting, specified in days. For more + information, see [Setting Audit Log Retention Period](/iaas/Content/Audit/Tasks/settingretentionperiod.htm). + properties: + retentionPeriodDays: + description: | + The retention period setting, specified in days. The minimum is 90, the maximum 365. + + Example: `90` + maximum: 365 + minimum: 90 + type: integer + required: + - retentionPeriodDays + type: object + x-example: | + { + "retentionPeriodDays": 90 + } + data: + description: | + The payload of the event. Information within `data` comes from the resource emitting the event. + properties: + additionalDetails: + additionalProperties: + type: string + description: (opaque JSON object) + description: | + A container object for attribues unique to the resource emitting the event. + + Example: + + ----- + { + "imageId": "ocid1.image.oc1.phx.", + "shape": "VM.Standard1.1", + "type": "CustomerVmi" + } + ----- + type: object + availabilityDomain: + description: | + The availability domain where the resource resides. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment of the resource + emitting the event. + maxLength: 255 + minLength: 1 + type: string + compartmentName: + description: | + The name of the compartment. This value is the friendly name associated with compartmentId. + This value can change, but the service logs the value that appeared at the time of the audit + event. + + Example: `CompartmentA` + maxLength: 100 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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 + eventGroupingId: + description: | + This value links multiple audit events that are part of the same API operation. For example, + a long running API operations that emit an event at the start and the end of an operation + would use the same value in this field for both events. + maxLength: 255 + minLength: 1 + type: string + eventName: + description: | + Name of the API operation that generated this event. + + Example: `GetInstance` + 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. Exists for cross-compatibility only. For more information, + see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + identity: + $ref: '#/components/schemas/identity' + request: + $ref: '#/components/schemas/request' + resourceId: + description: | + An [OCID](/Content/General/Concepts/identifiers.htm) or some other ID for the resource + emitting the event. + maxLength: 255 + minLength: 1 + type: string + resourceName: + description: | + The name of the resource emitting the event. + maxLength: 255 + minLength: 1 + type: string + response: + $ref: '#/components/schemas/response' + stateChange: + $ref: '#/components/schemas/stateChange' + type: object + x-example: | + { + "eventGroupingId": null, + "eventName": "GetInstance", + "compartmentId": "ocid1.tenancy.oc1..<unique_ID>", + "compartmentName": "compartmentA", + "resourceName": "my_instance", + "resourceId": "ocid1.instance.oc1.phx.<unique_ID>", + "availabilityDomain": "", + "freeformTags": null, + "definedTags": null, + "identity": { + "principalName": "ExampleName", + "principalId": "ocid1.user.oc1..<unique_ID>", + "authType": "natv", + "callerName": null, + "callerId": null, + "tenantId": "ocid1.tenancy.oc1..<unique_ID>", + "ipAddress": "172.24.80.88", + "credentials": null, + "userAgent": "Jersey/2.23 (HttpUrlConnection 1.8.0_212)", + "consoleSessionId": null + }, + "request": { + "id": "<unique_ID>", + "path": "/20160918/instances/ocid1.instance.oc1.phx.<unique_ID>", + "action": "GET", + "parameters": {}, + "headers": { + "opc-principal": [ + "{\"tenantId\":\"ocid1.tenancy.oc1..<unique_ID>\",\"subjectId\":\"ocid1.user.oc1..<unique_ID>\",\"claims\":[{\"key\":\"pstype\",\"value\":\"natv\",\"issuer\":\"authService.oracle.com\"},{\"key\":\"h_host\",\"value\":\"iaas.r2.oracleiaas.com\",\"issuer\":\"h\"},{\"key\":\"h_opc-request-id\",\"value\":\"<unique_ID>\",\"issuer\":\"h\"},{\"key\":\"ptype\",\"value\":\"user\",\"issuer\":\"authService.oracle.com\"},{\"key\":\"h_date\",\"value\":\"Wed, 18 Sep 2019 00:10:58 UTC\",\"issuer\":\"h\"},{\"key\":\"h_accept\",\"value\":\"application/json\",\"issuer\":\"h\"},{\"key\":\"authorization\",\"value\":\"Signature headers=\\\"date (request-target) host accept opc-request-id\\\",keyId=\\\"ocid1.tenancy.oc1..<unique_ID>/ocid1.user.oc1..<unique_ID>/8c:b4:5f:18:e7:ec:db:08:b8:fa:d2:2a:7d:11:76:ac\\\",algorithm=\\\"rsa-pss-sha256\\\",signature=\\\"<unique_ID>\\\",version=\\\"1\\\"\",\"issuer\":\"h\"},{\"key\":\"h_(request-target)\",\"value\":\"get /20160918/instances/ocid1.instance.oc1.phx.<unique_ID>\",\"issuer\":\"h\"}]}" + ], + "Accept": [ + "application/json" + ], + "X-Oracle-Auth-Client-CN": [ + "splat-proxy-se-02302.node.ad2.r2" + ], + "X-Forwarded-Host": [ + "compute-api.svc.ad1.r2" + ], + "Connection": [ + "close" + ], + "User-Agent": [ + "Jersey/2.23 (HttpUrlConnection 1.8.0_212)" + ], + "X-Forwarded-For": [ + "172.24.80.88" + ], + "X-Real-IP": [ + "172.24.80.88" + ], + "oci-original-url": [ + "https://iaas.r2.oracleiaas.com/20160918/instances/ocid1.instance.oc1.phx.<unique_ID>" + ], + "opc-request-id": [ + "<unique_ID>" + ], + "Date": [ + "Wed, 18 Sep 2019 00:10:58 UTC" + ] + } + }, + "response": { + "status": "200", + "responseTime": "2019-09-18T00:10:59.278Z", + "headers": { + "ETag": [ + "<unique_ID>" + ], + "Connection": [ + "close" + ], + "Content-Length": [ + "1828" + ], + "opc-request-id": [ + "<unique_ID>" + ], + "Date": [ + "Wed, 18 Sep 2019 00:10:59 GMT" + ], + "Content-Type": [ + "application/json" + ] + }, + "payload": { + "resourceName": "my_instance", + "id": "ocid1.instance.oc1.phx.<unique_ID>" + }, + "message": null + }, + "stateChange": { + "previous": null, + "current": null + }, + "additionalDetails": { + "imageId": "ocid1.image.oc1.phx.<unique_ID>", + "shape": "VM.Standard1.1", + "type": "CustomerVmi" + } + } + Error: + properties: + code: + description: | + A short error code that defines the error, meant for programmatic parsing. See + [API Errors](/Content/API/References/apierrors.htm). + + Example: `400` + format: string + type: string + message: + description: | + A human-readable error string. + + Example: `InvalidParameter` + format: string + type: string + required: + - code + - message + type: object + x-example: | + { + "code" : "400", + "message" : "InvalidParameter" + } + identity: + description: | + A container object for identity attributes. + properties: + authType: + description: | + The type of authentication used. + + Example: `natv` + maxLength: 255 + minLength: 1 + type: string + callerId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the caller. The caller that made a + request on behalf of the prinicpal. + maxLength: 255 + minLength: 1 + type: string + callerName: + description: | + The name of the user or service. This value is the friendly name associated with `callerId`. + maxLength: 100 + minLength: 1 + type: string + consoleSessionId: + description: | + This value identifies any Console session associated with this request. + maxLength: 255 + minLength: 1 + type: string + credentials: + description: | + The credential ID of the user. This value is extracted from the HTTP 'Authorization' request + header. It consists of the tenantId, userId, and user fingerprint, all delimited by a slash (/). + maxLength: 255 + minLength: 1 + type: string + ipAddress: + description: | + The IP address of the source of the request. + + Example: `172.24.80.88` + maxLength: 255 + minLength: 1 + type: string + principalId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the principal. + maxLength: 255 + minLength: 1 + type: string + principalName: + description: | + The name of the user or service. This value is the friendly name associated with `principalId`. + + Example: `ExampleName` + maxLength: 100 + minLength: 1 + type: string + tenantId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the tenant. + maxLength: 255 + minLength: 1 + type: string + userAgent: + description: | + The user agent of the client that made the request. + + Example: `Jersey/2.23 (HttpUrlConnection 1.8.0_212)` + maxLength: 1024 + minLength: 1 + type: string + type: object + x-example: | + { + "principalName": "ExampleName", + "principalId": "ocid1.user.oc1..<unique_ID>", + "authType": "natv", + "callerName": null, + "callerId": null, + "tenantId": "ocid1.tenancy.oc1..<unique_ID>", + "ipAddress": "172.24.80.88", + "credentials": null, + "userAgent": "Jersey/2.23 (HttpUrlConnection 1.8.0_212)", + "consoleSessionId": null + } + request: + description: | + A container object for request attributes. + properties: + action: + description: | + The HTTP method of the request. + + Example: `GET` + maxLength: 255 + minLength: 1 + type: string + headers: + additionalProperties: + items: + type: string + type: array + description: | + The HTTP header fields and values in the request. + + Example: + + ----- + { + "opc-principal": [ + "{\"tenantId\":\"ocid1.tenancy.oc1..\",\"subjectId\":\"ocid1.user.oc1..\",\"claims\":[{\"key\":\"pstype\",\"value\":\"natv\",\"issuer\":\"authService.oracle.com\"},{\"key\":\"h_host\",\"value\":\"iaas.r2.oracleiaas.com\",\"issuer\":\"h\"},{\"key\":\"h_opc-request-id\",\"value\":\"\",\"issuer\":\"h\"},{\"key\":\"ptype\",\"value\":\"user\",\"issuer\":\"authService.oracle.com\"},{\"key\":\"h_date\",\"value\":\"Wed, 18 Sep 2019 00:10:58 UTC\",\"issuer\":\"h\"},{\"key\":\"h_accept\",\"value\":\"application/json\",\"issuer\":\"h\"},{\"key\":\"authorization\",\"value\":\"Signature headers=\\\"date (request-target) host accept opc-request-id\\\",keyId=\\\"ocid1.tenancy.oc1../ocid1.user.oc1../8c:b4:5f:18:e7:ec:db:08:b8:fa:d2:2a:7d:11:76:ac\\\",algorithm=\\\"rsa-pss-sha256\\\",signature=\\\"\\\",version=\\\"1\\\"\",\"issuer\":\"h\"},{\"key\":\"h_(request-target)\",\"value\":\"get /20160918/instances/ocid1.instance.oc1.phx.\",\"issuer\":\"h\"}]}" + ], + "Accept": [ + "application/json" + ], + "X-Oracle-Auth-Client-CN": [ + "splat-proxy-se-02302.node.ad2.r2" + ], + "X-Forwarded-Host": [ + "compute-api.svc.ad1.r2" + ], + "Connection": [ + "close" + ], + "User-Agent": [ + "Jersey/2.23 (HttpUrlConnection 1.8.0_212)" + ], + "X-Forwarded-For": [ + "172.24.80.88" + ], + "X-Real-IP": [ + "172.24.80.88" + ], + "oci-original-url": [ + "https://iaas.r2.oracleiaas.com/20160918/instances/ocid1.instance.oc1.phx." + ], + "opc-request-id": [ + "" + ], + "Date": [ + "Wed, 18 Sep 2019 00:10:58 UTC" + ] + } + ----- + type: object + id: + description: | + The opc-request-id of the request. + maxLength: 255 + minLength: 1 + type: string + parameters: + additionalProperties: + items: + type: string + type: array + description: | + The parameters supplied by the caller during this operation. + type: object + path: + description: | + The full path of the API request. + + Example: `/20160918/instances/ocid1.instance.oc1.phx.` + type: string + type: object + x-example: | + { + "id": "<unique_ID>", + "path": "/20160918/instances/ocid1.instance.oc1.phx.<unique_ID>", + "action": "GET", + "parameters": {}, + "headers": { + "opc-principal": [ + "{\"tenantId\":\"ocid1.tenancy.oc1..<unique_ID>\",\"subjectId\":\"ocid1.user.oc1..<unique_ID>\",\"claims\":[{\"key\":\"pstype\",\"value\":\"natv\",\"issuer\":\"authService.oracle.com\"},{\"key\":\"h_host\",\"value\":\"iaas.r2.oracleiaas.com\",\"issuer\":\"h\"},{\"key\":\"h_opc-request-id\",\"value\":\"<unique_ID>\",\"issuer\":\"h\"},{\"key\":\"ptype\",\"value\":\"user\",\"issuer\":\"authService.oracle.com\"},{\"key\":\"h_date\",\"value\":\"Wed, 18 Sep 2019 00:10:58 UTC\",\"issuer\":\"h\"},{\"key\":\"h_accept\",\"value\":\"application/json\",\"issuer\":\"h\"},{\"key\":\"authorization\",\"value\":\"Signature headers=\\\"date (request-target) host accept opc-request-id\\\",keyId=\\\"ocid1.tenancy.oc1..<unique_ID>/ocid1.user.oc1..<unique_ID>/8c:b4:5f:18:e7:ec:db:08:b8:fa:d2:2a:7d:11:76:ac\\\",algorithm=\\\"rsa-pss-sha256\\\",signature=\\\"<unique_ID>\\\",version=\\\"1\\\"\",\"issuer\":\"h\"},{\"key\":\"h_(request-target)\",\"value\":\"get /20160918/instances/ocid1.instance.oc1.phx.<unique_ID>\",\"issuer\":\"h\"}]}" + ], + "Accept": [ + "application/json" + ], + "X-Oracle-Auth-Client-CN": [ + "splat-proxy-se-02302.node.ad2.r2" + ], + "X-Forwarded-Host": [ + "compute-api.svc.ad1.r2" + ], + "Connection": [ + "close" + ], + "User-Agent": [ + "Jersey/2.23 (HttpUrlConnection 1.8.0_212)" + ], + "X-Forwarded-For": [ + "172.24.80.88" + ], + "X-Real-IP": [ + "172.24.80.88" + ], + "oci-original-url": [ + "https://iaas.r2.oracleiaas.com/20160918/instances/ocid1.instance.oc1.phx.<unique_ID>" + ], + "opc-request-id": [ + "<unique_ID>" + ], + "Date": [ + "Wed, 18 Sep 2019 00:10:58 UTC" + ] + } + } + response: + description: | + A container object for response attributes. + properties: + headers: + additionalProperties: + items: + type: string + type: array + description: | + The headers of the response. + + Example: + + ----- + { + "ETag": [ + "" + ], + "Connection": [ + "close" + ], + "Content-Length": [ + "1828" + ], + "opc-request-id": [ + "" + ], + "Date": [ + "Wed, 18 Sep 2019 00:10:59 GMT" + ], + "Content-Type": [ + "application/json" + ] + } + ----- + type: object + message: + description: | + A friendly description of what happened during the operation. Use this for troubleshooting. + maxLength: 1024 + minLength: 1 + type: string + payload: + additionalProperties: + type: string + description: (opaque JSON object) + description: | + This value is included for backward compatibility with the Audit version 1 schema, where + it contained metadata of interest from the response payload. + + Example: + + ----- + { + "resourceName": "my_instance", + "id": "ocid1.instance.oc1.phx." + } + ----- + type: object + responseTime: + description: | + The time of the response to the audited request, expressed in + [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + + Example: `2019-09-18T00:10:59.278Z` + format: date-time + type: string + status: + description: | + The status code of the response. + + Example: `200` + maxLength: 255 + minLength: 1 + type: string + type: object + x-example: | + { + "status": "200", + "responseTime": "2019-09-18T00:10:59.278Z", + "headers": { + "ETag": [ + "" + ], + "Connection": [ + "close" + ], + "Content-Length": [ + "1828" + ], + "opc-request-id": [ + "" + ], + "Date": [ + "Wed, 18 Sep 2019 00:10:59 GMT" + ], + "Content-Type": [ + "application/json" + ] + }, + "payload": { + "resourceName": "my_instance", + "id": "ocid1.instance.oc1.phx." + }, + "message": null + } + stateChange: + description: | + A container object for state change attributes. + properties: + current: + additionalProperties: + type: string + description: (opaque JSON object) + description: | + Provides the current state of fields that may have changed during an operation. To determine + how the current operation changed a resource, compare the information in this attribute to + `previous`. + type: object + previous: + additionalProperties: + type: string + description: (opaque JSON object) + description: | + Provides the previous state of fields that may have changed during an operation. To determine + how the current operation changed a resource, compare the information in this attribute to + `current`. + type: object + type: object + x-example: | + { + "previous": null, + "current": null + } + ListEventsResponse: + type: object + properties: + events: + type: array + items: + $ref: '#/components/schemas/AuditEvent' + responses: + '400': + description: Bad Request + 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' + '401': + description: Unauthorized + 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' + '404': + description: Not Found + 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' + '429': + description: Too Many Requests + 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' + '500': + description: Internal Server 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' + DefaultError: + description: An error has occurred + 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' + parameters: + CompartmentIdQueryParam: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + in: query + name: compartmentId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + StartWithQueryParam: + description: | + Returns events that were processed at or after this start date and time, expressed in + [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + + For example, a start value of `2017-01-15T11:30:00Z` will retrieve a list of all events processed + since 30 minutes after the 11th hour of January 15, 2017, in Coordinated Universal Time (UTC). + You can specify a value with granularity to the minute. Seconds (and milliseconds, if included) must + be set to `0`. + in: query + name: startTime + required: true + schema: + type: string + format: date-time + EndBeforeQueryParam: + description: | + Returns events that were processed before this end date and time, expressed in + [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + + For example, a start value of `2017-01-01T00:00:00Z` and an end value of `2017-01-02T00:00:00Z` + will retrieve a list of all events processed on January 1, 2017. Similarly, a start value of + `2017-01-01T00:00:00Z` and an end value of `2017-02-01T00:00:00Z` will result in a list of all + events processed between January 1, 2017 and January 31, 2017. You can specify a value with + granularity to the minute. Seconds (and milliseconds, if included) must be set to `0`. + in: query + name: endTime + required: true + schema: + type: string + format: date-time + PaginationTokenQueryParam: + description: | + For list pagination. The value of the `opc-next-page` response header from the previous "List" call. + For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + in: query + name: page + schema: + type: string + minLength: 1 + maxLength: 1024 + RequestIdHeader: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + schema: + type: string + pattern: '[A-Za-z0-9\\-_\\.]+' + ConfigurationCompartmentIdQueryParam: + description: ID of the root compartment (tenancy) + in: query + name: compartmentId + required: true + schema: + type: string + x-stackQL-resources: + events: + id: oci.audit.events + name: events + title: Events + methods: + list: + operation: + $ref: '#/paths/~1auditEvents/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.events + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListEventsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"events\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/events/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + configurations: + id: oci.audit.configurations + name: configurations + title: Configurations + methods: + get: + operation: + $ref: '#/paths/~1configuration/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1configuration/put' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/configurations/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/configurations/methods/update' + delete: [] + replace: [] +servers: + - url: https://audit.{region}.oraclecloud.com/20190901 + variables: + region: + default: us-ashburn-1 + description: OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. + x-stackQL-envVar: OCI_REGION +x-stackQL-config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: opc-next-page + location: header diff --git a/providers/src/oci/v00.00.00000/services/block_storage.yaml b/providers/src/oci/v00.00.00000/services/block_storage.yaml new file mode 100644 index 00000000..e3644506 --- /dev/null +++ b/providers/src/oci/v00.00.00000/services/block_storage.yaml @@ -0,0 +1,7022 @@ +openapi: 3.0.0 +info: + title: block_storage API + description: oci block_storage API + version: '20160918' +paths: + /blockVolumeReplicas: + get: + description: | + Lists the block volume replicas in the specified compartment and availability domain. + operationId: ListBlockVolumeReplicas + parameters: + - $ref: '#/components/parameters/RequiredAvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/BlockVolumeReplica/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListBlockVolumeReplicasResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListBlockVolumeReplicas + tags: + - blockstorage + /blockVolumeReplicas/{blockVolumeReplicaId}: + get: + description: Gets information for the specified block volume replica. + operationId: GetBlockVolumeReplica + parameters: + - $ref: '#/components/parameters/BlockVolumeReplicaIdPathParam' + responses: + '200': + description: The block volume replica's information has been retrieved. + 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/BlockVolumeReplica' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetBlockVolumeReplica + tags: + - blockstorage + /bootVolumeBackups: + get: + description: | + Lists the boot volume backups in the specified compartment. You can filter the results by boot volume. + operationId: ListBootVolumeBackups + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/BootVolumeIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/FilterBySourceBootVolumeBackupIdQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state value is + case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/BootVolumeBackup/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListBootVolumeBackupsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListBootVolumeBackups + tags: + - blockstorage + post: + description: | + Creates a new boot volume backup of the specified boot volume. For general information about boot volume backups, + see [Overview of Boot Volume Backups](/iaas/Content/Block/Concepts/bootvolumebackups.htm) + + When the request is received, the backup object is in a REQUEST_RECEIVED state. + When the data is imaged, it goes into a CREATING state. + After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state. + operationId: CreateBootVolumeBackup + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBootVolumeBackupDetails' + description: Request to create a new backup of given boot volume. + required: true + responses: + '200': + description: The boot volume backup is being created. + 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/BootVolumeBackup' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateBootVolumeBackup + tags: + - blockstorage + /bootVolumeBackups/{bootVolumeBackupId}: + delete: + description: Deletes a boot volume backup. + operationId: DeleteBootVolumeBackup + parameters: + - $ref: '#/components/parameters/BootVolumeBackupIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The boot volume backup is being 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteBootVolumeBackup + tags: + - blockstorage + get: + description: Gets information for the specified boot volume backup. + operationId: GetBootVolumeBackup + parameters: + - $ref: '#/components/parameters/BootVolumeBackupIdPathParam' + responses: + '200': + description: The boot volume backup was retrieved. + 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/BootVolumeBackup' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetBootVolumeBackup + tags: + - blockstorage + put: + description: | + Updates the display name for the specified boot volume backup. + Avoid entering confidential information. + operationId: UpdateBootVolumeBackup + parameters: + - $ref: '#/components/parameters/BootVolumeBackupIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBootVolumeBackupDetails' + description: Update boot volume backup fields + required: true + responses: + '200': + description: The boot volume backup was updated. + headers: + etag: + description: | + For optimistic concurrency control. See `if-match`. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/BootVolumeBackup' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateBootVolumeBackup + tags: + - blockstorage + /bootVolumeBackups/{bootVolumeBackupId}/actions/changeCompartment: + post: + description: | + Moves a boot volume backup into a different compartment within the same tenancy. + For information about moving resources between compartments, + see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeBootVolumeBackupCompartment + parameters: + - $ref: '#/components/parameters/BootVolumeBackupIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeBootVolumeBackupCompartmentDetails' + description: Request to change the compartment of given boot volume backup. + required: true + responses: + '204': + description: The BootVolume Backup Compartment Details is being changed. + 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeBootVolumeBackupCompartment + tags: + - blockstorage + x-related-resource: '#/definitions/BootVolumeBackup' + /bootVolumeBackups/{bootVolumeBackupId}/actions/copy: + post: + description: | + Creates a boot volume backup copy in specified region. For general information about volume backups, + see [Overview of Boot Volume Backups](/iaas/Content/Block/Concepts/bootvolumebackups.htm) + operationId: CopyBootVolumeBackup + parameters: + - $ref: '#/components/parameters/BootVolumeBackupIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CopyBootVolumeBackupDetails' + description: Request to create a cross-region copy of given boot volume backup. + required: true + responses: + '200': + description: The boot volume backup copy is being created in specified region. + headers: + content-location: + description: | + Location of the resource. + schema: + type: string + etag: + description: | + For optimistic concurrency control. See `if-match`. + schema: + type: string + location: + description: | + Location of the resource. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/BootVolumeBackup' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateBootVolumeBackupCopy + tags: + - blockstorage + x-related-resource: '#/definitions/BootVolumeBackup' + /bootVolumeReplicas: + get: + description: | + Lists the boot volume replicas in the specified compartment and availability domain. + operationId: ListBootVolumeReplicas + parameters: + - $ref: '#/components/parameters/RequiredAvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/BootVolumeReplica/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListBootVolumeReplicasResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListBootVolumeReplicas + tags: + - blockstorage + /bootVolumeReplicas/{bootVolumeReplicaId}: + get: + description: Gets information for the specified boot volume replica. + operationId: GetBootVolumeReplica + parameters: + - $ref: '#/components/parameters/BootVolumeReplicaIdPathParam' + responses: + '200': + description: The boot volume replica's information has been retrieved. + 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/BootVolumeReplica' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetBootVolumeReplica + tags: + - blockstorage + /bootVolumes: + get: + description: | + Lists the boot volumes in the specified compartment and availability domain. + operationId: ListBootVolumes + parameters: + - $ref: '#/components/parameters/RequiredAvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/VolumeGroupIdQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListBootVolumesResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListBootVolumes + tags: + - blockstorage + post: + description: | + Creates a new boot volume in the specified compartment from an existing boot volume or a boot volume backup. + For general information about boot volumes, see [Boot Volumes](/iaas/Content/Block/Concepts/bootvolumes.htm). + You may optionally specify a *display name* for the volume, which is simply a friendly name or + description. It does not have to be unique, and you can change it. Avoid entering confidential information. + operationId: CreateBootVolume + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBootVolumeDetails' + description: Request to create a new boot volume. + required: true + responses: + '200': + description: The boot volume is being created. + 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/BootVolume' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateBootVolume + tags: + - blockstorage + /bootVolumes/{bootVolumeId}: + delete: + description: | + Deletes the specified boot volume. The volume cannot have an active connection to an instance. + To disconnect the boot volume from a connected instance, see + [Disconnecting From a Boot Volume](/iaas/Content/Block/Tasks/deletingbootvolume.htm). + **Warning:** All data on the boot volume will be permanently lost when the boot volume is deleted. + operationId: DeleteBootVolume + parameters: + - $ref: '#/components/parameters/BootVolumeIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The boot volume is being 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 + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteBootVolume + tags: + - blockstorage + get: + description: Gets information for the specified boot volume. + operationId: GetBootVolume + parameters: + - $ref: '#/components/parameters/BootVolumeIdPathParam' + responses: + '200': + description: The boot volume's information has been retrieved. + 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/BootVolume' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetBootVolume + tags: + - blockstorage + put: + description: Updates the specified boot volume's display name, defined tags, and free-form tags. + operationId: UpdateBootVolume + parameters: + - $ref: '#/components/parameters/BootVolumeIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBootVolumeDetails' + description: Update boot volume's display name. + required: true + responses: + '200': + description: The boot volume was updated. + 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/BootVolume' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateBootVolume + tags: + - blockstorage + /bootVolumes/{bootVolumeId}/actions/changeCompartment: + post: + description: | + Moves a boot volume into a different compartment within the same tenancy. + For information about moving resources between compartments, + see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeBootVolumeCompartment + parameters: + - $ref: '#/components/parameters/BootVolumeIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeBootVolumeCompartmentDetails' + description: Request to change the compartment of given boot volume. + required: true + responses: + '204': + description: The BootVolume Compartment Details is being changed + 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeBootVolumeCompartment + tags: + - blockstorage + x-related-resource: '#/definitions/BootVolume' + /bootVolumes/{bootVolumeId}/kmsKey: + delete: + description: | + Removes the specified boot volume's assigned Vault Service encryption key. + operationId: DeleteBootVolumeKmsKey + parameters: + - $ref: '#/components/parameters/BootVolumeIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: | + The boot volume's assigned Vault service encryption key is being removed and replaced with an Oracle-managed encryption key. + 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteBootVolumeKmsKey + tags: + - blockstorage + get: + description: | + Gets the Vault service encryption key assigned to the specified boot volume. + operationId: GetBootVolumeKmsKey + parameters: + - $ref: '#/components/parameters/BootVolumeIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '200': + description: The OCID of the Vault service master encryption key associated with this boot volume. + 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/BootVolumeKmsKey' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetBootVolumeKmsKey + tags: + - blockstorage + put: + description: | + Updates the specified volume with a new Vault service master encryption key. + operationId: UpdateBootVolumeKmsKey + parameters: + - $ref: '#/components/parameters/BootVolumeIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBootVolumeKmsKeyDetails' + description: Updates the Vault service master encryption key assigned to the specified boot volume. + required: true + responses: + '200': + description: The volume is being updated. + 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/BootVolumeKmsKey' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateBootVolumeKmsKey + tags: + - blockstorage + /volumeBackupPolicies: + get: + description: | + Lists all the volume backup policies available in the specified compartment. + + For more information about Oracle defined backup policies and user defined backup policies, + see [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm). + operationId: ListVolumeBackupPolicies + parameters: + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - description: | + The OCID of the compartment. + If no compartment is specified, the Oracle defined backup policies are listed. + in: query + name: compartmentId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + responses: + '200': + description: The list is being retrieved. + 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/ListVolumeBackupPoliciesResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListVolumeBackupPolicies + tags: + - blockstorage + post: + description: | + Creates a new user defined backup policy. + + For more information about Oracle defined backup policies and user defined backup policies, + see [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm). + operationId: CreateVolumeBackupPolicy + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateVolumeBackupPolicyDetails' + description: Request to create a new scheduled backup policy. + required: true + responses: + '200': + description: The policy is being created. + 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/VolumeBackupPolicy' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateVolumeBackupPolicy + tags: + - blockstorage + /volumeBackupPolicies/{policyId}: + delete: + description: | + Deletes a user defined backup policy. + For more information about user defined backup policies, + see [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#UserDefinedBackupPolicies). + + Avoid entering confidential information. + operationId: DeleteVolumeBackupPolicy + parameters: + - $ref: '#/components/parameters/VolumeBackupPolicyIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The volume backup policy is being 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteVolumeBackupPolicy + tags: + - blockstorage + get: + description: Gets information for the specified volume backup policy. + operationId: GetVolumeBackupPolicy + parameters: + - $ref: '#/components/parameters/VolumeBackupPolicyIdPathParam' + responses: + '200': + description: The volume backup policy was retrieved. + 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/VolumeBackupPolicy' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetVolumeBackupPolicy + tags: + - blockstorage + put: + description: | + Updates a user defined backup policy. + For more information about user defined backup policies, + see [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#UserDefinedBackupPolicies). + + Avoid entering confidential information. + operationId: UpdateVolumeBackupPolicy + parameters: + - $ref: '#/components/parameters/VolumeBackupPolicyIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateVolumeBackupPolicyDetails' + description: Update volume backup policy fields + required: true + responses: + '200': + description: The volume backup policy was updated. + 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/VolumeBackupPolicy' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateVolumeBackupPolicy + tags: + - blockstorage + /volumeBackupPolicyAssignments: + get: + description: | + Gets the volume backup policy assignment for the specified volume. The + `assetId` query parameter is required, and the returned list will contain at most + one item, since volume can only have one volume backup policy assigned at a time. + operationId: GetVolumeBackupPolicyAssetAssignment + parameters: + - $ref: '#/components/parameters/AssetIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/GetVolumeBackupPolicyAssetAssignmentResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetVolumeBackupPolicyAssetAssignment + tags: + - blockstorage + post: + description: | + Assigns a volume backup policy to the specified volume. Note that a given volume can + only have one backup policy assigned to it. If this operation is used for a volume that already + has a different backup policy assigned, the prior backup policy will be silently unassigned. + operationId: CreateVolumeBackupPolicyAssignment + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateVolumeBackupPolicyAssignmentDetails' + description: Request to assign a specified policy to a particular volume. + required: true + responses: + '200': + description: The volume backup policy has been assigned. + 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/VolumeBackupPolicyAssignment' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateVolumeBackupPolicyAssignment + tags: + - blockstorage + /volumeBackupPolicyAssignments/{policyAssignmentId}: + delete: + description: Deletes a volume backup policy assignment. + operationId: DeleteVolumeBackupPolicyAssignment + parameters: + - $ref: '#/components/parameters/VolumeBackupPolicyAssignmentIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The volume backup policy assignment has been 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteVolumeBackupPolicyAssignment + tags: + - blockstorage + get: + description: Gets information for the specified volume backup policy assignment. + operationId: GetVolumeBackupPolicyAssignment + parameters: + - $ref: '#/components/parameters/VolumeBackupPolicyAssignmentIdPathParam' + responses: + '200': + description: The volume backup policy assignment was retrieved. + 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/VolumeBackupPolicyAssignment' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetVolumeBackupPolicyAssignment + tags: + - blockstorage + /volumeBackups: + get: + description: | + Lists the volume backups in the specified compartment. You can filter the results by volume. + operationId: ListVolumeBackups + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/VolumeIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/FilterBySourceVolumeBackupIdQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state + value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/VolumeBackup/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListVolumeBackupsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListVolumeBackups + tags: + - blockstorage + post: + description: | + Creates a new backup of the specified volume. For general information about volume backups, + see [Overview of Block Volume Service Backups](/iaas/Content/Block/Concepts/blockvolumebackups.htm) + + When the request is received, the backup object is in a REQUEST_RECEIVED state. + When the data is imaged, it goes into a CREATING state. + After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state. + operationId: CreateVolumeBackup + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateVolumeBackupDetails' + description: Request to create a new backup of given volume. + required: true + responses: + '200': + description: The volume backup is being created. + 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/VolumeBackup' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateVolumeBackup + tags: + - blockstorage + /volumeBackups/{volumeBackupId}: + delete: + description: Deletes a volume backup. + operationId: DeleteVolumeBackup + parameters: + - $ref: '#/components/parameters/VolumeBackupIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The volume backup is being 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteVolumeBackup + tags: + - blockstorage + get: + description: Gets information for the specified volume backup. + operationId: GetVolumeBackup + parameters: + - $ref: '#/components/parameters/VolumeBackupIdPathParam' + responses: + '200': + description: The volume backup was retrieved. + 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/VolumeBackup' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetVolumeBackup + tags: + - blockstorage + put: + description: | + Updates the display name for the specified volume backup. + Avoid entering confidential information. + operationId: UpdateVolumeBackup + parameters: + - $ref: '#/components/parameters/VolumeBackupIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateVolumeBackupDetails' + description: Update volume backup fields + required: true + responses: + '200': + description: The volume backup was updated. + headers: + etag: + description: | + For optimistic concurrency control. See `if-match`. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/VolumeBackup' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateVolumeBackup + tags: + - blockstorage + /volumeBackups/{volumeBackupId}/actions/changeCompartment: + post: + description: | + Moves a volume backup into a different compartment within the same tenancy. + For information about moving resources between compartments, + see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeVolumeBackupCompartment + parameters: + - $ref: '#/components/parameters/VolumeBackupIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeVolumeBackupCompartmentDetails' + description: Request to change the compartment of given volume backup. + required: true + responses: + '204': + description: The Volume Backup Compartment Details is being changed. + 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeVolumeBackupCompartment + tags: + - blockstorage + x-related-resource: '#/definitions/VolumeBackup' + /volumeBackups/{volumeBackupId}/actions/copy: + post: + description: | + Creates a volume backup copy in specified region. For general information about volume backups, + see [Overview of Block Volume Service Backups](/iaas/Content/Block/Concepts/blockvolumebackups.htm) + operationId: CopyVolumeBackup + parameters: + - $ref: '#/components/parameters/VolumeBackupIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CopyVolumeBackupDetails' + description: Request to create a cross-region copy of given backup. + required: true + responses: + '200': + description: The volume backup copy is being created in specified region. + headers: + content-location: + description: | + Location of the resource. + schema: + type: string + etag: + description: | + For optimistic concurrency control. See `if-match`. + schema: + type: string + location: + description: | + Location of the resource. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/VolumeBackup' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateVolumeBackupCopy + tags: + - blockstorage + x-related-resource: '#/definitions/VolumeBackup' + /volumeGroupBackups: + get: + description: | + Lists the volume group backups in the specified compartment. You can filter the results by volume group. + For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). + operationId: ListVolumeGroupBackups + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/VolumeGroupIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListVolumeGroupBackupsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListVolumeGroupBackups + tags: + - blockstorage + post: + description: | + Creates a new backup volume group of the specified volume group. + For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). + operationId: CreateVolumeGroupBackup + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateVolumeGroupBackupDetails' + description: Request to create a new backup group of given volume group. + required: true + responses: + '200': + description: The volume group backup is being created. + 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/VolumeGroupBackup' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateVolumeGroupBackup + tags: + - blockstorage + /volumeGroupBackups/{volumeGroupBackupId}: + delete: + description: | + Deletes a volume group backup. This operation deletes all the backups in + the volume group. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). + operationId: DeleteVolumeGroupBackup + parameters: + - $ref: '#/components/parameters/VolumeGroupBackupIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The volume group backup is being 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteVolumeGroupBackup + tags: + - blockstorage + get: + description: Gets information for the specified volume group backup. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). + operationId: GetVolumeGroupBackup + parameters: + - $ref: '#/components/parameters/VolumeGroupBackupIdPathParam' + responses: + '200': + description: The volume group backup was retrieved. + 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/VolumeGroupBackup' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetVolumeGroupBackup + tags: + - blockstorage + put: + description: Updates the display name for the specified volume group backup. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). + operationId: UpdateVolumeGroupBackup + parameters: + - $ref: '#/components/parameters/VolumeGroupBackupIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateVolumeGroupBackupDetails' + description: Update volume group backup fields + required: true + responses: + '200': + description: The volume group backup was updated. + headers: + etag: + description: | + For optimistic concurrency control. See `if-match`. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/VolumeGroupBackup' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateVolumeGroupBackup + tags: + - blockstorage + /volumeGroupBackups/{volumeGroupBackupId}/actions/changeCompartment: + post: + description: | + Moves a volume group backup into a different compartment within the same tenancy. + For information about moving resources between compartments, + see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeVolumeGroupBackupCompartment + parameters: + - $ref: '#/components/parameters/VolumeGroupBackupIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeVolumeGroupBackupCompartmentDetails' + description: Request to change the compartment of given volume group backup. + required: true + responses: + '204': + description: The VolumeGroup Backup Compartment Details is being changed. + 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeVolumeGroupBackupCompartment + tags: + - blockstorage + x-related-resource: '#/definitions/VolumeGroupBackup' + /volumeGroupBackups/{volumeGroupBackupId}/actions/copy: + post: + description: | + Creates a volume group backup copy in specified region. For general information about volume group backups, + see [Overview of Block Volume Backups](/iaas/Content/Block/Concepts/blockvolumebackups.htm). + operationId: CopyVolumeGroupBackup + parameters: + - $ref: '#/components/parameters/VolumeGroupBackupIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CopyVolumeGroupBackupDetails' + description: Request to create a cross-region copy of given volume group backup. + required: true + responses: + '200': + description: The volume group backup copy is being created in specified region. + 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/VolumeGroupBackup' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateVolumeGroupBackupCopy + tags: + - blockstorage + x-related-resource: '#/definitions/VolumeGroupBackup' + /volumeGroupReplicas: + get: + description: | + Lists the volume group replicas in the specified compartment. You can filter the results by volume group. + For more information, see [Volume Group Replication](/iaas/Content/Block/Concepts/volumegroupreplication.htm). + operationId: ListVolumeGroupReplicas + parameters: + - $ref: '#/components/parameters/RequiredAvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/VolumeGroupReplica/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListVolumeGroupReplicasResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Lists the volume group replicas in the specified compartment. + tags: + - blockstorage + /volumeGroupReplicas/{volumeGroupReplicaId}: + get: + description: Gets information for the specified volume group replica. + operationId: GetVolumeGroupReplica + parameters: + - $ref: '#/components/parameters/VolumeGroupReplicaIdPathParam' + responses: + '200': + description: The volume group replica was retrieved. + 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/VolumeGroupReplica' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Gets information for the specified volume group replica. + tags: + - blockstorage + /volumeGroups: + get: + description: | + Lists the volume groups in the specified compartment and availability domain. + For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). + operationId: ListVolumeGroups + parameters: + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle + state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/VolumeGroup/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListVolumeGroupsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListVolumeGroups + tags: + - blockstorage + post: + description: | + Creates a new volume group in the specified compartment. + A volume group is a collection of volumes and may be created from a list of volumes, cloning an existing + volume group, or by restoring a volume group backup. + You may optionally specify a *display name* for the volume group, which is simply a friendly name or + description. It does not have to be unique, and you can change it. Avoid entering confidential information. + + For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). + operationId: CreateVolumeGroup + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateVolumeGroupDetails' + description: Request to create a new volume group. + required: true + responses: + '200': + description: The volume group is being created. + 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/VolumeGroup' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateVolumeGroup + tags: + - blockstorage + /volumeGroups/{volumeGroupId}: + delete: + description: | + Deletes the specified volume group. Individual volumes are not deleted, only the volume group is deleted. + For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). + operationId: DeleteVolumeGroup + parameters: + - $ref: '#/components/parameters/VolumeGroupIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The volume group is being 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteVolumeGroup + tags: + - blockstorage + get: + description: Gets information for the specified volume group. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). + operationId: GetVolumeGroup + parameters: + - $ref: '#/components/parameters/VolumeGroupIdPathParam' + responses: + '200': + description: The volume group's information has been retrieved. + 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/VolumeGroup' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetVolumeGroup + tags: + - blockstorage + put: + description: | + Updates the set of volumes in a volume group along with the display name. Use this operation + to add or remove volumes in a volume group. Specify the full list of volume IDs to include in the + volume group. If the volume ID is not specified in the call, it will be removed from the volume group. + Avoid entering confidential information. + + For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). + operationId: UpdateVolumeGroup + parameters: + - $ref: '#/components/parameters/VolumeGroupIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/PreserveVolumeReplicaQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateVolumeGroupDetails' + description: Update volume group's set of volumes and/or display name + required: true + responses: + '200': + description: The volume group was updated. + 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/VolumeGroup' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateVolumeGroup + tags: + - blockstorage + /volumeGroups/{volumeGroupId}/actions/changeCompartment: + post: + description: | + Moves a volume group into a different compartment within the same tenancy. + For information about moving resources between compartments, + see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeVolumeGroupCompartment + parameters: + - $ref: '#/components/parameters/VolumeGroupIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeVolumeGroupCompartmentDetails' + description: Request to change the compartment of given volume group. + required: true + responses: + '204': + description: The VolumeGroup Compartment Details is being changed. + 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeVolumeGroupCompartment + tags: + - blockstorage + x-related-resource: '#/definitions/VolumeGroup' + /volumes: + get: + description: | + Lists the volumes in the specified compartment and availability domain. + operationId: ListVolumes + parameters: + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/VolumeGroupIdQueryParam' + - $ref: '#/components/parameters/FilterByClusterPlacementGroupIdQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state + value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/Volume/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListVolumesResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListVolumes + tags: + - blockstorage + post: + description: | + Creates a new volume in the specified compartment. Volumes can be created in sizes ranging from + 50 GB (51200 MB) to 32 TB (33554432 MB), in 1 GB (1024 MB) increments. By default, volumes are 1 TB (1048576 MB). + For general information about block volumes, see + [Overview of Block Volume Service](/iaas/Content/Block/Concepts/overview.htm). + + A volume and instance can be in separate compartments but must be in the same availability domain. + For information about access control and compartments, see + [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about + availability domains, see [Regions and Availability Domains](/iaas/Content/General/Concepts/regions.htm). + To get a list of availability domains, use the `ListAvailabilityDomains` operation + in the Identity and Access Management Service API. + + You may optionally specify a *display name* for the volume, which is simply a friendly name or + description. It does not have to be unique, and you can change it. Avoid entering confidential information. + operationId: CreateVolume + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateVolumeDetails' + description: Request to create a new volume. + required: true + responses: + '200': + description: The volume is being created. + 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/Volume' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateVolume + tags: + - blockstorage + /volumes/{volumeId}: + delete: + description: | + Deletes the specified volume. The volume cannot have an active connection to an instance. + To disconnect the volume from a connected instance, see + [Disconnecting From a Volume](/iaas/Content/Block/Tasks/disconnectingfromavolume.htm). + **Warning:** All data on the volume will be permanently lost when the volume is deleted. + operationId: DeleteVolume + parameters: + - $ref: '#/components/parameters/VolumeIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The volume is being 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteVolume + tags: + - blockstorage + get: + description: Gets information for the specified volume. + operationId: GetVolume + parameters: + - $ref: '#/components/parameters/VolumeIdPathParam' + responses: + '200': + description: The volume's information has been retrieved. + 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/Volume' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetVolume + tags: + - blockstorage + put: + description: | + Updates the specified volume's display name. + Avoid entering confidential information. + operationId: UpdateVolume + parameters: + - $ref: '#/components/parameters/VolumeIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateVolumeDetails' + description: Update volume's display name. Avoid entering confidential information. + required: true + responses: + '200': + description: The volume was updated. + 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/Volume' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateVolume + tags: + - blockstorage + /volumes/{volumeId}/actions/changeCompartment: + post: + description: | + Moves a volume into a different compartment within the same tenancy. + For information about moving resources between compartments, + see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeVolumeCompartment + parameters: + - $ref: '#/components/parameters/VolumeIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeVolumeCompartmentDetails' + description: Request to change the compartment of given volume. + required: true + responses: + '204': + description: The Volume Compartment Details is being changed. + 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeVolumeCompartment + tags: + - blockstorage + x-related-resource: '#/definitions/Volume' + /volumes/{volumeId}/kmsKey: + delete: + description: | + Removes the specified volume's assigned Vault service encryption key. + operationId: DeleteVolumeKmsKey + parameters: + - $ref: '#/components/parameters/VolumeIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: | + The volume's assigned Vault service encryption key is being removed and replaced with an Oracle-managed encryption key. + 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteVolumeKmsKey + tags: + - blockstorage + get: + description: | + Gets the Vault service encryption key assigned to the specified volume. + operationId: GetVolumeKmsKey + parameters: + - $ref: '#/components/parameters/VolumeIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '200': + description: The OCID of the Vault service master encryption key associated with this volume. + 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/VolumeKmsKey' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetVolumeKmsKey + tags: + - blockstorage + put: + description: | + Updates the specified volume with a new Key Management master encryption key. + operationId: UpdateVolumeKmsKey + parameters: + - $ref: '#/components/parameters/VolumeIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateVolumeKmsKeyDetails' + description: Updates the Vault service master encryption key assigned to the specified volume. + required: true + responses: + '200': + description: The volume is being updated. + 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/VolumeKmsKey' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateVolumeKmsKey + tags: + - blockstorage +components: + schemas: + BlockVolumeReplica: + description: | + An asynchronous replica of a block volume that can then be used to create + a new block volume or recover a block volume. For more information, see [Overview + of Cross-Region Volume Replication](/iaas/Content/Block/Concepts/volumereplication.htm) + To use any of the API operations, you must be authorized in an IAM policy. + If you're not authorized, talk to an administrator. If you're an administrator + who needs to write policies to give users access, see [Getting Started with + Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + properties: + availabilityDomain: + description: | + The availability domain of the block volume replica. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + blockVolumeId: + description: The OCID of the source block volume. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment that contains the block volume replica. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The block volume replica's Oracle ID (OCID). + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of a block volume replica. + enum: + - PROVISIONING + - AVAILABLE + - ACTIVATING + - TERMINATING + - TERMINATED + - FAULTY + type: string + sizeInGBs: + description: | + The size of the source block volume, in GBs. + format: int64 + maximum: 16384 + minimum: 1 + type: integer + timeCreated: + description: | + The date and time the block volume replica was created. Format defined + by [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + timeLastSynced: + description: | + The date and time the block volume replica was last synced from the source block volume. + Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + totalDataTransferredInGBs: + description: | + The total size of the data transferred from the source block volume to the block volume replica, in GBs. + format: int64 + type: integer + volumeGroupReplicaId: + description: | + The OCID of the volume group replica. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - availabilityDomain + - sizeInGBs + - compartmentId + - displayName + - timeCreated + - lifecycleState + - timeLastSynced + - blockVolumeId + type: object + BootVolumeBackup: + description: | + A point-in-time copy of a boot volume that can then be used to create + a new boot volume or recover a boot volume. For more information, see [Overview + of Boot Volume Backups](/iaas/Content/Block/Concepts/bootvolumebackups.htm) + To use any of the API operations, you must be authorized in an IAM policy. + If you're not authorized, talk to an administrator. If you're an administrator + who needs to write policies to give users access, see [Getting Started with + Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + properties: + bootVolumeId: + description: The OCID of the boot volume. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment that contains the boot volume backup. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + expirationTime: + description: | + The date and time the volume backup will expire and be automatically deleted. + Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). This parameter will always be present for backups that + were created automatically by a scheduled-backup policy. For manually created backups, + it will be absent, signifying that there is no expiration time and the backup will + last forever until manually deleted. + format: date-time + 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 + id: + description: The OCID of the boot volume backup. + maxLength: 255 + minLength: 1 + type: string + imageId: + description: | + The image OCID used to create the boot volume the backup is taken from. + maxLength: 255 + minLength: 1 + type: string + kmsKeyId: + description: | + The OCID of the Vault service master encryption assigned to the boot volume backup. + For more information about the Vault service and encryption keys, see + [Overview of Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and + [Using Keys](/iaas/Content/KeyManagement/Tasks/usingkeys.htm). + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of a boot volume backup. + enum: + - CREATING + - AVAILABLE + - TERMINATING + - TERMINATED + - FAULTY + - REQUEST_RECEIVED + type: string + sizeInGBs: + description: | + The size of the boot volume, in GBs. + format: int64 + maximum: 16384 + minimum: 1 + type: integer + sourceBootVolumeBackupId: + description: The OCID of the source boot volume backup. + maxLength: 255 + minLength: 1 + type: string + sourceType: + description: | + Specifies whether the backup was created manually, or via scheduled backup policy. + enum: + - MANUAL + - SCHEDULED + type: string + timeCreated: + description: | + The date and time the boot volume backup was created. This is the time the actual point-in-time image + of the volume data was taken. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + timeRequestReceived: + description: | + The date and time the request to create the boot volume backup was received. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + type: + description: The type of a volume backup. + enum: + - FULL + - INCREMENTAL + type: string + uniqueSizeInGBs: + description: | + The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space + consumed on the boot volume and whether the backup is full or incremental. + format: int64 + maximum: 16384 + minimum: 0 + type: integer + required: + - id + - displayName + - compartmentId + - timeCreated + - lifecycleState + type: object + CreateBootVolumeBackupDetails: + properties: + bootVolumeId: + description: The OCID of the boot volume that needs to be backed up. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + kmsKeyId: + description: | + The OCID of the Vault service key which is the master encryption key for the volume backup. + For more information about the Vault service and encryption keys, see + [Overview of Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and + [Using Keys](/iaas/Content/KeyManagement/Tasks/usingkeys.htm). + maxLength: 255 + minLength: 1 + type: string + type: + description: The type of backup to create. If omitted, defaults to incremental. + enum: + - FULL + - INCREMENTAL + type: string + required: + - bootVolumeId + type: object + UpdateBootVolumeBackupDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + kmsKeyId: + description: | + The OCID of the Vault service key which is the master encryption key for the volume backup. + For more information about the Vault service and encryption keys, see + [Overview of Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and + [Using Keys](/iaas/Content/KeyManagement/Tasks/usingkeys.htm). + maxLength: 255 + minLength: 1 + type: string + type: object + ChangeBootVolumeBackupCompartmentDetails: + description: Contains the details for the compartment to move the boot volume backup to. + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the boot volume backup to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + CopyBootVolumeBackupDetails: + properties: + destinationRegion: + description: | + The name of the destination region. + + Example: `us-ashburn-1` + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + kmsKeyId: + description: | + The OCID of the Vault service key in the destination region which will be the master encryption key + for the copied boot volume backup. If you do not specify this attribute the boot volume backup + will be encrypted with the Oracle-provided encryption key when it is copied to the destination region. + + + For more information about the Vault service and encryption keys, see + [Overview of Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and + [Using Keys](/iaas/Content/KeyManagement/Tasks/usingkeys.htm). + maxLength: 255 + minLength: 1 + type: string + required: + - destinationRegion + type: object + BootVolumeReplica: + description: | + An asynchronous replica of a boot volume that can then be used to create + a new boot volume or recover a boot volume. For more information, see [Overview + of Cross-Region Volume Replication](/iaas/Content/Block/Concepts/volumereplication.htm) + To use any of the API operations, you must be authorized in an IAM policy. + If you're not authorized, talk to an administrator. If you're an administrator + who needs to write policies to give users access, see [Getting Started with + Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + properties: + availabilityDomain: + description: | + The availability domain of the boot volume replica. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + bootVolumeId: + description: The OCID of the source boot volume. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment that contains the boot volume replica. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The boot volume replica's Oracle ID (OCID). + maxLength: 255 + minLength: 1 + type: string + imageId: + description: | + The image OCID used to create the boot volume the replica is replicated from. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of a boot volume replica. + enum: + - PROVISIONING + - AVAILABLE + - ACTIVATING + - TERMINATING + - TERMINATED + - FAULTY + type: string + sizeInGBs: + description: | + The size of the source boot volume, in GBs. + format: int64 + maximum: 16384 + minimum: 1 + type: integer + timeCreated: + description: | + The date and time the boot volume replica was created. Format defined + by [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + timeLastSynced: + description: | + The date and time the boot volume replica was last synced from the source boot volume. + Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + totalDataTransferredInGBs: + description: | + The total size of the data transferred from the source boot volume to the boot volume replica, in GBs. + format: int64 + type: integer + volumeGroupReplicaId: + description: | + The OCID of the volume group replica. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - availabilityDomain + - sizeInGBs + - displayName + - compartmentId + - timeCreated + - lifecycleState + - timeLastSynced + - bootVolumeId + type: object + BootVolume: + description: | + A detachable boot volume device that contains the image used to boot a Compute instance. For more information, see + [Overview of Boot Volumes](/iaas/Content/Block/Concepts/bootvolumes.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + properties: + autoTunedVpusPerGB: + description: | + The number of Volume Performance Units per GB that this boot volume is effectively tuned to. + format: int64 + type: integer + autotunePolicies: + description: The list of autotune policies enabled for this volume. + items: + $ref: '#/components/schemas/AutotunePolicy' + type: array + uniqueItems: true + availabilityDomain: + description: | + The availability domain of the boot volume. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + bootVolumeReplicas: + description: The list of boot volume replicas of this boot volume + items: + $ref: '#/components/schemas/BootVolumeReplicaInfo' + type: array + clusterPlacementGroupId: + description: The clusterPlacementGroup Id of the volume for volume placement. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment that contains the boot volume. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The boot volume's Oracle ID (OCID). + maxLength: 255 + minLength: 1 + type: string + imageId: + description: The image OCID used to create the boot volume. + maxLength: 255 + minLength: 1 + type: string + isAutoTuneEnabled: + description: | + Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. + Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. + type: boolean + isHydrated: + description: | + Specifies whether the boot volume's data has finished copying + from the source boot volume or boot volume backup. + type: boolean + kmsKeyId: + description: The OCID of the Vault service master encryption key assigned to the boot volume. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of a boot volume. + enum: + - PROVISIONING + - RESTORING + - AVAILABLE + - TERMINATING + - TERMINATED + - FAULTY + type: string + sizeInGBs: + description: The size of the boot volume in GBs. + format: int64 + type: integer + sizeInMBs: + description: | + The size of the volume in MBs. The value must be a multiple of 1024. + This field is deprecated. Please use sizeInGBs. + format: int64 + type: integer + sourceDetails: + $ref: '#/components/schemas/BootVolumeSourceDetails' + timeCreated: + description: | + The date and time the boot volume was created. Format defined + by [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + volumeGroupId: + description: The OCID of the source volume group. + maxLength: 255 + minLength: 1 + type: string + vpusPerGB: + description: | + The number of volume performance units (VPUs) that will be applied to this boot volume per GB, + representing the Block Volume service's elastic performance options. + See [Block Volume Performance Levels](/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information. + + Allowed values: + + * `10`: Represents Balanced option. + + * `20`: Represents Higher Performance option. + + * `30`-`120`: Represents the Ultra High Performance option. + + For performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB. + format: int64 + type: integer + required: + - id + - availabilityDomain + - sizeInMBs + - compartmentId + - timeCreated + - lifecycleState + type: object + CreateBootVolumeDetails: + properties: + autotunePolicies: + description: The list of autotune policies to be enabled for this volume. + items: + $ref: '#/components/schemas/AutotunePolicy' + type: array + uniqueItems: true + availabilityDomain: + description: | + The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + bootVolumeReplicas: + description: | + The list of boot volume replicas to be enabled for this boot volume + in the specified destination availability domains. + items: + $ref: '#/components/schemas/BootVolumeReplicaDetails' + maxItems: 1 + type: array + uniqueItems: true + clusterPlacementGroupId: + description: The clusterPlacementGroup Id of the volume for volume placement. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment that contains the boot volume. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + isAutoTuneEnabled: + description: | + Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. + Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. + type: boolean + kmsKeyId: + description: | + The OCID of the Vault service key to assign as the master encryption key + for the boot volume. + maxLength: 255 + minLength: 1 + type: string + sizeInGBs: + description: The size of the volume in GBs. + format: int64 + type: integer + sourceDetails: + $ref: '#/components/schemas/BootVolumeSourceDetails' + vpusPerGB: + description: | + The number of volume performance units (VPUs) that will be applied to this volume per GB, + representing the Block Volume service's elastic performance options. + See [Block Volume Performance Levels](/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information. + + Allowed values: + + * `10`: Represents the Balanced option. + + * `20`: Represents the Higher Performance option. + + * `30`-`120`: Represents the Ultra High Performance option. + + For performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB. + format: int64 + type: integer + required: + - compartmentId + - sourceDetails + type: object + UpdateBootVolumeDetails: + properties: + autotunePolicies: + description: The list of autotune policies to be enabled for this volume. + items: + $ref: '#/components/schemas/AutotunePolicy' + type: array + uniqueItems: true + bootVolumeReplicas: + description: | + The list of boot volume replicas that this boot volume will be updated to have + in the specified destination availability domains. + items: + $ref: '#/components/schemas/BootVolumeReplicaDetails' + maxItems: 1 + type: array + uniqueItems: true + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + isAutoTuneEnabled: + description: | + Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. + Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. + type: boolean + sizeInGBs: + description: The size to resize the volume to in GBs. Has to be larger than the current size. + format: int64 + type: integer + vpusPerGB: + description: | + The number of volume performance units (VPUs) that will be applied to this volume per GB, + representing the Block Volume service's elastic performance options. + See [Block Volume Performance Levels](/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information. + + Allowed values: + + * `10`: Represents Balanced option. + + * `20`: Represents Higher Performance option. + + * `30`-`120`: Represents the Ultra High Performance option. + + For performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB. + format: int64 + type: integer + type: object + ChangeBootVolumeCompartmentDetails: + description: Contains the details for the compartment to move the boot volume to. + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the boot volume to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + BootVolumeKmsKey: + description: | + The Vault service master encryption key associated with this volume. + properties: + kmsKeyId: + description: | + The OCID of the Vault service key assigned to this volume. If the volume is not using Vault service, then the `kmsKeyId` will be a null string. + maxLength: 255 + minLength: 1 + type: string + type: object + UpdateBootVolumeKmsKeyDetails: + properties: + kmsKeyId: + description: | + The OCID of the new Vault service key to assign to protect the specified volume. + This key has to be a valid Vault service key, and policies must exist to allow the user and the Block Volume service to access this key. + If you specify the same OCID as the previous key's OCID, the Block Volume service will use it to regenerate a volume encryption key. + maxLength: 255 + minLength: 1 + type: string + type: object + VolumeBackupPolicy: + description: | + A policy for automatically creating volume backups according to a + recurring schedule. Has a set of one or more schedules that control when and + how backups are created. + + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + properties: + compartmentId: + description: The OCID of the compartment that contains the volume backup. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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 + destinationRegion: + description: | + The paired destination region for copying scheduled backups to. Example `us-ashburn-1`. + See [Region Pairs](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#RegionPairs) for details about paired regions. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The OCID of the volume backup policy. + maxLength: 255 + minLength: 1 + type: string + schedules: + description: The collection of schedules that this policy will apply. + items: + $ref: '#/components/schemas/VolumeBackupSchedule' + type: array + timeCreated: + description: | + The date and time the volume backup policy was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + required: + - id + - displayName + - schedules + - timeCreated + type: object + CreateVolumeBackupPolicyDetails: + description: | + Specifies the properties for creating user defined backup policy. + For more information about user defined backup policies, + see [User Defined Policies](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#UserDefinedBackupPolicies) in + [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm). + properties: + compartmentId: + description: The OCID of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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 + destinationRegion: + description: | + The paired destination region for copying scheduled backups to. Example: `us-ashburn-1`. + See [Region Pairs](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#RegionPairs) for details about paired regions. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + schedules: + description: | + The collection of schedules for the volume backup policy. See + see [Schedules](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#schedules) in + [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm) for more information. + items: + $ref: '#/components/schemas/VolumeBackupSchedule' + type: array + required: + - compartmentId + type: object + UpdateVolumeBackupPolicyDetails: + description: | + Specifies the properties for updating a user defined backup policy. + For more information about user defined backup policies, + see [User Defined Policies](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#UserDefinedBackupPolicies) in + [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm). + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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 + destinationRegion: + description: | + The paired destination region for copying scheduled backups to. Example: `us-ashburn-1`. + Specify `none` to reset the `destinationRegion` parameter. + See [Region Pairs](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#RegionPairs) for details about paired regions. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + schedules: + description: | + The collection of schedules for the volume backup policy. See + see [Schedules](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#schedules) in + [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm) for more information. + items: + $ref: '#/components/schemas/VolumeBackupSchedule' + type: array + type: object + VolumeBackupPolicyAssignment: + description: | + Specifies the volume that the volume backup policy is assigned to. + + For more information about Oracle defined backup policies and custom backup policies, + see [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm). + properties: + assetId: + description: The OCID of the volume the policy has been assigned to. + maxLength: 255 + minLength: 1 + type: string + id: + description: The OCID of the volume backup policy assignment. + maxLength: 255 + minLength: 1 + type: string + policyId: + description: | + The OCID of the volume backup policy that has been assigned to the volume. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the volume backup policy was assigned to the volume. The format is + defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + required: + - id + - policyId + - assetId + - timeCreated + type: object + CreateVolumeBackupPolicyAssignmentDetails: + properties: + assetId: + description: The OCID of the volume to assign the policy to. + maxLength: 255 + minLength: 1 + type: string + policyId: + description: The OCID of the volume backup policy to assign to the volume. + maxLength: 255 + minLength: 1 + type: string + required: + - policyId + - assetId + type: object + VolumeBackup: + description: | + A point-in-time copy of a volume that can then be used to create a new block volume + or recover a block volume. For more information, see + [Overview of Cloud Volume Storage](/iaas/Content/Block/Concepts/overview.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + properties: + compartmentId: + description: The OCID of the compartment that contains the volume backup. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + expirationTime: + description: | + The date and time the volume backup will expire and be automatically deleted. + Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). This parameter will always be present for backups that + were created automatically by a scheduled-backup policy. For manually created backups, + it will be absent, signifying that there is no expiration time and the backup will + last forever until manually deleted. + format: date-time + 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 + id: + description: The OCID of the volume backup. + maxLength: 255 + minLength: 1 + type: string + kmsKeyId: + description: | + The OCID of the Vault service key which is the master encryption key for the volume backup. + For more information about the Vault service and encryption keys, see + [Overview of Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and + [Using Keys](/iaas/Content/KeyManagement/Tasks/usingkeys.htm). + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of a volume backup. + enum: + - CREATING + - AVAILABLE + - TERMINATING + - TERMINATED + - FAULTY + - REQUEST_RECEIVED + type: string + sizeInGBs: + description: | + The size of the volume, in GBs. + format: int64 + maximum: 16384 + minimum: 1 + type: integer + sizeInMBs: + description: | + The size of the volume in MBs. The value must be a multiple of 1024. + This field is deprecated. Please use sizeInGBs. + format: int64 + maximum: 16777216 + minimum: 1024 + type: integer + sourceType: + description: | + Specifies whether the backup was created manually, or via scheduled backup policy. + enum: + - MANUAL + - SCHEDULED + type: string + sourceVolumeBackupId: + description: The OCID of the source volume backup. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the volume backup was created. This is the time the actual point-in-time image + of the volume data was taken. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + timeRequestReceived: + description: | + The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339. + format: date-time + type: string + type: + description: The type of a volume backup. + enum: + - FULL + - INCREMENTAL + type: string + uniqueSizeInGBs: + description: | + The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space + consumed on the volume and whether the backup is full or incremental. + format: int64 + maximum: 16384 + minimum: 0 + type: integer + uniqueSizeInMbs: + description: | + The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space + consumed on the volume and whether the backup is full or incremental. + This field is deprecated. Please use uniqueSizeInGBs. + format: int64 + maximum: 16777216 + minimum: 0 + type: integer + volumeId: + description: The OCID of the volume. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - type + - displayName + - compartmentId + - timeCreated + - lifecycleState + type: object + CreateVolumeBackupDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + kmsKeyId: + description: | + The OCID of the Vault service key which is the master encryption key for the volume backup. + For more information about the Vault service and encryption keys, see + [Overview of Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and + [Using Keys](/iaas/Content/KeyManagement/Tasks/usingkeys.htm). + maxLength: 255 + minLength: 1 + type: string + type: + description: The type of backup to create. If omitted, defaults to INCREMENTAL. + enum: + - FULL + - INCREMENTAL + type: string + volumeId: + description: The OCID of the volume that needs to be backed up. + maxLength: 255 + minLength: 1 + type: string + required: + - volumeId + type: object + UpdateVolumeBackupDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + kmsKeyId: + description: | + The OCID of the Vault service key which is the master encryption key for the volume backup. + For more information about the Vault service and encryption keys, see + [Overview of Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and + [Using Keys](/iaas/Content/KeyManagement/Tasks/usingkeys.htm). + maxLength: 255 + minLength: 1 + type: string + type: object + ChangeVolumeBackupCompartmentDetails: + description: Contains the details for the compartment to move the volume backup to. + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the volume backup to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + CopyVolumeBackupDetails: + properties: + destinationRegion: + description: | + The name of the destination region. + + Example: `us-ashburn-1` + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + kmsKeyId: + description: | + The OCID of the Vault service key in the destination region which will be the master encryption key + for the copied volume backup. + If you do not specify this attribute the volume backup will be encrypted with the Oracle-provided encryption + key when it is copied to the destination region. + + + For more information about the Vault service and encryption keys, see + [Overview of Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and + [Using Keys](/iaas/Content/KeyManagement/Tasks/usingkeys.htm). + maxLength: 255 + minLength: 1 + type: string + required: + - destinationRegion + type: object + VolumeGroupBackup: + description: | + A point-in-time copy of a volume group that can then be used to create a new volume group + or restore a volume group. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + properties: + compartmentId: + description: The OCID of the compartment that contains the volume group backup. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + expirationTime: + description: | + The date and time the volume group backup will expire and be automatically deleted. + Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). This parameter will always be present for volume group + backups that were created automatically by a scheduled-backup policy. For manually + created volume group backups, it will be absent, signifying that there is no expiration + time and the backup will last forever until manually deleted. + format: date-time + 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 + id: + description: The OCID of the volume group backup. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of a volume group backup. + enum: + - CREATING + - COMMITTED + - AVAILABLE + - TERMINATING + - TERMINATED + - FAULTY + - REQUEST_RECEIVED + type: string + sizeInGBs: + description: | + The aggregate size of the volume group backup, in GBs. + format: int64 + type: integer + sizeInMBs: + description: | + The aggregate size of the volume group backup, in MBs. + format: int64 + type: integer + sourceType: + description: | + Specifies whether the volume group backup was created manually, or via scheduled + backup policy. + enum: + - MANUAL + - SCHEDULED + type: string + sourceVolumeGroupBackupId: + description: The OCID of the source volume group backup. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the volume group backup was created. This is the time the actual point-in-time image + of the volume group data was taken. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + timeRequestReceived: + description: | + The date and time the request to create the volume group backup was received. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + type: + description: The type of backup. + enum: + - FULL + - INCREMENTAL + type: string + uniqueSizeInGbs: + description: | + The aggregate size used by the volume group backup, in GBs. + + It is typically smaller than sizeInGBs, depending on the spaceconsumed + on the volume group and whether the volume backup is full or incremental. + format: int64 + type: integer + uniqueSizeInMbs: + description: | + The aggregate size used by the volume group backup, in MBs. + + It is typically smaller than sizeInMBs, depending on the spaceconsumed + on the volume group and whether the volume backup is full or incremental. + format: int64 + type: integer + volumeBackupIds: + description: OCIDs for the volume backups in this volume group backup. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 64 + type: array + volumeGroupId: + description: The OCID of the source volume group. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - volumeBackupIds + - displayName + - compartmentId + - timeCreated + - type + - lifecycleState + type: object + CreateVolumeGroupBackupDetails: + properties: + compartmentId: + description: | + The OCID of the compartment that will contain the volume group + backup. This parameter is optional, by default backup will be created in + the same compartment and source volume group. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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: + description: The type of backup to create. If omitted, defaults to incremental. + enum: + - FULL + - INCREMENTAL + type: string + volumeGroupId: + description: The OCID of the volume group that needs to be backed up. + maxLength: 255 + minLength: 1 + type: string + required: + - volumeGroupId + type: object + UpdateVolumeGroupBackupDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + ChangeVolumeGroupBackupCompartmentDetails: + description: Contains the details for the compartment to move the volume group backup to. + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the volume group backup to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + CopyVolumeGroupBackupDetails: + properties: + destinationRegion: + description: | + The name of the destination region. + + Example: `us-ashburn-1` + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + kmsKeyId: + description: | + The OCID of the Vault service key in the destination region which will be the master encryption key + for the copied volume group backup. + If you do not specify this attribute the volume group backup will be encrypted with the Oracle-provided encryption + key when it is copied to the destination region. + + + For more information about the Vault service and encryption keys, see + [Overview of Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and + [Using Keys](/iaas/Content/KeyManagement/Tasks/usingkeys.htm). + maxLength: 255 + minLength: 1 + type: string + required: + - destinationRegion + type: object + VolumeGroupReplica: + description: | + An asynchronous replica of a volume group that can then be used to create a new volume group + or recover a volume group. For more information, see [Volume Group Replication](/iaas/Content/Block/Concepts/volumegroupreplication.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + properties: + availabilityDomain: + description: The availability domain of the volume group replica. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment that contains the volume group replica. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The OCID for the volume group replica. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of a volume group. + enum: + - PROVISIONING + - AVAILABLE + - ACTIVATING + - TERMINATING + - TERMINATED + - FAULTY + type: string + memberReplicas: + description: Volume replicas within this volume group replica. + items: + $ref: '#/components/schemas/MemberReplica' + maxItems: 64 + type: array + sizeInGBs: + description: The aggregate size of the volume group replica in GBs. + format: int64 + type: integer + timeCreated: + description: The date and time the volume group replica was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + timeLastSynced: + description: | + The date and time the volume group replica was last synced from the source volume group. + Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + volumeGroupId: + description: The OCID of the source volume group. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - memberReplicas + - availabilityDomain + - displayName + - sizeInGBs + - compartmentId + - timeCreated + - lifecycleState + - volumeGroupId + - timeLastSynced + type: object + VolumeGroup: + description: | + Specifies a volume group which is a collection of + volumes. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + properties: + availabilityDomain: + description: The availability domain of the volume group. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment that contains the volume group. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The OCID for the volume group. + maxLength: 255 + minLength: 1 + type: string + isHydrated: + description: | + Specifies whether the newly created cloned volume group's data has finished copying + from the source volume group or backup. + type: boolean + lifecycleState: + description: The current state of a volume group. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + - FAULTY + type: string + sizeInGBs: + description: The aggregate size of the volume group in GBs. + format: int64 + type: integer + sizeInMBs: + description: The aggregate size of the volume group in MBs. + format: int64 + type: integer + sourceDetails: + $ref: '#/components/schemas/VolumeGroupSourceDetails' + timeCreated: + description: The date and time the volume group was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + volumeGroupReplicas: + description: The list of volume group replicas of this volume group. + items: + $ref: '#/components/schemas/VolumeGroupReplicaInfo' + type: array + volumeIds: + description: OCIDs for the volumes in this volume group. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 64 + type: array + required: + - id + - volumeIds + - availabilityDomain + - displayName + - sizeInMBs + - compartmentId + - timeCreated + - lifecycleState + type: object + CreateVolumeGroupDetails: + properties: + availabilityDomain: + description: The availability domain of the volume group. + maxLength: 255 + minLength: 1 + type: string + backupPolicyId: + description: | + If provided, specifies the ID of the volume backup policy to assign to the newly + created volume group. If omitted, no policy will be assigned. + maxLength: 255 + minLength: 1 + type: string + clusterPlacementGroupId: + description: The clusterPlacementGroup Id of the volume group for volume group placement. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment that contains the volume group. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + sourceDetails: + $ref: '#/components/schemas/VolumeGroupSourceDetails' + volumeGroupReplicas: + description: | + The list of volume group replicas that this volume group will be enabled to have + in the specified destination availability domains. + items: + $ref: '#/components/schemas/VolumeGroupReplicaDetails' + maxItems: 1 + type: array + uniqueItems: true + required: + - availabilityDomain + - compartmentId + - sourceDetails + type: object + UpdateVolumeGroupDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + volumeGroupReplicas: + description: | + The list of volume group replicas that this volume group will be updated to have + in the specified destination availability domains. + items: + $ref: '#/components/schemas/VolumeGroupReplicaDetails' + maxItems: 1 + type: array + uniqueItems: true + volumeIds: + description: OCIDs for the volumes in this volume group. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 64 + type: array + type: object + ChangeVolumeGroupCompartmentDetails: + description: Contains the details for the compartment to move the volume group to. + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the volume group to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + Volume: + description: | + A detachable block volume device that allows you to dynamically expand + the storage capacity of an instance. For more information, see + [Overview of Cloud Volume Storage](/iaas/Content/Block/Concepts/overview.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + properties: + autoTunedVpusPerGB: + description: | + The number of Volume Performance Units per GB that this volume is effectively tuned to. + format: int64 + type: integer + autotunePolicies: + description: The list of autotune policies enabled for this volume. + items: + $ref: '#/components/schemas/AutotunePolicy' + type: array + uniqueItems: true + availabilityDomain: + description: | + The availability domain of the volume. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + blockVolumeReplicas: + description: The list of block volume replicas of this volume. + items: + $ref: '#/components/schemas/BlockVolumeReplicaInfo' + type: array + clusterPlacementGroupId: + description: The clusterPlacementGroup Id of the volume for volume placement. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment that contains the volume. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The OCID of the volume. + maxLength: 255 + minLength: 1 + type: string + isAutoTuneEnabled: + description: | + Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated. + Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. + type: boolean + isHydrated: + description: | + Specifies whether the cloned volume's data has finished copying from the source volume or backup. + type: boolean + isReservationsEnabled: + description: | + When set to true, enables SCSI Persistent Reservation (SCSI PR) for the volume. For more information, see + [Persistent Reservations](/iaas/Content/Block/Concepts/persistent-reservations.htm). + type: boolean + kmsKeyId: + description: | + The OCID of the Vault service key which is the master encryption key for the volume. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of a volume. + enum: + - PROVISIONING + - RESTORING + - AVAILABLE + - TERMINATING + - TERMINATED + - FAULTY + type: string + sizeInGBs: + description: The size of the volume in GBs. + format: int64 + type: integer + sizeInMBs: + description: | + The size of the volume in MBs. This field is deprecated. Use + sizeInGBs instead. + format: int64 + type: integer + sourceDetails: + $ref: '#/components/schemas/VolumeSourceDetails' + timeCreated: + description: The date and time the volume was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + volumeGroupId: + description: The OCID of the source volume group. + maxLength: 255 + minLength: 1 + type: string + vpusPerGB: + description: | + The number of volume performance units (VPUs) that will be applied to this volume per GB, + representing the Block Volume service's elastic performance options. + See [Block Volume Performance Levels](/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information. + + Allowed values: + + * `0`: Represents Lower Cost option. + + * `10`: Represents Balanced option. + + * `20`: Represents Higher Performance option. + + * `30`-`120`: Represents the Ultra High Performance option. + + For performance autotune enabled volumes, It would be the Default(Minimum) VPUs/GB. + format: int64 + type: integer + required: + - id + - availabilityDomain + - displayName + - sizeInMBs + - compartmentId + - timeCreated + - lifecycleState + type: object + CreateVolumeDetails: + description: | + The details of the volume to create. For CreateVolume operation, this field is required in the request, + see [CreateVolume](#/en/iaas/latest/Volume/CreateVolume). + properties: + autotunePolicies: + description: The list of autotune policies to be enabled for this volume. + items: + $ref: '#/components/schemas/AutotunePolicy' + type: array + uniqueItems: true + availabilityDomain: + description: | + The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + backupPolicyId: + description: | + If provided, specifies the ID of the volume backup policy to assign to the newly + created volume. If omitted, no policy will be assigned. + maxLength: 255 + minLength: 1 + type: string + blockVolumeReplicas: + description: | + The list of block volume replicas to be enabled for this volume + in the specified destination availability domains. + items: + $ref: '#/components/schemas/BlockVolumeReplicaDetails' + maxItems: 1 + type: array + uniqueItems: true + clusterPlacementGroupId: + description: The clusterPlacementGroup Id of the volume for volume placement. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment that contains the volume. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + isAutoTuneEnabled: + description: | + Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated. + Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. + type: boolean + isReservationsEnabled: + description: | + When set to true, enables SCSI Persistent Reservation (SCSI PR) for the volume. For more information, see + [Persistent Reservations](/iaas/Content/Block/Concepts/persistent-reservations.htm). + type: boolean + kmsKeyId: + description: | + The OCID of the Vault service key to assign as the master encryption key + for the volume. + maxLength: 255 + minLength: 1 + type: string + sizeInGBs: + description: The size of the volume in GBs. + format: int64 + type: integer + sizeInMBs: + description: | + The size of the volume in MBs. The value must be a multiple of 1024. + This field is deprecated. Use sizeInGBs instead. + format: int64 + type: integer + sourceDetails: + $ref: '#/components/schemas/VolumeSourceDetails' + volumeBackupId: + description: | + The OCID of the volume backup from which the data should be restored on the newly created volume. + This field is deprecated. Use the sourceDetails field instead to specify the + backup for the volume. + maxLength: 255 + minLength: 1 + type: string + vpusPerGB: + description: | + The number of volume performance units (VPUs) that will be applied to this volume per GB, + representing the Block Volume service's elastic performance options. + See [Block Volume Performance Levels](/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information. + + Allowed values: + + * `0`: Represents Lower Cost option. + + * `10`: Represents Balanced option. + + * `20`: Represents Higher Performance option. + + * `30`-`120`: Represents the Ultra High Performance option. + + For performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB. + format: int64 + type: integer + required: + - compartmentId + type: object + UpdateVolumeDetails: + properties: + autotunePolicies: + description: The list of autotune policies enabled for this volume. + items: + $ref: '#/components/schemas/AutotunePolicy' + type: array + uniqueItems: true + blockVolumeReplicas: + description: | + The list of block volume replicas that this volume will be updated to have + in the specified destination availability domains. + items: + $ref: '#/components/schemas/BlockVolumeReplicaDetails' + maxItems: 1 + type: array + uniqueItems: true + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + isAutoTuneEnabled: + description: | + Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated. + Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. + type: boolean + isReservationsEnabled: + description: | + When set to true, enables SCSI Persistent Reservation (SCSI PR) for the volume. For more information, see + [Persistent Reservations](/iaas/Content/Block/Concepts/persistent-reservations.htm). + type: boolean + sizeInGBs: + description: The size to resize the volume to in GBs. Has to be larger than the current size. + format: int64 + type: integer + vpusPerGB: + description: | + The number of volume performance units (VPUs) that will be applied to this volume per GB, + representing the Block Volume service's elastic performance options. + See [Block Volume Performance Levels](/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information. + + Allowed values: + + * `0`: Represents Lower Cost option. + + * `10`: Represents Balanced option. + + * `20`: Represents Higher Performance option. + + * `30`-`120`: Represents the Ultra High Performance option. + + For performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB. + format: int64 + type: integer + type: object + ChangeVolumeCompartmentDetails: + description: Contains the details for the compartment to move the volume to. + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the volume to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + VolumeKmsKey: + description: | + The Vault service master encryption key associated with this volume. + properties: + kmsKeyId: + description: | + The OCID of the Vault service key assigned to this volume. If the volume is not using Vault service, then the `kmsKeyId` will be a null string. + maxLength: 255 + minLength: 1 + type: string + type: object + UpdateVolumeKmsKeyDetails: + properties: + kmsKeyId: + description: | + The OCID of the new Vault service key to assign to protect the specified volume. + This key has to be a valid Vault service key, and policies must exist to allow the user and the Block Volume service to access this key. + If you specify the same OCID as the previous key's OCID, the Block Volume service will use it to regenerate a volume encryption key. + maxLength: 255 + minLength: 1 + type: string + type: object + Error: + properties: + code: + description: | + A short error code that defines the error, meant for programmatic parsing. See + [API Errors](/iaas/Content/API/References/apierrors.htm). + type: string + message: + description: A human-readable error message. + type: string + messageArguments: + additionalProperties: + type: string + description: | + The values to be substituted into the `originalMessageTemplate`, expressed as a string-to-string map. + type: object + originalMessage: + description: A human-readable error string in English. This value might be different from the `message` field. + type: string + originalMessageTemplate: + description: | + The template for the `originalMessage` in ICU message format, but without the values to be substituted. + type: string + required: + - code + - message + type: object + AutotunePolicy: + description: An autotune policy automatically tunes the volume's performace based on the type of the policy. + discriminator: + propertyName: autotuneType + properties: + autotuneType: + description: This specifies the type of autotunes supported by OCI. + enum: + - DETACHED_VOLUME + - PERFORMANCE_BASED + type: string + required: + - autotuneType + type: object + BootVolumeReplicaInfo: + description: Information about the boot volume replica in the destination availability domain. + properties: + availabilityDomain: + description: | + The availability domain of the boot volume replica. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + bootVolumeReplicaId: + description: The boot volume replica's Oracle ID (OCID). + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + required: + - bootVolumeReplicaId + - availabilityDomain + - displayName + type: object + BootVolumeSourceDetails: + discriminator: + propertyName: type + properties: + type: + type: string + required: + - type + type: object + BootVolumeReplicaDetails: + description: Contains the details for the boot volume replica + properties: + availabilityDomain: + description: | + The availability domain of the boot volume replica. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + required: + - availabilityDomain + type: object + VolumeBackupSchedule: + description: | + Defines the backup frequency and retention period for a volume backup policy. For more information, + see [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm). + properties: + backupType: + description: The type of volume backup to create. + enum: + - FULL + - INCREMENTAL + type: string + dayOfMonth: + description: The day of the month to schedule the volume backup. + maximum: 31 + minimum: 1 + type: integer + dayOfWeek: + description: The day of the week to schedule the volume backup. + enum: + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY + type: string + hourOfDay: + description: The hour of the day to schedule the volume backup. + maximum: 23 + minimum: 0 + type: integer + month: + description: The month of the year to schedule the volume backup. + enum: + - JANUARY + - FEBRUARY + - MARCH + - APRIL + - MAY + - JUNE + - JULY + - AUGUST + - SEPTEMBER + - OCTOBER + - NOVEMBER + - DECEMBER + type: string + offsetSeconds: + description: | + The number of seconds that the volume backup start + time should be shifted from the default interval boundaries specified by + the period. The volume backup start time is the frequency start time plus the offset. + maximum: 31532400 + minimum: 0 + multipleOf: 3600 + type: integer + offsetType: + description: | + Indicates how the offset is defined. If value is `STRUCTURED`, + then `hourOfDay`, `dayOfWeek`, `dayOfMonth`, and `month` fields are used + and `offsetSeconds` will be ignored in requests and users should ignore its + value from the responses. + + `hourOfDay` is applicable for periods `ONE_DAY`, + `ONE_WEEK`, `ONE_MONTH` and `ONE_YEAR`. + + `dayOfWeek` is applicable for period + `ONE_WEEK`. + + `dayOfMonth` is applicable for periods `ONE_MONTH` and `ONE_YEAR`. + + 'month' is applicable for period 'ONE_YEAR'. + + They will be ignored in the requests for inapplicable periods. + + If value is `NUMERIC_SECONDS`, then `offsetSeconds` + will be used for both requests and responses and the structured fields will be + ignored in the requests and users should ignore their values from the responses. + + For clients using older versions of Apis and not sending `offsetType` in their + requests, the behaviour is just like `NUMERIC_SECONDS`. + enum: + - STRUCTURED + - NUMERIC_SECONDS + type: string + period: + description: The volume backup frequency. + enum: + - ONE_HOUR + - ONE_DAY + - ONE_WEEK + - ONE_MONTH + - ONE_YEAR + type: string + retentionSeconds: + description: How long, in seconds, to keep the volume backups created by this schedule. + maximum: 1576800000 + minimum: 3600 + multipleOf: 3600 + type: integer + timeZone: + default: UTC + description: Specifies what time zone is the schedule in + enum: + - UTC + - REGIONAL_DATA_CENTER_TIME + type: string + required: + - period + - backupType + - retentionSeconds + type: object + MemberReplica: + description: OCIDs for the volume replicas in this volume group replica. + properties: + volumeReplicaId: + description: The volume replica ID. + maxLength: 255 + minLength: 1 + type: string + required: + - volumeReplicaId + type: object + VolumeGroupSourceDetails: + description: Specifies the source for a volume group. + discriminator: + propertyName: type + properties: + type: + type: string + required: + - type + type: object + VolumeGroupReplicaInfo: + description: Information about the volume group replica in the destination availability domain. + properties: + availabilityDomain: + description: | + The availability domain of the boot volume replica replica. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + volumeGroupReplicaId: + description: The volume group replica's Oracle ID (OCID). + maxLength: 255 + minLength: 1 + type: string + required: + - volumeGroupReplicaId + - availabilityDomain + - displayName + type: object + VolumeGroupReplicaDetails: + description: Contains the details for the volume group replica. + properties: + availabilityDomain: + description: | + The availability domain of the volume group replica. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + required: + - availabilityDomain + type: object + BlockVolumeReplicaInfo: + description: Information about the block volume replica in the destination availability domain. + properties: + availabilityDomain: + description: | + The availability domain of the block volume replica. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + blockVolumeReplicaId: + description: The block volume replica's Oracle ID (OCID). + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + required: + - blockVolumeReplicaId + - availabilityDomain + - displayName + type: object + VolumeSourceDetails: + description: | + Specifies the volume source details for a new Block volume. The volume source is either another Block volume in the same Availability Domain or a Block volume backup. + This is an optional field. If not specified or set to null, the new Block volume will be empty. + When specified, the new Block volume will contain data from the source volume or backup. + discriminator: + propertyName: type + properties: + type: + type: string + required: + - type + type: object + BlockVolumeReplicaDetails: + description: Contains the details for the block volume replica + properties: + availabilityDomain: + description: | + The availability domain of the block volume replica. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + required: + - availabilityDomain + type: object + ListBlockVolumeReplicasResponse: + type: object + properties: + block_volume_replicas: + type: array + items: + $ref: '#/components/schemas/BlockVolumeReplica' + ListBootVolumeBackupsResponse: + type: object + properties: + boot_volume_backups: + type: array + items: + $ref: '#/components/schemas/BootVolumeBackup' + ListBootVolumeReplicasResponse: + type: object + properties: + boot_volume_replicas: + type: array + items: + $ref: '#/components/schemas/BootVolumeReplica' + ListBootVolumesResponse: + type: object + properties: + boot_volumes: + type: array + items: + $ref: '#/components/schemas/BootVolume' + ListVolumeBackupPoliciesResponse: + type: object + properties: + volume_backup_policies: + type: array + items: + $ref: '#/components/schemas/VolumeBackupPolicy' + GetVolumeBackupPolicyAssetAssignmentResponse: + type: object + properties: + volume_backup_policy_asset_assignment: + type: array + items: + $ref: '#/components/schemas/VolumeBackupPolicyAssignment' + ListVolumeBackupsResponse: + type: object + properties: + volume_backups: + type: array + items: + $ref: '#/components/schemas/VolumeBackup' + ListVolumeGroupBackupsResponse: + type: object + properties: + volume_group_backups: + type: array + items: + $ref: '#/components/schemas/VolumeGroupBackup' + ListVolumeGroupReplicasResponse: + type: object + properties: + volume_group_replicas: + type: array + items: + $ref: '#/components/schemas/VolumeGroupReplica' + ListVolumeGroupsResponse: + type: object + properties: + volume_groups: + type: array + items: + $ref: '#/components/schemas/VolumeGroup' + ListVolumesResponse: + type: object + properties: + volumes: + type: array + items: + $ref: '#/components/schemas/Volume' + responses: + '400': + description: Bad Request + 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' + '401': + description: Unauthorized + 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' + '404': + description: Not Found + 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' + '409': + description: Conflict + 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' + '412': + description: Precondition Failed + 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' + '500': + description: Internal Server 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' + DefaultError: + description: An error has occurred. + 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' + parameters: + RequiredAvailabilityDomainQueryParam: + description: | + The name of the availability domain. + + Example: `Uocm:PHX-AD-1` + in: query + name: availabilityDomain + required: true + schema: + type: string + CompartmentIdQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. + in: query + name: compartmentId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + PaginationLimitQueryParam: + description: | + For list pagination. The maximum number of results per page, or items to return in a paginated + "List" call. For important details about how pagination works, see + [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + + Example: `50` + in: query + name: limit + x-default-description: The default maximum results per page varies by API. + schema: + type: integer + minimum: 1 + maximum: 100 + PaginationTokenQueryParam: + description: | + For list pagination. The value of the `opc-next-page` response header from the previous "List" + call. For important details about how pagination works, see + [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + in: query + name: page + schema: + type: string + minLength: 1 + maxLength: 4096 + FilterByDisplayNameQueryParam: + description: | + A filter to return only resources that match the given display name exactly. + in: query + name: displayName + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + SortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for + TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME + sort order is case sensitive. + + **Note:** In general, some "List" operations (for example, `ListInstances`) let you + optionally filter by availability domain if the scope of the resource type is within a + single availability domain. If you call one of these "List" operations without specifying + an availability domain, the resources are grouped by availability domain, then sorted. + in: query + name: sortBy + required: false + x-default-description: The default field to sort by varies by API. + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + SortOrderQueryParam: + description: | + The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order + is case sensitive. + in: query + name: sortOrder + required: false + x-default-description: The default sort order varies by API. + schema: + type: string + enum: + - ASC + - DESC + default: ASC + BlockVolumeReplicaIdPathParam: + description: The OCID of the block volume replica. + in: path + name: blockVolumeReplicaId + required: true + schema: + type: string + BootVolumeIdQueryParam: + description: The OCID of the boot volume. + in: query + name: bootVolumeId + schema: + type: string + FilterBySourceBootVolumeBackupIdQueryParam: + description: | + A filter to return only resources that originated from the given source boot volume backup. + in: query + name: sourceBootVolumeBackupId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + RetryTokenHeader: + description: | + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + may be rejected). + in: header + name: opc-retry-token + schema: + type: string + minLength: 1 + maxLength: 64 + BootVolumeBackupIdPathParam: + description: The OCID of the boot volume backup. + in: path + name: bootVolumeBackupId + required: true + schema: + type: string + 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 + schema: + type: string + RequestIdHeader: + description: | + Unique identifier for the request. + If you need to contact Oracle about a particular request, please provide the request ID. + in: header + name: opc-request-id + schema: + type: string + pattern: '[A-Za-z0-9\-_\.]+' + BootVolumeReplicaIdPathParam: + description: The OCID of the boot volume replica. + in: path + name: bootVolumeReplicaId + required: true + schema: + type: string + VolumeGroupIdQueryParam: + description: The OCID of the volume group. + in: query + name: volumeGroupId + schema: + type: string + BootVolumeIdPathParam: + description: The OCID of the boot volume. + in: path + name: bootVolumeId + required: true + schema: + type: string + VolumeBackupPolicyIdPathParam: + description: The OCID of the volume backup policy. + in: path + name: policyId + required: true + schema: + type: string + AssetIdQueryParam: + description: The OCID of an asset (e.g. a volume). + in: query + name: assetId + required: true + schema: + type: string + VolumeBackupPolicyAssignmentIdPathParam: + description: The OCID of the volume backup policy assignment. + in: path + name: policyAssignmentId + required: true + schema: + type: string + VolumeIdQueryParam: + description: The OCID of the volume. + in: query + name: volumeId + schema: + type: string + FilterBySourceVolumeBackupIdQueryParam: + description: | + A filter to return only resources that originated from the given source volume backup. + in: query + name: sourceVolumeBackupId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + VolumeBackupIdPathParam: + description: The OCID of the volume backup. + in: path + name: volumeBackupId + required: true + schema: + type: string + VolumeGroupBackupIdPathParam: + description: | + The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup. + in: path + name: volumeGroupBackupId + required: true + schema: + type: string + VolumeGroupReplicaIdPathParam: + description: The OCID of the volume replica group. + in: path + name: volumeGroupReplicaId + required: true + schema: + type: string + AvailabilityDomainQueryParam: + description: | + The name of the availability domain. + + Example: `Uocm:PHX-AD-1` + in: query + name: availabilityDomain + required: false + schema: + type: string + VolumeGroupIdPathParam: + description: The Oracle Cloud ID (OCID) that uniquely identifies the volume group. + in: path + name: volumeGroupId + required: true + schema: + type: string + PreserveVolumeReplicaQueryParam: + description: | + Specifies whether to disable or preserve the individual volume replication when removing a volume from the + replication enabled volume group. When set to `true`, the individual volume replica is preserved. The default + value is `true`. + in: query + name: preserveVolumeReplica + required: false + schema: + type: boolean + FilterByClusterPlacementGroupIdQueryParam: + description: | + A filter to return only resources that match the given cluster placement group Id exactly. + in: query + name: clusterPlacementGroupId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + VolumeIdPathParam: + description: The OCID of the volume. + in: path + name: volumeId + required: true + schema: + type: string + x-stackQL-resources: + block_volume_replicas: + id: oci.block_storage.block_volume_replicas + name: block_volume_replicas + title: Block Volume Replicas + methods: + list: + operation: + $ref: '#/paths/~1blockVolumeReplicas/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.block_volume_replicas + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListBlockVolumeReplicasResponse' + transform: + body: |- + {{- $wrapped := printf "{\"block_volume_replicas\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1blockVolumeReplicas~1{blockVolumeReplicaId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/block_volume_replicas/methods/get' + - $ref: '#/components/x-stackQL-resources/block_volume_replicas/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + boot_volume_backups: + id: oci.block_storage.boot_volume_backups + name: boot_volume_backups + title: Boot Volume Backups + methods: + list: + operation: + $ref: '#/paths/~1bootVolumeBackups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.boot_volume_backups + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListBootVolumeBackupsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"boot_volume_backups\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1bootVolumeBackups/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1bootVolumeBackups~1{bootVolumeBackupId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1bootVolumeBackups~1{bootVolumeBackupId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1bootVolumeBackups~1{bootVolumeBackupId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1bootVolumeBackups~1{bootVolumeBackupId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + copy_boot_volume_backup: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1bootVolumeBackups~1{bootVolumeBackupId}~1actions~1copy/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/boot_volume_backups/methods/get' + - $ref: '#/components/x-stackQL-resources/boot_volume_backups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/boot_volume_backups/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/boot_volume_backups/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/boot_volume_backups/methods/delete' + replace: [] + boot_volume_replicas: + id: oci.block_storage.boot_volume_replicas + name: boot_volume_replicas + title: Boot Volume Replicas + methods: + list: + operation: + $ref: '#/paths/~1bootVolumeReplicas/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.boot_volume_replicas + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListBootVolumeReplicasResponse' + transform: + body: |- + {{- $wrapped := printf "{\"boot_volume_replicas\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1bootVolumeReplicas~1{bootVolumeReplicaId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/boot_volume_replicas/methods/get' + - $ref: '#/components/x-stackQL-resources/boot_volume_replicas/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + boot_volumes: + id: oci.block_storage.boot_volumes + name: boot_volumes + title: Boot Volumes + methods: + list: + operation: + $ref: '#/paths/~1bootVolumes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.boot_volumes + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListBootVolumesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"boot_volumes\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1bootVolumes/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1bootVolumes~1{bootVolumeId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1bootVolumes~1{bootVolumeId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1bootVolumes~1{bootVolumeId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1bootVolumes~1{bootVolumeId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/boot_volumes/methods/get' + - $ref: '#/components/x-stackQL-resources/boot_volumes/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/boot_volumes/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/boot_volumes/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/boot_volumes/methods/delete' + replace: [] + boot_volume_kms_keys: + id: oci.block_storage.boot_volume_kms_keys + name: boot_volume_kms_keys + title: Boot Volume Kms Keys + methods: + delete: + operation: + $ref: '#/paths/~1bootVolumes~1{bootVolumeId}~1kmsKey/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1bootVolumes~1{bootVolumeId}~1kmsKey/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1bootVolumes~1{bootVolumeId}~1kmsKey/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/boot_volume_kms_keys/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/boot_volume_kms_keys/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/boot_volume_kms_keys/methods/delete' + replace: [] + volume_backup_policies: + id: oci.block_storage.volume_backup_policies + name: volume_backup_policies + title: Volume Backup Policies + methods: + list: + operation: + $ref: '#/paths/~1volumeBackupPolicies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.volume_backup_policies + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVolumeBackupPoliciesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"volume_backup_policies\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1volumeBackupPolicies/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1volumeBackupPolicies~1{policyId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1volumeBackupPolicies~1{policyId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1volumeBackupPolicies~1{policyId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/volume_backup_policies/methods/get' + - $ref: '#/components/x-stackQL-resources/volume_backup_policies/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/volume_backup_policies/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/volume_backup_policies/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/volume_backup_policies/methods/delete' + replace: [] + volume_backup_policy_asset_assignments: + id: oci.block_storage.volume_backup_policy_asset_assignments + name: volume_backup_policy_asset_assignments + title: Volume Backup Policy Asset Assignments + methods: + get: + operation: + $ref: '#/paths/~1volumeBackupPolicyAssignments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.volume_backup_policy_asset_assignment + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/GetVolumeBackupPolicyAssetAssignmentResponse' + transform: + body: |- + {{- $wrapped := printf "{\"volume_backup_policy_asset_assignment\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/volume_backup_policy_asset_assignments/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + volume_backup_policy_assignments: + id: oci.block_storage.volume_backup_policy_assignments + name: volume_backup_policy_assignments + title: Volume Backup Policy Assignments + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1volumeBackupPolicyAssignments/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1volumeBackupPolicyAssignments~1{policyAssignmentId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1volumeBackupPolicyAssignments~1{policyAssignmentId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/volume_backup_policy_assignments/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/volume_backup_policy_assignments/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/volume_backup_policy_assignments/methods/delete' + replace: [] + volume_backups: + id: oci.block_storage.volume_backups + name: volume_backups + title: Volume Backups + methods: + list: + operation: + $ref: '#/paths/~1volumeBackups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.volume_backups + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVolumeBackupsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"volume_backups\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1volumeBackups/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1volumeBackups~1{volumeBackupId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1volumeBackups~1{volumeBackupId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1volumeBackups~1{volumeBackupId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1volumeBackups~1{volumeBackupId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + copy_volume_backup: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1volumeBackups~1{volumeBackupId}~1actions~1copy/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/volume_backups/methods/get' + - $ref: '#/components/x-stackQL-resources/volume_backups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/volume_backups/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/volume_backups/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/volume_backups/methods/delete' + replace: [] + volume_group_backups: + id: oci.block_storage.volume_group_backups + name: volume_group_backups + title: Volume Group Backups + methods: + list: + operation: + $ref: '#/paths/~1volumeGroupBackups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.volume_group_backups + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVolumeGroupBackupsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"volume_group_backups\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1volumeGroupBackups/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1volumeGroupBackups~1{volumeGroupBackupId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1volumeGroupBackups~1{volumeGroupBackupId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1volumeGroupBackups~1{volumeGroupBackupId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1volumeGroupBackups~1{volumeGroupBackupId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + copy_volume_group_backup: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1volumeGroupBackups~1{volumeGroupBackupId}~1actions~1copy/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/volume_group_backups/methods/get' + - $ref: '#/components/x-stackQL-resources/volume_group_backups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/volume_group_backups/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/volume_group_backups/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/volume_group_backups/methods/delete' + replace: [] + volume_group_replicas: + id: oci.block_storage.volume_group_replicas + name: volume_group_replicas + title: Volume Group Replicas + methods: + list: + operation: + $ref: '#/paths/~1volumeGroupReplicas/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.volume_group_replicas + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVolumeGroupReplicasResponse' + transform: + body: |- + {{- $wrapped := printf "{\"volume_group_replicas\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1volumeGroupReplicas~1{volumeGroupReplicaId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/volume_group_replicas/methods/get' + - $ref: '#/components/x-stackQL-resources/volume_group_replicas/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + volume_groups: + id: oci.block_storage.volume_groups + name: volume_groups + title: Volume Groups + methods: + list: + operation: + $ref: '#/paths/~1volumeGroups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.volume_groups + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVolumeGroupsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"volume_groups\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1volumeGroups/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1volumeGroups~1{volumeGroupId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1volumeGroups~1{volumeGroupId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1volumeGroups~1{volumeGroupId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1volumeGroups~1{volumeGroupId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/volume_groups/methods/get' + - $ref: '#/components/x-stackQL-resources/volume_groups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/volume_groups/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/volume_groups/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/volume_groups/methods/delete' + replace: [] + volumes: + id: oci.block_storage.volumes + name: volumes + title: Volumes + methods: + list: + operation: + $ref: '#/paths/~1volumes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.volumes + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVolumesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"volumes\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1volumes/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1volumes~1{volumeId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1volumes~1{volumeId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1volumes~1{volumeId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1volumes~1{volumeId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/volumes/methods/get' + - $ref: '#/components/x-stackQL-resources/volumes/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/volumes/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/volumes/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/volumes/methods/delete' + replace: [] + volume_kms_keys: + id: oci.block_storage.volume_kms_keys + name: volume_kms_keys + title: Volume Kms Keys + methods: + delete: + operation: + $ref: '#/paths/~1volumes~1{volumeId}~1kmsKey/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1volumes~1{volumeId}~1kmsKey/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1volumes~1{volumeId}~1kmsKey/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/volume_kms_keys/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/volume_kms_keys/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/volume_kms_keys/methods/delete' + replace: [] +servers: + - url: https://iaas.{region}.oraclecloud.com/20160918 + variables: + region: + default: us-ashburn-1 + description: OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. + x-stackQL-envVar: OCI_REGION +x-stackQL-config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: opc-next-page + location: header diff --git a/providers/src/oci/v00.00.00000/services/budgets.yaml b/providers/src/oci/v00.00.00000/services/budgets.yaml new file mode 100644 index 00000000..c0552001 --- /dev/null +++ b/providers/src/oci/v00.00.00000/services/budgets.yaml @@ -0,0 +1,3970 @@ +openapi: 3.0.0 +info: + title: budgets API + description: oci budgets API + version: '20190111' +paths: + /budgets: + get: + description: | + Gets a list of budgets in a compartment. + + By default, ListBudgets returns budgets of the 'COMPARTMENT' target type, and the budget records with only one target compartment OCID. + + To list all budgets, set the targetType query parameter to ALL (for example: 'targetType=ALL'). + + Clients should ignore new targetTypes, or upgrade to the latest version of the client SDK to handle new targetTypes. + operationId: ListBudgets + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/LifecycleStateQueryParam' + - $ref: '#/components/parameters/DisplayNameQueryParam' + - $ref: '#/components/parameters/TargetTypeQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: A page of BudgetSummary objects. + headers: + opc-next-page: + description: | + For pagination of a list of `Budget`s. If this header appears in the response, then this + is a partial list of budgets. Include this value as the `page` parameter in a subsequent + GET request to get the next batch of budgets. + 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/ListBudgetsResponse' + '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: Returns a list of Budgets + tags: + - budget + post: + description: | + Creates a new budget. + operationId: CreateBudget + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBudgetDetails' + description: Details for the new budget. + required: true + responses: + '200': + description: The budget was successfully created. + 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/Budget' + '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 a new Budget + tags: + - budget + x-example: | + POST /20190111/budgets + Host: usage.us-phoenix-1.oci.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..aaaaaaaayzfqeibduyox6iib3olcmdar3ugly4fmameq4h7lcdlihrvur7xq", + "targetType" : "COMPARTMENT", + "targets" : ["ocid1.compartment.oc1..aaaaaaaayzfqeibduyox6iib3olcmdar3ugly4fmameq4h7lcdlihrvur7xq"], + "amount": "100.00", + "resetPeriod": "Monthly" + } + /budgets/{budgetId}: + delete: + description: Deletes a specified budget resource. + operationId: DeleteBudget + parameters: + - $ref: '#/components/parameters/BudgetIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '204': + description: The budget was successfully 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 + '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: Delete a Budget + tags: + - budget + x-related-resource: '#/definitions/Budget' + get: + description: Gets a budget by the identifier. + operationId: GetBudget + parameters: + - $ref: '#/components/parameters/BudgetIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: Retrieves the budget with the given OCID. + 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/Budget' + '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: Returns a Budget + tags: + - budget + put: + description: Update a budget identified by the OCID. + operationId: UpdateBudget + parameters: + - $ref: '#/components/parameters/BudgetIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBudgetDetails' + description: The information to be updated. + required: true + responses: + '200': + description: The budget was successfully updated. + 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/Budget' + '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: Updates a Budget + tags: + - budget + /budgets/{budgetId}/alertRules: + get: + description: | + Returns a list of Alert Rules for a specified budget. + operationId: ListAlertRules + parameters: + - $ref: '#/components/parameters/BudgetIdPathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/LifecycleStateQueryParam' + - $ref: '#/components/parameters/DisplayNameQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: A page of AlertRuleSummary objects. + headers: + opc-next-page: + description: | + For pagination of a list of `AlertRuleSummary`. If this header appears in the response, then this + is a partial list of AlertRuleSummaries. Include this value as the `page` parameter in a subsequent + GET request to get the next batch of AlertRuleSummaries. + 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/ListAlertRulesResponse' + '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: Gets a list of all Alert Rules for a Budget + tags: + - budget + post: + description: | + Creates a new Alert Rule. + operationId: CreateAlertRule + parameters: + - $ref: '#/components/parameters/BudgetIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAlertRuleDetails' + description: Details for the new Alert Rule. + required: true + responses: + '200': + description: The Alert Rule was successfully created. + 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/AlertRule' + '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 a new Alert Rule + tags: + - budget + /budgets/{budgetId}/alertRules/{alertRuleId}: + delete: + description: Deletes a specified Alert Rule resource. + operationId: DeleteAlertRule + parameters: + - $ref: '#/components/parameters/BudgetIdPathParam' + - $ref: '#/components/parameters/AlertRuleIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '204': + description: The Alert Rule was successfully 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 + '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: Delete an Alert Rule + tags: + - budget + x-related-resource: '#/definitions/AlertRule' + get: + description: Gets an Alert Rule for a specified budget. + operationId: GetAlertRule + parameters: + - $ref: '#/components/parameters/BudgetIdPathParam' + - $ref: '#/components/parameters/AlertRuleIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: Retrieves the Alert Rule with the given OCID. + 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/AlertRule' + '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: Get an Alert Rule for a specified budget + tags: + - budget + put: + description: Update an Alert Rule for the budget identified by the OCID. + operationId: UpdateAlertRule + parameters: + - $ref: '#/components/parameters/BudgetIdPathParam' + - $ref: '#/components/parameters/AlertRuleIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAlertRuleDetails' + description: The information to be updated. + required: true + responses: + '200': + description: The Alert Rule was successfully updated. + 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/AlertRule' + '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: Updates an Alert Rule + tags: + - budget + /costAlertSubscriptions: + get: + description: | + Gets a list of Cost Alert Subscription in a compartment. + operationId: ListCostAlertSubscriptions + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/NameQueryParam' + - $ref: '#/components/parameters/CostAlertSubscriptionLifecycleStateQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: A page of CostAlertSubscriptionSummary objects. + 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/CostAlertSubscriptionCollection' + '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: Returns a list of Cost Alert Subscriptions + tags: + - costAd + post: + description: | + Creates a new CostAlert Subscription. + operationId: CreateCostAlertSubscription + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCostAlertSubscriptionDetails' + description: Details for the new subscription. + required: true + responses: + '200': + description: The costAlertSubscription was successfully created. + 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/CostAlertSubscription' + '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 a new Cost Alert Subscription + tags: + - costAd + x-example: | + POST /20190111/costAlertSubscription + Host: usage.us-phoenix-1.oci.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..aaaaaaaayzfqeibduyox6iib3olcmdar3ugly4fmameq4h7lcdlihrvur7xq", + "name": "Department A email list", + "channels" : {"email": ["abc123@example.com","example-user@domain-ex.com"]} + } + /costAlertSubscriptions/{costAlertSubscriptionId}: + delete: + description: Deletes a specified CostAlertSubscription resource. + operationId: DeleteCostAlertSubscription + parameters: + - $ref: '#/components/parameters/CostAlertSubscriptionIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '204': + description: CostAlertSubscription is successfully 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 + '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: Delete a CostAlertSubscription + tags: + - costAd + x-related-resource: '#/definitions/CostAlertSubscription' + get: + description: Gets a CostAlertSubscription by the identifier. + operationId: GetCostAlertSubscription + parameters: + - $ref: '#/components/parameters/CostAlertSubscriptionIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: Retrieves the CostAlertSubscription with the given OCID. + 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/CostAlertSubscription' + '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: Returns a CostAlertSubscription + tags: + - costAd + put: + description: Update a CostAlertSubscription identified by the OCID. + operationId: UpdateCostAlertSubscription + parameters: + - $ref: '#/components/parameters/CostAlertSubscriptionIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCostAlertSubscriptionDetails' + description: The information to be updated. + required: true + responses: + '200': + description: The CostAlertSubscription was successfully updated. + 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/CostAlertSubscription' + '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: Updates a CostAlertSubscription + tags: + - costAd + /costAnomalyEventAnalytics: + get: + description: | + Gets a list of Cost Anomaly Events analytics summary - aggregated metrics for a given time period. + operationId: SummarizeCostAnomalyEventAnalytics + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/NameQueryParam' + - $ref: '#/components/parameters/CostMonitorIdQueryParam' + - $ref: '#/components/parameters/TargetTenantIdQueryParam' + - $ref: '#/components/parameters/StartDateQueryParam' + - $ref: '#/components/parameters/EndDateQueryParam' + - $ref: '#/components/parameters/RegionQueryParam' + - $ref: '#/components/parameters/CostImpactQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: A page of CostAnomalyEventAnalyticSummary objects. + 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/CostAnomalyEventAnalyticCollection' + '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: Returns a list of Cost Anomaly Events analytics summary. + tags: + - costAd + x-related-resource: '#/definitions/CostAnomalyEvent' + /costAnomalyEvents: + get: + description: | + Gets a list of Cost Anomaly Event in a compartment. + operationId: ListCostAnomalyEvents + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/NameQueryParam' + - $ref: '#/components/parameters/CostMonitorIdQueryParam' + - $ref: '#/components/parameters/TargetTenantIdQueryParam' + - $ref: '#/components/parameters/StartDateQueryParam' + - $ref: '#/components/parameters/EndDateQueryParam' + - $ref: '#/components/parameters/RegionQueryParam' + - $ref: '#/components/parameters/CostImpactQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: A page of CostAnomalyEventSummary objects. + 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/CostAnomalyEventCollection' + '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: Returns a list of Cost Anomaly Event + tags: + - costAd + /costAnomalyEvents/{costAnomalyEventId}: + get: + description: Gets a CostAnomalyEvent by the identifier. + operationId: GetCostAnomalyEvent + parameters: + - $ref: '#/components/parameters/CostAnomalyEventIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: Retrieves the CostAnomalyEvent with the given OCID. + 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/CostAnomalyEvent' + '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: Returns a CostAnomalyEvent + tags: + - costAd + put: + description: Update a CostAnomalyEvent identified by the OCID. + operationId: UpdateCostAnomalyEvent + parameters: + - $ref: '#/components/parameters/CostAnomalyEventIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCostAnomalyEventDetails' + description: The information to be updated. + required: true + responses: + '200': + description: The CostAnomalyEvent was successfully updated. + 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/CostAnomalyEvent' + '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: Updates a CostAnomalyEvent + tags: + - costAd + /costAnomalyMonitors: + get: + description: | + Gets a list of Cost Anomaly Monitors in a compartment. + operationId: ListCostAnomalyMonitors + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/CostAnomalyMonitorLifecycleStateQueryParam' + - $ref: '#/components/parameters/NameQueryParam' + - $ref: '#/components/parameters/TargetTenantIdQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: A page of CostAnomalyMonitorSummary objects. + 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/CostAnomalyMonitorCollection' + '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: Returns a list of Cost Anomaly Monitors + tags: + - costAd + post: + description: | + Creates a new costAnomaly Monitor. + operationId: CreateCostAnomalyMonitor + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCostAnomalyMonitorDetails' + description: Details for the new monitor. + required: true + responses: + '200': + description: The cost anomaly monitor is successfully created. + 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/CostAnomalyMonitor' + '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 a new costAnomaly Monitor + tags: + - costAd + x-example: | + POST /20250520/costAnomalyMonitor + Host: usage.us-phoenix-1.oci.oraclecloud.com + <authorization and other headers> + { + compartmentId: "ocid1.compartment.oc1..aaaaaaaayzfqeibduyox6iib3olcmdar3ugly4fmameq4h7lcdlihrvur7xq", + name: "sample cost monitor", + targetResourceFilter: { + operator: "AND", + filters: [ + { + operator: "OR", + dimensions: [ + {key: "compartment",value: "ocid1.compartment.oc1..aaaaaaaayzfqeibduyox6iib3olcmdar3ugly4fmameq4h7lcdlihrtge6tg"}, + {key: "compartment",value: "ocid1.compartment.oc1..aaaaaaaayzfqeibduyox6iib3olcmdar3ugly4fmameq4h7lcdlihrtbefww"} + ], + tags: [], + filters: [] + }, + { + operator: "OR", + dimensions: [ + {key: "service",value: "compute"}, + {key: "service",value: "network"} + ], + tags: [], + filters: [] + }, + { + operator: "OR", + dimensions: [], + tags: [ + {namespace: "Oracle-Tags", key: "CreatedBy", value: "ocid1.user.oc1..aaaaaaaayzfqeibduyox6iib3olcmdar3ugly4fmameq4h7lcdlihrfffebde"}, + {namespace: "Oracle-Tags", key: "CreatedBy", value: "ocid1.user.oc1..aaaaaaaayzfqeibduyox6iib3olcmdar3ugly4fmameq4h7lcdlihrpounnhr"} + ], + filters: [] + } + ] + dimensions: [], + tags: [] + } + } + /costAnomalyMonitors/{costAnomalyMonitorId}: + delete: + description: Deletes a specified CostAnomalyMonitor resource. + operationId: DeleteCostAnomalyMonitor + parameters: + - $ref: '#/components/parameters/CostAnomalyMonitorIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '204': + description: The CostAnomalyMonitor is successfully 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 + '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: Delete a CostAnomalyMonitor + tags: + - costAd + x-related-resource: '#/definitions/CostAnomalyMonitor' + get: + description: Gets a CostAnomalyMonitor by the identifier. + operationId: GetCostAnomalyMonitor + parameters: + - $ref: '#/components/parameters/CostAnomalyMonitorIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: Retrieves the CostAnomalyMonitor with the given OCID. + 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/CostAnomalyMonitor' + '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: Returns a CostAnomalyMonitor + tags: + - costAd + put: + description: Update a CostAnomalyMonitor identified by the OCID. + operationId: UpdateCostAnomalyMonitor + parameters: + - $ref: '#/components/parameters/CostAnomalyMonitorIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCostAnomalyMonitorDetails' + description: The information to be updated. + required: true + responses: + '200': + description: The Cost Anomaly Monitor is successfully updated. + 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/CostAnomalyMonitor' + '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: Updates a Cost Anomaly Monitor + tags: + - costAd + /costAnomalyMonitors/{costAnomalyMonitorId}/actions/disable: + post: + description: Disables the cost anomaly monitor. This stops cost anomaly detection for targeted resource(s). + operationId: DisableCostAnomalyMonitor + parameters: + - $ref: '#/components/parameters/CostAnomalyMonitorIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '200': + description: The cost anomaly monitor has been disabled. + 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/CostAnomalyMonitor' + '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: Disables the cost anomaly monitor. + tags: + - costAd + x-obmcs-terraform: + actionType: DISABLE + identifier: CostAnomalyMonitorEnableToggle + x-related-resource: '#/definitions/CostAnomalyMonitor' + /costAnomalyMonitors/{costAnomalyMonitorId}/actions/enable: + post: + description: Enables the cost anomaly monitor. This (re)starts the cost anomaly detection for targeted resource(s). + operationId: EnableCostAnomalyMonitor + parameters: + - $ref: '#/components/parameters/CostAnomalyMonitorIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '200': + description: The cost anomaly monitor has been enabled. + 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/CostAnomalyMonitor' + '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: Enables the cost anomaly monitor. + tags: + - costAd + x-obmcs-terraform: + actionType: ENABLE + identifier: CostAnomalyMonitorEnableToggle + x-related-resource: '#/definitions/CostAnomalyMonitor' +components: + schemas: + BudgetSummary: + description: A budget. + properties: + actualSpend: + description: The actual spend in currency for the current budget cycle. + minimum: 0 + type: number + alertRuleCount: + description: The total number of alert rules in the budget. + minimum: 0 + type: integer + amount: + description: | + The amount of the budget, expressed in the currency of the customer's rate card. + exclusiveMinimum: true + minimum: 0 + type: number + budgetProcessingPeriodStartOffset: + default: 1 + description: The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight. + exclusiveMaximum: false + exclusiveMinimum: false + maximum: 31 + minimum: 1 + type: integer + compartmentId: + description: The OCID of the compartment. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description of the budget. + type: string + displayName: + description: The display name of the budget. Avoid entering confidential information. + type: string + endDate: + description: The time when the one-time budget concludes. For example, - `2023-08-12T16:01:19.847222+05:30`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time. + format: date-time + type: string + forecastedSpend: + description: The forecasted spend in currency by the end of the current budget cycle. + minimum: 0 + type: number + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the budget. + type: string + lifecycleState: + description: The current state of the budget. + enum: + - ACTIVE + - INACTIVE + type: string + x-obmcs-top-level-enum: '#/definitions/LifecycleState' + processingPeriodType: + description: | + The type of the budget processing period. Valid values are INVOICE, MONTH, and SINGLE_USE. + enum: + - INVOICE + - MONTH + - SINGLE_USE + type: string + x-obmcs-top-level-enum: '#/definitions/ProcessingPeriodType' + resetPeriod: + description: | + The reset period for the budget. + enum: + - MONTHLY + type: string + x-obmcs-top-level-enum: '#/definitions/ResetPeriod' + startDate: + description: The date when the one-time budget begins. For example, `2023-07-12T16:01:19.847222+05:30`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time. + format: date-time + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + targetCompartmentId: + description: | + This is DEPRECATED. For backwards compatability, the property is populated when + the targetType is "COMPARTMENT", and the targets contain the specific target compartment OCID. + For all other scenarios, this property is left empty. + type: string + targetType: + description: | + The type of target on which the budget is applied. + enum: + - COMPARTMENT + - TAG + type: string + x-obmcs-top-level-enum: '#/definitions/TargetType' + targets: + description: | + The list of targets on which the budget is applied. + If the targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. + If the targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}". + items: + type: string + type: array + timeCreated: + description: The time the budget was created. + format: date-time + type: string + timeSpendComputed: + description: The time the budget spend was last computed. + format: date-time + type: string + timeUpdated: + description: The time the budget was updated. + format: date-time + type: string + version: + description: The version of the budget. Starts from 1 and increments by 1. + type: integer + required: + - id + - compartmentId + - displayName + - amount + - resetPeriod + - timeCreated + - timeUpdated + - alertRuleCount + - lifecycleState + type: object + CreateBudgetDetails: + description: | + The create budget details. + + Clients should use 'targetType' and 'targets' to specify the target type and list of targets on which the budget is applied. + + For backwards compatibility, 'targetCompartmentId' is still supported for all existing clients. + This is considered deprecated, however, and all clients are upgraded to use 'targetType' and 'targets'. + + Specifying both 'targetCompartmentId' and 'targets' causes a Bad Request. + properties: + amount: + description: | + The amount of the budget expressed as a whole number in the currency of the customer's rate card. + exclusiveMaximum: true + exclusiveMinimum: true + maximum: 1000000000000 + minimum: 0 + type: number + budgetProcessingPeriodStartOffset: + default: 1 + description: The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight. + exclusiveMaximum: false + exclusiveMinimum: false + maximum: 31 + minimum: 1 + type: integer + compartmentId: + description: The OCID of the compartment. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description of the budget. + maxLength: 200 + type: string + displayName: + description: The displayName of the budget. Avoid entering confidential information. + maxLength: 200 + type: string + endDate: + description: The date when the one-time budget concludes. For example, `2023-08-12T16:01:19.847222+05:30`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time. + format: date-time + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + processingPeriodType: + description: | + The type of the budget processing period. Valid values are INVOICE, MONTH, and SINGLE_USE. + enum: + - INVOICE + - MONTH + - SINGLE_USE + type: string + x-obmcs-top-level-enum: '#/definitions/ProcessingPeriodType' + resetPeriod: + description: | + The reset period for the budget. + enum: + - MONTHLY + type: string + x-obmcs-top-level-enum: '#/definitions/ResetPeriod' + startDate: + description: The date when the one-time budget begins. For example, `2023-07-12T16:01:19.847222+05:30`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time. + format: date-time + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + targetCompartmentId: + description: | + This is DEPRECATED. Set the target compartment ID in targets instead. + type: string + targetType: + default: COMPARTMENT + description: | + The type of target on which the budget is applied. + enum: + - COMPARTMENT + - TAG + type: string + x-obmcs-top-level-enum: '#/definitions/TargetType' + targets: + description: | + The list of targets on which the budget is applied. + If targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. + If targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}". + Curerntly, the array should contain exactly one item. + items: + type: string + type: array + required: + - compartmentId + - amount + - resetPeriod + type: object + Budget: + description: A budget. + properties: + actualSpend: + description: The actual spend in currency for the current budget cycle. + minimum: 0 + type: number + alertRuleCount: + description: The total number of alert rules in the budget. + minimum: 0 + type: integer + amount: + description: | + The amount of the budget expressed in the currency of the customer's rate card. + exclusiveMinimum: true + minimum: 0 + type: number + budgetProcessingPeriodStartOffset: + default: 1 + description: The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight. + exclusiveMaximum: false + exclusiveMinimum: false + maximum: 31 + minimum: 1 + type: integer + compartmentId: + description: The OCID of the compartment. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description of the budget. + type: string + displayName: + description: The display name of the budget. Avoid entering confidential information. + type: string + endDate: + description: The time when the one-time budget concludes. For example, `2023-08-12T16:01:19.847222+05:30`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time. + format: date-time + type: string + forecastedSpend: + description: The forecasted spend in currency by the end of the current budget cycle. + minimum: 0 + type: number + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the budget. + type: string + lifecycleState: + description: The current state of the budget. + enum: + - ACTIVE + - INACTIVE + type: string + x-obmcs-top-level-enum: '#/definitions/LifecycleState' + processingPeriodType: + description: | + The budget processing period type. Valid values are INVOICE, MONTH, and SINGLE_USE. + enum: + - INVOICE + - MONTH + - SINGLE_USE + type: string + x-obmcs-top-level-enum: '#/definitions/ProcessingPeriodType' + resetPeriod: + description: | + The reset period for the budget. + enum: + - MONTHLY + type: string + x-obmcs-top-level-enum: '#/definitions/ResetPeriod' + startDate: + description: The date when the one-time budget begins. For example, `2023-07-12T16:01:19.847222+05:30`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time. + format: date-time + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + targetCompartmentId: + description: | + This is DEPRECATED. For backwards compatability, the property is populated when + the targetType is "COMPARTMENT", and targets contain the specific target compartment OCID. + For all other scenarios, this property will be left empty. + type: string + targetType: + description: | + The type of target on which the budget is applied. + enum: + - COMPARTMENT + - TAG + type: string + x-obmcs-top-level-enum: '#/definitions/TargetType' + targets: + description: | + The list of targets on which the budget is applied. + If the targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. + If the targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}". + items: + type: string + type: array + timeCreated: + description: The time that the budget was created. + format: date-time + type: string + timeSpendComputed: + description: The time that the budget spend was last computed. + format: date-time + type: string + timeUpdated: + description: The time that the budget was updated. + format: date-time + type: string + version: + description: The version of the budget. Starts from 1 and increments by 1. + type: integer + required: + - id + - compartmentId + - displayName + - amount + - resetPeriod + - timeCreated + - timeUpdated + - alertRuleCount + - lifecycleState + type: object + UpdateBudgetDetails: + description: The update budget details. + properties: + amount: + description: | + The amount of the budget expressed as a whole number in the currency of the customer's rate card. + exclusiveMaximum: true + exclusiveMinimum: true + maximum: 1000000000000 + minimum: 0 + type: number + budgetProcessingPeriodStartOffset: + default: 1 + description: The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight. + exclusiveMaximum: false + exclusiveMinimum: false + maximum: 31 + minimum: 1 + type: integer + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description of the budget. + maxLength: 200 + type: string + displayName: + description: The displayName of the budget. Avoid entering confidential information. + maxLength: 200 + type: string + endDate: + description: The time when the one-time budget concludes. For example, `2023-08-12T16:01:19.847222+05:30`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time. + format: date-time + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + processingPeriodType: + description: | + The type of the budget processing period. Valid values are INVOICE, MONTH, and SINGLE_USE. + enum: + - INVOICE + - MONTH + - SINGLE_USE + type: string + x-obmcs-top-level-enum: '#/definitions/ProcessingPeriodType' + resetPeriod: + description: | + The reset period for the budget. + enum: + - MONTHLY + type: string + x-obmcs-top-level-enum: '#/definitions/ResetPeriod' + startDate: + description: The date when the one-time budget begins. For example, `2023-07-12T16:01:19.847222+05:30`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time. + format: date-time + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + type: object + AlertRuleSummary: + description: The alert rule. + properties: + budgetId: + description: The OCID of the budget. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description of the alert rule. + type: string + displayName: + description: The name of the alert rule. Avoid entering confidential information. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the alert rule. + type: string + lifecycleState: + description: The current state of the alert rule. + enum: + - ACTIVE + - INACTIVE + type: string + x-obmcs-top-level-enum: '#/definitions/LifecycleState' + message: + description: The custom message that will be sent when the alert is triggered. + type: string + recipients: + description: The audience that receives the alert when it triggers. + type: string + threshold: + description: | + The threshold for triggering the alert. If the thresholdType is PERCENTAGE, the maximum value is 10000. + exclusiveMinimum: true + minimum: 0 + type: number + thresholdType: + description: The type of threshold. + enum: + - PERCENTAGE + - ABSOLUTE + type: string + x-obmcs-top-level-enum: '#/definitions/ThresholdType' + timeCreated: + description: The time when the budget was created. + format: date-time + type: string + timeUpdated: + description: The time when the budget was updated. + format: date-time + type: string + type: + description: | + ACTUAL means the alert triggers based on actual usage. + FORECAST means the alert triggers based on predicted usage. + enum: + - ACTUAL + - FORECAST + type: string + x-obmcs-top-level-enum: '#/definitions/AlertType' + version: + description: The version of the alert rule. Starts from 1 and increments by 1. + type: integer + required: + - id + - budgetId + - displayName + - type + - threshold + - thresholdType + - recipients + - timeCreated + - timeUpdated + - lifecycleState + type: object + CreateAlertRuleDetails: + description: The create alert rule details. This is a batch-create. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description of the alert rule. + maxLength: 200 + type: string + displayName: + description: The name of the alert rule. Avoid entering confidential information. + maxLength: 200 + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + message: + description: The message to be sent to the recipients when the alert rule is triggered. + maxLength: 1000 + type: string + recipients: + description: The audience that receives the alert when it triggers. An empty string is interpreted as null. + type: string + threshold: + description: | + The threshold for triggering the alert, expressed as a whole number or decimal value. + If the thresholdType is ABSOLUTE, the threshold can have at most 12 digits before the decimal point, and up to two digits after the decimal point. + If the thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to two digits after the decimal point. + exclusiveMaximum: true + exclusiveMinimum: true + maximum: 1000000000000 + minimum: 0 + type: number + thresholdType: + description: The type of threshold. + enum: + - PERCENTAGE + - ABSOLUTE + type: string + x-obmcs-top-level-enum: '#/definitions/ThresholdType' + type: + description: | + The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or + FORECAST (the alert triggers based on predicted usage). + enum: + - ACTUAL + - FORECAST + type: string + x-obmcs-top-level-enum: '#/definitions/AlertType' + required: + - type + - threshold + - thresholdType + type: object + AlertRule: + description: The alert rule. + properties: + budgetId: + description: The OCID of the budget. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description of the alert rule. + type: string + displayName: + description: The name of the alert rule. Avoid entering confidential information. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the alert rule. + type: string + lifecycleState: + description: The current state of the alert rule. + enum: + - ACTIVE + - INACTIVE + type: string + x-obmcs-top-level-enum: '#/definitions/LifecycleState' + message: + description: Custom message sent when an alert is triggered. + type: string + recipients: + description: | + The delimited list of email addresses to receive the alert when it triggers. + Delimiter characters can be a comma, space, TAB, or semicolon. + type: string + threshold: + description: | + The threshold for triggering the alert. If the thresholdType is PERCENTAGE, the maximum value is 10000. + exclusiveMinimum: true + minimum: 0 + type: number + thresholdType: + description: The type of threshold. + enum: + - PERCENTAGE + - ABSOLUTE + type: string + x-obmcs-top-level-enum: '#/definitions/ThresholdType' + timeCreated: + description: The time the budget was created. + format: date-time + type: string + timeUpdated: + description: The time the budget was updated. + format: date-time + type: string + type: + description: | + The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or + FORECAST (the alert triggers based on predicted usage). + enum: + - ACTUAL + - FORECAST + type: string + x-obmcs-top-level-enum: '#/definitions/AlertType' + version: + description: The version of the alert rule. Starts from 1 and increments by 1. + type: integer + required: + - id + - budgetId + - displayName + - type + - threshold + - thresholdType + - recipients + - timeCreated + - timeUpdated + - lifecycleState + type: object + UpdateAlertRuleDetails: + description: The update alert rule details. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description of the alert rule. + maxLength: 200 + type: string + displayName: + description: The name of the alert rule. Avoid entering confidential information. + maxLength: 200 + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + message: + description: The message to be delivered to the recipients when an alert is triggered. + maxLength: 1000 + type: string + recipients: + description: The audience that receives the alert when it triggers. If you need to clear out this value, pass in an empty string instead of a null value. + type: string + threshold: + description: | + The threshold for triggering the alert, expressed as a whole number or decimal value. + If the thresholdType is ABSOLUTE, the threshold can have at most 12 digits before the decimal point, and up to two digits after the decimal point. + If the thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to two digits after the decimal point. + exclusiveMaximum: true + exclusiveMinimum: true + maximum: 1000000000000 + minimum: 0 + type: number + thresholdType: + description: The type of threshold. + enum: + - PERCENTAGE + - ABSOLUTE + type: string + x-obmcs-top-level-enum: '#/definitions/ThresholdType' + type: + description: | + The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or + FORECAST (the alert triggers based on predicted usage). + enum: + - ACTUAL + - FORECAST + type: string + x-obmcs-top-level-enum: '#/definitions/AlertType' + type: object + CostAlertSubscriptionCollection: + description: Results of a costAlertSubscription search. Contains both CostAlertSubscriptionSummary items and other data. + properties: + items: + description: A page of CostAnomalyMonitorSummary objects. + items: + $ref: '#/components/schemas/CostAlertSubscriptionSummary' + type: array + required: + - items + type: object + CreateCostAlertSubscriptionDetails: + description: | + The create CostAlertSubscriptionDetails details. + The clients should pass compartmentId where the resource should belong, description and channels. + properties: + channels: + description: The notification channels string. + maxLength: 1000 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description of the cost alert subscription. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the Cost Anomaly Subscription. + maxLength: 255 + minLength: 1 + type: string + name: + description: The name of the cost alert subscription. Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + type: + description: Type of alert subscription + enum: + - DEFAULT + - CUSTOM + type: string + x-obmcs-top-level-enum: '#/definitions/MonitorType' + required: + - compartmentId + - name + - type + - channels + type: object + CostAlertSubscription: + description: A CostAlertSubscription. + properties: + channels: + description: The notification channels string. + maxLength: 1000 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment which hold the cost alert subscription resource. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description of the cost alert subscription. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the Cost Alert Subscription. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the cost alert subscription. + enum: + - ACTIVE + - INACTIVE + type: string + name: + description: The name of the cost alert subscription. Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined 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. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + System tags can be viewed by users, but can only be created by the system. + + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + timeCreated: + description: The time that the cost alert subscription was created. + format: date-time + type: string + timeUpdated: + description: The time that the cost alert subscription was updated. + format: date-time + type: string + type: + description: Type of alert subscription + enum: + - DEFAULT + - CUSTOM + type: string + x-obmcs-top-level-enum: '#/definitions/MonitorType' + required: + - id + - compartmentId + - name + - lifecycleState + - channels + - timeCreated + - timeUpdated + type: object + UpdateCostAlertSubscriptionDetails: + description: | + The update CostAlertSubscriptionDetails details. + properties: + channels: + description: The notification channels string. + maxLength: 1000 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description of the cost alert subscription. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + type: object + CostAnomalyEventAnalyticCollection: + description: Results of a CostAnomalyEventAnalytics search. + properties: + items: + description: The list of CostAnomalyEvent Analytic summary. + items: + $ref: '#/components/schemas/CostAnomalyEventAnalyticSummary' + type: array + required: + - items + type: object + CostAnomalyEventCollection: + description: Results of a costAnomalyEvent search. Contains both CostAnomalyEventSummary items and other data. + properties: + items: + description: A page of CostAnomalyMonitorSummary objects. + items: + $ref: '#/components/schemas/CostAnomalyEventSummary' + type: array + required: + - items + type: object + CostAnomalyEvent: + description: A CostAnomalyEvent. + properties: + compartmentId: + description: The OCID of the compartment. + maxLength: 255 + minLength: 1 + type: string + costImpact: + description: The cost impact of the detected anomaly. + format: double + type: number + costMonitorId: + description: The OCID of the associated cost monitor. + maxLength: 255 + minLength: 1 + type: string + costMonitorName: + description: The name of the associated cost monitor. + maxLength: 255 + minLength: 1 + type: string + costVariancePercentage: + description: The cost variance percentage of the detected anomaly. + format: double + type: number + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + feedbackResponse: + description: The feedback response for the cost anomaly event. + enum: + - ACCURATE_ANOMALY + - EXPECTED_ANOMALY + - NOT_AN_ANOMALY + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the Cost Anomaly Event. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the cost anomaly event. + enum: + - ACTIVE + - INACTIVE + type: string + rootCauseDetail: + $ref: '#/components/schemas/RootCauseDetail' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined 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. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + System tags can be viewed by users, but can only be created by the system. + + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + targetResourceFilter: + $ref: '#/components/schemas/TargetResourceFilter' + timeAnomalyEventDate: + description: The event date of the anomaly event. + format: date-time + type: string + timeCreated: + description: The created time of the cost anomaly event. + format: date-time + type: string + timeUpdated: + description: The updated time of the cost anomaly event. + format: date-time + type: string + required: + - id + - compartmentId + - costMonitorId + - lifecycleState + - costMonitorName + - targetResourceFilter + - timeAnomalyEventDate + - timeCreated + - timeUpdated + type: object + UpdateCostAnomalyEventDetails: + description: | + The update CostAnomalyEvent details. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + feedbackResponse: + description: The feedback response for the cost anomaly event. + type: string + x-obmcs-enumref: '#/definitions/CostAnomalyEvent/feedbackResponse' + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + type: object + CostAnomalyMonitorCollection: + description: Results of a costAnomalyMonitor search. Contains both CostAnomalyMonitorSummary items and other data. + properties: + items: + description: A page of CostAnomalyMonitorSummary objects. + items: + $ref: '#/components/schemas/CostAnomalyMonitorSummary' + type: array + required: + - items + type: object + CreateCostAnomalyMonitorDetails: + description: | + The create CostAnomalyMonitor details. + The clients should pass ocid of the compartmentId for the monitor resource to be created. tenantIdFilter and resourceFilter + targets resources to monitor in a given tenancy. + properties: + compartmentId: + description: The OCID of the compartment. + maxLength: 255 + minLength: 1 + type: string + costAlertSubscriptionMap: + $ref: '#/components/schemas/CostAlertSubscriptionMap' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description of the cost anomaly monitor. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + name: + description: The name of the cost anomaly monitor. Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + targetResourceFilter: + $ref: '#/components/schemas/TargetResourceFilter' + required: + - compartmentId + - name + - targetResourceFilter + type: object + CostAnomalyMonitor: + description: A CostAnomalyMonitor. + properties: + compartmentId: + description: The OCID of the compartment. + maxLength: 255 + minLength: 1 + type: string + costAlertSubscriptionMap: + $ref: '#/components/schemas/CostAlertSubscriptionMap' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description of the budget. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the Cost Anomaly Monitor. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: | + The current state details of the cost monitor. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the cost monitor. + enum: + - ACTIVE + - INACTIVE + - DELETED + type: string + name: + description: The name of the cost anomaly monitor. Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined 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. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + System tags can be viewed by users, but can only be created by the system. + + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + targetResourceFilter: + $ref: '#/components/schemas/TargetResourceFilter' + timeCreated: + description: The time that the cost monitor was created. + format: date-time + type: string + timeUpdated: + description: The time that the cost monitor was last updated. + format: date-time + type: string + type: + description: Type of cost monitor + enum: + - DEFAULT + - CUSTOM + type: string + x-obmcs-top-level-enum: '#/definitions/MonitorType' + required: + - id + - compartmentId + - name + - lifecycleState + - targetResourceFilter + - timeCreated + - timeUpdated + type: object + UpdateCostAnomalyMonitorDetails: + description: Update CostAnomalyMonitor details. + properties: + costAlertSubscriptionMap: + $ref: '#/components/schemas/CostAlertSubscriptionMap' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description of the cost anomaly monitor. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + 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 string. + type: string + required: + - code + - message + type: object + CostAlertSubscriptionSummary: + description: A CostAlertSubscription. + properties: + compartmentId: + description: The OCID of the compartment which hold the cost alert subscription resource. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the Cost Alert Subscription. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the cost alert subscription. + type: string + x-obmcs-enumref: '#/definitions/CostAlertSubscription/lifecycleState' + name: + description: The name of the cost alert subscription. Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined 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. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + System tags can be viewed by users, but can only be created by the system. + + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + required: + - id + - compartmentId + - name + - lifecycleState + type: object + CostAnomalyEventAnalyticSummary: + description: A CostAnomalyEventAnalyticSummary. + properties: + averageCostImpact: + description: The average cost impact of the anomaly events in the given time period. + format: double + type: number + averageCostVariance: + description: The average cost variance of the anomaly events in the given time period. + format: double + type: number + count: + description: The number of cost anomaly events in the given time period. + type: integer + timeAnomalyEventEndDate: + description: startDate for anomaly event date. + format: date-time + type: string + timeAnomalyEventStartDate: + description: startDate for anomaly event date. + format: date-time + type: string + required: + - timeAnomalyEventStartDate + - timeAnomalyEventEndDate + - count + - averageCostImpact + - averageCostVariance + type: object + CostAnomalyEventSummary: + description: A CostAnomalyEvent. + properties: + compartmentId: + description: The OCID of the compartment. + maxLength: 255 + minLength: 1 + type: string + costImpact: + description: The cost impact of the detected anomaly. + format: double + type: number + costMonitorId: + description: The OCID of the associated cost monitor. + maxLength: 255 + minLength: 1 + type: string + costMonitorName: + description: The name of the associated cost monitor. + maxLength: 255 + minLength: 1 + type: string + costVariancePercentage: + description: The cost variance percentage of the detected anomaly. + format: double + type: number + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the Cost Anomaly Event. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the cost anomaly event. + type: string + x-obmcs-enumref: '#/definitions/CostAnomalyEvent/lifecycleState' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined 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. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + System tags can be viewed by users, but can only be created by the system. + + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + targetResourceFilter: + $ref: '#/components/schemas/TargetResourceFilter' + timeAnomalyEventDate: + description: The event date of the anomaly event. + format: date-time + type: string + required: + - id + - compartmentId + - costMonitorId + - costMonitorName + - targetResourceFilter + - timeAnomalyEventDate + type: object + RootCauseDetail: + description: The root cause details of the cost anomaly event. + properties: + value: + description: The json object representing the root cause details of the anomaly event. (opaque JSON object) + type: string + type: object + TargetResourceFilter: + description: | + The filter object to target resources for cost monitor. + Cost generated by one or more resources identified by this + filter is monitored for anomalous deviations. + properties: + dimensions: + description: The dimensions to filter on. + items: + $ref: '#/components/schemas/Dimension' + maxItems: 100 + type: array + filters: + description: The nested filter object. + items: + $ref: '#/components/schemas/TargetResourceFilter' + maxItems: 100 + type: array + operator: + description: 'The filter operator. Example: ''AND'', ''OR'', ''NOT''.' + enum: + - AND + - NOT + - OR + type: string + tags: + description: The tags to filter on. + items: + $ref: '#/components/schemas/Tag' + maxItems: 100 + type: array + type: object + CostAnomalyMonitorSummary: + description: A CostAnomalyMonitor. + properties: + compartmentId: + description: The OCID of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description of the budget. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the Cost Anomaly Monitor. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the cost monitor. + type: string + x-obmcs-enumref: '#/definitions/CostAnomalyMonitor/lifecycleState' + name: + description: The name of the cost anomaly monitor. Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined 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. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + System tags can be viewed by users, but can only be created by the system. + + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + targetResourceFilter: + $ref: '#/components/schemas/TargetResourceFilter' + timeCreated: + description: The time that the cost monitor was created. + format: date-time + type: string + timeUpdated: + description: The time that the cost monitor was last updated. + format: date-time + type: string + type: + description: Type of cost monitor + enum: + - DEFAULT + - CUSTOM + type: string + x-obmcs-top-level-enum: '#/definitions/MonitorType' + required: + - id + - compartmentId + - name + - lifecycleState + - targetResourceFilter + - timeCreated + - timeUpdated + type: object + CostAlertSubscriptionMap: + description: The mapping of cost monitor to alert subscription along with thresholds. + properties: + costAlertSubscriptionId: + description: The costAlertSubscription ocid which the cost monitor alert maps to. + type: string + operator: + description: 'The filter operator. Example: ''AND'', ''OR'', ''NOT''.' + enum: + - AND + - NOT + - OR + type: string + thresholdAbsoluteValue: + description: The absolute threshold value. + minimum: 0 + type: integer + thresholdRelativePercent: + description: The relative percentage threshold value. + minimum: 0 + type: integer + type: object + Dimension: + description: | + The dimension used for filtering. Available dimensions are: "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "tenantName, "tenantId", "platform", "region", "logicalAd", "resourceId". + For example: + `[{value: "COMPUTE", key: "service"}]` + properties: + key: + description: The dimension key. + maxLength: 255 + minLength: 1 + type: string + value: + description: The dimension value. + maxLength: 255 + minLength: 1 + type: string + required: + - key + - value + type: object + Tag: + description: The tag used for filtering. + properties: + key: + description: The tag key. + maxLength: 255 + minLength: 1 + type: string + namespace: + description: The tag namespace. + maxLength: 255 + minLength: 1 + type: string + value: + description: The tag value. + maxLength: 100 + minLength: 1 + type: string + type: object + ListBudgetsResponse: + type: object + properties: + budgets: + type: array + items: + $ref: '#/components/schemas/BudgetSummary' + ListAlertRulesResponse: + type: object + properties: + alert_rules: + type: array + items: + $ref: '#/components/schemas/AlertRuleSummary' + responses: + '400': + description: Bad Request + 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' + '401': + description: Unauthorized + 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' + '404': + description: Not Found + 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' + '409': + description: Conflict + 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' + '412': + description: Precondition failed + 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' + '429': + description: Too Many Requests + 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' + '500': + description: Internal Server 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' + 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' + parameters: + CompartmentIdQueryParam: + description: The ID of the compartment in which to list resources. + in: query + name: compartmentId + required: true + schema: + type: string + PaginationLimitQueryParam: + description: The maximum number of items to return. + in: query + name: limit + schema: + type: integer + minimum: 1 + maximum: 1000 + default: 25 + 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: '' + schema: + type: string + minLength: 1 + SortOrderQueryParam: + description: The sort order to use, either 'asc' or 'desc'. + in: query + name: sortOrder + x-default-description: '' + x-obmcs-top-level-enum: '#/definitions/SortOrder' + schema: + type: string + enum: + - ASC + - DESC + SortByQueryParam: + description: | + The field to sort by. If not specified, the default is timeCreated. + The default sort order for timeCreated is DESC. + The default sort order for displayName is ASC in alphanumeric order. + in: query + name: sortBy + x-obmcs-top-level-enum: '#/definitions/SortBy' + schema: + type: string + enum: + - timeCreated + - displayName + default: timeCreated + LifecycleStateQueryParam: + description: The current state of the resource to filter by. + in: query + name: lifecycleState + x-default-description: '' + x-obmcs-top-level-enum: '#/definitions/LifecycleState' + schema: + type: string + enum: + - ACTIVE + - INACTIVE + DisplayNameQueryParam: + description: | + A user-friendly name. This does not have to be unique, and it's changeable. + + Example: `My new resource` + in: query + name: displayName + x-default-description: '' + schema: + type: string + minLength: 1 + maxLength: 255 + TargetTypeQueryParam: + description: | + The type of target to filter by: + * ALL - List all budgets + * COMPARTMENT - List all budgets with targetType == "COMPARTMENT" + * TAG - List all budgets with targetType == "TAG" + in: query + name: targetType + x-default-description: '' + schema: + type: string + enum: + - ALL + - COMPARTMENT + - TAG + RequestIdHeader: + description: The client request ID for tracing. + in: header + name: opc-request-id + schema: + type: string + RetryTokenHeader: + description: | + A token that uniquely identifies a request so it can be retried, in case of a timeout or + server error, without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + in: header + name: opc-retry-token + required: false + schema: + type: string + minLength: 1 + maxLength: 64 + BudgetIdPathParam: + description: The unique budget OCID. + in: path + name: budgetId + required: true + x-default-description: '' + schema: + type: string + 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 + AlertRuleIdPathParam: + description: The unique Alert Rule OCID. + in: path + name: alertRuleId + required: true + x-default-description: '' + schema: + type: string + NameQueryParam: + description: | + Unique, non-changeable resource name. + in: query + name: name + x-default-description: '' + schema: + type: string + minLength: 1 + maxLength: 255 + CostAlertSubscriptionLifecycleStateQueryParam: + description: The current state of the cost alert subscription. + in: query + name: lifecycleState + x-obmcs-enumref: '#/definitions/CostAlertSubscription/lifecycleState' + schema: + type: string + CostAlertSubscriptionIdPathParam: + description: The unique costAlertSubscription OCID. + in: path + name: costAlertSubscriptionId + required: true + x-default-description: '' + schema: + type: string + minLength: 1 + maxLength: 255 + CostMonitorIdQueryParam: + description: The cost monitor ocid. + in: query + name: costAnomalyMonitorId + required: true + x-default-description: '' + schema: + type: string + minLength: 1 + maxLength: 255 + TargetTenantIdQueryParam: + description: The target tenantId ocid filter param. + in: query + name: targetTenantId + x-default-description: '' + schema: + type: string + minLength: 1 + maxLength: 255 + StartDateQueryParam: + description: startDate for anomaly event date. + in: query + name: timeAnomalyEventStartDate + required: true + x-default-description: '' + schema: + type: string + format: date-time + EndDateQueryParam: + description: endDate for anomaly event date. + in: query + name: timeAnomalyEventEndDate + required: true + x-default-description: '' + schema: + type: string + format: date-time + RegionQueryParam: + description: region of the anomaly event. + in: query + name: region + required: true + x-default-description: '' + schema: + type: string + minLength: 1 + maxLength: 255 + CostImpactQueryParam: + description: cost impact of the anomaly event. + in: query + name: costImpact + required: true + x-default-description: '' + schema: + type: number + format: double + CostAnomalyEventIdPathParam: + description: The unique costAnomalyEventId OCID. + in: path + name: costAnomalyEventId + required: true + x-default-description: '' + schema: + type: string + minLength: 1 + maxLength: 255 + CostAnomalyMonitorLifecycleStateQueryParam: + description: The current state of the cost monitor. + in: query + name: lifecycleState + x-obmcs-enumref: '#/definitions/CostAnomalyMonitor/lifecycleState' + schema: + type: string + CostAnomalyMonitorIdPathParam: + description: The unique costAnomalyMonitor OCID. + in: path + name: costAnomalyMonitorId + required: true + x-default-description: '' + schema: + type: string + minLength: 1 + maxLength: 255 + x-stackQL-resources: + budgets: + id: oci.budgets.budgets + name: budgets + title: Budgets + methods: + list: + operation: + $ref: '#/paths/~1budgets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.budgets + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListBudgetsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"budgets\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1budgets/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1budgets~1{budgetId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1budgets~1{budgetId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1budgets~1{budgetId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/budgets/methods/get' + - $ref: '#/components/x-stackQL-resources/budgets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/budgets/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/budgets/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/budgets/methods/delete' + replace: [] + alert_rules: + id: oci.budgets.alert_rules + name: alert_rules + title: Alert Rules + methods: + list: + operation: + $ref: '#/paths/~1budgets~1{budgetId}~1alertRules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.alert_rules + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAlertRulesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"alert_rules\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1budgets~1{budgetId}~1alertRules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1budgets~1{budgetId}~1alertRules~1{alertRuleId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1budgets~1{budgetId}~1alertRules~1{alertRuleId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1budgets~1{budgetId}~1alertRules~1{alertRuleId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/alert_rules/methods/get' + - $ref: '#/components/x-stackQL-resources/alert_rules/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/alert_rules/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/alert_rules/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/alert_rules/methods/delete' + replace: [] + cost_alert_subscriptions: + id: oci.budgets.cost_alert_subscriptions + name: cost_alert_subscriptions + title: Cost Alert Subscriptions + methods: + list: + operation: + $ref: '#/paths/~1costAlertSubscriptions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1costAlertSubscriptions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1costAlertSubscriptions~1{costAlertSubscriptionId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1costAlertSubscriptions~1{costAlertSubscriptionId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1costAlertSubscriptions~1{costAlertSubscriptionId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cost_alert_subscriptions/methods/get' + - $ref: '#/components/x-stackQL-resources/cost_alert_subscriptions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/cost_alert_subscriptions/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/cost_alert_subscriptions/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/cost_alert_subscriptions/methods/delete' + replace: [] + cost_anomaly_event_analytics: + id: oci.budgets.cost_anomaly_event_analytics + name: cost_anomaly_event_analytics + title: Cost Anomaly Event Analytics + methods: + summarize_cost_anomaly_event_analytics: + operation: + $ref: '#/paths/~1costAnomalyEventAnalytics/get' + response: + mediaType: application/json + openAPIDocKey: '200' + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + cost_anomaly_events: + id: oci.budgets.cost_anomaly_events + name: cost_anomaly_events + title: Cost Anomaly Events + methods: + list: + operation: + $ref: '#/paths/~1costAnomalyEvents/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1costAnomalyEvents~1{costAnomalyEventId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1costAnomalyEvents~1{costAnomalyEventId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cost_anomaly_events/methods/get' + - $ref: '#/components/x-stackQL-resources/cost_anomaly_events/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/cost_anomaly_events/methods/update' + delete: [] + replace: [] + cost_anomaly_monitors: + id: oci.budgets.cost_anomaly_monitors + name: cost_anomaly_monitors + title: Cost Anomaly Monitors + methods: + list: + operation: + $ref: '#/paths/~1costAnomalyMonitors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1costAnomalyMonitors/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1costAnomalyMonitors~1{costAnomalyMonitorId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1costAnomalyMonitors~1{costAnomalyMonitorId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1costAnomalyMonitors~1{costAnomalyMonitorId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + disable_cost_anomaly_monitor: + operation: + $ref: '#/paths/~1costAnomalyMonitors~1{costAnomalyMonitorId}~1actions~1disable/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + enable_cost_anomaly_monitor: + operation: + $ref: '#/paths/~1costAnomalyMonitors~1{costAnomalyMonitorId}~1actions~1enable/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cost_anomaly_monitors/methods/get' + - $ref: '#/components/x-stackQL-resources/cost_anomaly_monitors/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/cost_anomaly_monitors/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/cost_anomaly_monitors/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/cost_anomaly_monitors/methods/delete' + replace: [] +servers: + - url: https://usage.{region}.oci.oraclecloud.com/20190111 + variables: + region: + default: us-ashburn-1 + description: OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. + x-stackQL-envVar: OCI_REGION +x-stackQL-config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: opc-next-page + location: header diff --git a/providers/src/oci/v00.00.00000/services/compute.yaml b/providers/src/oci/v00.00.00000/services/compute.yaml new file mode 100644 index 00000000..fb073feb --- /dev/null +++ b/providers/src/oci/v00.00.00000/services/compute.yaml @@ -0,0 +1,23597 @@ +openapi: 3.0.0 +info: + title: compute API + description: oci compute API + version: '20160918' +paths: + /appCatalogListings: + get: + description: Lists the published listings. + operationId: ListAppCatalogListings + parameters: + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/FilterByPublisherNameQueryParam' + - $ref: '#/components/parameters/FilterByPublisherTypeQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListAppCatalogListingsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListAppCatalogListings + tags: + - compute + x-obmcs-client-retries-enabled: true + /appCatalogListings/{listingId}: + get: + description: Gets the specified listing. + operationId: GetAppCatalogListing + parameters: + - $ref: '#/components/parameters/ListingIdPathParam' + responses: + '200': + description: The listing was retrieved. + 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/AppCatalogListing' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetAppCatalogListing + tags: + - compute + x-obmcs-client-retries-enabled: true + /appCatalogListings/{listingId}/resourceVersions: + get: + description: Gets all resource versions for a particular listing. + operationId: ListAppCatalogListingResourceVersions + parameters: + - $ref: '#/components/parameters/ListingIdPathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The listing resource versions were retrieved. + 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/ListAppCatalogListingResourceVersionsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListAppCatalogListingResourceVersions + tags: + - compute + x-obmcs-client-retries-enabled: true + /appCatalogListings/{listingId}/resourceVersions/{resourceVersion}: + get: + description: Gets the specified listing resource version. + operationId: GetAppCatalogListingResourceVersion + parameters: + - $ref: '#/components/parameters/ListingIdPathParam' + - $ref: '#/components/parameters/ResourceVersionPathParam' + responses: + '200': + description: The listing resource version was retrieved. + 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/AppCatalogListingResourceVersion' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetAppCatalogListingResourceVersion + tags: + - compute + x-obmcs-client-retries-enabled: true + /appCatalogListings/{listingId}/resourceVersions/{resourceVersion}/agreements: + get: + description: Retrieves the agreements for a particular resource version of a listing. + operationId: GetAppCatalogListingAgreements + parameters: + - $ref: '#/components/parameters/ListingIdPathParam' + - $ref: '#/components/parameters/ResourceVersionPathParam' + responses: + '200': + description: Agreements for the listing resource version were retrieved. + 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/AppCatalogListingResourceVersionAgreements' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetAppCatalogListingAgreements + tags: + - compute + x-obmcs-client-retries-enabled: true + /appCatalogSubscriptions: + delete: + description: Delete a subscription for a listing resource version for a compartment. + operationId: DeleteAppCatalogSubscription + parameters: + - $ref: '#/components/parameters/ListingIdQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/ResourceVersionQueryParam' + responses: + '204': + description: The resource version was successfully deleted to for a 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteAppCatalogSubscription + tags: + - compute + get: + description: Lists subscriptions for a compartment. + operationId: ListAppCatalogSubscriptions + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/FilterByListingIdQueryParam' + responses: + '200': + description: The list of subscriptions has been returned. + 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/ListAppCatalogSubscriptionsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListAppCatalogSubscriptions + tags: + - compute + x-obmcs-client-retries-enabled: true + post: + description: | + Create a subscription for listing resource version for a compartment. It will take some time to propagate to all regions. + operationId: CreateAppCatalogSubscription + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAppCatalogSubscriptionDetails' + description: Request for the creation of a subscription for listing resource version for a compartment. + required: true + responses: + '200': + description: The resource version was successfully subscribed to. + 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/AppCatalogSubscription' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateAppCatalogSubscription + tags: + - compute + x-obmcs-client-retries-enabled: true + /bootVolumeAttachments/: + get: + description: | + Lists the boot volume attachments in the specified compartment. You can filter the + list by specifying an instance OCID, boot volume OCID, or both. + operationId: ListBootVolumeAttachments + parameters: + - $ref: '#/components/parameters/RequiredAvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/InstanceIdQueryParam' + - $ref: '#/components/parameters/BootVolumeIdQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListBootVolumeAttachmentsResponse' + application/x-json-stream: + schema: + items: + $ref: '#/components/schemas/BootVolumeAttachment' + type: array + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListBootVolumeAttachments + tags: + - compute + post: + description: | + Attaches the specified boot volume to the specified instance. + operationId: AttachBootVolume + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AttachBootVolumeDetails' + description: Attach boot volume request + required: true + responses: + '200': + description: The boot volume is being attached. + 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/BootVolumeAttachment' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: AttachBootVolume + tags: + - compute + /bootVolumeAttachments/{bootVolumeAttachmentId}: + delete: + description: | + Detaches a boot volume from an instance. You must specify the OCID of the boot volume attachment. + + This is an asynchronous operation. The attachment's `lifecycleState` will change to DETACHING temporarily + until the attachment is completely removed. + operationId: DetachBootVolume + parameters: + - $ref: '#/components/parameters/BootVolumeAttachmentIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The request was accepted by the server + 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DetachBootVolume + tags: + - compute + get: + description: Gets information about the specified boot volume attachment. + operationId: GetBootVolumeAttachment + parameters: + - $ref: '#/components/parameters/BootVolumeAttachmentIdPathParam' + responses: + '200': + description: The boot volume attachment was retrieved. + 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/BootVolumeAttachment' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetBootVolumeAttachment + tags: + - compute + /clusterNetworks: + get: + description: | + Lists the [cluster networks with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm) + in the specified compartment. + operationId: ListClusterNetworks + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle + state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/ClusterNetworkSummary/lifecycleState' + schema: + type: string + responses: + '200': + description: The list was retrieved. + 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/ListClusterNetworksResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListClusterNetworks + tags: + - computeManagement + x-example: | + GET /20160918/clusterNetworks + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>" + } + x-related-resource: '#/definitions/ClusterNetwork' + post: + description: | + Creates a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm). + A cluster network is a group of high performance computing (HPC), GPU, or optimized bare metal + instances that are connected with an ultra low-latency remote direct memory access (RDMA) network. + Cluster networks with instance pools use instance pools to manage groups of identical instances. + + Use cluster networks with instance pools when you want predictable capacity for a specific number of identical + instances that are managed as a group. + + If you want to manage instances in the RDMA network independently of each other or use different types of instances + in the network group, create a compute cluster by using the [CreateComputeCluster](#/en/iaas/latest/ComputeCluster/CreateComputeCluster) + operation. + + To determine whether capacity is available for a specific shape before you create a cluster network, + use the [CreateComputeCapacityReport](#/en/iaas/latest/ComputeCapacityReport/CreateComputeCapacityReport) + operation. + operationId: CreateClusterNetwork + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateClusterNetworkDetails' + description: Cluster network creation details + required: true + responses: + '200': + description: The cluster network. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterNetwork' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateClusterNetwork + tags: + - computeManagement + x-example: | + POST /20160918/clusterNetworks + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName": "hpc-cluster-network", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "instancePools": [ + { + "displayName": "hpc-instance-pool-1", + "instanceConfigurationId": "ocid1.instanceconfiguration.oc1..<unique_ID>", + "size": 10, + } + ], + "placementConfiguration": + { + "availabilityDomain": "Uocm:PHX-AD-1", + "primarySubnetId": "ocid1.subnet.oc1..<unique_ID>" + } + } + /clusterNetworks/{clusterNetworkId}: + delete: + description: | + Deletes (terminates) a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm). + + When you delete a cluster network, all of its resources are permanently deleted, + including associated instances and instance pools. + operationId: TerminateClusterNetwork + parameters: + - $ref: '#/components/parameters/ClusterNetworkIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The cluster network is being terminated. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: TerminateClusterNetwork + tags: + - computeManagement + x-example: | + ​DELETE /20160918/clusterNetworks/<cluster_network_OCID> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ClusterNetwork' + get: + description: | + Gets information about a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm). + operationId: GetClusterNetwork + parameters: + - $ref: '#/components/parameters/ClusterNetworkIdPathParam' + responses: + '200': + description: The cluster network was retrieved. + 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/ClusterNetwork' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetClusterNetwork + tags: + - computeManagement + x-example: | + GET /20160918/clusterNetworks/<cluster_network_OCID> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm). + The OCID of the cluster network remains the same. + operationId: UpdateClusterNetwork + parameters: + - $ref: '#/components/parameters/ClusterNetworkIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateClusterNetworkDetails' + description: Update cluster network + required: true + responses: + '200': + description: The cluster network was updated. + 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/ClusterNetwork' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateClusterNetwork + tags: + - computeManagement + x-example: | + PUT /20160918/clusterNetworks/<cluster_network_OCID> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName": "example_cluster_network" + } + /clusterNetworks/{clusterNetworkId}/actions/changeCompartment: + post: + description: | + Moves a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm) + into a different compartment within the same tenancy. For + information about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + + When you move a cluster network to a different compartment, associated resources such as the instances + in the cluster network, boot volumes, and VNICs are not moved. + operationId: ChangeClusterNetworkCompartment + parameters: + - $ref: '#/components/parameters/ClusterNetworkIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeClusterNetworkCompartmentDetails' + description: Request to change the compartment of given cluster network. + required: true + responses: + '204': + description: The Cluster Network Compartment Details is being changed. + 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 + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeClusterNetworkCompartment + tags: + - computeManagement + x-example: | + ​POST /20160918/clusterNetworks/<cluster_network_OCID>/actions/changeCompartment + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<cluster_network_OCID>", + } + x-related-resource: '#/definitions/ClusterNetwork' + /clusterNetworks/{clusterNetworkId}/instances: + get: + description: | + Lists the instances in a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm). + operationId: ListClusterNetworkInstances + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/ClusterNetworkIdPathParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListClusterNetworkInstancesResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListClusterNetworkInstances + tags: + - computeManagement + x-example: | + GET /20160918/clusterNetworks/<cluster_network_OCID>/instances?compartmentId=<compartment_OCID> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ClusterNetwork' + /computeCapacityReports: + post: + description: | + Generates a report of the host capacity within an availability domain that is available for you + to create compute instances. Host capacity is the physical infrastructure that resources such as compute + instances run on. + + Use the capacity report to determine whether sufficient capacity is available for a shape before + you create an instance or change the shape of an instance. + operationId: CreateComputeCapacityReport + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateComputeCapacityReportDetails' + description: | + Details for creating a new compute capacity report. + required: true + responses: + '200': + description: The compute capacity report was created and retrieved. + 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/ComputeCapacityReport' + '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/DefaultError' + summary: CreateComputeCapacityReport + tags: + - compute + x-obmcs-client-retries-enabled: true + /computeCapacityReservationInstanceShapes: + get: + description: | + Lists the shapes that can be reserved within the specified compartment. + operationId: ListComputeCapacityReservationInstanceShapes + parameters: + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListComputeCapacityReservationInstanceShapesResponse' + '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/DefaultError' + summary: ListComputeCapacityReservationInstanceShapes + tags: + - compute + /computeCapacityReservations: + get: + description: | + Lists the compute capacity reservations that match the specified criteria and compartment. + + You can limit the list by specifying a compute capacity reservation display name + (the list will include all the identically-named compute capacity reservations in the compartment). + operationId: ListComputeCapacityReservations + parameters: + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/CapacityReservationLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListComputeCapacityReservationsResponse' + application/x-json-stream: + schema: + items: + $ref: '#/components/schemas/ComputeCapacityReservationSummary' + type: array + '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/DefaultError' + summary: ListComputeCapacityReservations + tags: + - compute + x-related-resource: '#/definitions/ComputeCapacityReservation' + post: + description: | + Creates a new compute capacity reservation in the specified compartment and availability domain. + Compute capacity reservations let you reserve instances in a compartment. + When you launch an instance using this reservation, you are assured that you have enough space for your instance, + and you won't get out of capacity errors. + For more information, see [Reserved Capacity](/iaas/Content/Compute/Tasks/reserve-capacity.htm). + operationId: CreateComputeCapacityReservation + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateComputeCapacityReservationDetails' + description: | + Details for creating a new compute capacity reservation. + + **Caution:** Avoid using any confidential information when you use the API to supply string values. + required: true + responses: + '201': + description: The compute capacity reservation is being created. + headers: + etag: + description: | + For optimistic concurrency control. See `if-match`. + schema: + type: string + location: + description: | + Location of the resource. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ComputeCapacityReservation' + '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/DefaultError' + summary: CreateComputeCapacityReservation + tags: + - compute + /computeCapacityReservations/{capacityReservationId}: + delete: + description: Deletes the specified compute capacity reservation. + operationId: DeleteComputeCapacityReservation + parameters: + - $ref: '#/components/parameters/ComputeCapacityReservationIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + description: The compute capacity reservation is being 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + '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/DefaultError' + summary: DeleteComputeCapacityReservation + tags: + - compute + x-related-resource: '#/definitions/ComputeCapacityReservation' + get: + description: Gets information about the specified compute capacity reservation. + operationId: GetComputeCapacityReservation + parameters: + - $ref: '#/components/parameters/ComputeCapacityReservationIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The compute capacity reservation's information was retrieved. + 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/ComputeCapacityReservation' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetComputeCapacityReservation + tags: + - compute + put: + description: | + Updates the specified capacity reservation and its associated capacity configurations. + Fields that are not provided in the request will not be updated. Capacity configurations that are not included will be deleted. + Avoid entering confidential information. + operationId: UpdateComputeCapacityReservation + parameters: + - $ref: '#/components/parameters/ComputeCapacityReservationIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateComputeCapacityReservationDetails' + description: Update compute capacity reservation details. + required: true + responses: + '202': + description: The compute capacity reservation is being 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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/DefaultError' + summary: UpdateComputeCapacityReservation + tags: + - compute + x-related-resource: '#/definitions/ComputeCapacityReservation' + /computeCapacityReservations/{capacityReservationId}/actions/changeCompartment: + post: + description: | + Moves a compute capacity reservation into a different compartment. For information about + moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeComputeCapacityReservationCompartment + parameters: + - $ref: '#/components/parameters/ComputeCapacityReservationIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeComputeCapacityReservationCompartmentDetails' + description: The configuration details for the move operation. + required: true + responses: + '202': + description: The compute capacity reservation is being moved into a different 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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/DefaultError' + summary: ChangeComputeCapacityReservationCompartment + tags: + - compute + x-related-resource: '#/definitions/ComputeCapacityReservation' + /computeCapacityReservations/{capacityReservationId}/instances: + get: + description: | + Lists the instances launched under a capacity reservation. You can filter results by specifying criteria. + operationId: ListComputeCapacityReservationInstances + parameters: + - $ref: '#/components/parameters/ComputeCapacityReservationIdPathParam' + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListComputeCapacityReservationInstancesResponse' + application/x-json-stream: + schema: + items: + $ref: '#/components/schemas/CapacityReservationInstanceSummary' + type: array + '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/DefaultError' + summary: ListComputeCapacityReservationInstances + tags: + - compute + /computeCapacityTopologies: + get: + description: | + Lists the compute capacity topologies in the specified compartment. You can filter the list by a compute + capacity topology display name. + operationId: ListComputeCapacityTopologies + parameters: + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ComputeCapacityTopologyCollection' + '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/DefaultError' + summary: ListComputeCapacityTopologies + tags: + - compute + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeCapacityTopology' + post: + description: | + Creates a new compute capacity topology in the specified compartment and availability domain. + + Compute capacity topologies provide the RDMA network topology of your bare metal hosts so that you can launch + instances on your bare metal hosts with targeted network locations. + + Compute capacity topologies report the health status of your bare metal hosts. + operationId: CreateComputeCapacityTopology + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateComputeCapacityTopologyDetails' + description: | + Details for creating a new compute capacity topology. + required: true + responses: + '201': + description: The compute capacity topology is being created. + headers: + etag: + description: | + For optimistic concurrency control. See `if-match`. + schema: + type: string + location: + description: | + Location of the resource. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ComputeCapacityTopology' + '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/DefaultError' + summary: CreateComputeCapacityTopology + tags: + - compute + x-obmcs-client-retries-enabled: true + /computeCapacityTopologies/{computeCapacityTopologyId}: + delete: + description: Deletes the specified compute capacity topology. + operationId: DeleteComputeCapacityTopology + parameters: + - $ref: '#/components/parameters/ComputeCapacityTopologyIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '202': + description: The compute capacity topology is being 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + '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/DefaultError' + summary: DeleteComputeCapacityTopology + tags: + - compute + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeCapacityTopology' + get: + description: Gets information about the specified compute capacity topology. + operationId: GetComputeCapacityTopology + parameters: + - $ref: '#/components/parameters/ComputeCapacityTopologyIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The information of the compute capacity topology was retrieved. + 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/ComputeCapacityTopology' + '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/DefaultError' + summary: GetComputeCapacityTopology + tags: + - compute + x-obmcs-client-retries-enabled: true + put: + description: | + Updates the specified compute capacity topology. Fields that are not provided in the request will not be updated. + operationId: UpdateComputeCapacityTopology + parameters: + - $ref: '#/components/parameters/ComputeCapacityTopologyIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateComputeCapacityTopologyDetails' + description: Update compute capacity topology details. + required: true + responses: + '202': + description: The compute capacity topology is being 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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/DefaultError' + summary: UpdateComputeCapacityTopology + tags: + - compute + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeCapacityTopology' + /computeCapacityTopologies/{computeCapacityTopologyId}/actions/changeCompartment: + post: + description: | + Moves a compute capacity topology into a different compartment. For information about moving resources between + compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeComputeCapacityTopologyCompartment + parameters: + - $ref: '#/components/parameters/ComputeCapacityTopologyIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeComputeCapacityTopologyCompartmentDetails' + description: The configuration details for the move operation. + required: true + responses: + '202': + description: The compute capacity topology is being moved into a different 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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/DefaultError' + summary: ChangeComputeCapacityTopologyCompartment + tags: + - compute + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeCapacityTopology' + /computeCapacityTopologies/{computeCapacityTopologyId}/computeBareMetalHosts: + get: + description: Lists compute bare metal hosts in the specified compute capacity topology. + operationId: ListComputeCapacityTopologyComputeBareMetalHosts + parameters: + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' + - $ref: '#/components/parameters/ComputeCapacityTopologyIdPathParam' + - $ref: '#/components/parameters/ComputeHpcIslandIdQueryParam' + - $ref: '#/components/parameters/ComputeNetworkBlockIdQueryParam' + - $ref: '#/components/parameters/ComputeLocalBlockIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The list of compute bare metal hosts is being retrieved. + 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/ComputeBareMetalHostCollection' + '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/DefaultError' + summary: ListComputeCapacityTopologyComputeBareMetalHosts + tags: + - compute + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeBareMetalHost' + /computeCapacityTopologies/{computeCapacityTopologyId}/computeHpcIslands: + get: + description: Lists compute HPC islands in the specified compute capacity topology. + operationId: ListComputeCapacityTopologyComputeHpcIslands + parameters: + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' + - $ref: '#/components/parameters/ComputeCapacityTopologyIdPathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The list of compute HPC islands is being retrieved. + 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/ComputeHpcIslandCollection' + '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/DefaultError' + summary: ListComputeCapacityTopologyComputeHpcIslands + tags: + - compute + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeHpcIsland' + /computeCapacityTopologies/{computeCapacityTopologyId}/computeNetworkBlocks: + get: + description: Lists compute network blocks in the specified compute capacity topology. + operationId: ListComputeCapacityTopologyComputeNetworkBlocks + parameters: + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' + - $ref: '#/components/parameters/ComputeCapacityTopologyIdPathParam' + - $ref: '#/components/parameters/ComputeHpcIslandIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The list of compute network blocks is being retrieved. + 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/ComputeNetworkBlockCollection' + '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/DefaultError' + summary: ListComputeCapacityTopologyComputeNetworkBlocks + tags: + - compute + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeNetworkBlock' + /computeClusters: + get: + description: | + Lists the compute clusters in the specified compartment. + A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory access (RDMA) network group. + operationId: ListComputeClusters + parameters: + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The list is being retrieved. + 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/ComputeClusterCollection' + '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/DefaultError' + summary: ListComputeCluster + tags: + - compute + x-related-resource: '#/definitions/ComputeCluster' + post: + description: | + Creates an empty [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm). A compute cluster + is a remote direct memory access (RDMA) network group. + + After the compute cluster is created, you can use the compute cluster's OCID with the + [LaunchInstance](#/en/iaas/latest/Instance/LaunchInstance) operation to create instances in the compute cluster. + The instances must be created in the same compartment and availability domain as the cluster. + + Use compute clusters when you want to manage instances in the cluster individually in the RDMA network group. + + If you want predictable capacity for a specific number of identical instances that are managed as a group, + create a cluster network that uses instance pools by using the + [CreateClusterNetwork](#/en/iaas/latest/ClusterNetwork/CreateClusterNetwork) operation. + operationId: CreateComputeCluster + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateComputeClusterDetails' + description: | + The data for creating a [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm). A compute cluster + is an empty remote direct memory access (RDMA) network group. + + After the compute cluster is created, you can use the compute cluster's OCID with the + [LaunchInstance](#/en/iaas/latest/Instance/LaunchInstance) operation to create instances in the compute cluster. + The instances must be created in the same compartment and availability domain as the cluster. + + Use compute clusters when you want to manage instances in the cluster individually in the RDMA network group. + + For details about creating a cluster network that uses instance pools to manage groups of identical instances, + see [CreateClusterNetworkDetails](#/en/iaas/latest/datatypes/CreateClusterNetworkDetails). + required: true + responses: + '200': + description: The compute cluster is being created. + 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/ComputeCluster' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateComputeCluster + tags: + - compute + /computeClusters/{computeClusterId}: + delete: + description: | + Deletes a compute cluster. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a + remote direct memory access (RDMA) network group. + + Before you delete a compute cluster, first delete all instances in the cluster by using + the [TerminateInstance](#/en/iaas/latest/Instance/TerminateInstance) operation. + operationId: DeleteComputeCluster + parameters: + - $ref: '#/components/parameters/ComputeClusterIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The compute cluster is being 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 + '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/DefaultError' + summary: DeleteComputeCluster + tags: + - compute + x-related-resource: '#/definitions/ComputeCluster' + get: + description: | + Gets information about a compute cluster. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) + is a remote direct memory access (RDMA) network group. + operationId: GetComputeCluster + parameters: + - $ref: '#/components/parameters/ComputeClusterIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The compute cluster was retrieved. + 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/ComputeCluster' + '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/DefaultError' + summary: GetComputeCluster + tags: + - compute + put: + description: | + Updates a compute cluster. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a + remote direct memory access (RDMA) network group. + + To create instances within a compute cluster, use the [LaunchInstance](#/en/iaas/latest/Instance/LaunchInstance) + operation. + + To delete instances from a compute cluster, use the [TerminateInstance](#/en/iaas/latest/Instance/TerminateInstance) + operation. + operationId: UpdateComputeCluster + parameters: + - $ref: '#/components/parameters/ComputeClusterIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateComputeClusterDetails' + description: Details for updating the compute cluster. + required: true + responses: + '200': + description: The compute cluster was updated. + 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/ComputeCluster' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateComputeCluster + tags: + - compute + /computeClusters/{computeClusterId}/actions/changeCompartment: + post: + description: | + Moves a compute cluster into a different compartment within the same tenancy. + A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory access (RDMA) network group. + + For information about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeComputeClusterCompartment + parameters: + - $ref: '#/components/parameters/ComputeClusterIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeComputeClusterCompartmentDetails' + description: The request to move the compute cluster to a different compartment. + required: true + responses: + '204': + description: The compute cluster was moved into a different 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 + '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/DefaultError' + summary: MoveComputeCluster + tags: + - compute + x-related-resource: '#/definitions/ComputeCluster' + /computeGlobalImageCapabilitySchemas: + get: + description: | + Lists Compute Global Image Capability Schema in the specified compartment. + operationId: ListComputeGlobalImageCapabilitySchemas + parameters: + - $ref: '#/components/parameters/ComputeImageCapabilityCompartmentIdQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListComputeGlobalImageCapabilitySchemasResponse' + '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/DefaultError' + summary: ListComputeGlobalImageCapabilitySchemas + tags: + - compute + x-obmcs-client-retries-enabled: true + /computeGlobalImageCapabilitySchemas/{computeGlobalImageCapabilitySchemaId}: + get: + description: Gets the specified Compute Global Image Capability Schema + operationId: GetComputeGlobalImageCapabilitySchema + parameters: + - $ref: '#/components/parameters/ComputeGlobalImageCapabilitySchemaIdPathParam' + responses: + '200': + description: The compute global image capability schema retrieved. + 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/ComputeGlobalImageCapabilitySchema' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetComputeGlobalImageCapabilitySchema + tags: + - compute + x-obmcs-client-retries-enabled: true + /computeGlobalImageCapabilitySchemas/{computeGlobalImageCapabilitySchemaId}/versions: + get: + description: | + Lists Compute Global Image Capability Schema versions in the specified compartment. + operationId: ListComputeGlobalImageCapabilitySchemaVersions + parameters: + - $ref: '#/components/parameters/ComputeGlobalImageCapabilitySchemaIdPathParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The list of Compute Global Image Capability Schema Versions retrieved. + 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/ListComputeGlobalImageCapabilitySchemaVersionsResponse' + '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/DefaultError' + summary: ListComputeGlobalImageCapabilitySchemaVersions + tags: + - compute + x-obmcs-client-retries-enabled: true + /computeGlobalImageCapabilitySchemas/{computeGlobalImageCapabilitySchemaId}/versions/{computeGlobalImageCapabilitySchemaVersionName}: + get: + description: Gets the specified Compute Global Image Capability Schema Version + operationId: GetComputeGlobalImageCapabilitySchemaVersion + parameters: + - $ref: '#/components/parameters/ComputeGlobalImageCapabilitySchemaIdPathParam' + - $ref: '#/components/parameters/ComputeGlobalImageCapabilitySchemaVersionNamePathParam' + responses: + '200': + description: The compute global image capability schema version retrieved. + 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/ComputeGlobalImageCapabilitySchemaVersion' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetComputeGlobalImageCapabilitySchemaVersion + tags: + - compute + x-obmcs-client-retries-enabled: true + /computeGpuMemoryClusters: + get: + description: | + List all of the compute GPU memory clusters. + operationId: ListComputeGpuMemoryClusters + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/ComputeGpuMemoryClusterIdQueryParam' + - $ref: '#/components/parameters/ComputeGpuMemoryFabricIdQueryParam' + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/ComputeClusterIdQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + responses: + '200': + description: The list of GPU memory clusters was created and retrieved. + headers: + etag: + description: | + For optimistic concurrency control. See `if-match`. + schema: + 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). + 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/ComputeGpuMemoryClusterCollection' + application/x-json-stream: + schema: + $ref: '#/components/schemas/ComputeGpuMemoryClusterCollection' + '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/DefaultError' + summary: ListComputeGpuMemoryClusters + tags: + - compute + x-example: | + GET /20160918/computeGpuMemoryClusters?compartmentId=ocid1.compartment.oc1..<unique_ID> + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeGpuMemoryCluster' + post: + description: | + Create a compute GPU memory cluster instance on a specific compute GPU memory fabric + operationId: CreateComputeGpuMemoryCluster + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateComputeGpuMemoryClusterDetails' + description: The configuration details of a GPU memory cluster + required: true + responses: + '201': + description: The compute GPU memory cluster is being created. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ComputeGpuMemoryCluster' + '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/DefaultError' + summary: CreateComputeGpuMemoryCluster + tags: + - compute + x-example: | + POST /20160918/ComputeGpuMemoryClusters + <authorization and other headers> + { + "availabilityDomain": "Uocm:PHX-AD-1", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "gpuMemoryFabricId": "ocid1.computegpumemoryfabric.oc1..<unique_ID>", + "computeClusterId": "ocid1.computecluster.oc1..<unique_ID>", + "instanceConfigurationId": "ocid1.instanceconfiguration.oc1..<unique_ID>", + "size": 18, + "displayName": "example-gpu-memory-cluster" + } + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeGpuMemoryCluster' + /computeGpuMemoryClusters/{computeGpuMemoryClusterId}: + delete: + description: Terminates and deletes the specified compute GPU memory cluster and underlying instances. + operationId: DeleteComputeGpuMemoryCluster + parameters: + - $ref: '#/components/parameters/ComputeGpuMemoryClusterIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '202': + description: The compute GPU memory cluster is terminating and underlying instances are being 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + '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/DefaultError' + summary: DeleteComputeGpuMemoryCluster + tags: + - compute + x-example: | + DELETE /20160918/computeGpuMemoryClusters/<ComputeGpuMemoryCluster_OCID> + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeGpuMemoryCluster' + get: + description: | + Gets information about the specified compute GPU memory cluster + operationId: GetComputeGpuMemoryCluster + parameters: + - $ref: '#/components/parameters/ComputeGpuMemoryClusterIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The information of the compute GPU memory cluster was retrieved. + 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/ComputeGpuMemoryCluster' + '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/DefaultError' + summary: GetComputeGpuMemoryCluster + tags: + - compute + x-example: | + GET /20160918/computeGpuMemoryClusters/<ComputeGpuMemoryCluster_OCID> + x-related-resource: '#/definitions/ComputeGpuMemoryCluster' + put: + description: | + Updates a compute gpu memory cluster resource. + operationId: UpdateComputeGpuMemoryCluster + parameters: + - $ref: '#/components/parameters/ComputeGpuMemoryClusterIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateComputeGpuMemoryClusterDetails' + description: Update compute GPU memory cluster details. + required: true + responses: + '202': + description: The compute GPU memory cluster is being updated. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ComputeGpuMemoryCluster' + '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/DefaultError' + summary: UpdateComputeGpuMemoryCluster + tags: + - compute + x-example: | + PUT /20160918/computeGpuMemoryClusters/<ComputeGpuMemoryCluster_OCID> + <authorization and other headers> + { + "instanceConfigurationId": "<newInstanceConfigurationId>", + "displayName": "<newDisplayName>", + "definedTags": "<newDefinedTags>", + "freeformTags": "<newFreeformTags>", + "size": "<newSize>" + } + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeGpuMemoryCluster' + x-obmcs-client-retries-enabled: true + /computeGpuMemoryClusters/{computeGpuMemoryClusterId}/actions/changeCompartment: + post: + description: | + Moves a compute GPU memory cluster into a different compartment. For information about moving resources between + compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeComputeGpuMemoryClusterCompartment + parameters: + - $ref: '#/components/parameters/ComputeGpuMemoryClusterIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeComputeGpuMemoryClusterCompartmentDetails' + description: The configuration details for the move operation. + required: true + responses: + '204': + description: The GPU memory cluster is moved into a different 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 + '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/DefaultError' + summary: ChangeComputeGpuMemoryClusterCompartment + tags: + - compute + x-example: | + POST /20160918/ComputeGpuMemoryClusters/<computeGpuMemoryCluster_OCID>/actions/changeCompartment + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>" + } + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeGpuMemoryCluster' + /computeGpuMemoryClusters/{computeGpuMemoryClusterId}/instances: + get: + description: | + List all of the GPU memory cluster instances. + operationId: ListComputeGpuMemoryClusterInstances + parameters: + - $ref: '#/components/parameters/ComputeGpuMemoryClusterIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + responses: + '200': + description: The list of summary memory cluster details was created and retrieved. + headers: + etag: + description: | + For optimistic concurrency control. See `if-match`. + schema: + 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). + 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/ComputeGpuMemoryClusterInstanceCollection' + application/x-json-stream: + schema: + $ref: '#/components/schemas/ComputeGpuMemoryClusterInstanceCollection' + '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/DefaultError' + summary: ListComputeGpuMemoryClustersInstances + tags: + - compute + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeGpuMemoryClusterInstanceSummary' + /computeGpuMemoryFabrics: + get: + description: Lists the compute GPU memory fabrics that match the specified criteria and compartmentId. + operationId: ListComputeGpuMemoryFabrics + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/ComputeGpuMemoryFabricIdQueryParam' + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/ComputeHpcIslandIdQueryParam' + - $ref: '#/components/parameters/ComputeNetworkBlockIdQueryParam' + - $ref: '#/components/parameters/ComputeGpuMemoryFabricLifecycleStateQueryParam' + - $ref: '#/components/parameters/ComputeGpuMemoryFabricHealthQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The list of summary memory fabric details was created and retrieved. + 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/ComputeGpuMemoryFabricCollection' + application/x-json-stream: + schema: + $ref: '#/components/schemas/ComputeGpuMemoryFabricCollection' + '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/DefaultError' + summary: ListComputeGpuMemoryFabrics + tags: + - compute + x-example: | + GET /20160918/computeGpuMemoryFabrics?compartmentId=ocid1.compartment.oc1..<unique_ID> + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeGpuMemoryFabric' + /computeGpuMemoryFabrics/{computeGpuMemoryFabricId}: + get: + description: | + Gets information about the specified compute GPU memory fabric + operationId: GetComputeGpuMemoryFabric + parameters: + - $ref: '#/components/parameters/ComputeGpuMemoryFabricIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The information of the compute GPU memory fabric was retrieved. + 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/ComputeGpuMemoryFabric' + '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/DefaultError' + summary: GetComputeGpuMemoryFabric + tags: + - compute + x-example: | + GET /20160918/computeGpuMemoryFabric/ocid1.computeGpuMemoryFabric.oc1..<unique_ID> + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeGpuMemoryFabric' + put: + description: | + Customer can update displayName, tags and desired firmware bundle, recycle level for + compute GPU memory fabric record + operationId: UpdateComputeGpuMemoryFabric + parameters: + - $ref: '#/components/parameters/ComputeGpuMemoryFabricIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateComputeGpuMemoryFabricDetails' + description: Update compute GPU memory fabric details. + required: true + responses: + '200': + description: The compute GPU memory fabric details was successfully updated. + 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/ComputeGpuMemoryFabric' + '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/DefaultError' + summary: UpdateComputeGpuMemoryFabric + tags: + - compute + x-example: | + PUT /20160918/computeGpuMemoryFabric/<computeGpuMemoryFabric_OCID> + <authorization and other headers> + { + "displayName": "<newDisplayName>", + "definedTags": "<newDefinedTags>", + "freeformTags": "<newFreeformTags>" + "memoryFabricPreferences": "<{"customerDesiredFirmwareBundleId": "ocid1.firmwarebundle.oc1..<unique_ID> + ", "fabricRecycleLevel”:“FULL_RECYCLE"}> + " + } + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeGpuMemoryFabric' + /computeGpuMemoryFabrics/{computeGpuMemoryFabricId}/actions/changeCompartment: + post: + description: | + Moves a compute GPU memory fabric into a different compartment. For information about moving resources between + compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeComputeGpuMemoryFabricCompartment + parameters: + - $ref: '#/components/parameters/ComputeGpuMemoryFabricIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeComputeGpuMemoryFabricCompartmentDetails' + description: The configuration details for the move operation. + required: true + responses: + '204': + description: The compute GPU memory fabric is moved into a different 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 + '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/DefaultError' + summary: ChangeComputeGpuMemoryFabricCompartment + tags: + - compute + x-example: | + POST /20160918/ComputeGpuMemoryFabrics/<computeGpuMemoryFabric_OCID>/actions/changeCompartment + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>" + } + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeGpuMemoryFabric' + /computeHostGroups: + get: + description: Lists the compute host groups that match the specified criteria and compartment. + operationId: ListComputeHostGroups + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ComputeHostGroupCollection' + application/x-json-stream: + schema: + $ref: '#/components/schemas/ComputeHostGroupCollection' + '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/DefaultError' + summary: ListComputeHostGroups + tags: + - compute + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeHostGroup' + post: + description: Creates a new compute host group in the specified compartment and availability domain. + operationId: CreateComputeHostGroup + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateComputeHostGroupDetails' + description: Details for creating a new host group. + required: true + responses: + '201': + description: The compute host group is being created. + headers: + etag: + description: | + For optimistic concurrency control. See `if-match`. + schema: + type: string + location: + description: | + Location of the resource. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ComputeHostGroup' + '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/DefaultError' + summary: CreateComputeHostGroup + tags: + - compute + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeHostGroup' + /computeHostGroups/{computeHostGroupId}: + delete: + description: Deletes the specified compute host group + operationId: DeleteComputeHostGroup + parameters: + - $ref: '#/components/parameters/ComputeHostGroupIdParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + description: The compute host group is being 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 + '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/DefaultError' + summary: DeleteComputeHostGroup + tags: + - compute + x-related-resource: '#/definitions/ComputeHostGroup' + get: + description: Gets information about the specified compute host group + operationId: GetComputeHostGroup + parameters: + - $ref: '#/components/parameters/ComputeHostGroupIdParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The information host details for the specific host group was retrieved. + 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/ComputeHostGroup' + '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/DefaultError' + summary: GetComputeHostGroup + tags: + - compute + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeHostGroup' + put: + description: Updates the specified compute host group details. + operationId: UpdateComputeHostGroup + parameters: + - $ref: '#/components/parameters/ComputeHostGroupIdParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateComputeHostGroupDetails' + description: Update compute host group details. + required: true + responses: + '200': + description: The compute host group is being updated. + headers: + etag: + description: | + For optimistic concurrency control. See `if-match`. + schema: + type: string + location: + description: | + Location of the resource. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ComputeHostGroup' + '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/DefaultError' + summary: UpdateComputeHostGroup + tags: + - compute + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeHostGroup' + /computeHostGroups/{computeHostGroupId}/actions/changeCompartment: + post: + description: | + Moves a compute host group into a different compartment. For information about moving resources between + compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeComputeHostGroupCompartment + parameters: + - $ref: '#/components/parameters/ComputeHostGroupIdParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeComputeHostGroupCompartmentDetails' + description: The configuration details for the move operation. + required: true + responses: + '202': + description: The compute host group is being moved into a different 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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/DefaultError' + summary: ChangeComputeHostGroupCompartment + tags: + - compute + x-example: | + POST /20160918/ComputeHostGroup/<computeHostGroup_OCID>/actions/changeCompartment + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>" + } + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeHostGroup' + /computeHosts: + get: + description: | + Generates a list of summary host details + operationId: ListComputeHosts + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/ComputeHostNetworkResourceQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ComputeHostLifecycleStateParam' + - $ref: '#/components/parameters/ComputeHostHealthParam' + - $ref: '#/components/parameters/ComputeHostGroupIdQueryParam' + - $ref: '#/components/parameters/ComputeHostInSubtreeQueryParam' + responses: + '200': + description: The list of summary host details was created and retrieved. + 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/ComputeHostCollection' + application/x-json-stream: + schema: + $ref: '#/components/schemas/ComputeHostCollection' + '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/DefaultError' + summary: ListComputeHosts + tags: + - compute + x-example: | + GET /20160918/computeHost + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeHost' + /computeHosts/{computeHostId}: + get: + description: | + Gets information about the specified compute host + operationId: GetComputeHost + parameters: + - $ref: '#/components/parameters/ComputeHostIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The information host details for the specific host was retrieved. + 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/ComputeHost' + '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/DefaultError' + summary: GetComputeHost + tags: + - compute + x-example: | + GET /20160918/computeHost/?computeHostId=ocid1.computeHost.oc1..<unique_ID> + x-obmcs-client-retries-enabled: true + put: + description: | + Customer can update the some fields for ComputeHost record + operationId: UpdateComputeHost + parameters: + - $ref: '#/components/parameters/ComputeHostIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateComputeHostDetails' + description: Update compute capacity topology details. + required: true + responses: + '200': + description: The host details for the specific host was successfully updated. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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/DefaultError' + summary: UpdateComputeHost + tags: + - compute + x-example: | + PUT /20160918/ComputeHost/<computeHost_OCID> + { + "displayName": "newName" + } + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeHost' + /computeHosts/{computeHostId}/actions/applyConfiguration: + post: + description: Triggers the asynchronous process that applies the host's target configuration + operationId: ApplyHostConfiguration + parameters: + - $ref: '#/components/parameters/ComputeHostIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '202': + description: The host's target configuration is being applied + headers: + etag: + description: | + For optimistic concurrency control. See `if-match`. + schema: + type: string + location: + description: | + Location of the resource. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ComputeHost' + '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/DefaultError' + summary: ApplyHostConfiguration + tags: + - compute + x-obmcs-client-retries-enabled: true + x-obmcs-terraform: + actionType: UPDATE_FIELD + x-related-resource: '#/definitions/ComputeHost' + /computeHosts/{computeHostId}/actions/attachToHostGroup: + post: + description: Attaches the Compute BM Host to a Host group + operationId: AttachComputeHostGroupHost + parameters: + - $ref: '#/components/parameters/ComputeHostIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AttachComputeHostGroupHostDetails' + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host group. + required: true + responses: + '202': + description: The host has been attached to a host group. + headers: + etag: + description: | + For optimistic concurrency control. See `if-match`. + schema: + type: string + location: + description: | + Location of the resource. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ComputeHost' + '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/DefaultError' + summary: AttachComputeHostGroupHost + tags: + - compute + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeHost' + /computeHosts/{computeHostId}/actions/changeCompartment: + post: + description: | + Moves a compute host into a different compartment. For information about moving resources between + compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeComputeHostCompartment + parameters: + - $ref: '#/components/parameters/ComputeHostIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeComputeHostCompartmentDetails' + description: The configuration details for the move operation. + required: true + responses: + '202': + description: The compute host is being moved into a different 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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/DefaultError' + summary: ChangeComputeHostCompartment + tags: + - compute + x-example: | + POST /20160918/ComputeHost/<computeHost_OCID>/actions/changeCompartment + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>" + } + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeHost' + /computeHosts/{computeHostId}/actions/checkConfiguration: + post: + description: Marks the host to be checked for conformance to its target configuration + operationId: CheckHostConfiguration + parameters: + - $ref: '#/components/parameters/ComputeHostIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '200': + description: The host's conformance to its configuration will be checked + headers: + etag: + description: | + For optimistic concurrency control. See `if-match`. + schema: + type: string + location: + description: | + Location of the resource. + 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/ComputeHost' + '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/DefaultError' + summary: CheckHostConfiguration + tags: + - compute + x-obmcs-client-retries-enabled: true + x-obmcs-terraform: + actionType: UPDATE_FIELD + x-related-resource: '#/definitions/ComputeHost' + /computeHosts/{computeHostId}/actions/detachFromHostGroup: + post: + description: Detaches the specified bare metal host from the compute host group + operationId: DetachComputeHostGroupHost + parameters: + - $ref: '#/components/parameters/ComputeHostIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DetachComputeHostGroupHostDetails' + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host group. + required: true + responses: + '202': + description: The compute bare metal host is being detached from the host group. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + '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/DefaultError' + summary: DetachComputeHostGroupHost + tags: + - compute + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeHost' + /computeImageCapabilitySchemas: + get: + description: | + Lists Compute Image Capability Schema in the specified compartment. You can also query by a specific imageId. + operationId: ListComputeImageCapabilitySchemas + parameters: + - $ref: '#/components/parameters/ComputeImageCapabilityCompartmentIdQueryParam' + - $ref: '#/components/parameters/ImageIdQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The list of compute image capability schemas retrieved. + 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/ListComputeImageCapabilitySchemasResponse' + '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/DefaultError' + summary: ListComputeImageCapabilitySchemas + tags: + - compute + x-obmcs-client-retries-enabled: true + post: + description: | + Creates compute image capability schema. + operationId: CreateComputeImageCapabilitySchema + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateComputeImageCapabilitySchemaDetails' + description: Compute Image Capability Schema creation details + required: true + responses: + '200': + description: Compute Image Capability Schema + 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/ComputeImageCapabilitySchema' + '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/DefaultError' + summary: CreateComputeImageCapabilitySchema + tags: + - compute + x-obmcs-client-retries-enabled: true + /computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}: + delete: + description: | + Deletes the specified Compute Image Capability Schema + operationId: DeleteComputeImageCapabilitySchema + parameters: + - $ref: '#/components/parameters/ComputeImageCapabilitySchemaIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The Compute Image Capability Schema has been 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 + '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/DefaultError' + summary: DeleteComputeImageCapabilitySchema + tags: + - compute + x-related-resource: '#/definitions/ComputeImageCapabilitySchema' + get: + description: | + Gets the specified Compute Image Capability Schema + operationId: GetComputeImageCapabilitySchema + parameters: + - $ref: '#/components/parameters/ComputeImageCapabilitySchemaIdPathParam' + - $ref: '#/components/parameters/ComputeImageCapabilityMergeQueryParam' + responses: + '200': + description: The compute image capability schema retrieved. + 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/ComputeImageCapabilitySchema' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetComputeImageCapabilitySchema + tags: + - compute + x-obmcs-client-retries-enabled: true + put: + description: | + Updates the specified Compute Image Capability Schema + operationId: UpdateComputeImageCapabilitySchema + parameters: + - $ref: '#/components/parameters/ComputeImageCapabilitySchemaIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateComputeImageCapabilitySchemaDetails' + description: Updates the freeFormTags, definedTags, and display name of the image capability schema + required: true + responses: + '200': + description: The updated Compute Image Capability Schema + 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/ComputeImageCapabilitySchema' + '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/DefaultError' + summary: UpdateComputeImageCapabilitySchema + tags: + - compute + /computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}/actions/changeCompartment: + post: + description: | + Moves a compute image capability schema into a different compartment within the same tenancy. + For information about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeComputeImageCapabilitySchemaCompartment + parameters: + - $ref: '#/components/parameters/ComputeImageCapabilitySchemaIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeComputeImageCapabilitySchemaCompartmentDetails' + description: Compute Image Capability Schema change compartment details + required: true + responses: + '204': + description: The Compute Image Capability Schema has been moved. + 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 + '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/DefaultError' + summary: ChangeComputeImageCapabilitySchemaCompartment + tags: + - compute + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ComputeImageCapabilitySchema' + /dedicatedVmHostInstanceShapes: + get: + description: | + Lists the shapes that can be used to launch a virtual machine instance on a dedicated virtual machine host within the specified compartment. + You can filter the list by compatibility with a specific dedicated virtual machine host shape. + operationId: ListDedicatedVmHostInstanceShapes + parameters: + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/DedicatedVmHostShapeNameQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The list is being retrieved. + 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/ListDedicatedVmHostInstanceShapesResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDedicatedVmHostInstanceShapes + tags: + - compute + /dedicatedVmHostShapes: + get: + description: | + Lists the shapes that can be used to launch a dedicated virtual machine host within the specified compartment. + operationId: ListDedicatedVmHostShapes + parameters: + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/InstanceShapeNameQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The list is being retrieved. + 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/ListDedicatedVmHostShapesResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDedicatedVmHostShapes + tags: + - compute + /dedicatedVmHosts: + get: + description: | + Returns the list of dedicated virtual machine hosts that match the specified criteria in the specified compartment. + + You can limit the list by specifying a dedicated virtual machine host display name. The list will include all the identically-named + dedicated virtual machine hosts in the compartment. + operationId: ListDedicatedVmHosts + parameters: + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/DedicatedVmHostLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/InstanceShapeNameQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/RemainingMemoryInGBsGreaterThanOrEqualToQueryParam' + - $ref: '#/components/parameters/RemainingOcpusGreaterThanOrEqualToQueryParam' + - $ref: '#/components/parameters/IsMemoryEncryptionEnabledQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListDedicatedVmHostsResponse' + application/x-json-stream: + schema: + items: + $ref: '#/components/schemas/DedicatedVmHostSummary' + type: array + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDedicatedVmHosts + tags: + - compute + post: + description: | + Creates a new dedicated virtual machine host in the specified compartment and the specified availability domain. + Dedicated virtual machine hosts enable you to run your Compute virtual machine (VM) instances on dedicated servers + that are a single tenant and not shared with other customers. + For more information, see [Dedicated Virtual Machine Hosts](/iaas/Content/Compute/Concepts/dedicatedvmhosts.htm). + operationId: CreateDedicatedVmHost + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateDedicatedVmHostDetails' + description: The details for creating a new dedicated virtual machine host. + required: true + responses: + '200': + description: | + The dedicated virtual machine host is being created. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DedicatedVmHost' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateDedicatedVmHost + tags: + - compute + /dedicatedVmHosts/{dedicatedVmHostId}: + delete: + description: | + Deletes the specified dedicated virtual machine host. + + If any VM instances are assigned to the dedicated virtual machine host, + the delete operation will fail and the service will return a 409 response code. + operationId: DeleteDedicatedVmHost + parameters: + - $ref: '#/components/parameters/DedicatedVmHostIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '204': + description: The dedicated virtual machine host is being 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteDedicatedVmHost + tags: + - compute + x-related-resource: '#/definitions/DedicatedVmHost' + get: + description: Gets information about the specified dedicated virtual machine host. + operationId: GetDedicatedVmHost + parameters: + - $ref: '#/components/parameters/DedicatedVmHostIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The dedicated virtual machine host was retrieved. + 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/DedicatedVmHost' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetDedicatedVmHost + tags: + - compute + put: + description: | + Updates the displayName, freeformTags, and definedTags attributes for the specified dedicated virtual machine host. + If an attribute value is not included, it will not be updated. + operationId: UpdateDedicatedVmHost + parameters: + - $ref: '#/components/parameters/DedicatedVmHostIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateDedicatedVmHostDetails' + description: Update dedicated VM host details + required: true + responses: + '200': + description: The dedicated virtual machine host was updated. + 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/DedicatedVmHost' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateDedicatedVmHost + tags: + - compute + /dedicatedVmHosts/{dedicatedVmHostId}/actions/changeCompartment: + post: + description: Moves a dedicated virtual machine host from one compartment to another. + operationId: ChangeDedicatedVmHostCompartment + parameters: + - $ref: '#/components/parameters/DedicatedVmHostIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeDedicatedVmHostCompartmentDetails' + description: The request to move the dedicated virtual machine host to a different compartment. + required: true + responses: + '202': + description: Moves a dedicated vm host into a different compartment. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeDedicatedVmHostCompartment + tags: + - compute + x-related-resource: '#/definitions/DedicatedVmHost' + /dedicatedVmHosts/{dedicatedVmHostId}/instances: + get: + description: | + Returns the list of instances on the dedicated virtual machine hosts that match the specified criteria. + operationId: ListDedicatedVmHostInstances + parameters: + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/DedicatedVmHostIdPathParam' + - $ref: '#/components/parameters/IsMemoryEncryptionEnabledQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListDedicatedVmHostInstancesResponse' + application/x-json-stream: + schema: + items: + $ref: '#/components/schemas/DedicatedVmHostInstanceSummary' + type: array + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDedicatedVmHostInstances + tags: + - compute + /firmwareBundles: + get: + description: | + Gets a list of all Firmware Bundles in a compartment for specified platform. Can filter results to include + only the default (recommended) Firmware Bundle for the given platform. + operationId: ListFirmwareBundles + parameters: + - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' + - $ref: '#/components/parameters/DevicePlatformQueryParam' + - $ref: '#/components/parameters/DefaultBundleQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The list is being retrieved. + 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/FirmwareBundlesCollection' + '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/DefaultError' + summary: ListFirmwareBundles + tags: + - compute + x-related-resource: '#/definitions/FirmwareBundlesCollection' + /firmwareBundles/{firmwareBundleId}: + get: + description: | + Returns the Firmware Bundle matching the provided firmwareBundleId. + operationId: GetFirmwareBundle + parameters: + - $ref: '#/components/parameters/FirmwareBundleIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: A Firmware Bundle object. + 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/FirmwareBundle' + '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/DefaultError' + summary: GetFirmwareBundle + tags: + - compute + x-related-resource: '#/definitions/FirmwareBundle' + /images: + get: + description: | + Lists a subset of images available in the specified compartment, including + [platform images](/iaas/Content/Compute/References/images.htm) and + [custom images](/iaas/Content/Compute/Tasks/managingcustomimages.htm). + The list of platform images includes the three most recently published versions + of each major distribution. The list does not support filtering based on image tags. + + The list of images returned is ordered to first show the recent platform images, + then all of the custom images. + + **Caution:** Platform images are refreshed regularly. When new images are released, older versions are replaced. + The image OCIDs remain available, but when the platform image is replaced, the image OCIDs are no longer returned as part of the platform image list. + operationId: ListImages + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/OperatingSystemQueryParam' + - $ref: '#/components/parameters/OperatingSystemVersionQueryParam' + - $ref: '#/components/parameters/ShapeNameQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state + value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/Image/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListImagesResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListImages + tags: + - compute + x-obmcs-client-retries-enabled: true + post: + description: | + Creates a boot disk image for the specified instance or imports an exported image from the Oracle Cloud Infrastructure Object Storage service. + + When creating a new image, you must provide the OCID of the instance you want to use as the basis for the image, and + the OCID of the compartment containing that instance. For more information about images, + see [Managing Custom Images](/iaas/Content/Compute/Tasks/managingcustomimages.htm). + + When importing an exported image from Object Storage, you specify the source information + in [ImageSourceDetails](#/en/iaas/latest/requests/ImageSourceDetails). + + When importing an image based on the namespace, bucket name, and object name, + use [ImageSourceViaObjectStorageTupleDetails](#/en/iaas/latest/requests/ImageSourceViaObjectStorageTupleDetails). + + When importing an image based on the Object Storage URL, use + [ImageSourceViaObjectStorageUriDetails](#/en/iaas/latest/requests/ImageSourceViaObjectStorageUriDetails). + See [Object Storage URLs](/iaas/Content/Compute/Tasks/imageimportexport.htm#URLs) and [Using Pre-Authenticated Requests](/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm) + for constructing URLs for image import/export. + + For more information about importing exported images, see + [Image Import/Export](/iaas/Content/Compute/Tasks/imageimportexport.htm). + + You may optionally specify a *display name* for the image, which is simply a friendly name or description. + It does not have to be unique, and you can change it. See [UpdateImage](#/en/iaas/latest/Image/UpdateImage). + Avoid entering confidential information. + operationId: CreateImage + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateImageDetails' + description: Image creation details + required: true + responses: + '200': + description: The image is being created. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Image' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateImage + tags: + - compute + x-example: | + Example 1 request: Create new image for specified instance. + POST /20160918/images + { + "instanceId": "ocid1.instance.oc1.phx.<unique_ID>", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "MyCustomImage" + } + + Example 2 request: Import image using the namespace, bucket name, and object name. + POST /20160918/images + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "imageSourceDetails": { + "objectName": "image-to-import.oci", + "bucketName": "MyBucket", + "namespaceName": "MyNamespace", + "sourceType": "objectStorageTuple" + } + } + + Example 3 request: Import image using the Object Storage URL. + POST /20160918/images + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "MyImportedImage", + "imageSourceDetails": { + "sourceUri": "https://objectstorage.us-phoenix-1.oraclecloud.com/n/<MyNamespace>/b/<MyBucket>/o/<image-to-import>;.oci", + "sourceType": "objectStorageUri" + } + } + x-obmcs-client-retries-enabled: true + /images/{imageId}: + delete: + description: Deletes an image. + operationId: DeleteImage + parameters: + - $ref: '#/components/parameters/ImageIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The image is being 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteImage + tags: + - compute + get: + description: Gets the specified image. + operationId: GetImage + parameters: + - $ref: '#/components/parameters/ImageIdPathParam' + responses: + '200': + description: The image was retrieved. + 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/Image' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetImage + tags: + - compute + x-obmcs-client-retries-enabled: true + put: + description: | + Updates the display name of the image. Avoid entering confidential information. + operationId: UpdateImage + parameters: + - $ref: '#/components/parameters/ImageIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateImageDetails' + description: | + Updates the image display name field. Avoid entering confidential information. + required: true + responses: + '200': + description: The image name was updated. + 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/Image' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateImage + tags: + - compute + x-example: | + PUT /20160918/images/<image_OCID> + { + "displayName": "MyFavoriteImage" + } + /images/{imageId}/actions/changeCompartment: + post: + description: | + Moves an image into a different compartment within the same tenancy. For information about moving + resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeImageCompartment + parameters: + - $ref: '#/components/parameters/ImageIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeImageCompartmentDetails' + description: Request to change the compartment of a given image. + required: true + responses: + '204': + description: The Image Compartment Details is being changed. + 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 + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeImageCompartment + tags: + - compute + x-example: | + POST /20160918/images/<image_OCID>/actions/changeCompartment + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>" + } + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/Image' + /images/{imageId}/actions/export: + post: + description: | + Exports the specified image to the Oracle Cloud Infrastructure Object Storage service. You can use the Object Storage URL, + or the namespace, bucket name, and object name when specifying the location to export to. + + For more information about exporting images, see [Image Import/Export](/iaas/Content/Compute/Tasks/imageimportexport.htm). + + To perform an image export, you need write access to the Object Storage bucket for the image, + see [Let Users Write Objects to Object Storage Buckets](/iaas/Content/Identity/Concepts/commonpolicies.htm#Let4). + + See [Object Storage URLs](/iaas/Content/Compute/Tasks/imageimportexport.htm#URLs) and [Using Pre-Authenticated Requests](/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm) + for constructing URLs for image import/export. + operationId: ExportImage + parameters: + - $ref: '#/components/parameters/ImageIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExportImageDetails' + description: Details for the image export. + required: true + responses: + '200': + description: The export is being performed. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Image' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ExportImage + tags: + - compute + x-example: | + Example 1 request: Export image using the namespace, bucket name, and object name without export format + POST /20160918/images/<image_OCID>/actions/export + { + "objectName": "my-exported-image.oci", + "bucketName": "MyBucket", + "namespaceName": "MyNamespace", + "destinationType": "objectStorageTuple" + } + + Example 2 request: Export image using the namespace, bucket name, and object name with export format defined as "VMDK" + POST /20160918/images/<image_OCID>/actions/export + { + "objectName": "my-exported-image.vmdk", + "bucketName": "MyBucket", + "namespaceName": "MyNamespace", + "destinationType": "objectStorageTuple", + "exportFormat": "VMDK" + } + + + Example 3 request: Export image using the Object Storage URL with export format defined as "QCOW2" + POST /20160918/images/<image_OCID>/actions/export + { + "destinationUri": "https://objectstorage.us-phoenix-1.oraclecloud.com/n/<MyNamespace>/b/<MyBucket>/o/<exported-image>.qcow2", + "destinationType": "objectStorageUri", + "exportFormat": "QCOW2" + x-obmcs-client-retries-enabled: true + /images/{imageId}/shapes: + get: + description: Lists the compatible shapes for the specified image. + operationId: ListImageShapeCompatibilityEntries + parameters: + - $ref: '#/components/parameters/ImageIdPathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The list of compatible images and shapes. + 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/ListImageShapeCompatibilityEntriesResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListImageShapeCompatibilityEntries + tags: + - compute + x-example: | + ​GET /20160918/images/<image_OCID>/shapes + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/ImageShapeCompatibilityEntry' + /images/{imageId}/shapes/{shapeName}: + delete: + description: Removes a shape from the compatible shapes list for the image. + operationId: RemoveImageShapeCompatibilityEntry + parameters: + - $ref: '#/components/parameters/ImageIdPathParam' + - $ref: '#/components/parameters/ShapeNamePathParam' + responses: + '204': + description: The shape has been removed from the compatible shapes list. + 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: RemoveImageShapeCompatibilityEntry + tags: + - compute + x-related-resource: '#/definitions/ImageShapeCompatibilityEntry' + get: + description: Retrieves an image shape compatibility entry. + operationId: GetImageShapeCompatibilityEntry + parameters: + - $ref: '#/components/parameters/ImageIdPathParam' + - $ref: '#/components/parameters/ShapeNamePathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The image shape compatibility entry was retrieved. + 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/ImageShapeCompatibilityEntry' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetImageShapeCompatibilityEntry + tags: + - compute + x-obmcs-client-retries-enabled: true + put: + description: Adds a shape to the compatible shapes list for the image. + operationId: AddImageShapeCompatibilityEntry + parameters: + - $ref: '#/components/parameters/ImageIdPathParam' + - $ref: '#/components/parameters/ShapeNamePathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddImageShapeCompatibilityEntryDetails' + description: Image shape compatibility details + responses: + '200': + description: The shape has been added to the compatible shapes list. + 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/ImageShapeCompatibilityEntry' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: AddImageShapeCompatibilityEntry + tags: + - compute + /instanceConfigurations: + get: + description: | + Lists the instance configurations in the specified compartment. + operationId: ListInstanceConfigurations + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListInstanceConfigurationsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListInstanceConfigurations + tags: + - computeManagement + post: + description: | + Creates an instance configuration. An instance configuration is a template that defines the + settings to use when creating Compute instances. + operationId: CreateInstanceConfiguration + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateInstanceConfigurationBase' + description: Instance configuration creation details + required: true + responses: + '200': + description: The instance configuration. + 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/InstanceConfiguration' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateInstanceConfiguration + tags: + - computeManagement + x-example: | + Example 1: Create an instance configuration by providing a list of configuration settings + POST /20160918/instanceConfigurations + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "example-instance-configuration", + "source": "NONE", + "instanceDetails" : { + "instanceType": "compute", + "blockVolumes" : [ { + //Optional parameters for creating or attaching block volumes + } ], + "launchDetails" : { + "compartmentId":"ocid1.tenancy.oc1..<unique_ID>", + "shape":"VM.Standard2.1", + "sourceDetails": { + "sourceType": "image", + "imageId": "oci.image.oc1.phx.<unique_ID>" + }, + //Optional parameters for configuring settings such as + //the availability domain, primary VNIC, and instance metadata + }, + "secondaryVnics" : [ { + //Optional parameters for attaching secondary VNICs + } ] + } + } + + Example 2: Create an instance configuration using an existing instance as a template + POST /20160918/instanceConfigurations + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "example-instance-configuration", + "source": "INSTANCE", + "instanceId" : "ocid1.instance.oc1.phx.<unique_ID>" + } + /instanceConfigurations/{instanceConfigurationId}: + delete: + description: Deletes an instance configuration. + operationId: DeleteInstanceConfiguration + parameters: + - $ref: '#/components/parameters/InstanceConfigurationIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The instance configuration is being 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteInstanceConfiguration + tags: + - computeManagement + get: + description: Gets the specified instance configuration + operationId: GetInstanceConfiguration + parameters: + - $ref: '#/components/parameters/InstanceConfigurationIdPathParam' + responses: + '200': + description: The instance configuration was retrieved. + 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/InstanceConfiguration' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetInstanceConfiguration + tags: + - computeManagement + put: + description: Updates the free-form tags, defined tags, and display name of an instance configuration. + operationId: UpdateInstanceConfiguration + parameters: + - $ref: '#/components/parameters/InstanceConfigurationIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateInstanceConfigurationDetails' + description: Updates the freeFormTags, definedTags, and display name of an instance configuration. + required: true + responses: + '200': + description: The instance configuration was updated + 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/InstanceConfiguration' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateInstanceConfiguration + tags: + - computeManagement + /instanceConfigurations/{instanceConfigurationId}/actions/changeCompartment: + post: + description: | + Moves an instance configuration into a different compartment within the same tenancy. + For information about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + + When you move an instance configuration to a different compartment, associated resources such as + instance pools are not moved. + + **Important:** Most of the properties for an existing instance configuration, including the compartment, + cannot be modified after you create the instance configuration. Although you can move an instance configuration + to a different compartment, you will not be able to use the instance configuration to manage instance pools + in the new compartment. If you want to update an instance configuration to point to a different compartment, + you should instead create a new instance configuration in the target compartment using + [CreateInstanceConfiguration](/iaas/api/#/en/iaas/20160918/InstanceConfiguration/CreateInstanceConfiguration). + operationId: ChangeInstanceConfigurationCompartment + parameters: + - $ref: '#/components/parameters/InstanceConfigurationIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeInstanceConfigurationCompartmentDetails' + description: Request to change the compartment of given instance configuration. + required: true + responses: + '204': + description: The Instance Configuration Compartment Details is getting changed + 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 + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeInstanceConfigurationCompartment + tags: + - computeManagement + x-example: | + POST /20160918/instanceConfigurations/<instance_configuration_OCID>/actions/changeCompartment + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>" + } + x-related-resource: '#/definitions/InstanceConfiguration' + /instanceConfigurations/{instanceConfigurationId}/actions/launch: + post: + description: | + Creates an instance from an instance configuration. + + If the instance configuration does not include all of the parameters that are + required to create an instance, such as the availability domain and subnet ID, you must + provide these parameters when you create an instance from the instance configuration. + For more information, see the [InstanceConfiguration](#/en/iaas/latest/InstanceConfiguration/) + resource. + + To determine whether capacity is available for a specific shape before you create an instance, + use the [CreateComputeCapacityReport](#/en/iaas/latest/ComputeCapacityReport/CreateComputeCapacityReport) + operation. + operationId: LaunchInstanceConfiguration + parameters: + - $ref: '#/components/parameters/InstanceConfigurationIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OpcComputeClusterIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceConfigurationInstanceDetails' + description: Instance configuration Instance Details + required: true + responses: + '200': + description: The instance that was launched. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: LaunchInstanceConfiguration + tags: + - computeManagement + x-example: | + POST /20160918/instanceConfigurations/<instance_configuration_OCID>/actions/launch + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "instanceType" : "compute", + "blockVolumes" : [ { + //Optional parameters for creating or attaching block volumes + } ], + "launchDetails" : { + //Parameters for configuring settings such as + //the availability domain, primary VNIC, and instance metadata. + //If the instance configuration does not include all of the parameters + //that are required to create an instance, you must provide the + //required parameters here. Get a list of required parameters from the + //deferred fields attribute of the instance configuration. + }, + "secondaryVnics" : [ { + //Optional parameters for attaching secondary VNICs + } ] + } + /instanceConsoleConnections: + get: + description: | + Lists the console connections for the specified compartment or instance. + + For more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](/iaas/Content/Compute/References/serialconsole.htm). + operationId: ListInstanceConsoleConnections + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/InstanceIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListInstanceConsoleConnectionsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListInstanceConsoleConnections + tags: + - compute + x-example: | + GET /20160918/instanceConsoleConnections?compartmentId=ocid1.compartment.oc1..<unique_ID> + post: + description: | + Creates a new console connection to the specified instance. + After the console connection has been created and is available, + you connect to the console using SSH. + + For more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](/iaas/Content/Compute/References/serialconsole.htm). + operationId: CreateInstanceConsoleConnection + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateInstanceConsoleConnectionDetails' + description: Request object for creating an InstanceConsoleConnection + required: true + responses: + '200': + description: The instance console connection is being configured. + 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/InstanceConsoleConnection' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateInstanceConsoleConnection + tags: + - compute + x-example: | + POST /20160918/instanceConsoleConnections + { + "instanceId":"ocid1.instance.oc1.phx.<unique_ID>", + "publicKey":"ssh-rsa <your_public_SSH_key>== rsa-key-20160227" + } + /instanceConsoleConnections/{instanceConsoleConnectionId}: + delete: + description: Deletes the specified instance console connection. + operationId: DeleteInstanceConsoleConnection + parameters: + - $ref: '#/components/parameters/InstanceConsoleConnectionIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The instance console connection is being 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 + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteInstanceConsoleConnection + tags: + - compute + x-example: | + DELETE /20160918/instanceConsoleConnections/ocid1.instanceconsoleconnection.iad.<unique_ID> + x-related-resource: '#/definitions/InstanceConsoleConnection' + get: + description: Gets the specified instance console connection's information. + operationId: GetInstanceConsoleConnection + parameters: + - $ref: '#/components/parameters/InstanceConsoleConnectionIdPathParam' + responses: + '200': + description: The instance console connection was retrieved. + 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/InstanceConsoleConnection' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetInstanceConsoleConnection + tags: + - compute + x-example: | + GET /20160918/instanceConsoleConnections/ocid1.instanceconsoleconnection.iad.<unique_ID> + put: + description: Updates the defined tags and free-form tags for the specified instance console connection. + operationId: UpdateInstanceConsoleConnection + parameters: + - $ref: '#/components/parameters/InstanceConsoleConnectionIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateInstanceConsoleConnectionDetails' + description: Update instanceConsoleConnection tags + required: true + responses: + '200': + description: The instance console connection was updated. + 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/InstanceConsoleConnection' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateInstanceConsoleConnection + tags: + - compute + x-example: | + PUT /20160918/instanceConsoleConnections/ocid1.instanceconsoleconnection.iad.<unique_ID> + /instanceConsoleHistories/: + get: + description: | + Lists the console history metadata for the specified compartment or instance. + operationId: ListConsoleHistories + parameters: + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/InstanceIdQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state + value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/ConsoleHistory/lifecycleState' + schema: + type: string + responses: + '200': + description: The metadata is being retrieved. + 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/ListConsoleHistoriesResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListConsoleHistories + tags: + - compute + post: + description: | + Captures the most recent serial console data (up to a megabyte) for the + specified instance. + + The `CaptureConsoleHistory` operation works with the other console history operations + as described below. + + 1. Use `CaptureConsoleHistory` to request the capture of up to a megabyte of the + most recent console history. This call returns a `ConsoleHistory` + object. The object will have a state of REQUESTED. + 2. Wait for the capture operation to succeed by polling `GetConsoleHistory` with + the identifier of the console history metadata. The state of the + `ConsoleHistory` object will go from REQUESTED to GETTING-HISTORY and + then SUCCEEDED (or FAILED). + 3. Use `GetConsoleHistoryContent` to get the actual console history data (not the + metadata). + 4. Optionally, use `DeleteConsoleHistory` to delete the console history metadata + and the console history data. + operationId: CaptureConsoleHistory + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CaptureConsoleHistoryDetails' + description: Console history details + required: true + responses: + '200': + description: The console history is being captured. + 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/ConsoleHistory' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CaptureConsoleHistory + tags: + - compute + /instanceConsoleHistories/{instanceConsoleHistoryId}: + delete: + description: | + Deletes the specified console history metadata and the console history data. + operationId: DeleteConsoleHistory + parameters: + - $ref: '#/components/parameters/InstanceConsoleHistoryIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The information is being 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteConsoleHistory + tags: + - compute + x-related-resource: '#/definitions/ConsoleHistory' + get: + description: | + Shows the metadata for the specified console history. + See [CaptureConsoleHistory](#/en/iaas/latest/ConsoleHistory/CaptureConsoleHistory) + for details about using the console history operations. + operationId: GetConsoleHistory + parameters: + - $ref: '#/components/parameters/InstanceConsoleHistoryIdPathParam' + responses: + '200': + description: Console history metadata + 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/ConsoleHistory' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetConsoleHistory + tags: + - compute + put: + description: Updates the specified console history metadata. + operationId: UpdateConsoleHistory + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/InstanceConsoleHistoryIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateConsoleHistoryDetails' + description: Update instance fields + required: true + responses: + '200': + description: The request was accepted by the server + 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/ConsoleHistory' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateConsoleHistory + tags: + - compute + /instanceConsoleHistories/{instanceConsoleHistoryId}/data: + get: + description: | + Gets the actual console history data (not the metadata). + See [CaptureConsoleHistory](#/en/iaas/latest/ConsoleHistory/CaptureConsoleHistory) + for details about using the console history operations. + operationId: GetConsoleHistoryContent + parameters: + - $ref: '#/components/parameters/InstanceConsoleHistoryIdPathParam' + - description: Offset of the snapshot data to retrieve. + in: query + name: offset + schema: + type: integer + format: int32 + minimum: 0 + - description: Length of the snapshot data to retrieve. + in: query + name: length + schema: + type: integer + format: int32 + minimum: 10240 + responses: + '200': + description: The information is being retrieved. + headers: + opc-bytes-remaining: + description: The number of bytes remaining in the snapshot. + schema: + type: integer + format: int32 + 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: + type: string + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetConsoleHistoryContent + tags: + - compute + x-related-resource: '#/definitions/ConsoleHistory' + /instanceMaintenanceEvents: + get: + description: | + Gets a list of all the maintenance events for the given compartment. + operationId: ListInstanceMaintenanceEvents + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/InstanceIdQueryParam' + - $ref: '#/components/parameters/InstanceMaintenanceEventLifecycleStateQueryParam' + - $ref: '#/components/parameters/InstanceMaintenanceEventCorrelationTokenQueryParam' + - $ref: '#/components/parameters/InstanceMaintenanceEventInstanceActionQueryParam' + - $ref: '#/components/parameters/TimeWindowStartGreaterThanOrEqualToQueryParam' + - $ref: '#/components/parameters/TimeWindowStartLessThanOrEqualToQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: List of maintenance events. + 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/ListInstanceMaintenanceEventsResponse' + '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/DefaultError' + summary: ListInstanceMaintenanceEvents + tags: + - compute + /instanceMaintenanceEvents/{instanceMaintenanceEventId}: + get: + description: | + Gets the maintenance event for the given instance. + operationId: GetInstanceMaintenanceEvent + parameters: + - $ref: '#/components/parameters/MaintenanceIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: Maintenance event of an instance. + 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/InstanceMaintenanceEvent' + '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/DefaultError' + summary: GetInstanceMaintenanceEvent + tags: + - compute + put: + description: | + Updates the maintenance event for the given instance. + operationId: UpdateInstanceMaintenanceEvent + parameters: + - $ref: '#/components/parameters/MaintenanceIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateInstanceMaintenanceEventDetails' + description: Update instance maintenance event due date. + required: true + responses: + '202': + description: Updating the InstanceMaintenanceEvent will be completed asynchronously. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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/DefaultError' + summary: UpdateInstanceMaintenanceEvent + tags: + - compute + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/InstanceMaintenanceEvent' + /instancePools: + get: + description: Lists the instance pools in the specified compartment. + operationId: ListInstancePools + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state + value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/InstancePoolSummary/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved + 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/ListInstancePoolsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListInstancePools + tags: + - computeManagement + post: + description: | + Creates an instance pool. + + To determine whether capacity is available for a specific shape before you create an instance pool, + use the [CreateComputeCapacityReport](#/en/iaas/latest/ComputeCapacityReport/CreateComputeCapacityReport) + operation. + operationId: CreateInstancePool + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateInstancePoolDetails' + description: Instance pool creation details + required: true + responses: + '200': + description: The instance pool. + 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/InstancePool' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateInstancePool + tags: + - computeManagement + x-example: | + Example 1: Create an instance pool with a regional subnet (recommended) and an attached + load balancer (optional) + POST /20160918/instancePools + { + "displayName": "autoscaling-instance-pool", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "instanceConfigurationId": "ocid1.instanceconfiguration.oc1..<unique_ID>", + "size": 15, + "placementConfigurations": [ + { + "availabilityDomain": "Uocm:PHX-AD-1", + "primarySubnetId": "ocid1.subnet.oc1..<regional_subnet_unique_ID>" + }, + { + "availabilityDomain": "Uocm:PHX-AD-2", + "primarySubnetId": "ocid1.subnet.oc1..<regional_subnet_unique_ID>" + }, + { + "availabilityDomain": "Uocm:PHX-AD-3", + "primarySubnetId": "ocid1.subnet.oc1..<regional_subnet_unique_ID>" + } + ], + "loadBalancers": [ + { + "loadBalancerId": "ocid1.loadbalancer.oc1.phx..<unique_ID>", + "backendSetName": "lb-20190410-1147-backend-set", + "port": 80, + "vnicSelection": "PrimaryVnic" + } + ] + } + + Example 2: Create an instance pool with AD-specific subnets + POST /20160918/instancePools + { + "displayName": "backend-servers-pool", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "instanceConfigurationId": "ocid1.instanceconfiguration.oc1..<unique_ID>", + "size": 10, + "placementConfigurations": [ + { + "availabilityDomain": "Uocm:PHX-AD-1", + "primarySubnetId": "ocid1.subnet.oc1..<unique_ID_1>" + }, + { + "availabilityDomain": "Uocm:PHX-AD-2", + "primarySubnetId": "ocid1.subnet.oc1..<unique_ID_2>" + } + ] + } + + Example 3: Create an instance pool with instances balanced evenly across the + specified fault domains + POST /20160918/instancePools + { + "displayName": "high-availability-pool", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "instanceConfigurationId": "ocid1.instanceconfiguration.oc1..<unique_ID>", + "size": 20, + "placementConfigurations": [ + { + "availabilityDomain": "sOZD:AP-TOKYO-1-AD-1", + "faultDomains": ["FAULT-DOMAIN-1", "FAULT-DOMAIN-2"] + "primarySubnetId": "ocid1.subnet.oc1..<unique_ID_1>", + } + ] + } + /instancePools/{instancePoolId}: + delete: + description: | + Terminate the specified instance pool. + + **Warning:** When you delete an instance pool, the resources that were created by the pool are permanently + deleted, including associated instances, attached boot volumes, and block volumes. + + If an autoscaling configuration applies to the instance pool, the autoscaling configuration will be deleted + asynchronously after the pool is deleted. You can also manually delete the autoscaling configuration using + the `DeleteAutoScalingConfiguration` operation in the Autoscaling API. + operationId: TerminateInstancePool + parameters: + - $ref: '#/components/parameters/InstancePoolIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The instance pool is being terminated. + 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: TerminateInstancePool + tags: + - computeManagement + get: + description: Gets the specified instance pool + operationId: GetInstancePool + parameters: + - $ref: '#/components/parameters/InstancePoolIdPathParam' + responses: + '200': + description: The instance pool was retrieved. + 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/InstancePool' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetInstancePool + tags: + - computeManagement + put: + description: | + Update the specified instance pool. + + The OCID of the instance pool remains the same. + operationId: UpdateInstancePool + parameters: + - $ref: '#/components/parameters/InstancePoolIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateInstancePoolDetails' + description: Update instance pool configuration + required: true + responses: + '200': + description: The instance pool was updated. + 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/InstancePool' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateInstancePool + tags: + - computeManagement + /instancePools/{instancePoolId}/actions/attachLoadBalancer: + post: + description: | + Attach a load balancer to the instance pool. + operationId: AttachLoadBalancer + parameters: + - $ref: '#/components/parameters/InstancePoolIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AttachLoadBalancerDetails' + description: Load balancer being attached + required: true + responses: + '200': + description: The load balancer is being attached. + 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/InstancePool' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: AttachLoadBalancer + tags: + - computeManagement + /instancePools/{instancePoolId}/actions/changeCompartment: + post: + description: | + Moves an instance pool into a different compartment within the same tenancy. For + information about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + + When you move an instance pool to a different compartment, associated resources such as the instances in + the pool, boot volumes, VNICs, and autoscaling configurations are not moved. + operationId: ChangeInstancePoolCompartment + parameters: + - $ref: '#/components/parameters/InstancePoolIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeInstancePoolCompartmentDetails' + description: Request to change the compartment of given instance pool. + required: true + responses: + '204': + description: The Instance Pool Compartment Details is being changed. + 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 + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeInstancePoolCompartment + tags: + - computeManagement + x-example: | + POST /20160918/instancePools/<instance_pool_OCID>/actions/changeCompartment + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>" + } + x-related-resource: '#/definitions/InstancePool' + /instancePools/{instancePoolId}/actions/detachInstance: + post: + description: | + Detaches an instance from an instance pool. + operationId: DetachInstancePoolInstance + parameters: + - $ref: '#/components/parameters/InstancePoolIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DetachInstancePoolInstanceDetails' + description: Instance being detached + required: true + responses: + '202': + description: | + The instance is being detached from the pool. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DetachInstancePoolInstance + tags: + - computeManagement + x-related-resource: '#/definitions/InstancePoolInstance' + /instancePools/{instancePoolId}/actions/detachLoadBalancer: + post: + description: | + Detach a load balancer from the instance pool. + operationId: DetachLoadBalancer + parameters: + - $ref: '#/components/parameters/InstancePoolIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DetachLoadBalancerDetails' + description: Load balancer being detached + required: true + responses: + '200': + description: The load balancer is being detached. + 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/InstancePool' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DetachLoadBalancer + tags: + - computeManagement + /instancePools/{instancePoolId}/actions/reset: + post: + description: | + Performs the reset (immediate power off and power on) action on the specified instance pool, + which performs the action on all the instances in the pool. + operationId: ResetInstancePool + parameters: + - $ref: '#/components/parameters/InstancePoolIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '200': + description: The action is being performed. + 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/InstancePool' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ResetInstancePool + tags: + - computeManagement + x-related-resource: '#/definitions/InstancePool' + /instancePools/{instancePoolId}/actions/softreset: + post: + description: | + Performs the softreset (ACPI shutdown and power on) action on the specified instance pool, + which performs the action on all the instances in the pool. + + Softreset gracefully reboots the instances by sending a shutdown command to the operating systems. + After waiting 15 minutes for the OS to shut down, the instances are powered off and then powered back on. + operationId: SoftresetInstancePool + parameters: + - $ref: '#/components/parameters/InstancePoolIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '200': + description: The action is being performed. + 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/InstancePool' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: SoftresetInstancePool + tags: + - computeManagement + x-related-resource: '#/definitions/InstancePool' + /instancePools/{instancePoolId}/actions/softstop: + post: + description: | + Performs the softstop (ACPI shutdown and power on) action on the specified instance pool, + which performs the action on all the instances in the pool. + + Softstop gracefully reboots the instances by sending a shutdown command to the operating systems. + After waiting 15 minutes for the OS to shutdown, the instances are powered off and then powered back on. + operationId: SoftstopInstancePool + parameters: + - $ref: '#/components/parameters/InstancePoolIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '200': + description: The action is being performed. + 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/InstancePool' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: SoftstopInstancePool + tags: + - computeManagement + x-related-resource: '#/definitions/InstancePool' + /instancePools/{instancePoolId}/actions/start: + post: + description: | + Performs the start (power on) action on the specified instance pool, + which performs the action on all the instances in the pool. + operationId: StartInstancePool + parameters: + - $ref: '#/components/parameters/InstancePoolIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '200': + description: The action is being performed. + 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/InstancePool' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: StartInstancePool + tags: + - computeManagement + x-related-resource: '#/definitions/InstancePool' + /instancePools/{instancePoolId}/actions/stop: + post: + description: | + Performs the stop (immediate power off) action on the specified instance pool, + which performs the action on all the instances in the pool. + operationId: StopInstancePool + parameters: + - $ref: '#/components/parameters/InstancePoolIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '200': + description: The action is being performed. + 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/InstancePool' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: StopInstancePool + tags: + - computeManagement + x-related-resource: '#/definitions/InstancePool' + /instancePools/{instancePoolId}/actions/terminationProceed: + post: + description: | + Marks an instance in an instance pool to be ready for termination. + operationId: TerminationProceedInstancePoolInstance + parameters: + - $ref: '#/components/parameters/InstancePoolIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TerminationProceedInstancePoolInstanceDetails' + description: Instance to be marked for terminating. + required: true + responses: + '202': + description: | + The instance is marked for termination. + 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 + '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/DefaultError' + summary: TerminationProceedInstancePoolInstance + tags: + - computeManagement + x-related-resource: '#/definitions/InstancePoolInstance' + /instancePools/{instancePoolId}/instances: + get: + description: List the instances in the specified instance pool. + operationId: ListInstancePoolInstances + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/InstancePoolIdPathParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The list is being retrieved + 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/ListInstancePoolInstancesResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListInstancePoolInstances + tags: + - computeManagement + post: + description: | + Attaches an instance to an instance pool. For information about the prerequisites + that an instance must meet before you can attach it to a pool, see + [Attaching an Instance to an Instance Pool](/iaas/Content/Compute/Tasks/updatinginstancepool.htm#attach-instance). + operationId: AttachInstancePoolInstance + parameters: + - $ref: '#/components/parameters/InstancePoolIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AttachInstancePoolInstanceDetails' + description: Attach an instance to a pool + required: true + responses: + '201': + description: | + The instance is being attached to the pool. + headers: + etag: + description: | + For optimistic concurrency control. See `if-match`. + schema: + type: string + location: + description: | + Location of the resource. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/InstancePoolInstance' + '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/DefaultError' + summary: AttachInstancePoolInstance + tags: + - computeManagement + /instancePools/{instancePoolId}/instances/{instanceId}: + get: + description: Gets information about an instance that belongs to an instance pool. + operationId: GetInstancePoolInstance + parameters: + - $ref: '#/components/parameters/InstancePoolIdPathParam' + - $ref: '#/components/parameters/InstanceIdPathParam' + responses: + '200': + description: The instance was retrieved. + 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/InstancePoolInstance' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetInstancePoolInstance + tags: + - computeManagement + /instancePools/{instancePoolId}/loadBalancerAttachments/{instancePoolLoadBalancerAttachmentId}: + get: + description: | + Gets information about a load balancer that is attached to the specified instance pool. + operationId: GetInstancePoolLoadBalancerAttachment + parameters: + - $ref: '#/components/parameters/InstancePoolIdPathParam' + - $ref: '#/components/parameters/InstancePoolLoadBalancerAttachmentIdPathParam' + responses: + '200': + description: The load balancer attached to the instance pool was retrieved. + 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/InstancePoolLoadBalancerAttachment' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetLoadBalancerAttachment + tags: + - computeManagement + /instances/: + get: + description: | + Lists the instances in the specified compartment and the specified availability domain. + You can filter the results by specifying an instance name (the list will include all the identically-named + instances in the compartment). + + **Note:** To retrieve public and private IP addresses for an instance, use the [ListVnicAttachments](#/en/iaas/latest/VnicAttachment/ListVnicAttachments) + operation to get the VNIC ID for the instance, and then call [GetVnic](#/en/iaas/latest/Vnic/GetVnic) with the VNIC ID. + operationId: ListInstances + parameters: + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/ComputeCapacityReservationIdQueryParam' + - $ref: '#/components/parameters/ComputeClusterIdQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state + value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/Instance/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListInstancesResponse' + application/x-json-stream: + schema: + items: + $ref: '#/components/schemas/Instance' + type: array + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListInstances + tags: + - compute + post: + description: | + Creates a new instance in the specified compartment and the specified availability domain. + For general information about instances, see + [Overview of the Compute Service](/iaas/Content/Compute/Concepts/computeoverview.htm). + + For information about access control and compartments, see + [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). + + For information about availability domains, see + [Regions and Availability Domains](/iaas/Content/General/Concepts/regions.htm). + To get a list of availability domains, use the `ListAvailabilityDomains` operation + in the Identity and Access Management Service API. + + All Oracle Cloud Infrastructure resources, including instances, get an Oracle-assigned, + unique ID called an Oracle Cloud Identifier (OCID). + When you create a resource, you can find its OCID in the response. You can + also retrieve a resource's OCID by using a List API operation + on that resource type, or by viewing the resource in the Console. + + To launch an instance using an image or a boot volume use the `sourceDetails` parameter in [LaunchInstanceDetails](#/en/iaas/latest/LaunchInstanceDetails). + + When you launch an instance, it is automatically attached to a virtual + network interface card (VNIC), called the *primary VNIC*. The VNIC + has a private IP address from the subnet's CIDR. You can either assign a + private IP address of your choice or let Oracle automatically assign one. + You can choose whether the instance has a public IP address. To retrieve the + addresses, use the [ListVnicAttachments](#/en/iaas/latest/VnicAttachment/ListVnicAttachments) + operation to get the VNIC ID for the instance, and then call + [GetVnic](#/en/iaas/latest/Vnic/GetVnic) with the VNIC ID. + + You can later add secondary VNICs to an instance. For more information, see + [Virtual Network Interface Cards (VNICs)](/iaas/Content/Network/Tasks/managingVNICs.htm). + + To launch an instance from a Marketplace image listing, you must provide the image ID of the + listing resource version that you want, but you also must subscribe to the listing before you try + to launch the instance. To subscribe to the listing, use the [GetAppCatalogListingAgreements](#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) + operation to get the signature for the terms of use agreement for the desired listing resource version. + Then, call [CreateAppCatalogSubscription](#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) + with the signature. To get the image ID for the LaunchInstance operation, call + [GetAppCatalogListingResourceVersion](#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion). + + When launching an instance, you may provide the `securityAttributes` parameter in + [LaunchInstanceDetails](#/en/iaas/latest/LaunchInstanceDetails) to manage security attributes via the instance, + or in the embedded [CreateVnicDetails](#/en/iaas/latest/CreateVnicDetails/) to manage security attributes + via the VNIC directly, but not both. Providing `securityAttributes` in both locations will return a + 400 Bad Request response. + + To determine whether capacity is available for a specific shape before you create an instance, + use the [CreateComputeCapacityReport](#/en/iaas/latest/ComputeCapacityReport/CreateComputeCapacityReport) + operation. + operationId: LaunchInstance + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LaunchInstanceDetails' + description: Instance details + required: true + responses: + '200': + description: The instance is being launched. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: LaunchInstance + tags: + - compute + /instances/{instanceId}: + delete: + description: | + Permanently terminates (deletes) the specified instance. Any attached VNICs and volumes are automatically detached + when the instance terminates. + + To preserve the boot volume associated with the instance, specify `true` for `PreserveBootVolumeQueryParam`. + To delete the boot volume when the instance is deleted, specify `false` or do not specify a value for `PreserveBootVolumeQueryParam`. + + To preserve data volumes created with the instance, specify `true` or do not specify a value for `PreserveDataVolumesQueryParam`. + To delete the data volumes when the instance itself is deleted, specify `false` for `PreserveDataVolumesQueryParam`. + + This is an asynchronous operation. The instance's `lifecycleState` changes to TERMINATING temporarily + until the instance is completely deleted. After the instance is deleted, the record remains visible in the list of instances + with the state TERMINATED for at least 12 hours, but no further action is needed. + operationId: TerminateInstance + parameters: + - $ref: '#/components/parameters/InstanceIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/PreserveBootVolumeQueryParam' + - $ref: '#/components/parameters/PreserveDataVolumesQueryParam' + - $ref: '#/components/parameters/RecycleLevelQueryParam' + responses: + '204': + description: The instance is being terminated. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: TerminateInstance + tags: + - compute + get: + description: | + Gets information about the specified instance. + + **Note:** To retrieve public and private IP addresses for an instance, use the [ListVnicAttachments](#/en/iaas/latest/VnicAttachment/ListVnicAttachments) + operation to get the VNIC ID for the instance, and then call [GetVnic](#/en/iaas/latest/Vnic/GetVnic) with the VNIC ID. + operationId: GetInstance + parameters: + - $ref: '#/components/parameters/InstanceIdPathParam' + responses: + '200': + description: The instance was retrieved. + 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/Instance' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetInstance + tags: + - compute + post: + description: | + Performs one of the following power actions on the specified instance: + + - **START** - Powers on the instance. + + - **STOP** - Powers off the instance. + + - **RESET** - Powers off the instance and then powers it back on. + + - **SOFTSTOP** - Gracefully shuts down the instance by sending a shutdown command to the operating system. + After waiting 15 minutes for the OS to shut down, the instance is powered off. + If the applications that run on the instance take more than 15 minutes to shut down, they could be improperly stopped, resulting + in data corruption. To avoid this, manually shut down the instance using the commands available in the OS before you softstop the + instance. + + - **SOFTRESET** - Gracefully reboots the instance by sending a shutdown command to the operating system. + After waiting 15 minutes for the OS to shut down, the instance is powered off and + then powered back on. + + + - **SENDDIAGNOSTICINTERRUPT** - For advanced users. **Caution: Sending a diagnostic interrupt to a live system can + cause data corruption or system failure.** Sends a diagnostic interrupt that causes the instance's + OS to crash and then reboot. Before you send a diagnostic interrupt, you must configure the instance to generate a + crash dump file when it crashes. The crash dump captures information about the state of the OS at the time of + the crash. After the OS restarts, you can analyze the crash dump to diagnose the issue. For more information, see + [Sending a Diagnostic Interrupt](/iaas/Content/Compute/Tasks/sendingdiagnosticinterrupt.htm). + + + + - **DIAGNOSTICREBOOT** - Powers off the instance, rebuilds it, and then powers it back on. + Before you send a diagnostic reboot, restart the instance's OS, confirm that the instance and networking settings are configured + correctly, and try other [troubleshooting steps](/iaas/Content/Compute/References/troubleshooting-compute-instances.htm). + Use diagnostic reboot as a final attempt to troubleshoot an unreachable instance. For virtual machine (VM) instances only. + For more information, see [Performing a Diagnostic Reboot](/iaas/Content/Compute/Tasks/diagnostic-reboot.htm). + + + - **REBOOTMIGRATE** - Powers off the instance, moves it to new hardware, and then powers it back on. For more information, see + [Infrastructure Maintenance](/iaas/Content/Compute/References/infrastructure-maintenance.htm). + + + For more information about managing instance lifecycle states, see + [Stopping and Starting an Instance](/iaas/Content/Compute/Tasks/restartinginstance.htm). + operationId: InstanceAction + parameters: + - $ref: '#/components/parameters/InstanceIdPathParam' + - $ref: '#/components/parameters/InstanceActionQueryParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '200': + description: The action is being performed. + 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/Instance' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: InstanceAction + tags: + - compute + put: + description: | + Updates certain fields on the specified instance. Fields that are not provided in the + request will not be updated. Avoid entering confidential information. + + Changes to metadata fields will be reflected in the instance metadata service (this may take + up to a minute). + + The OCID of the instance remains the same. + operationId: UpdateInstance + parameters: + - $ref: '#/components/parameters/InstanceIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateInstanceDetails' + description: Update instance fields + required: true + responses: + '200': + description: The instance was updated. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateInstance + tags: + - compute + /instances/{instanceId}/actions/acceptShieldedIntegrityPolicy: + post: + description: Accept the changes to the PCR values in the measured boot report. + operationId: AcceptShieldedIntegrityPolicy + parameters: + - $ref: '#/components/parameters/InstanceIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '202': + description: The PCR values in the measured boot report have been 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: AcceptShieldedIntegrityPolicy + tags: + - compute + x-related-resource: '#/definitions/MeasuredBootReport' + /instances/{instanceId}/actions/changeCompartment: + post: + description: | + Moves an instance into a different compartment within the same tenancy. For information about + moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + + When you move an instance to a different compartment, associated resources such as boot volumes and VNICs + are not moved. + operationId: ChangeInstanceCompartment + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/InstanceIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeInstanceCompartmentDetails' + description: Request to change the compartment of a given instance. + required: true + responses: + '202': + description: The instance is being moved. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeInstanceCompartment + tags: + - compute + x-example: | + POST /20160918/instances/<instance_OCID>/actions/changeCompartment + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>" + } + x-related-resource: '#/definitions/Instance' + /instances/{instanceId}/defaultCredentials: + get: + description: | + Gets the generated credentials for the instance. Only works for instances that require a password to log in, such as Windows. + For certain operating systems, users will be forced to change the initial credentials. + operationId: GetInstanceDefaultCredentials + parameters: + - $ref: '#/components/parameters/InstanceIdPathParam' + responses: + '200': + description: The credentials were retrieved. + 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/InstanceCredentials' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetInstanceDefaultCredentials + tags: + - compute + /instances/{instanceId}/devices: + get: + description: Gets a list of all the devices for given instance. You can optionally filter results by device availability. + operationId: ListInstanceDevices + parameters: + - $ref: '#/components/parameters/FilterByDeviceAvailabilityQueryParam' + - $ref: '#/components/parameters/FilterByDeviceNameQueryParam' + - $ref: '#/components/parameters/InstanceIdPathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: List of devices + 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/ListInstanceDevicesResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListInstanceDevices + tags: + - compute + /instances/{instanceId}/initialCredentials: + get: + deprecated: true + description: | + Deprecated. Use [GetInstanceDefaultCredentials](#/en/iaas/latest/InstanceCredentials/GetInstanceDefaultCredentials) instead. + + Gets the generated credentials for the instance. Only works for instances that require a password to log in, such as Windows. + For certain operating systems, users will be forced to change the initial credentials. + operationId: GetWindowsInstanceInitialCredentials + parameters: + - $ref: '#/components/parameters/InstanceIdPathParam' + responses: + '200': + description: The credentials were retrieved. + 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/InstanceCredentials' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetWindowsInstanceInitialCredentials + tags: + - compute + /instances/{instanceId}/maintenanceReboot: + get: + description: | + Gets the maximum possible date that a maintenance reboot can be extended. For more information, see + [Infrastructure Maintenance](/iaas/Content/Compute/References/infrastructure-maintenance.htm). + operationId: GetInstanceMaintenanceReboot + parameters: + - $ref: '#/components/parameters/InstanceIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The maximum extension date for the maintenance reboot was retrieved. + 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/InstanceMaintenanceReboot' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetInstanceMaintenanceReboot + tags: + - compute + /instances/{instanceId}/measuredBootReport: + get: + description: Gets the measured boot report for this shielded instance. + operationId: GetMeasuredBootReport + parameters: + - $ref: '#/components/parameters/InstanceIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The measured boot report was retrieved. + 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/MeasuredBootReport' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetMeasuredBootReport + tags: + - compute + /shapes: + get: + description: | + Lists the shapes that can be used to launch an instance within the specified compartment. You can + filter the list by compatibility with a specific image. + operationId: ListShapes + parameters: + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/ImageIdQueryParam' + - $ref: '#/components/parameters/ShapeNameQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListShapesResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListShapes + tags: + - compute + /vnicAttachments/: + get: + description: | + Lists the VNIC attachments in the specified compartment. A VNIC attachment + resides in the same compartment as the attached instance. The list can be + filtered by instance, VNIC, or availability domain. + operationId: ListVnicAttachments + parameters: + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/InstanceIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/VnicIdOptionalQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListVnicAttachmentsResponse' + application/x-json-stream: + schema: + items: + $ref: '#/components/schemas/VnicAttachment' + type: array + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListVnicAttachments + tags: + - compute + post: + description: | + Creates a secondary VNIC and attaches it to the specified instance. + For more information about secondary VNICs, see + [Virtual Network Interface Cards (VNICs)](/iaas/Content/Network/Tasks/managingVNICs.htm). + operationId: AttachVnic + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AttachVnicDetails' + description: Attach VNIC details. + required: true + responses: + '200': + description: The VNIC is being attached. + 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/VnicAttachment' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: AttachVnic + tags: + - compute + /vnicAttachments/{vnicAttachmentId}: + delete: + description: | + Detaches and deletes the specified secondary VNIC. + This operation cannot be used on the instance's primary VNIC. + When you terminate an instance, all attached VNICs (primary + and secondary) are automatically detached and deleted. + + **Important:** If the VNIC has a + [private IP](#/en/iaas/latest/PrivateIp/) that is the + [target of a route rule](/iaas/Content/Network/Tasks/managingroutetables.htm#privateip), + deleting the VNIC causes that route rule to blackhole and the traffic + will be dropped. + operationId: DetachVnic + parameters: + - $ref: '#/components/parameters/VnicAttachmentIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The VNIC is being detached. + 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DetachVnic + tags: + - compute + x-related-resource: '#/definitions/VnicAttachment' + get: + description: | + Gets the information for the specified VNIC attachment. + operationId: GetVnicAttachment + parameters: + - $ref: '#/components/parameters/VnicAttachmentIdPathParam' + responses: + '200': + description: The VNIC attachment was retrieved. + 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/VnicAttachment' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetVnicAttachment + tags: + - compute + /volumeAttachments/: + get: + description: | + Lists the volume attachments in the specified compartment. You can filter the + list by specifying an instance OCID, volume OCID, or both. + + Currently, the only supported volume attachment type are [IScsiVolumeAttachment](#/en/iaas/latest/IScsiVolumeAttachment/) and + [ParavirtualizedVolumeAttachment](#/en/iaas/latest/ParavirtualizedVolumeAttachment/). + operationId: ListVolumeAttachments + parameters: + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/InstanceIdQueryParam' + - $ref: '#/components/parameters/VolumeIdQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListVolumeAttachmentsResponse' + application/x-json-stream: + schema: + items: + $ref: '#/components/schemas/VolumeAttachment' + type: array + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListVolumeAttachments + tags: + - compute + post: + description: | + Attaches the specified storage volume to the specified instance. + operationId: AttachVolume + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AttachVolumeDetails' + description: Attach volume request + required: true + responses: + '200': + description: The volume is being attached. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/VolumeAttachment' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: AttachVolume + tags: + - compute + /volumeAttachments/{volumeAttachmentId}: + delete: + description: | + Detaches a storage volume from an instance. You must specify the OCID of the volume attachment. + + This is an asynchronous operation. The attachment's `lifecycleState` will change to DETACHING temporarily + until the attachment is completely removed. + operationId: DetachVolume + parameters: + - $ref: '#/components/parameters/VolumeAttachmentIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The request was accepted by the server + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DetachVolume + tags: + - compute + x-related-resource: '#/definitions/VolumeAttachment' + get: + description: Gets information about the specified volume attachment. + operationId: GetVolumeAttachment + parameters: + - $ref: '#/components/parameters/VolumeAttachmentIdPathParam' + responses: + '200': + description: The volume attachment was retrieved. + 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/VolumeAttachment' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetVolumeAttachment + tags: + - compute + put: + description: Updates information about the specified volume attachment. + operationId: UpdateVolumeAttachment + parameters: + - $ref: '#/components/parameters/VolumeAttachmentIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateVolumeAttachmentDetails' + description: Update information about the specified volume attachment. + required: true + responses: + '200': + description: The volume attachment was updated. + 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/VolumeAttachment' + '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/DefaultError' + summary: UpdateVolumeAttachment + tags: + - compute +components: + schemas: + AppCatalogListingSummary: + description: A summary of a listing. + properties: + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + listingId: + description: the region free ocid of the listing resource. + maxLength: 255 + minLength: 1 + type: string + publisherName: + description: The name of the publisher who published this listing. + maxLength: 64 + minLength: 1 + type: string + summary: + description: The short summary for the listing. + maxLength: 255 + minLength: 1 + type: string + type: object + AppCatalogListing: + description: Listing details. + properties: + contactUrl: + description: Listing's contact URL. + maxLength: 255 + minLength: 1 + type: string + description: + description: Description of the listing. + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + listingId: + description: The OCID of the listing. + maxLength: 255 + minLength: 1 + type: string + publisherLogoUrl: + description: Publisher's logo URL. + maxLength: 255 + minLength: 1 + type: string + publisherName: + description: Name of the publisher who published this listing. + maxLength: 64 + minLength: 1 + type: string + summary: + description: Summary of the listing. + maxLength: 255 + minLength: 1 + type: string + timePublished: + description: | + Date and time the listing was published, in [RFC3339](https://tools.ietf.org/html/rfc3339) format. + Example: `2018-03-20T12:32:53.532Z` + format: date-time + type: string + type: object + AppCatalogListingResourceVersionSummary: + description: Listing Resource Version summary + properties: + listingId: + description: The OCID of the listing this resource version belongs to. + maxLength: 255 + minLength: 1 + type: string + listingResourceId: + description: OCID of the listing resource. + maxLength: 255 + minLength: 1 + type: string + listingResourceVersion: + description: Resource Version. + maxLength: 64 + minLength: 1 + type: string + timePublished: + description: | + Date and time the listing resource version was published, in [RFC3339](https://tools.ietf.org/html/rfc3339) format. + Example: `2018-03-20T12:32:53.532Z` + format: date-time + type: string + type: object + AppCatalogListingResourceVersion: + description: Listing Resource Version + properties: + accessiblePorts: + description: List of accessible ports for instances launched with this listing resource version. + items: + format: int32 + type: integer + type: array + allowedActions: + description: Allowed actions for the listing resource. + items: + enum: + - SNAPSHOT + - BOOT_VOLUME_DETACH + - PRESERVE_BOOT_VOLUME + - SERIAL_CONSOLE_ACCESS + - BOOT_RECOVERY + - BACKUP_BOOT_VOLUME + - CAPTURE_CONSOLE_HISTORY + type: string + type: array + availableRegions: + description: | + List of regions that this listing resource version is available. + + For information about regions, see + [Regions and Availability Domains](/iaas/Content/General/Concepts/regions.htm). + + Example: `["us-ashburn-1", "us-phoenix-1"]` + items: + type: string + type: array + compatibleShapes: + description: | + Array of shapes compatible with this resource. + + You can enumerate all available shapes by calling [ListShapes](#/en/iaas/latest/Shape/ListShapes). + + Example: `["VM.Standard1.1", "VM.Standard1.2"]` + items: + type: string + type: array + listingId: + description: The OCID of the listing this resource version belongs to. + maxLength: 255 + minLength: 1 + type: string + listingResourceId: + description: OCID of the listing resource. + maxLength: 255 + minLength: 1 + type: string + listingResourceVersion: + description: Resource Version. + maxLength: 64 + minLength: 1 + type: string + timePublished: + description: | + Date and time the listing resource version was published, in [RFC3339](https://tools.ietf.org/html/rfc3339) format. + Example: `2018-03-20T12:32:53.532Z` + format: date-time + type: string + type: object + AppCatalogListingResourceVersionAgreements: + description: Agreements for a listing resource version. + properties: + eulaLink: + description: EULA link + maxLength: 1024 + minLength: 1 + type: string + listingId: + description: The OCID of the listing associated with these agreements. + maxLength: 255 + minLength: 1 + type: string + listingResourceVersion: + description: Listing resource version associated with these agreements. + maxLength: 64 + minLength: 1 + type: string + oracleTermsOfUseLink: + description: Oracle TOU link + maxLength: 1024 + minLength: 1 + type: string + signature: + description: | + A generated signature for this agreement retrieval operation which should be used in the create subscription call. + maxLength: 255 + minLength: 1 + type: string + timeRetrieved: + description: | + Date and time the agreements were retrieved, in [RFC3339](https://tools.ietf.org/html/rfc3339) format. + Example: `2018-03-20T12:32:53.532Z` + format: date-time + type: string + type: object + AppCatalogSubscriptionSummary: + description: a subscription summary for a listing resource version. + properties: + compartmentId: + description: The compartmentID of the subscription. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + listingId: + description: The ocid of the listing resource. + maxLength: 255 + minLength: 1 + type: string + listingResourceId: + description: Listing resource id. + maxLength: 255 + minLength: 1 + type: string + listingResourceVersion: + description: Listing resource version. + maxLength: 255 + minLength: 1 + type: string + publisherName: + description: Name of the publisher who published this listing. + maxLength: 64 + minLength: 1 + type: string + summary: + description: The short summary to the listing. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + Date and time at which the subscription was created, in [RFC3339](https://tools.ietf.org/html/rfc3339) format. + Example: `2018-03-20T12:32:53.532Z` + format: date-time + type: string + type: object + CreateAppCatalogSubscriptionDetails: + description: details for creating a subscription for a listing resource version. + properties: + compartmentId: + description: The compartmentID for the subscription. + maxLength: 255 + minLength: 1 + type: string + eulaLink: + description: EULA link + maxLength: 1024 + minLength: 1 + type: string + listingId: + description: The OCID of the listing. + maxLength: 255 + minLength: 1 + type: string + listingResourceVersion: + description: Listing resource version. + maxLength: 255 + minLength: 1 + type: string + oracleTermsOfUseLink: + description: Oracle TOU link + maxLength: 1024 + minLength: 1 + type: string + signature: + description: A generated signature for this listing resource version retrieved the agreements API. + maxLength: 255 + minLength: 1 + type: string + timeRetrieved: + description: | + Date and time the agreements were retrieved, in [RFC3339](https://tools.ietf.org/html/rfc3339) format. + Example: `2018-03-20T12:32:53.532Z` + format: date-time + type: string + required: + - compartmentId + - listingId + - listingResourceVersion + - oracleTermsOfUseLink + - timeRetrieved + - signature + type: object + AppCatalogSubscription: + description: a subscription for a listing resource version. + properties: + compartmentId: + description: The compartmentID of the subscription. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + listingId: + description: The ocid of the listing resource. + maxLength: 255 + minLength: 1 + type: string + listingResourceId: + description: Listing resource id. + maxLength: 255 + minLength: 1 + type: string + listingResourceVersion: + description: Listing resource version. + maxLength: 255 + minLength: 1 + type: string + publisherName: + description: Name of the publisher who published this listing. + maxLength: 64 + minLength: 1 + type: string + summary: + description: The short summary to the listing. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + Date and time at which the subscription was created, in [RFC3339](https://tools.ietf.org/html/rfc3339) format. + Example: `2018-03-20T12:32:53.532Z` + format: date-time + type: string + type: object + BootVolumeAttachment: + description: | + Represents an attachment between a boot volume and an instance. + + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + properties: + availabilityDomain: + description: | + The availability domain of an instance. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + bootVolumeId: + description: The OCID of the boot volume. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + encryptionInTransitType: + default: NONE + description: | + Refer the top-level definition of encryptionInTransitType. + The default value is NONE. + enum: + - NONE + - BM_ENCRYPTION_IN_TRANSIT + type: string + x-obmcs-top-level-enum: '#/definitions/EncryptionInTransitType' + id: + description: The OCID of the boot volume attachment. + maxLength: 255 + minLength: 1 + type: string + instanceId: + description: The OCID of the instance the boot volume is attached to. + maxLength: 255 + minLength: 1 + type: string + isPvEncryptionInTransitEnabled: + description: | + Whether in-transit encryption for the boot volume's paravirtualized attachment is enabled or not. + type: boolean + lifecycleState: + description: The current state of the boot volume attachment. + enum: + - ATTACHING + - ATTACHED + - DETACHING + - DETACHED + type: string + timeCreated: + description: | + The date and time the boot volume was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time the boot volume attachment was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - instanceId + - bootVolumeId + - lifecycleState + - compartmentId + - availabilityDomain + - timeCreated + type: object + AttachBootVolumeDetails: + properties: + bootVolumeId: + description: The OCID of the boot volume. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + encryptionInTransitType: + default: NONE + description: | + Refer the top-level definition of encryptionInTransitType. + The default value is NONE. + enum: + - NONE + - BM_ENCRYPTION_IN_TRANSIT + type: string + x-obmcs-top-level-enum: '#/definitions/EncryptionInTransitType' + instanceId: + description: The OCID of the instance. + maxLength: 255 + minLength: 1 + type: string + required: + - instanceId + - bootVolumeId + type: object + ClusterNetworkSummary: + description: | + Summary information for a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm). + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the + cluster netowrk. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster network. + maxLength: 255 + minLength: 1 + type: string + instancePools: + description: The instance pools in the cluster network. + items: + $ref: '#/components/schemas/InstancePoolSummary' + type: array + lifecycleState: + description: The current state of the cluster network. + enum: + - PROVISIONING + - SCALING + - STARTING + - STOPPING + - TERMINATING + - STOPPED + - TERMINATED + - RUNNING + type: string + timeCreated: + description: | + The date and time the resource was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time the resource was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - lifecycleState + - timeCreated + - timeUpdated + type: object + CreateClusterNetworkDetails: + description: | + The data to create a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm). + + Use cluster networks with instance pools when you want predictable capacity for a specific number of identical + instances that are managed as a group. + + For details about creating compute clusters, which let you manage instances in the RDMA network independently + of each other or use different types of instances in the network group, + see [CreateComputeClusterDetails](#/en/iaas/latest/datatypes/CreateComputeClusterDetails). + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment + containing the cluster network. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + instancePools: + description: | + The data to create the instance pools in the cluster network. + + Each cluster network can have one instance pool. + items: + $ref: '#/components/schemas/CreateClusterNetworkInstancePoolDetails' + type: array + placementConfiguration: + $ref: '#/components/schemas/ClusterNetworkPlacementConfigurationDetails' + required: + - compartmentId + - instancePools + - placementConfiguration + type: object + ClusterNetwork: + description: | + A cluster network is a group of high performance computing (HPC), GPU, or optimized bare metal + instances that are connected with an ultra low-latency remote direct memory access (RDMA) + network. [Cluster networks with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm) + use instance pools to manage groups of identical instances. + + Use cluster networks with instance pools when you want predictable capacity for a specific number of identical + instances that are managed as a group. + + If you want to manage instances in the RDMA network independently of each other or use different types of instances + in the network group, use compute clusters instead. For details, see [ComputeCluster](#/en/iaas/latest/ComputeCluster/). + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the cluster network. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + hpcIslandId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the HPC island used by the cluster network. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster network. + maxLength: 255 + minLength: 1 + type: string + instancePools: + description: | + The instance pools in the cluster network. + + Each cluster network can have one instance pool. + items: + $ref: '#/components/schemas/InstancePool' + type: array + lifecycleState: + description: The current state of the cluster network. + enum: + - PROVISIONING + - SCALING + - STARTING + - STOPPING + - TERMINATING + - STOPPED + - TERMINATED + - RUNNING + type: string + networkBlockIds: + description: The list of network block OCIDs of the HPC island. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + uniqueItems: true + placementConfiguration: + $ref: '#/components/schemas/ClusterNetworkPlacementConfigurationDetails' + timeCreated: + description: | + The date and time the resource was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time the resource was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - lifecycleState + - timeCreated + - timeUpdated + x-example: | + { + "id": "ocid1.clusternetwork.phx..<unique_ID>", + "displayName": "hpc-cluster-network", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "lifecycleState": "PROVISIONING", + "placementConfiguration": + { + "availabilityDomain": "Uocm:PHX-AD-1", + "primarySubnetId": "ocid1.subnet.oc1..<unique_ID>" + }, + "timeCreated": "2019-04-17T17:04:47.627Z" + } + type: object + UpdateClusterNetworkDetails: + description: | + The data to update a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm). + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + instancePools: + description: | + The instance pools in the cluster network to update. + items: + $ref: '#/components/schemas/UpdateClusterNetworkInstancePoolDetails' + type: array + uniqueItems: true + type: object + ChangeClusterNetworkCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment + into which the resource should be moved. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + InstanceSummary: + description: Condensed instance data when listing instances in an instance pool. + properties: + availabilityDomain: + description: The availability domain the instance is running in. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment that contains the instance. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + faultDomain: + description: The fault domain the instance is running in. + maxLength: 255 + minLength: 1 + type: string + id: + description: The OCID of the instance. + maxLength: 255 + minLength: 1 + type: string + instanceConfigurationId: + description: The OCID of the instance confgiuration used to create the instance. + maxLength: 255 + minLength: 1 + type: string + loadBalancerBackends: + description: | + The load balancer backends that are configured for the instance pool instance. + items: + $ref: '#/components/schemas/InstancePoolInstanceLoadBalancerBackend' + type: array + region: + description: The region that contains the availability domain the instance is running in. + maxLength: 255 + minLength: 1 + type: string + shape: + description: | + The shape of an instance. The shape determines the number of CPUs, amount of memory, + and other resources allocated to the instance. + + You can enumerate all available shapes by calling [ListShapes](#/en/iaas/latest/Shape/ListShapes). + maxLength: 255 + minLength: 1 + type: string + state: + description: The current state of the instance pool instance. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the instance pool instance was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - availabilityDomain + - compartmentId + - instanceConfigurationId + - region + - state + - timeCreated + type: object + CreateComputeCapacityReportDetails: + description: | + The data to create a report of available Compute capacity. + properties: + availabilityDomain: + description: | + The availability domain for the capacity report. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the compartment. This should always be the root + compartment. + maxLength: 255 + minLength: 1 + type: string + shapeAvailabilities: + description: | + Information about the shapes in the capacity report. + items: + $ref: '#/components/schemas/CreateCapacityReportShapeAvailabilityDetails' + type: array + required: + - compartmentId + - availabilityDomain + - shapeAvailabilities + type: object + ComputeCapacityReport: + description: | + A report of the host capacity within an availability domain that is available for you + to create compute instances. Host capacity is the physical infrastructure that resources such as compute + instances run on. + + Use the capacity report to determine whether sufficient capacity is available for a shape before + you create an instance or change the shape of an instance. + properties: + availabilityDomain: + description: | + The availability domain for the capacity report. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the compartment. This should always be the root + compartment. + maxLength: 255 + minLength: 1 + type: string + shapeAvailabilities: + description: | + Information about the available capacity for each shape in a capacity report. + items: + $ref: '#/components/schemas/CapacityReportShapeAvailability' + type: array + timeCreated: + description: | + The date and time the capacity report was created, in the format defined by + [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - compartmentId + - timeCreated + - availabilityDomain + - shapeAvailabilities + type: object + ComputeCapacityReservationInstanceShapeSummary: + description: | + An available shape used to launch instances in a compute capacity reservation. + properties: + availabilityDomain: + description: | + The shape's availability domain. + maxLength: 255 + minLength: 1 + type: string + instanceShape: + description: | + The name of the available shape used to launch instances in a compute capacity reservation. + maxLength: 255 + minLength: 1 + type: string + required: + - availabilityDomain + - instanceShape + type: object + ComputeCapacityReservationSummary: + description: | + Summary information for a compute capacity reservation. + properties: + availabilityDomain: + description: The availability domain of the capacity reservation. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The OCID of the instance reservation configuration. + maxLength: 255 + minLength: 1 + type: string + isDefaultReservation: + default: false + description: | + Whether this capacity reservation is the default. + For more information, see [Capacity Reservations](/iaas/Content/Compute/Tasks/reserve-capacity.htm#default). + type: boolean + lifecycleState: + description: The current state of the capacity reservation. + type: string + x-obmcs-enumref: '#/definitions/ComputeCapacityReservation/lifecycleState' + reservedInstanceCount: + description: | + The number of instances for which capacity will be held in this + compute capacity reservation. This number is the sum of the values of the `reservedCount` fields + for all of the instance capacity configurations under this reservation. + The purpose of this field is to calculate the percentage usage of the reservation. + format: int64 + minimum: 0 + type: integer + timeCreated: + description: | + The date and time the capacity reservation was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + usedInstanceCount: + description: | + The total number of instances currently consuming space in + this compute capacity reservation. This number is the sum of the values of the `usedCount` fields + for all of the instance capacity configurations under this reservation. + The purpose of this field is to calculate the percentage usage of the reservation. + format: int64 + minimum: 0 + type: integer + required: + - id + - timeCreated + - availabilityDomain + type: object + CreateComputeCapacityReservationDetails: + description: | + The details for creating a new compute capacity reservation. + properties: + availabilityDomain: + description: | + The availability domain of this compute capacity reservation. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the capacity reservation. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + instanceReservationConfigs: + description: | + The capacity configurations for the capacity reservation. + + To use the reservation for the desired shape, specify the shape, count, and + optionally the fault domain where you want this configuration. + items: + $ref: '#/components/schemas/InstanceReservationConfigDetails' + type: array + isDefaultReservation: + default: false + description: | + Whether this capacity reservation is the default. + For more information, see [Capacity Reservations](/iaas/Content/Compute/Tasks/reserve-capacity.htm#default). + type: boolean + required: + - compartmentId + - availabilityDomain + type: object + ComputeCapacityReservation: + description: | + A template that defines the settings to use when creating compute capacity reservations. + properties: + availabilityDomain: + description: | + The availability domain of the compute capacity reservation. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment + containing the compute capacity reservation. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity reservation. + maxLength: 255 + minLength: 1 + type: string + instanceReservationConfigs: + description: | + The capacity configurations for the capacity reservation. + + To use the reservation for the desired shape, specify the shape, count, and + optionally the fault domain where you want this configuration. + items: + $ref: '#/components/schemas/InstanceReservationConfig' + type: array + isDefaultReservation: + default: false + description: | + Whether this capacity reservation is the default. + For more information, see [Capacity Reservations](/iaas/Content/Compute/Tasks/reserve-capacity.htm#default). + type: boolean + lifecycleState: + description: The current state of the compute capacity reservation. + enum: + - ACTIVE + - CREATING + - UPDATING + - MOVING + - DELETED + - DELETING + type: string + reservedInstanceCount: + description: | + The number of instances for which capacity will be held with this + compute capacity reservation. This number is the sum of the values of the `reservedCount` fields + for all of the instance capacity configurations under this reservation. + The purpose of this field is to calculate the percentage usage of the reservation. + format: int64 + type: integer + timeCreated: + description: | + The date and time the compute capacity reservation was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time the compute capacity reservation was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + usedInstanceCount: + description: | + The total number of instances currently consuming space in + this compute capacity reservation. This number is the sum of the values of the `usedCount` fields + for all of the instance capacity configurations under this reservation. + The purpose of this field is to calculate the percentage usage of the reservation. + format: int64 + type: integer + required: + - id + - compartmentId + - lifecycleState + - timeCreated + - availabilityDomain + type: object + UpdateComputeCapacityReservationDetails: + description: | + Details for updating the compute capacity reservation. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + instanceReservationConfigs: + description: | + The capacity configurations for the capacity reservation. + + To use the reservation for the desired shape, specify the shape, count, and + optionally the fault domain where you want this configuration. + items: + $ref: '#/components/schemas/InstanceReservationConfigDetails' + type: array + isDefaultReservation: + description: | + Whether this capacity reservation is the default. + For more information, see [Capacity Reservations](/iaas/Content/Compute/Tasks/reserve-capacity.htm#default). + type: boolean + type: object + ChangeComputeCapacityReservationCompartmentDetails: + description: Specifies the compartment to move the compute capacity reservation to. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment + to move the compute capacity reservation to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + CapacityReservationInstanceSummary: + description: Condensed instance data when listing instances in a compute capacity reservation. + properties: + availabilityDomain: + description: The availability domain the instance is running in. + maxLength: 255 + minLength: 1 + type: string + clusterPlacementGroupId: + description: The OCID of the cluster placement group of the instance. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment that contains the instance. + maxLength: 255 + minLength: 1 + type: string + faultDomain: + description: The fault domain the instance is running in. + maxLength: 255 + minLength: 1 + type: string + id: + description: The OCID of the instance. + maxLength: 255 + minLength: 1 + type: string + shape: + description: | + The shape of the instance. The shape determines the number of CPUs, amount of memory, + and other resources allocated to the instance. + + You can enumerate all available shapes by calling [ListComputeCapacityReservationInstanceShapes](#/en/iaas/latest/computeCapacityReservationInstanceShapes/ListComputeCapacityReservationInstanceShapes). + maxLength: 255 + minLength: 1 + type: string + shapeConfig: + $ref: '#/components/schemas/InstanceReservationShapeConfigDetails' + required: + - id + - availabilityDomain + - compartmentId + - shape + type: object + ComputeCapacityTopologyCollection: + description: | + A list of compute capacity topologies. + properties: + items: + description: The list of compute capacity topologies. + items: + $ref: '#/components/schemas/ComputeCapacityTopologySummary' + type: array + required: + - items + type: object + CreateComputeCapacityTopologyDetails: + description: | + The details for creating a new compute capacity topology. + properties: + availabilityDomain: + description: | + The availability domain of this compute capacity topology. + + Example: `Uocm:US-CHICAGO-1-AD-2` + maxLength: 255 + minLength: 1 + type: string + capacitySource: + $ref: '#/components/schemas/CreateCapacitySourceDetails' + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains this compute capacity topology. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + required: + - availabilityDomain + - capacitySource + - compartmentId + type: object + ComputeCapacityTopology: + description: | + A compute capacity topology that allows you to query your bare metal hosts and their RDMA network topology. + properties: + availabilityDomain: + description: | + The availability domain of the compute capacity topology. + + Example: `Uocm:US-CHICAGO-1-AD-2` + maxLength: 255 + minLength: 1 + type: string + capacitySource: + $ref: '#/components/schemas/CapacitySource' + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the compute capacity topology. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the compute capacity topology. + enum: + - ACTIVE + - CREATING + - UPDATING + - DELETED + - DELETING + type: string + timeCreated: + description: | + The date and time that the compute capacity topology was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time that the compute capacity topology was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - availabilityDomain + - capacitySource + - compartmentId + - id + - lifecycleState + - timeCreated + - timeUpdated + type: object + UpdateComputeCapacityTopologyDetails: + description: | + The details for updating the compute capacity topology. + properties: + capacitySource: + $ref: '#/components/schemas/UpdateCapacitySourceDetails' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + ChangeComputeCapacityTopologyCompartmentDetails: + description: Specifies the compartment to move the compute capacity topology to. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment + to move the compute capacity topology to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ComputeBareMetalHostCollection: + description: | + A list of compute bare metal hosts. + properties: + items: + description: The list of compute bare metal hosts. + items: + $ref: '#/components/schemas/ComputeBareMetalHostSummary' + type: array + required: + - items + type: object + ComputeHpcIslandCollection: + description: | + A list of compute HPC islands. + properties: + items: + description: The list of compute HPC islands. + items: + $ref: '#/components/schemas/ComputeHpcIslandSummary' + type: array + required: + - items + type: object + ComputeNetworkBlockCollection: + description: | + A list of compute network blocks. + properties: + items: + description: The list of compute network blocks. + items: + $ref: '#/components/schemas/ComputeNetworkBlockSummary' + type: array + required: + - items + type: object + ComputeClusterCollection: + description: | + A list of compute clusters that match filter criteria, if any. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) + is a remote direct memory access (RDMA) network group. + properties: + items: + description: The list of compute clusters. + items: + $ref: '#/components/schemas/ComputeClusterSummary' + type: array + required: + - items + type: object + CreateComputeClusterDetails: + description: | + The data for creating a [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm). A compute cluster + is an empty remote direct memory access (RDMA) network group + + After the compute cluster is created, you can use the compute cluster's OCID with the + [LaunchInstance](#/en/iaas/latest/Instance/LaunchInstance) operation to create instances in the compute cluster. + The instances must be created in the same compartment and availability domain as the cluster. + + Use compute clusters when you want to manage instances in the cluster individually in the RDMA network group. + + For details about creating a cluster network that uses instance pools to manage groups of identical instances, + see [CreateClusterNetworkDetails](#/en/iaas/latest/datatypes/CreateClusterNetworkDetails). + properties: + availabilityDomain: + description: | + The availability domain to place the compute cluster in. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + required: + - availabilityDomain + - compartmentId + type: object + ComputeCluster: + description: | + The data for creating a [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm). A compute cluster + is an empty remote direct memory access (RDMA) network group + + After the compute cluster is created, you can use the compute cluster's OCID with the + [LaunchInstance](#/en/iaas/latest/Instance/LaunchInstance) operation to create instances in the compute cluster. + The instances must be created in the same compartment and availability domain as the cluster. + + Use compute clusters when you want to manage instances in the cluster individually in the RDMA network group. + + For details about creating a cluster network that uses instance pools to manage groups of identical instances, + see [CreateClusterNetworkDetails](#/en/iaas/latest/datatypes/CreateClusterNetworkDetails). + properties: + availabilityDomain: + description: | + The availability domain the compute cluster is running in. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the compute cluster. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the compute cluster. + enum: + - ACTIVE + - DELETED + type: string + timeCreated: + description: | + The date and time the compute cluster was created, + in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - availabilityDomain + - compartmentId + - id + - lifecycleState + - timeCreated + type: object + UpdateComputeClusterDetails: + description: | + The data to update a compute cluster. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) + is a remote direct memory access (RDMA) network group. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + ChangeComputeClusterCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the compute cluster to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ComputeGlobalImageCapabilitySchemaSummary: + description: Summary information for a compute global image capability schema + properties: + compartmentId: + description: | + The OCID of the compartment containing the compute global image capability schema + maxLength: 255 + minLength: 1 + type: string + currentVersionName: + description: The name of the global capabilities version resource that is considered the current version. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The compute global image capability schema [OCID](/iaas/Content/General/Concepts/identifiers.htm). + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the compute global image capability schema was created, in the format defined by + [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - displayName + - timeCreated + type: object + ComputeGlobalImageCapabilitySchema: + description: | + Compute Global Image Capability Schema is a container for a set of compute global image capability schema versions + properties: + compartmentId: + description: The OCID of the compartment that contains the resource. + maxLength: 255 + minLength: 1 + type: string + currentVersionName: + description: The name of the global capabilities version resource that is considered the current version. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute global image capability schema + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the compute global image capability schema was created, in the format defined by + [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - displayName + - timeCreated + type: object + ComputeGlobalImageCapabilitySchemaVersionSummary: + description: Summary information for a compute global image capability schema + properties: + computeGlobalImageCapabilitySchemaId: + description: | + The OCID of the compute global image capability schema + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + name: + description: The compute global image capability schema version name + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the compute global image capability schema version was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - name + - computeGlobalImageCapabilitySchemaId + - timeCreated + type: object + ComputeGlobalImageCapabilitySchemaVersion: + description: | + Compute Global Image Capability Schema Version is a set of all possible capabilities for a collection of images. + properties: + computeGlobalImageCapabilitySchemaId: + description: | + The ocid of the compute global image capability schema + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + name: + description: | + The name of the compute global image capability schema version + maxLength: 255 + minLength: 1 + type: string + schemaData: + additionalProperties: + $ref: '#/components/schemas/ImageCapabilitySchemaDescriptor' + description: The map of each capability name to its ImageCapabilityDescriptor. + type: object + timeCreated: + description: | + The date and time the compute global image capability schema version was created, in the format defined by + [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - name + - displayName + - computeGlobalImageCapabilitySchemaId + - schemaData + - timeCreated + type: object + ComputeGpuMemoryClusterCollection: + description: | + A list of compute GPU Memory Clusters. + properties: + items: + description: The list of compute GPU Memory Clusters. + items: + $ref: '#/components/schemas/ComputeGpuMemoryClusterSummary' + type: array + required: + - items + type: object + CreateComputeGpuMemoryClusterDetails: + description: | + The customer facing object includes GPU Memory Cluster details. + properties: + availabilityDomain: + description: | + The availability domain of the GPU Memory Cluster. + type: string + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the compute GPU Memory Cluster. + compartment. + maxLength: 255 + minLength: 1 + type: string + computeClusterId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + gpuMemoryClusterScaleConfig: + $ref: '#/components/schemas/CreateComputeGpuMemoryClusterScaleConfig' + gpuMemoryFabricId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the GPU memory fabric. + maxLength: 255 + minLength: 1 + type: string + instanceConfigurationId: + description: | + Instance Configuration to be used for this GPU Memory Cluster + maxLength: 255 + minLength: 1 + type: string + privateIpIds: + description: Unique list of OCIDs for private IPs (IPv4/IPv6) associated with the GPU Memory Cluster + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 255 + type: array + uniqueItems: true + size: + description: | + The desired number of instances for the GPU Memory Cluster. + format: int64 + minimum: 0 + type: integer + required: + - availabilityDomain + - compartmentId + - computeClusterId + - instanceConfigurationId + type: object + ComputeGpuMemoryCluster: + description: | + The customer facing object includes GPU Memory Cluster details. + properties: + availabilityDomain: + description: | + The availability domain of the GPU Memory Cluster. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the compute GPU + memory cluster. + maxLength: 255 + minLength: 1 + type: string + computeClusterId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + gpuMemoryClusterScaleConfig: + $ref: '#/components/schemas/ComputeGpuMemoryClusterScaleConfig' + gpuMemoryFabricId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the GPU memory fabric. + maxLength: 255 + minLength: 1 + type: string + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique GPU Memory Cluster + maxLength: 255 + minLength: 1 + type: string + instanceConfigurationId: + description: The OCID of the Instance Configuration used to source launch details for this instance. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: | + The lifecycle state of the GPU Memory Cluster + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + - DELETED + type: string + privateIpIds: + description: Unique list of OCIDs for private IPs (IPv4/IPv6) associated with the GPU Memory Cluster + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 255 + type: array + uniqueItems: true + size: + description: | + The size represents the total number of instances in the GPU Memory Cluster, including both running instances and those still in the process of launching. + format: int64 + minimum: 0 + type: integer + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }` + type: object + timeCreated: + description: | + The date and time the GPU Memory Cluster was created. + + Example: `2016-09-15T21:10:29.600Z` + format: date-time + type: string + required: + - compartmentId + - computeClusterId + - instanceConfigurationId + - size + - availabilityDomain + - id + - lifecycleState + - timeCreated + type: object + UpdateComputeGpuMemoryClusterDetails: + description: | + Updates compute GPU Memory Cluster details. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + gpuMemoryClusterScaleConfig: + $ref: '#/components/schemas/UpdateComputeGpuMemoryClusterScaleConfig' + instanceConfigurationId: + description: | + Instance Configuration to be used for this GPU Memory Cluster + maxLength: 255 + minLength: 1 + type: string + privateIpIds: + description: Unique list of OCIDs for private IPs (IPv4/IPv6) associated with the GPU Memory Cluster + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 255 + type: array + uniqueItems: true + size: + description: | + The desired number of instances for the GPU Memory Cluster. + format: int64 + minimum: 0 + type: integer + type: object + ChangeComputeGpuMemoryClusterCompartmentDetails: + description: Specifies the compartment to move the compute GPU Memory Cluster to. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the compute GPU + memory cluster to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ComputeGpuMemoryClusterInstanceCollection: + description: | + A list of compute GPU Memory Cluster instances. + properties: + items: + description: The list of compute GPU Memory Cluster instances. + items: + $ref: '#/components/schemas/ComputeGpuMemoryClusterInstanceSummary' + type: array + required: + - items + type: object + ComputeGpuMemoryFabricCollection: + description: | + A list of compute GPU memory fabrics. + properties: + items: + description: The list of compute GPU memory fabrics. + items: + $ref: '#/components/schemas/ComputeGpuMemoryFabricSummary' + type: array + required: + - items + type: object + ComputeGpuMemoryFabric: + description: | + The customer facing object includes GPU memory fabric details. + properties: + additionalData: + additionalProperties: + type: string + description: (opaque JSON object) + description: | + Additional data that can be exposed to the customer. Right now it will include the switch tray ids. + type: object + availableHostCount: + description: The total number of available bare metal hosts located in this compute GPU memory fabric. + format: int64 + minimum: 0 + type: integer + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the compartment. This should always be the root + compartment. + maxLength: 255 + minLength: 1 + type: string + computeGpuMemoryClusters: + description: List of GPU memory clusters within this GPU memory fabric. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 255 + type: array + uniqueItems: true + computeHpcIslandId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique HPC Island + maxLength: 255 + minLength: 1 + type: string + computeLocalBlockId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Local Block + maxLength: 255 + minLength: 1 + type: string + computeNetworkBlockId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Network Block + maxLength: 255 + minLength: 1 + type: string + currentFirmwareBundleId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for current firmware bundle + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + fabricHealth: + description: | + The health state of the GPU memory fabric + enum: + - HEALTHY + - UNHEALTHY + type: string + firmwareUpdateReason: + description: | + The reason for updating firmware bundle version of the GPU memory fabric. + maxLength: 255 + minLength: 1 + type: string + firmwareUpdateState: + description: | + The state of Memory Fabric Firmware update + enum: + - WILL_UPDATE + - NO_UPDATE + - SKIP_RECYCLE_ENABLED + 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 + healthyHostCount: + description: The total number of healthy bare metal hosts located in this compute GPU memory fabric. + format: int64 + minimum: 0 + type: integer + hostPlatformName: + description: | + The host platform identifier used for bundle queries + maxLength: 255 + minLength: 1 + type: string + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique GPU memory fabric + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: | + The lifecycle state of the GPU memory fabric + enum: + - AVAILABLE + - OCCUPIED + - PROVISIONING + - DEGRADED + - UNAVAILABLE + type: string + memoryFabricPreferences: + $ref: '#/components/schemas/MemoryFabricPreferencesDescriptor' + switchPlatformName: + description: | + The switch platform identifier used for bundle queries + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }` + type: object + targetFirmwareBundleId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for targeted firmware bundle + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time that the compute GPU memory fabric record was created, in the format defined by [RFC3339] + (https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + totalHostCount: + description: The total number of bare metal hosts located in this compute GPU memory fabric. + format: int64 + minimum: 0 + type: integer + required: + - id + - compartmentId + - computeHpcIslandId + - computeNetworkBlockId + - computeLocalBlockId + - lifecycleState + - fabricHealth + - healthyHostCount + - totalHostCount + - timeCreated + type: object + UpdateComputeGpuMemoryFabricDetails: + description: | + Updates compute GPU memory fabric details. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + memoryFabricPreferences: + $ref: '#/components/schemas/MemoryFabricPreferencesDescriptor' + type: object + ChangeComputeGpuMemoryFabricCompartmentDetails: + description: Specifies the compartment to move the compute GPU memory fabric to. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the compute GPU + memory fabric to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ComputeHostGroupCollection: + description: | + A list of compute host groups. + properties: + items: + description: The list of compute host groups. + items: + $ref: '#/components/schemas/ComputeHostGroupSummary' + type: array + required: + - items + type: object + CreateComputeHostGroupDetails: + description: | + Detail information for a compute host group. + properties: + availabilityDomain: + description: | + The availability domain of a host group. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The OCID of the compartment that contains host group. + maxLength: 255 + minLength: 1 + type: string + configurations: + description: A list of HostGroupConfiguration objects + items: + $ref: '#/components/schemas/HostGroupConfiguration' + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + isTargetedPlacementRequired: + description: A flag that allows customers to restrict placement for hosts attached to the group. If true, the only way to place on hosts is to target the specific host group. + type: boolean + required: + - availabilityDomain + - displayName + - compartmentId + - isTargetedPlacementRequired + type: object + ComputeHostGroup: + description: | + Detail information for a compute host group. + properties: + availabilityDomain: + description: | + The availability domain of a host group. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The OCID of the compartment that contains host group. + maxLength: 255 + minLength: 1 + type: string + configurations: + description: A list of HostGroupConfiguration objects + items: + $ref: '#/components/schemas/HostGroupConfiguration' + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique host group + maxLength: 255 + minLength: 1 + type: string + isTargetedPlacementRequired: + description: A flag that allows customers to restrict placement for hosts attached to the group. If true, the only way to place on hosts is to target the specific host group. + type: boolean + lifecycleState: + description: | + The lifecycle state of the host group + enum: + - ACTIVE + - DELETED + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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 + timeCreated: + description: | + The date and time the host group was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time the host group was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - timeCreated + - availabilityDomain + - displayName + - compartmentId + - lifecycleState + type: object + UpdateComputeHostGroupDetails: + description: | + Update details information for a compute host group. + properties: + configurations: + description: A list of HostGroupConfiguration objects + items: + $ref: '#/components/schemas/HostGroupConfiguration' + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + isTargetedPlacementRequired: + description: A flag that allows customers to restrict placement for hosts attached to the group. If true, the only way to place on hosts is to target the specific host group. + type: boolean + type: object + ChangeComputeHostGroupCompartmentDetails: + description: Specifies the compartment to move the compute host group to. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment + to move the compute host group to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ComputeHostCollection: + description: | + A list of compute hosts. + properties: + items: + description: The list of compute hosts. + items: + $ref: '#/components/schemas/ComputeHostSummary' + type: array + required: + - items + type: object + ComputeHost: + description: | + The customer facing object includes host details. + properties: + additionalData: + additionalProperties: + type: string + description: (opaque JSON object) + description: | + Additional data that can be exposed to the customer. Will include raw fault codes for strategic customers + type: object + availabilityDomain: + description: | + The availability domain of the compute host. + + Example: `Uocm:US-CHICAGO-1-AD-2` + maxLength: 255 + minLength: 1 + type: string + capacityReservationId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Capacity Reserver that is currently on host + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the compartment. This should always be the root + compartment. + maxLength: 255 + minLength: 1 + type: string + computeHostGroupId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique host group associated with the Compute Bare Metal Host. + maxLength: 255 + minLength: 1 + type: string + configurationData: + $ref: '#/components/schemas/ComputeHostConfigurationData' + configurationState: + description: | + Configuration state of the Compute Bare Metal Host. + enum: + - CONFORMANT + - NON_CONFORMANT + - CHECKING + - PRE_APPLYING + - APPLYING + - UNKNOWN + type: string + x-obmcs-top-level-enum: '#/definitions/ConfigurationState' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + faultDomain: + description: | + A fault domain is a grouping of hardware and infrastructure within an availability domain. + Each availability domain contains three fault domains. Fault domains let you distribute your + instances so that they are not on the same physical hardware within a single availability domain. + A hardware failure or Compute hardware maintenance that affects one fault domain does not affect + instances in other fault domains. + + This field is the Fault domain of the host + maxLength: 255 + minLength: 1 + type: string + firmwareBundleId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique firmware bundle associated with the Host. + 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 + gpuMemoryFabricId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique GPU Memory Fabric + maxLength: 255 + minLength: 1 + type: string + health: + description: | + The heathy state of the host + enum: + - HEALTHY + - UNHEALTHY + type: string + hpcIslandId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique HPC Island + maxLength: 255 + minLength: 1 + type: string + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique host + maxLength: 255 + minLength: 1 + type: string + impactedComponentDetails: + additionalProperties: + type: string + description: (opaque JSON object) + description: | + A list that contains impacted components related to an unhealthy host. An impacted component will be a + free-form structure of key values pairs that will provide more or less details based on data tiering + type: object + instanceId: + description: | + The public [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Virtual Machine or Bare Metal instance + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + additionalProperties: + type: string + description: (opaque JSON object) + description: | + A free-form description detailing why the host is in its current state. + type: object + lifecycleState: + description: | + The lifecycle state of the host + enum: + - AVAILABLE + - OCCUPIED + - PROVISIONING + - REPAIR + - UNAVAILABLE + type: string + localBlockId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Local Block + maxLength: 255 + minLength: 1 + type: string + networkBlockId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Network Block + maxLength: 255 + minLength: 1 + type: string + platform: + description: | + The platform of the host + maxLength: 255 + minLength: 1 + type: string + recycleDetails: + $ref: '#/components/schemas/RecycleDetails' + shape: + description: | + The shape of host + maxLength: 255 + minLength: 1 + type: string + timeConfigurationCheck: + description: | + The date and time that the compute bare metal host configuration check was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeCreated: + description: | + The date and time that the compute host record was created, in the format defined by [RFC3339](https://tools + .ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time that the compute host record was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - compartmentId + - availabilityDomain + - id + - faultDomain + - shape + - health + - lifecycleState + - timeCreated + - timeUpdated + type: object + UpdateComputeHostDetails: + description: | + The details for updating the compute host. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + AttachComputeHostGroupHostDetails: + description: Specifies the host group id + properties: + computeHostGroupId: + description: | + 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host group.' + maxLength: 255 + minLength: 1 + type: string + required: + - computeHostGroupId + type: object + ChangeComputeHostCompartmentDetails: + description: Specifies the compartment to move the compute host to. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment + to move the compute host to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + DetachComputeHostGroupHostDetails: + description: Specifies the host group id + properties: + computeHostGroupId: + description: | + 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host group.' + maxLength: 255 + minLength: 1 + type: string + required: + - computeHostGroupId + type: object + ComputeImageCapabilitySchemaSummary: + description: Summary information for a compute image capability schema + properties: + compartmentId: + description: | + The OCID of the compartment containing the compute global image capability schema + maxLength: 255 + minLength: 1 + type: string + computeGlobalImageCapabilitySchemaVersionName: + description: | + The name of the compute global image capability schema version + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The compute image capability schema [OCID](/iaas/Content/General/Concepts/identifiers.htm). + maxLength: 255 + minLength: 1 + type: string + imageId: + description: | + The OCID of the image associated with this compute image capability schema + maxLength: 255 + minLength: 1 + type: string + schemaData: + additionalProperties: + $ref: '#/components/schemas/ImageCapabilitySchemaDescriptor' + description: A mapping of each capability name to its ImageCapabilityDescriptor. + type: object + timeCreated: + description: | + The date and time the compute image capability schema was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - computeGlobalImageCapabilitySchemaVersionName + - imageId + - displayName + - timeCreated + type: object + CreateComputeImageCapabilitySchemaDetails: + description: | + Create Image Capability Schema for an image. + properties: + compartmentId: + description: The OCID of the compartment that contains the resource. + maxLength: 255 + minLength: 1 + type: string + computeGlobalImageCapabilitySchemaVersionName: + description: | + The name of the compute global image capability schema version + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + imageId: + description: | + The ocid of the image + maxLength: 255 + minLength: 1 + type: string + schemaData: + additionalProperties: + $ref: '#/components/schemas/ImageCapabilitySchemaDescriptor' + description: The map of each capability name to its ImageCapabilitySchemaDescriptor. + type: object + required: + - compartmentId + - computeGlobalImageCapabilitySchemaVersionName + - imageId + - schemaData + type: object + ComputeImageCapabilitySchema: + description: | + Compute Image Capability Schema is a set of capabilities that filter the compute global capability schema + version for an image. + properties: + compartmentId: + description: The OCID of the compartment that contains the resource. + maxLength: 255 + minLength: 1 + type: string + computeGlobalImageCapabilitySchemaId: + description: | + The ocid of the compute global image capability schema + maxLength: 255 + minLength: 1 + type: string + computeGlobalImageCapabilitySchemaVersionName: + description: | + The name of the compute global image capability schema version + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: | + The id of the compute global image capability schema version + maxLength: 255 + minLength: 1 + type: string + imageId: + description: | + The OCID of the image associated with this compute image capability schema + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The ComputeImageCapabilitySchema current lifecycle state. + enum: + - CREATING + - ACTIVE + - DELETED + type: string + schemaData: + additionalProperties: + $ref: '#/components/schemas/ImageCapabilitySchemaDescriptor' + description: The map of each capability name to its ImageCapabilityDescriptor. + type: object + timeCreated: + description: | + The date and time the compute image capability schema was created, in the format defined by + [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - displayName + - imageId + - computeGlobalImageCapabilitySchemaId + - computeGlobalImageCapabilitySchemaVersionName + - schemaData + - timeCreated + type: object + UpdateComputeImageCapabilitySchemaDetails: + description: | + Create Image Capability Schema for an image. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + schemaData: + additionalProperties: + $ref: '#/components/schemas/ImageCapabilitySchemaDescriptor' + description: The map of each capability name to its ImageCapabilitySchemaDescriptor. + type: object + type: object + ChangeComputeImageCapabilitySchemaCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to + move the instance configuration to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + DedicatedVmHostInstanceShapeSummary: + description: | + The shape used to launch instances associated with the dedicated VM host. + properties: + availabilityDomain: + description: | + The shape's availability domain. + maxLength: 255 + minLength: 1 + type: string + instanceShapeName: + description: | + The name of the virtual machine instance shapes that can be launched on a dedicated VM host. + maxLength: 255 + minLength: 1 + type: string + supportedCapabilities: + $ref: '#/components/schemas/SupportedCapabilities' + required: + - instanceShapeName + type: object + DedicatedVmHostShapeSummary: + description: | + The shape used to launch the dedicated virtual machine (VM) host. + properties: + availabilityDomain: + description: | + The shape's availability domain. + maxLength: 255 + minLength: 1 + type: string + capacityConfigs: + description: | + A list of capacity configs that are supported by this dedicated VM host shape. + items: + $ref: '#/components/schemas/CapacityConfig' + maxItems: 25 + minItems: 1 + type: array + dedicatedVmHostShape: + description: | + The name of the dedicated VM host shape. You can enumerate all available shapes by calling + [ListDedicatedVmHostShapes](#/en/iaas/latest/DedicatedVmHostShapeSummary/ListDedicatedVmHostShapes). + maxLength: 255 + minLength: 1 + type: string + required: + - dedicatedVmHostShape + type: object + DedicatedVmHostSummary: + description: | + A dedicated virtual machine (VM) host lets you host multiple instances on a dedicated server that is not shared with other tenancies. + properties: + availabilityDomain: + description: | + The availability domain the dedicated VM host is running in. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The OCID of the compartment that contains the dedicated VM host. + maxLength: 255 + minLength: 1 + type: string + dedicatedVmHostShape: + description: | + The shape of the dedicated VM host. The shape determines the number of CPUs and + other resources available for VMs. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + faultDomain: + description: | + The fault domain for the dedicated VM host's assigned instances. For more information, see Fault Domains. + + If you do not specify the fault domain, the system selects one for you. To change the fault domain for a dedicated VM host, + delete it and create a new dedicated VM host in the preferred fault domain. + + To get a list of fault domains, use the ListFaultDomains operation in the Identity and Access Management Service API. + + Example: `FAULT-DOMAIN-1` + maxLength: 255 + minLength: 1 + type: string + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dedicated VM host. + maxLength: 255 + minLength: 1 + type: string + isBurstable: + default: false + description: | + Specifies if the Dedicated Virtual Machine Host (DVMH) is to running only Burstable VMs. If `true`, only Burstable VMs can be launched. If `false`, Burstable VMs cannot be launched. + type: boolean + isMemoryEncryptionEnabled: + default: false + description: | + Specifies if the Dedicated Virtual Machine Host is restricted to running only Confidential VMs. If `true`, only Confidential VMs can be launched. If `false`, Confidential VMs cannot be launched. + type: boolean + lifecycleState: + description: | + The current state of the dedicated VM host. + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + - DELETED + - FAILED + type: string + remainingMemoryInGBs: + description: | + The current available memory of the dedicated VM host, in GBs. + format: float + minimum: 0 + type: number + remainingOcpus: + description: | + The current available OCPUs of the dedicated VM host. + format: float + minimum: 0 + type: number + timeCreated: + description: | + The date and time the dedicated VM host was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + totalMemoryInGBs: + description: | + The current total memory of the dedicated VM host, in GBs. + format: float + minimum: 0 + type: number + totalOcpus: + description: | + The current total OCPUs of the dedicated VM host. + format: float + minimum: 0 + type: number + required: + - availabilityDomain + - compartmentId + - dedicatedVmHostShape + - displayName + - id + - lifecycleState + - timeCreated + - remainingOcpus + - totalOcpus + type: object + CreateDedicatedVmHostDetails: + description: | + The details for creating a new dedicated virtual machine host. + properties: + availabilityDomain: + description: | + The availability domain of the dedicated virtual machine host. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + capacityConfig: + description: | + The capacity configuration selected to be configured for the Dedicated Virtual Machine host. + Run [ListDedicatedVmHostShapes](#/en/iaas/latest/DedicatedVmHostShapeSummary/ListDedicatedVmHostShapes) API first to see the capacity configuration options. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment. + maxLength: 255 + minLength: 1 + type: string + dedicatedVmHostShape: + description: | + The dedicated virtual machine host shape. The shape determines the number of CPUs and + other resources available for VM instances launched on the dedicated virtual machine host. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + faultDomain: + description: | + The fault domain for the dedicated virtual machine host's assigned instances. + For more information, see [Fault Domains](/iaas/Content/General/Concepts/regions.htm#fault). + If you do not specify the fault domain, the system selects one for you. To change the fault domain for a dedicated virtual machine host, + delete it and create a new dedicated virtual machine host in the preferred fault domain. + + To get a list of fault domains, use the `ListFaultDomains` operation in + the [Identity and Access Management Service API](/iaas/api/#/en/identity/20160918/). + + Example: `FAULT-DOMAIN-1` + 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 + isBaselineOcpuUtilizationEnabled: + default: false + description: | + Specifies if the Dedicated Virtual Machine Host (DVMH) is restricted to running only Burstable VMs. If `true`, only Burstable VMs can be launched. If `false`, Burstable VMs cannot be launched. + type: boolean + isMemoryEncryptionEnabled: + default: false + description: | + Specifies if the Dedicated Virtual Machine Host (DVMH) is restricted to running only Confidential VMs. If `true`, only Confidential VMs can be launched. If `false`, Confidential VMs cannot be launched. + type: boolean + placementConstraintDetails: + $ref: '#/components/schemas/PlacementConstraintDetails' + required: + - availabilityDomain + - compartmentId + - dedicatedVmHostShape + type: object + DedicatedVmHost: + description: | + A dedicated virtual machine host lets you host multiple VM instances + on a dedicated server that is not shared with other tenancies. + properties: + availabilityDomain: + description: | + The availability domain the dedicated virtual machine host is running in. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + capacityBins: + items: + $ref: '#/components/schemas/CapacityBin' + maxItems: 25 + minItems: 0 + type: array + capacityConfig: + description: | + The capacity configuration selected to be configured for the Dedicated Virtual Machine host. + Run [ListDedicatedVmHostShapes](#/en/iaas/latest/DedicatedVmHostShapeSummary/ListDedicatedVmHostShapes) API to see details of this capacity configuration. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment that contains the dedicated virtual machine host. + maxLength: 255 + minLength: 1 + type: string + computeBareMetalHostId: + description: | + The compute bare metal host OCID of the dedicated virtual machine host. + maxLength: 255 + minLength: 1 + type: string + dedicatedVmHostShape: + description: | + The dedicated virtual machine host shape. The shape determines the number of CPUs and + other resources available for VMs. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + faultDomain: + description: | + The fault domain for the dedicated virtual machine host's assigned instances. + For more information, see [Fault Domains](/iaas/Content/General/Concepts/regions.htm#fault). + + If you do not specify the fault domain, the system selects one for you. To change the fault domain for a dedicated virtual machine host, + delete it, and then create a new dedicated virtual machine host in the preferred fault domain. + + To get a list of fault domains, use the `ListFaultDomains` operation in the [Identity and Access Management Service API](/iaas/api/#/en/identity/20160918/). + + Example: `FAULT-DOMAIN-1` + 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dedicated VM host. + maxLength: 255 + minLength: 1 + type: string + isBurstable: + default: false + description: | + Specifies if the Dedicated Virtual Machine Host (DVMH) is to running only Burstable VMs. If `true`, only Burstable VMs can be launched. If `false`, Burstable VMs cannot be launched. + type: boolean + isMemoryEncryptionEnabled: + default: false + description: | + Specifies if the Dedicated Virtual Machine Host (DVMH) is restricted to running only Confidential VMs. If `true`, only Confidential VMs can be launched. If `false`, Confidential VMs cannot be launched. + type: boolean + lifecycleState: + description: | + The current state of the dedicated VM host. + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + - DELETED + - FAILED + type: string + placementConstraintDetails: + $ref: '#/components/schemas/PlacementConstraintDetails' + remainingMemoryInGBs: + description: | + The remaining memory of the dedicated VM host, in GBs. + format: float + minimum: 0 + type: number + remainingOcpus: + description: | + The available OCPUs of the dedicated VM host. + format: float + minimum: 0 + type: number + timeCreated: + description: | + The date and time the dedicated VM host was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + totalMemoryInGBs: + description: | + The total memory of the dedicated VM host, in GBs. + format: float + minimum: 0 + type: number + totalOcpus: + description: | + The total OCPUs of the dedicated VM host. + format: float + minimum: 0 + type: number + required: + - availabilityDomain + - compartmentId + - dedicatedVmHostShape + - displayName + - id + - lifecycleState + - remainingOcpus + - timeCreated + - totalOcpus + type: object + UpdateDedicatedVmHostDetails: + description: | + Details for updating the dedicated virtual machine host details. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + ChangeDedicatedVmHostCompartmentDetails: + description: Specifies the compartment to move the dedicated virtual machine host to. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment + to move the dedicated virtual machine host to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + DedicatedVmHostInstanceSummary: + description: | + Condensed instance data when listing instances on a dedicated VM host. + properties: + availabilityDomain: + description: | + The availability domain the virtual machine instance is running in. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The OCID of the compartment that contains the virtual machine instance. + maxLength: 255 + minLength: 1 + type: string + instanceId: + description: | + The OCID of the virtual machine instance. + maxLength: 255 + minLength: 1 + type: string + isBurstable: + default: false + description: | + Specifies if the Dedicated Virtual Machine Host (DVMH) is to running only Burstable VMs. If `true`, only Burstable VMs can be launched. If `false`, Burstable VMs cannot be launched. + type: boolean + isMemoryEncryptionEnabled: + default: false + description: | + Specifies whether the VM instance is confidential. + type: boolean + shape: + description: | + The shape of the VM instance. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the virtual machine instance was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - availabilityDomain + - compartmentId + - instanceId + - shape + - timeCreated + type: object + FirmwareBundlesCollection: + description: Results of a firmwareBundles search. Contains FirmwareBundleSummary items. + properties: + items: + description: List of firmwareBundleSummary objects. + items: + $ref: '#/components/schemas/FirmwareBundleSummary' + type: array + required: + - items + type: object + FirmwareBundle: + description: A collection of pinned component firmware versions organized by platform. + properties: + allowableTransitions: + $ref: '#/components/schemas/FirmwareBundleTransitions' + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment of this firmware bundle. + maxLength: 255 + minLength: 1 + type: string + description: + description: A brief description or metadata about this firmware bundle. + type: string + displayName: + description: The user-friendly name of this firmware bundle. + type: string + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this firmware bundle. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the firmware bundle. + enum: + - ACTIVE + - INACTIVE + - DELETE_SCHEDULED + type: string + platforms: + description: A map of platforms to pinned firmware versions. + items: + $ref: '#/components/schemas/PlatformVersions' + type: array + timeCreated: + description: | + The date and time the firmware bundle was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time the firmware bundle was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - displayName + - description + - platforms + - compartmentId + - timeCreated + - timeUpdated + - lifecycleState + type: object + Image: + description: | + A boot disk image for launching an instance. For more information, see + [Overview of the Compute Service](/iaas/Content/Compute/Concepts/computeoverview.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + properties: + agentFeatures: + $ref: '#/components/schemas/InstanceAgentFeatures' + baseImageId: + description: The OCID of the image originally used to launch the instance. + maxLength: 255 + minLength: 1 + type: string + billableSizeInGBs: + description: | + The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). + + Example: `100` + format: int64 + type: integer + compartmentId: + description: | + The OCID of the compartment containing the instance you want to use as the basis for the image. + maxLength: 255 + minLength: 1 + type: string + createImageAllowed: + description: | + Whether instances launched with this image can be used to create new images. + For example, you cannot create an image of an Oracle Database instance. + + Example: `true` + type: boolean + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name for the image. It does not have to be unique, and it's changeable. + Avoid entering confidential information. + + You cannot use a platform image name as a custom image name. + + Example: `My custom Oracle Linux image` + 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 + id: + description: The OCID of the image. + maxLength: 255 + minLength: 1 + type: string + launchMode: + description: | + Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: + * `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images. + * `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller. + * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. + * `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type. + * `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter. + enum: + - NATIVE + - EMULATED + - PARAVIRTUALIZED + - ACCELERATEDPV + - CUSTOM + type: string + x-obmcs-resolve-component-ref: true + launchOptions: + $ref: '#/components/schemas/LaunchOptions' + lifecycleState: + enum: + - PROVISIONING + - IMPORTING + - AVAILABLE + - EXPORTING + - DISABLED + - DELETED + type: string + operatingSystem: + description: | + The image's operating system. + + Example: `Oracle Linux` + maxLength: 255 + minLength: 1 + type: string + operatingSystemVersion: + description: | + The image's operating system version. + + Example: `7.2` + maxLength: 255 + minLength: 1 + type: string + sizeInMBs: + description: | + The boot volume size for an instance launched from this image (1 MB = 1,048,576 bytes). + Note this is not the same as the size of the image when it was exported or the actual size of the image. + + Example: `47694` + format: int64 + type: integer + timeCreated: + description: | + The date and time the image was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - compartmentId + - id + - lifecycleState + - timeCreated + - operatingSystem + - operatingSystemVersion + - createImageAllowed + x-example: | + Example 1 + { + "baseImageId": "ocid1.image.oc1.phx.<unique_ID>", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "createImageAllowed": true, + "displayName": "MyCustomImage", + "id": "ocid1.image.oc1.phx.<unique_ID>", + "lifecycleState": "PROVISIONING", + "timeCreated": "2016-10-03T17:04:47.627Z" + } + + Example 2 + { + "baseImageId": null, + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "createImageAllowed": true, + "displayName": "MyCustomImage", + "id": "ocid1.image.oc1.phx.<unique_ID>", + "lifecycleState": "IMPORTING", + "timeCreated": "2016-10-03T17:04:47.627Z" + } + type: object + CreateImageDetails: + description: | + Either instanceId or imageSourceDetails must be provided in addition to other required parameters. + properties: + compartmentId: + description: The OCID of the compartment you want the image to be created in. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name for the image. It does not have to be unique, and it's changeable. + Avoid entering confidential information. + + You cannot use a platform image name as a custom image name. + + Example: `My Oracle Linux image` + 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 + imageSourceDetails: + $ref: '#/components/schemas/ImageSourceDetails' + instanceId: + description: | + The OCID of the instance you want to use as the basis for the image. + maxLength: 255 + minLength: 1 + type: string + launchMode: + description: | + Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: + * `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images. + * `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller. + * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. + * `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type. + * `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter. + enum: + - NATIVE + - EMULATED + - PARAVIRTUALIZED + - ACCELERATEDPV + - CUSTOM + type: string + x-obmcs-resolve-component-ref: true + launchOptions: + $ref: '#/components/schemas/LaunchOptions' + required: + - compartmentId + type: object + UpdateImageDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + operatingSystem: + description: | + Operating system + + Example: `Oracle Linux` + maxLength: 128 + minLength: 1 + type: string + operatingSystemVersion: + description: | + Operating system version + + Example: `7.4` + maxLength: 128 + minLength: 1 + type: string + type: object + ChangeImageCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the image to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ExportImageDetails: + description: | + The destination details for the image export. + + Set `destinationType` to `objectStorageTuple` + and use [ExportImageViaObjectStorageTupleDetails](#/en/iaas/latest/requests/ExportImageViaObjectStorageTupleDetails) + when specifying the namespace, bucket name, and object name. + + Set `destinationType` to `objectStorageUri` and + use [ExportImageViaObjectStorageUriDetails](#/en/iaas/latest/requests/ExportImageViaObjectStorageUriDetails) + when specifying the Object Storage URL. + discriminator: + propertyName: destinationType + properties: + destinationType: + description: | + The destination type. Use `objectStorageTuple` when specifying the namespace, bucket name, and object name. + Use `objectStorageUri` when specifying the Object Storage URL. + type: string + exportFormat: + description: | + The format to export the image to. The default value is `OCI`. + + The following image formats are available: + + - `OCI` - Oracle Cloud Infrastructure file with a QCOW2 image and Oracle Cloud Infrastructure metadata (.oci). + Use this format to export a custom image that you want to import into other tenancies or regions. + - `QCOW2` - QEMU Copy On Write (.qcow2) + - `VDI` - Virtual Disk Image (.vdi) for Oracle VM VirtualBox + - `VHD` - Virtual Hard Disk (.vhd) for Hyper-V + - `VMDK` - Virtual Machine Disk (.vmdk) + enum: + - QCOW2 + - VMDK + - OCI + - VHD + - VDI + type: string + required: + - destinationType + type: object + ImageShapeCompatibilitySummary: + description: Summary information for a compatible image and shape. + properties: + imageId: + description: The image [OCID](/iaas/Content/General/Concepts/identifiers.htm). + maxLength: 255 + minLength: 1 + type: string + memoryConstraints: + $ref: '#/components/schemas/ImageMemoryConstraints' + ocpuConstraints: + $ref: '#/components/schemas/ImageOcpuConstraints' + shape: + description: The shape name. + maxLength: 255 + minLength: 1 + type: string + required: + - imageId + - shape + x-example: | + { + "imageId":"ocid1.image.oc1.phx.<unique_ID>", + "shape":"VM.Standard.E3.Flex", + "memoryConstraints": { + "minInGBs":1, + "maxInGBs":1024 + }, + "ocpuConstraints": { + "min":1, + "max":64 + } + } + type: object + ImageShapeCompatibilityEntry: + description: An image and shape that are compatible. + properties: + imageId: + description: The image OCID. + maxLength: 255 + minLength: 1 + type: string + memoryConstraints: + $ref: '#/components/schemas/ImageMemoryConstraints' + ocpuConstraints: + $ref: '#/components/schemas/ImageOcpuConstraints' + shape: + description: The shape name. + maxLength: 255 + minLength: 1 + type: string + required: + - imageId + - shape + type: object + AddImageShapeCompatibilityEntryDetails: + description: Image shape compatibility details. + properties: + memoryConstraints: + $ref: '#/components/schemas/ImageMemoryConstraints' + ocpuConstraints: + $ref: '#/components/schemas/ImageOcpuConstraints' + type: object + InstanceConfigurationSummary: + description: | + Summary information for an instance configuration. + properties: + compartmentId: + description: | + The OCID of the compartment containing the instance configuration. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The OCID of the instance configuration. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the instance configuration was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - timeCreated + type: object + CreateInstanceConfigurationBase: + description: | + Creation details for an instance configuration. + discriminator: + propertyName: source + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment + containing the instance configuration. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + source: + default: NONE + description: | + The source of the instance configuration. An instance configuration defines the + settings to use when creating Compute instances, including details + such as the base image, shape, and metadata. You can also specify the associated resources for the + instance, such as block volume attachments and network configuration. + + When you create an instance configuration using an existing instance as a template, the instance + configuration does not include any information from the source instance's boot volume, such as installed + applications, binaries, and files on the instance. It also does not include the contents of + any block volumes that are attached to the instance. + + To create an instance configuration that includes the custom setup from an instance's boot volume, you + must first create a custom image from the instance (see [CreateImage](#/en/iaas/latest/Image/CreateImage)). + Then, use the custom image to launch a new instance + (see [LaunchInstance](#/en/iaas/latest/Instance/LaunchInstance)). Finally, create the instance + configuration based on the instance that you created from the custom image. + + To include block volume contents with an instance configuration, first create a backup of the attached block volumes + (see [CreateVolumeBackup](#/en/iaas/latest/VolumeBackup/CreateVolumeBackup)). Then, create the instance + configuration by specifying the list of settings, using + [InstanceConfigurationVolumeSourceFromVolumeBackupDetails](#/en/iaas/latest/datatypes/InstanceConfigurationVolumeSourceFromVolumeBackupDetails) + to include the block volume backups in the list of settings. + + The following values are supported: + + * `NONE`: Creates an instance configuration using the list of settings that you specify. + * `INSTANCE`: Creates an instance configuration using an existing instance as a template. + enum: + - NONE + - INSTANCE + type: string + required: + - compartmentId + type: object + InstanceConfiguration: + description: | + An instance configuration is a template that defines the settings to use when creating Compute instances. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment + containing the instance configuration. + maxLength: 255 + minLength: 1 + type: string + deferredFields: + description: | + Parameters that were not specified when the instance configuration was created, but that + are required to launch an instance from the instance configuration. See the + [LaunchInstanceConfiguration](#/en/iaas/latest/Instance/LaunchInstanceConfiguration) operation. + items: + type: string + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance configuration. + maxLength: 255 + minLength: 1 + type: string + instanceDetails: + $ref: '#/components/schemas/InstanceConfigurationInstanceDetails' + timeCreated: + description: | + The date and time the instance configuration was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - timeCreated + x-example: | + { + "compartmentId" : "ocid1.tenancy.oc1..<unique_ID>", + "definedTags":{}, + "displayName" : "example-instance-configuration", + "freeformTags":{}, + "id" : "ocid1.instanceconfiguration.oc1.phx.<unique_ID>", + "instanceDetails" : { + "instanceType" : "compute", + "launchDetails" : { + "compartmentId" : "ocid1.tenancy.oc1..<unique_ID>", + "createVnicDetails" : { + "assignPublicIp" : false, + "displayName" : "example-vnic", + "skipSourceDestCheck" : false + }, + "displayName" : "My instance", + "shape" : "VM.Standard2.1", + "sourceDetails" : { + "sourceType" : "image", + "imageId" : "ocid1.image.oc1.phx.<unique_ID>" + } + } + }, + "deferredFields" : [ + "instanceDetails.launchDetails.availabilityDomain", + "instanceDetails.launchDetails.createVnicDetails.subnetId" + ], + "timeCreated" : "2019-06-13T21:13:32.830Z" + } + type: object + UpdateInstanceConfigurationDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + ChangeInstanceConfigurationCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to + move the instance configuration to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + InstanceConfigurationInstanceDetails: + discriminator: + propertyName: instanceType + properties: + instanceType: + default: compute + description: | + The type of instance details. Supported instanceType is compute + type: string + required: + - instanceType + type: object + Instance: + description: | + A compute host. The image used to launch the instance determines its operating system and other + software. The shape specified during the launch process determines the number of CPUs and memory + allocated to the instance. + + When you launch an instance, it is automatically attached to a virtual + network interface card (VNIC), called the *primary VNIC*. The VNIC + has a private IP address from the subnet's CIDR. You can either assign a + private IP address of your choice or let Oracle automatically assign one. + You can choose whether the instance has a public IP address. To retrieve the + addresses, use the [ListVnicAttachments](#/en/iaas/latest/VnicAttachment/ListVnicAttachments) + operation to get the VNIC ID for the instance, and then call + [GetVnic](#/en/iaas/latest/Vnic/GetVnic) with the VNIC ID. + + For more information, see + [Overview of the Compute Service](/iaas/Content/Compute/Concepts/computeoverview.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + properties: + agentConfig: + $ref: '#/components/schemas/InstanceAgentConfig' + availabilityConfig: + $ref: '#/components/schemas/InstanceAvailabilityConfig' + availabilityDomain: + description: | + The availability domain the instance is running in. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + capacityReservationId: + description: | + The OCID of the compute capacity reservation this instance is launched under. + When this field contains an empty string or is null, the instance is not currently in a capacity reservation. + For more information, see [Capacity Reservations](/iaas/Content/Compute/Tasks/reserve-capacity.htm#default). + maxLength: 255 + minLength: 0 + type: string + x-default-description: | + The default reservation here refers to the reservation which is enabled by default for your tenancy. + If the value of this field is empty that means you have opted out of the default reservation. + clusterPlacementGroupId: + description: The OCID of the cluster placement group of the instance. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment that contains the instance. + maxLength: 255 + minLength: 1 + type: string + dedicatedVmHostId: + description: | + The OCID of the dedicated virtual machine host that the instance is placed on. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + extendedMetadata: + additionalProperties: + type: string + description: (opaque JSON object) + description: | + Additional metadata key/value pairs that you provide. They serve the same purpose and functionality + as fields in the `metadata` object. + + They are distinguished from `metadata` fields in that these can be nested JSON objects (whereas `metadata` + fields are string/string maps only). + type: object + faultDomain: + description: | + The name of the fault domain the instance is running in. + + A fault domain is a grouping of hardware and infrastructure within an availability domain. + Each availability domain contains three fault domains. Fault domains let you distribute your + instances so that they are not on the same physical hardware within a single availability domain. + A hardware failure or Compute hardware maintenance that affects one fault domain does not affect + instances in other fault domains. + + If you do not specify the fault domain, the system selects one for you. + + Example: `FAULT-DOMAIN-1` + 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 + id: + description: The OCID of the instance. + maxLength: 255 + minLength: 1 + type: string + imageId: + description: | + Deprecated. Use `sourceDetails` instead. + maxLength: 255 + minLength: 1 + type: string + instanceConfigurationId: + description: The OCID of the Instance Configuration used to source launch details for this instance. Any other fields supplied in the instance launch request override the details stored in the Instance Configuration for this instance launch. + type: string + instanceOptions: + $ref: '#/components/schemas/InstanceOptions' + ipxeScript: + description: | + When a bare metal or virtual machine + instance boots, the iPXE firmware that runs on the instance is + configured to run an iPXE script to continue the boot process. + + If you want more control over the boot process, you can provide + your own custom iPXE script that will run when the instance boots. + Be aware that the same iPXE script will run + every time an instance boots, not only after the initial + LaunchInstance call. + + The default iPXE script connects to the instance's local boot + volume over iSCSI and performs a network boot. If you use a custom iPXE + script and want to network-boot from the instance's local boot volume + over iSCSI the same way as the default iPXE script, use the + following iSCSI IP address: 169.254.0.2, and boot volume IQN: + iqn.2015-02.oracle.boot. + + If your instance boot volume attachment type is paravirtualized, + the boot volume is attached to the instance through virtio-scsi and no iPXE script is used. + If your instance boot volume attachment type is paravirtualized + and you use custom iPXE to network boot into your instance, + the primary boot volume is attached as a data volume through virtio-scsi drive. + + For more information about the Bring Your Own Image feature of + Oracle Cloud Infrastructure, see + [Bring Your Own Image](/iaas/Content/Compute/References/bringyourownimage.htm). + + For more information about iPXE, see http://ipxe.org. + maxLength: 10240 + minLength: 1 + type: string + isAIEnterpriseEnabled: + default: false + description: | + Whether AI enterprise is enabled on the instance. + type: boolean + launchMode: + description: | + Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: + * `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images. + * `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller. + * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. + * `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type. + * `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter. + enum: + - NATIVE + - EMULATED + - PARAVIRTUALIZED + - ACCELERATEDPV + - CUSTOM + type: string + x-obmcs-resolve-component-ref: true + launchOptions: + $ref: '#/components/schemas/LaunchOptions' + licensingConfigs: + description: List of licensing configurations associated with the instance. + items: + $ref: '#/components/schemas/LicensingConfig' + type: array + lifecycleState: + description: The current state of the instance. + enum: + - MOVING + - PROVISIONING + - RUNNING + - STARTING + - STOPPING + - STOPPED + - CREATING_IMAGE + - TERMINATING + - TERMINATED + type: string + metadata: + additionalProperties: + type: string + description: Custom metadata that you provide. + type: object + placementConstraintDetails: + $ref: '#/components/schemas/PlacementConstraintDetails' + platformConfig: + $ref: '#/components/schemas/PlatformConfig' + preemptibleInstanceConfig: + $ref: '#/components/schemas/PreemptibleInstanceConfigDetails' + region: + description: | + The region that contains the availability domain the instance is running in. + + For the us-phoenix-1 and us-ashburn-1 regions, `phx` and `iad` are returned, respectively. + For all other regions, the full region name is returned. + + Examples: `phx`, `eu-frankfurt-1` + maxLength: 255 + minLength: 1 + type: string + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). + type: object + description: | + [Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels + for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) + (ZPR) policy to control access to ZPR-supported resources. + + Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}` + type: object + securityAttributesState: + description: The lifecycle state of the `securityAttributes` + enum: + - STABLE + - UPDATING + type: string + shape: + description: | + The shape of the instance. The shape determines the number of CPUs and the amount of memory + allocated to the instance. You can enumerate all available shapes by calling + [ListShapes](#/en/iaas/latest/Shape/ListShapes). + maxLength: 255 + minLength: 1 + type: string + shapeConfig: + $ref: '#/components/schemas/InstanceShapeConfig' + sourceDetails: + $ref: '#/components/schemas/InstanceSourceDetails' + timeCreated: + description: | + The date and time the instance was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeMaintenanceRebootDue: + description: | + The date and time the instance is expected to be stopped / started, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. + Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. + Example: `2018-05-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - shape + - region + - availabilityDomain + - lifecycleState + - timeCreated + type: object + InstanceConsoleConnection: + description: | + The `InstanceConsoleConnection` API provides you with console access to Compute instances, + enabling you to troubleshoot malfunctioning instances remotely. + + For more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](/iaas/Content/Compute/References/serialconsole.htm). + properties: + compartmentId: + description: The OCID of the compartment to contain the console connection. + maxLength: 255 + minLength: 1 + type: string + connectionString: + description: The SSH connection string for the console connection. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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 + fingerprint: + description: The SSH public key's fingerprint for client authentication to the console connection. + 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 + id: + description: The OCID of the console connection. + type: string + instanceId: + description: The OCID of the instance the console connection connects to. + type: string + lifecycleState: + description: The current state of the console connection. + enum: + - ACTIVE + - CREATING + - DELETED + - DELETING + - FAILED + type: string + serviceHostKeyFingerprint: + description: The SSH public key's fingerprint for the console connection service host. + type: string + vncConnectionString: + description: | + The SSH connection string for the SSH tunnel used to + connect to the console connection over VNC. + type: string + x-example: | + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "connectionString": "ssh -o ProxyCommand='ssh -W %h:%p -p 443 ocid1.instanceconsoleconnection.oc1.iad.<unique_ID>@instance-console.us-ashburn-1.oraclecloud.com' ocid1.instance.oc1.iad.<unique_ID>", + "vncConnectionString": "ssh -L 5900:ocid1.instance.oc1.iad.<unique_ID> -N ocid1.instanceconsoleconnection.oc1.iad.<unique_ID>@instance-console.us-ashburn-1.oraclecloud.com ", + "fingerprint": "00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:aa", + "id": "ocid1.instanceconsoleconnection.oc1.iad.<unique_ID>", + "instanceId": "ocid1.instance.oc1.iad.<unique_ID>", + "lifecycleState": "ACTIVE", + } + type: object + CreateInstanceConsoleConnectionDetails: + description: | + The details for creating a instance console connection. + The instance console connection is created in the same compartment as the instance. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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 + instanceId: + description: The OCID of the instance to create the console connection to. + type: string + publicKey: + description: The SSH public key used to authenticate the console connection. + format: ssh-authorized-key + type: string + required: + - instanceId + - publicKey + type: object + UpdateInstanceConsoleConnectionDetails: + description: | + Specifies the properties for updating tags for an instance console connection. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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 + type: object + ConsoleHistory: + description: | + An instance's serial console data. It includes configuration messages that occur when the + instance boots, such as kernel and BIOS messages, and is useful for checking the status of + the instance or diagnosing problems. The console data is minimally formatted ASCII text. + + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + properties: + availabilityDomain: + description: | + The availability domain of an instance. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The OCID of the console history metadata object. + maxLength: 255 + minLength: 1 + type: string + instanceId: + description: The OCID of the instance this console history was fetched from. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the console history. + enum: + - REQUESTED + - GETTING-HISTORY + - SUCCEEDED + - FAILED + type: string + timeCreated: + description: | + The date and time the history was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - lifecycleState + - availabilityDomain + - timeCreated + - instanceId + type: object + CaptureConsoleHistoryDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + instanceId: + description: The OCID of the instance to get the console history from. + maxLength: 255 + minLength: 1 + type: string + required: + - instanceId + type: object + UpdateConsoleHistoryDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + InstanceMaintenanceEventSummary: + description: | + It is the event in which the maintenance action will be be performed on the customer instance on the scheduled date and time. + properties: + alternativeResolutionActions: + description: | + These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance. + items: + enum: + - REBOOT_MIGRATION + - TERMINATE + type: string + x-obmcs-top-level-enum: '#/definitions/InstanceMaintenanceAlternativeResolutionActions' + type: array + canReschedule: + description: | + Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate. + type: boolean + compartmentId: + description: | + The OCID of the compartment that contains the instance. + maxLength: 255 + minLength: 1 + type: string + correlationToken: + description: | + A unique identifier that will group Instances that have a relationship with one another and must be scheduled + together for the Maintenance to proceed. Any Instances that have a relationship with one another from a Maintenance + perspective will have a matching correlationToken. + maxLength: 255 + minLength: 1 + type: string + createdBy: + description: | + The creator of the maintenance event. + type: string + x-obmcs-enumref: '#/definitions/InstanceMaintenanceEvent/createdBy' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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 + description: + description: | + It is the descriptive information about the maintenance taking place on the customer instance. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + estimatedDuration: + description: | + This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state. + format: x-obmcs-duration + 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 + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the maintenance event. + maxLength: 255 + minLength: 1 + type: string + instanceAction: + description: | + This is the action that will be performed on the Instance by OCI when the Maintenance begins. + type: string + x-obmcs-enumref: '#/definitions/InstanceMaintenanceEvent/instanceAction' + instanceId: + description: The OCID of the instance. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: | + The current state of the maintenance event. + type: string + x-obmcs-enumref: '#/definitions/InstanceMaintenanceEvent/lifecycleState' + maintenanceCategory: + description: | + This indicates the priority and allowed actions for this Maintenance. Higher priority forms of Maintenance have + tighter restrictions and may not be rescheduled, while lower priority/severity Maintenance can be rescheduled, + deferred, or even cancelled. Please see the + [Instance Maintenance](/iaas/Content/Compute/Tasks/placeholder.htm) documentation for details. + type: string + x-obmcs-enumref: '#/definitions/InstanceMaintenanceEvent/maintenanceCategory' + maintenanceReason: + description: | + This is the reason that Maintenance is being performed. See + [Instance Maintenance](/iaas/Content/Compute/Tasks/placeholder.htm) documentation for details. + type: string + x-obmcs-enumref: '#/definitions/InstanceMaintenanceEvent/maintenanceReason' + startWindowDuration: + description: | + The duration of the time window Maintenance is scheduled to begin within. + format: x-obmcs-duration + type: string + timeCreated: + description: | + The date and time the maintenance event was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeFinished: + description: | + The time at which the Maintenance actually finished. + format: date-time + type: string + timeHardDueDate: + description: | + It is the scheduled hard due date and time of the maintenance event. + The maintenance event will happen at this time and the due date will not be extended. + format: date-time + type: string + timeStarted: + description: | + The time at which the Maintenance actually started. + format: date-time + type: string + timeWindowStart: + description: | + The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before + this time. + format: date-time + type: string + required: + - id + - instanceId + - compartmentId + - instanceAction + - timeWindowStart + - timeCreated + - canReschedule + - maintenanceReason + - lifecycleState + - createdBy + - maintenanceCategory + - alternativeResolutionActions + type: object + InstanceMaintenanceEvent: + description: | + It is the event in which the maintenance action will be be performed on the customer instance on the scheduled date and time. + properties: + additionalDetails: + additionalProperties: + type: string + description: | + Additional details of the maintenance in the form of json. + type: object + alternativeResolutionActions: + description: | + These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance. + items: + enum: + - REBOOT_MIGRATION + - TERMINATE + type: string + x-obmcs-top-level-enum: '#/definitions/InstanceMaintenanceAlternativeResolutionActions' + type: array + canDeleteLocalStorage: + description: | + For Instances that have local storage, this field is set to true when local storage + will be deleted as a result of the Maintenance. + type: boolean + canReschedule: + description: | + Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate. + type: boolean + compartmentId: + description: | + The OCID of the compartment that contains the instance. + maxLength: 255 + minLength: 1 + type: string + correlationToken: + description: | + A unique identifier that will group Instances that have a relationship with one another and must be scheduled + together for the Maintenance to proceed. Any Instances that have a relationship with one another from a Maintenance + perspective will have a matching correlationToken. + maxLength: 255 + minLength: 1 + type: string + createdBy: + description: | + The creator of the maintenance event. + enum: + - CUSTOMER + - SYSTEM + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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 + description: + description: | + It is the descriptive information about the maintenance taking place on the customer instance. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + estimatedDuration: + description: | + This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state. + format: x-obmcs-duration + 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 + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the maintenance event. + maxLength: 255 + minLength: 1 + type: string + instanceAction: + description: | + This is the action that will be performed on the Instance by OCI when the Maintenance begins. + enum: + - REBOOT_MIGRATION + - TERMINATE + - STOP + - NONE + type: string + instanceId: + description: The OCID of the instance. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: | + Provides more details about the state of the maintenance event. + type: string + lifecycleState: + description: | + The current state of the maintenance event. + enum: + - SCHEDULED + - STARTED + - PROCESSING + - SUCCEEDED + - FAILED + - CANCELED + type: string + maintenanceCategory: + description: | + This indicates the priority and allowed actions for this Maintenance. Higher priority forms of Maintenance have + tighter restrictions and may not be rescheduled, while lower priority/severity Maintenance can be rescheduled, + deferred, or even cancelled. Please see the + [Instance Maintenance](/iaas/Content/Compute/Tasks/placeholder.htm) documentation for details. + enum: + - EMERGENCY + - MANDATORY + - FLEXIBLE + - OPTIONAL + - NOTIFICATION + type: string + maintenanceReason: + description: | + This is the reason that Maintenance is being performed. See + [Instance Maintenance](/iaas/Content/Compute/Tasks/placeholder.htm) documentation for details. + enum: + - EVACUATION + - ENVIRONMENTAL_FACTORS + - DECOMMISSION + - HARDWARE_REPLACEMENT + - FIRMWARE_UPDATE + - SECURITY_UPDATE + type: string + startWindowDuration: + description: | + The duration of the time window Maintenance is scheduled to begin within. + format: x-obmcs-duration + type: string + timeCreated: + description: | + The date and time the maintenance event was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeFinished: + description: | + The time at which the Maintenance actually finished. + format: date-time + type: string + timeHardDueDate: + description: | + It is the scheduled hard due date and time of the maintenance event. + The maintenance event will happen at this time and the due date will not be extended. + format: date-time + type: string + timeStarted: + description: | + The time at which the Maintenance actually started. + format: date-time + type: string + timeWindowStart: + description: | + The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before + this time. + format: date-time + type: string + required: + - id + - instanceId + - compartmentId + - instanceAction + - timeWindowStart + - timeCreated + - canReschedule + - maintenanceReason + - lifecycleState + - createdBy + - maintenanceCategory + - alternativeResolutionActions + type: object + UpdateInstanceMaintenanceEventDetails: + description: | + Specifies the properties for updating maintenance due date. + properties: + alternativeResolutionAction: + description: | + One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent. + enum: + - REBOOT_MIGRATION + - TERMINATE + type: string + x-obmcs-top-level-enum: '#/definitions/InstanceMaintenanceAlternativeResolutionActions' + canDeleteLocalStorage: + description: | + This field is only applicable when setting the alternativeResolutionAction. + + For Instances that have local storage, this must be set to true to verify that the local storage + will be deleted during the migration. For instances without, this parameter has no effect. + + In cases where the local storage will be lost, this parameter must be set or the request will fail. + type: boolean + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + timeWindowStart: + description: | + The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before + this time. + + The timeWindowEnd is automatically calculated based on the maintenanceReason and the instanceAction. + format: date-time + type: string + type: object + InstancePoolSummary: + description: Summary information for an instance pool. + properties: + availabilityDomains: + description: The availability domains for the instance pool. + items: + type: string + maxLength: 255 + minItems: 1 + minLength: 1 + type: array + compartmentId: + description: The OCID of the compartment containing the instance pool. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The OCID of the instance pool. + maxLength: 255 + minLength: 1 + type: string + instanceConfigurationId: + description: The OCID of the instance configuration associated with the instance pool. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the instance pool. + enum: + - PROVISIONING + - SCALING + - STARTING + - STOPPING + - TERMINATING + - STOPPED + - TERMINATED + - RUNNING + type: string + size: + description: The number of instances that should be in the instance pool. + type: integer + timeCreated: + description: | + The date and time the instance pool was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - instanceConfigurationId + - lifecycleState + - size + - timeCreated + - availabilityDomains + type: object + CreateInstancePoolDetails: + description: | + The data to create an instance pool. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the instance pool. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + instanceConfigurationId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance configuration associated + with the instance pool. + maxLength: 255 + minLength: 1 + type: string + instanceDisplayNameFormatter: + description: | + A user-friendly formatter for the instance pool's instances. Instance displaynames follow the format. + The formatter does not retroactively change instance's displaynames, only instance displaynames in the future follow the format + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + instanceHostnameFormatter: + description: | + A user-friendly formatter for the instance pool's instances. Instance hostnames follow the format. + The formatter does not retroactively change instance's hostnames, only instance hostnames in the future follow the format + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + lifecycleManagement: + $ref: '#/components/schemas/InstancePoolLifecycleManagementDetails' + loadBalancers: + description: | + The load balancers to attach to the instance pool. + items: + $ref: '#/components/schemas/AttachLoadBalancerDetails' + type: array + placementConfigurations: + description: | + The placement configurations for the instance pool. Provide one placement configuration for + each availability domain. + + To use the instance pool with a regional subnet, provide a placement configuration for + each availability domain, and include the regional subnet in each placement + configuration. + To use compute cluster with instance pool, provide a single placement configuration. + items: + $ref: '#/components/schemas/CreateInstancePoolPlacementConfigurationDetails' + type: array + size: + description: | + The number of instances that should be in the instance pool. + type: integer + required: + - compartmentId + - instanceConfigurationId + - placementConfigurations + - size + type: object + InstancePool: + description: | + An instance pool is a set of instances within the same region that are managed as a group. + For more information about instance pools and instance configurations, see + [Managing Compute Instances](/iaas/Content/Compute/Concepts/instancemanagement.htm). + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the instance + pool. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool. + maxLength: 255 + minLength: 1 + type: string + instanceConfigurationId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance configuration associated + with the instance pool. + maxLength: 255 + minLength: 1 + type: string + instanceDisplayNameFormatter: + description: | + A user-friendly formatter for the instance pool's instances. Instance displaynames follow the format. + The formatter does not retroactively change instance's displaynames, only instance displaynames in the future follow the format + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + instanceHostnameFormatter: + description: | + A user-friendly formatter for the instance pool's instances. Instance hostnames follow the format. + The formatter does not retroactively change instance's hostnames, only instance hostnames in the future follow the format + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + lifecycleManagement: + $ref: '#/components/schemas/InstancePoolLifecycleManagementDetails' + lifecycleState: + description: The current state of the instance pool. + enum: + - PROVISIONING + - SCALING + - STARTING + - STOPPING + - TERMINATING + - STOPPED + - TERMINATED + - RUNNING + type: string + loadBalancers: + description: | + The load balancers attached to the instance pool. + items: + $ref: '#/components/schemas/InstancePoolLoadBalancerAttachment' + type: array + placementConfigurations: + description: The placement configurations for the instance pool. + items: + $ref: '#/components/schemas/InstancePoolPlacementConfiguration' + type: array + size: + description: The number of instances that should be in the instance pool. + type: integer + timeCreated: + description: | + The date and time the instance pool was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - instanceConfigurationId + - lifecycleState + - placementConfigurations + - size + - timeCreated + x-example: | + { + "id": "ocid1.instancepool.phx....<unique_ID>", + "displayName": "autoscaling-instance-pool", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "instanceConfigurationId": "ocid1.instanceconfiguration.oc1..<unique_ID>", + "lifecycleState": "PROVISIONING", + "placementConfigurations": [ + { + "availabilityDomain": "Uocm:PHX-AD-1", + "primarySubnetId": "ocid1.subnet.oc1..<unique_ID>" + }, + { + "availabilityDomain": "Uocm:PHX-AD-2", + "primarySubnetId": "ocid1.subnet.oc1..<unique_ID>" + }, + { + "availabilityDomain": "Uocm:PHX-AD-3", + "primarySubnetId": "ocid1.subnet.oc1..<unique_ID>" + } + ], + "size": 15, + "timeCreated": "2019-04-10T17:04:47.627Z", + "loadBalancers": [ + { + "id" : "ocid1.loadbalancerattachment.oc1.phx.<unique_ID>", + "instancePoolId" : "ocid1.instancepool.oc1.phx.<unique_ID>", + "loadBalancerId" : "ocid1.loadbalancer.oc1.phx.<unique_ID>", + "backendSetName" : "lb-20190410-1147-backend-set", + "port" : 80, + "vnicSelection" : "PrimaryVnic", + "lifecycleState" : "ATTACHING" + } + ] + } + type: object + UpdateInstancePoolDetails: + description: The data to update an instance pool. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + instanceConfigurationId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance configuration associated with the + instance pool. + maxLength: 255 + minLength: 1 + type: string + instanceDisplayNameFormatter: + description: | + A user-friendly formatter for the instance pool's instances. Instance displaynames follow the format. + The formatter does not retroactively change instance's displaynames, only instance displaynames in the future follow the format + maxLength: 255 + minLength: 0 + type: string + x-default-description: 'null' + instanceHostnameFormatter: + description: | + A user-friendly formatter for the instance pool's instances. Instance hostnames follow the format. + The formatter does not retroactively change instance's hostnames, only instance hostnames in the future follow the format + maxLength: 255 + minLength: 0 + type: string + x-default-description: 'null' + lifecycleManagement: + $ref: '#/components/schemas/InstancePoolLifecycleManagementDetails' + placementConfigurations: + description: | + The placement configurations for the instance pool. Provide one placement configuration for + each availability domain. + + To use the instance pool with a regional subnet, provide a placement configuration for + each availability domain, and include the regional subnet in each placement + configuration. + items: + $ref: '#/components/schemas/UpdateInstancePoolPlacementConfigurationDetails' + type: array + size: + description: | + The number of instances that should be in the instance pool. + + To determine whether capacity is available for a specific shape before you resize an instance pool, + use the [CreateComputeCapacityReport](#/en/iaas/latest/ComputeCapacityReport/CreateComputeCapacityReport) + operation. + type: integer + type: object + AttachLoadBalancerDetails: + description: Represents a load balancer that is to be attached to an instance pool. + properties: + backendSetName: + description: The name of the backend set on the load balancer to add instances to. + maxLength: 255 + minLength: 1 + type: string + loadBalancerId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the load balancer to attach to the instance pool. + maxLength: 255 + minLength: 1 + type: string + port: + description: The port value to use when creating the backend set. + maximum: 65535 + minimum: 1 + type: integer + vnicSelection: + description: | + Indicates which VNIC on each instance in the pool should be used to associate with the load balancer. + Possible values are "PrimaryVnic" or the displayName of one of the secondary VNICs on the instance configuration + that is associated with the instance pool. + maxLength: 255 + minLength: 1 + type: string + required: + - loadBalancerId + - backendSetName + - port + - vnicSelection + type: object + ChangeInstancePoolCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to + move the instance pool to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + DetachInstancePoolInstanceDetails: + description: | + An instance that is to be detached from an instance pool. + properties: + instanceId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance. + maxLength: 255 + minLength: 1 + type: string + isAutoTerminate: + default: false + description: | + Whether to permanently terminate (delete) the instance and its attached boot volume + when detaching it from the instance pool. Default is `false`. + type: boolean + isDecrementSize: + default: true + description: | + Whether to decrease the size of the instance pool when the instance is detached. If `true`, the + pool size is decreased. If `false`, the pool will provision a new, replacement instance + using the pool's instance configuration as a template. Default is `true`. + type: boolean + required: + - instanceId + type: object + DetachLoadBalancerDetails: + description: Represents a load balancer that is to be detached from an instance pool. + properties: + backendSetName: + description: The name of the backend set on the load balancer to detach from the instance pool. + maxLength: 255 + minLength: 1 + type: string + loadBalancerId: + description: The OCID of the load balancer to detach from the instance pool. + maxLength: 255 + minLength: 1 + type: string + required: + - loadBalancerId + - backendSetName + type: object + TerminationProceedInstancePoolInstanceDetails: + description: | + An instance to be marked for termination in an instance pool. + properties: + instanceId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance. + maxLength: 255 + minLength: 1 + type: string + required: + - instanceId + type: object + AttachInstancePoolInstanceDetails: + description: | + An instance that is to be attached to an instance pool. + properties: + instanceId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance. + maxLength: 255 + minLength: 1 + type: string + required: + - instanceId + type: object + InstancePoolInstance: + description: Information about an instance that belongs to an instance pool. + properties: + availabilityDomain: + description: The availability domain the instance is running in. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the + instance. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + faultDomain: + description: The fault domain the instance is running in. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance. + maxLength: 255 + minLength: 1 + type: string + instanceConfigurationId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance configuration + used to create the instance. + maxLength: 255 + minLength: 1 + type: string + instancePoolId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The attachment state of the instance in relation to the instance pool. + enum: + - ATTACHING + - ACTIVE + - DETACHING + - TERMINATION_AWAIT + - TERMINATION_PROCEED + type: string + loadBalancerBackends: + description: | + The load balancer backends that are configured for the instance. + items: + $ref: '#/components/schemas/InstancePoolInstanceLoadBalancerBackend' + type: array + region: + description: The region that contains the availability domain the instance is running in. + maxLength: 255 + minLength: 1 + type: string + shape: + description: | + The shape of the instance. The shape determines the number of CPUs, amount of memory, + and other resources allocated to the instance. + maxLength: 255 + minLength: 1 + type: string + state: + description: The lifecycle state of the instance. Refer to `lifecycleState` in the [Instance](#/en/iaas/latest/Instance) resource. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the instance pool instance was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - instancePoolId + - availabilityDomain + - lifecycleState + - compartmentId + - instanceConfigurationId + - region + - shape + - state + - timeCreated + type: object + InstancePoolLoadBalancerAttachment: + description: Represents a load balancer that is attached to an instance pool. + properties: + backendSetName: + description: The name of the backend set on the load balancer. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment. + maxLength: 255 + minLength: 1 + type: string + instancePoolId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool of the load balancer attachment. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The status of the interaction between the instance pool and the load balancer. + enum: + - ATTACHING + - ATTACHED + - DETACHING + - DETACHED + type: string + loadBalancerId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attached to the instance pool. + maxLength: 255 + minLength: 1 + type: string + port: + description: The port value used for the backends. + maximum: 65535 + minimum: 1 + type: integer + vnicSelection: + description: | + Indicates which VNIC on each instance in the instance pool should be used to associate with the load balancer. + Possible values are "PrimaryVnic" or the displayName of one of the secondary VNICs on the instance configuration + that is associated with the instance pool. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - instancePoolId + - loadBalancerId + - backendSetName + - port + - vnicSelection + - lifecycleState + type: object + LaunchInstanceDetails: + description: | + Instance launch details. + Use the `sourceDetails` parameter to specify whether a boot volume or an image should be used to launch a new instance. + properties: + agentConfig: + $ref: '#/components/schemas/LaunchInstanceAgentConfigDetails' + availabilityConfig: + $ref: '#/components/schemas/LaunchInstanceAvailabilityConfigDetails' + availabilityDomain: + description: | + The availability domain of the instance. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + capacityReservationId: + description: | + The OCID of the compute capacity reservation this instance is launched under. + You can opt out of all default reservations by specifying an empty string as input for this field. + For more information, see [Capacity Reservations](/iaas/Content/Compute/Tasks/reserve-capacity.htm#default). + maxLength: 255 + minLength: 0 + type: string + x-default-description: | + A default reservation refers to the reservation into which all instance launches are first attempted. + If an instance is launched without specifying a reservation ID or if a reservation ID is not present in the JSON input, + the instance is automatically launched under this reservation. To opt out, include capacityReservationId: "" in your JSON input. + Using an empty string for this field value causes the instance to be launched as a normal instance and not under the default reservation. + clusterPlacementGroupId: + description: The OCID of the cluster placement group of the instance. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeClusterId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the + [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) that the instance will be created in. + maxLength: 255 + minLength: 1 + type: string + createVnicDetails: + $ref: '#/components/schemas/CreateVnicDetails' + dedicatedVmHostId: + description: | + The OCID of the dedicated virtual machine host to place the instance on. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + extendedMetadata: + additionalProperties: + type: string + description: (opaque JSON object) + description: | + Additional metadata key/value pairs that you provide. They serve the same purpose and + functionality as fields in the `metadata` object. + + They are distinguished from `metadata` fields in that these can be nested JSON objects + (whereas `metadata` fields are string/string maps only). + + The combined size of the `metadata` and `extendedMetadata` objects can be a maximum of + 32,000 bytes. + type: object + faultDomain: + description: | + A fault domain is a grouping of hardware and infrastructure within an availability domain. + Each availability domain contains three fault domains. Fault domains let you distribute your + instances so that they are not on the same physical hardware within a single availability domain. + A hardware failure or Compute hardware maintenance that affects one fault domain does not affect + instances in other fault domains. + + If you do not specify the fault domain, the system selects one for you. + + + To get a list of fault domains, use the + [ListFaultDomains](#/en/identity/20160918/FaultDomain/ListFaultDomains) operation in the + Identity and Access Management Service API. + + Example: `FAULT-DOMAIN-1` + 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 + hostnameLabel: + description: | + Deprecated. Instead use `hostnameLabel` in + [CreateVnicDetails](#/en/iaas/latest/CreateVnicDetails/). + If you provide both, the values must match. + maxLength: 63 + minLength: 1 + type: string + imageId: + description: | + Deprecated. Use `sourceDetails` with [InstanceSourceViaImageDetails](#/en/iaas/latest/requests/InstanceSourceViaImageDetails) + source type instead. If you specify values for both, the values must match. + maxLength: 255 + minLength: 1 + type: string + instanceConfigurationId: + description: The OCID of the Instance Configuration containing instance launch details. Any other fields supplied in this instance launch request will override the details stored in the Instance Configuration for this instance launch. + type: string + instanceOptions: + $ref: '#/components/schemas/InstanceOptions' + ipxeScript: + description: | + This is an advanced option. + + When a bare metal or virtual machine + instance boots, the iPXE firmware that runs on the instance is + configured to run an iPXE script to continue the boot process. + + If you want more control over the boot process, you can provide + your own custom iPXE script that will run when the instance boots. + Be aware that the same iPXE script will run + every time an instance boots, not only after the initial + LaunchInstance call. + + The default iPXE script connects to the instance's local boot + volume over iSCSI and performs a network boot. If you use a custom iPXE + script and want to network-boot from the instance's local boot volume + over iSCSI the same way as the default iPXE script, use the + following iSCSI IP address: 169.254.0.2, and boot volume IQN: + iqn.2015-02.oracle.boot. + + If your instance boot volume attachment type is paravirtualized, + the boot volume is attached to the instance through virtio-scsi and no iPXE script is used. + If your instance boot volume attachment type is paravirtualized + and you use custom iPXE to network boot into your instance, + the primary boot volume is attached as a data volume through virtio-scsi drive. + + For more information about the Bring Your Own Image feature of + Oracle Cloud Infrastructure, see + [Bring Your Own Image](/iaas/Content/Compute/References/bringyourownimage.htm). + + For more information about iPXE, see http://ipxe.org. + maxLength: 10240 + minLength: 1 + type: string + isAIEnterpriseEnabled: + default: false + description: | + Whether to enable AI enterprise on the instance. + type: boolean + isPvEncryptionInTransitEnabled: + description: Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false. + type: boolean + launchMode: + description: | + Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: + * `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images. + * `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller. + * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. + * `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type. + * `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter. + enum: + - NATIVE + - EMULATED + - PARAVIRTUALIZED + - ACCELERATEDPV + - CUSTOM + type: string + x-obmcs-resolve-component-ref: true + launchOptions: + $ref: '#/components/schemas/LaunchOptions' + launchVolumeAttachments: + description: Volume attachments to create as part of the launch instance operation. + items: + $ref: '#/components/schemas/LaunchAttachVolumeDetails' + type: array + licensingConfigs: + description: List of licensing configurations associated with target launch values. + items: + $ref: '#/components/schemas/LaunchInstanceLicensingConfig' + type: array + metadata: + additionalProperties: + type: string + description: | + Custom metadata key/value pairs that you provide, such as the SSH public key + required to connect to the instance. + + A metadata service runs on every launched instance. The service is an HTTP + endpoint listening on 169.254.169.254. You can use the service to: + + * Provide information to [Cloud-Init](https://cloudinit.readthedocs.org/en/latest/) + to be used for various system initialization tasks. + + * Get information about the instance, including the custom metadata that you + provide when you launch the instance. + + **Providing Cloud-Init Metadata** + + You can use the following metadata key names to provide information to + Cloud-Init: + + **"ssh_authorized_keys"** - Provide one or more public SSH keys to be + included in the `~/.ssh/authorized_keys` file for the default user on the + instance. Use a newline character to separate multiple keys. The SSH + keys must be in the format necessary for the `authorized_keys` file, as shown + in the example below. + + **"user_data"** - Provide your own base64-encoded data to be used by + Cloud-Init to run custom scripts or provide custom Cloud-Init configuration. For + information about how to take advantage of user data, see the + [Cloud-Init Documentation](http://cloudinit.readthedocs.org/en/latest/topics/format.html). + + **Metadata Example** + + "metadata" : { + "quake_bot_level" : "Severe", + "ssh_authorized_keys" : "ssh-rsa == rsa-key-20160227", + "user_data" : "==" + } + **Getting Metadata on the Instance** + + To get information about your instance, connect to the instance using SSH and issue any of the + following GET requests: + + curl -H "Authorization: Bearer Oracle" http://169.254.169.254/opc/v2/instance/ + curl -H "Authorization: Bearer Oracle" http://169.254.169.254/opc/v2/instance/metadata/ + curl -H "Authorization: Bearer Oracle" http://169.254.169.254/opc/v2/instance/metadata/ + + You'll get back a response that includes all the instance information; only the metadata information; or + the metadata information for the specified key name, respectively. + + The combined size of the `metadata` and `extendedMetadata` objects can be a maximum of 32,000 bytes. + type: object + placementConstraintDetails: + $ref: '#/components/schemas/PlacementConstraintDetails' + platformConfig: + $ref: '#/components/schemas/LaunchInstancePlatformConfig' + preemptibleInstanceConfig: + $ref: '#/components/schemas/PreemptibleInstanceConfigDetails' + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). + type: object + description: | + [Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels + for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) + (ZPR) policy to control access to ZPR-supported resources. + + Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}` + type: object + shape: + description: | + The shape of an instance. The shape determines the number of CPUs, amount of memory, + and other resources allocated to the instance. + + You can enumerate all available shapes by calling [ListShapes](#/en/iaas/latest/Shape/ListShapes). + maxLength: 255 + minLength: 1 + type: string + shapeConfig: + $ref: '#/components/schemas/LaunchInstanceShapeConfigDetails' + sourceDetails: + $ref: '#/components/schemas/InstanceSourceDetails' + subnetId: + description: | + Deprecated. Instead use `subnetId` in + [CreateVnicDetails](#/en/iaas/latest/CreateVnicDetails/). + At least one of them is required; if you provide both, the values must match. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - availabilityDomain + type: object + InstancePowerActionDetails: + description: A base object for all types of instance power action requests. + discriminator: + propertyName: actionType + properties: + actionType: + description: The type of power action to perform. + type: string + required: + - actionType + type: object + UpdateInstanceDetails: + properties: + agentConfig: + $ref: '#/components/schemas/UpdateInstanceAgentConfigDetails' + availabilityConfig: + $ref: '#/components/schemas/UpdateInstanceAvailabilityConfigDetails' + capacityReservationId: + description: | + The OCID of the compute capacity reservation this instance is launched under. + You can remove the instance from a reservation by specifying an empty string as input for this field. + For more information, see [Capacity Reservations](/iaas/Content/Compute/Tasks/reserve-capacity.htm#default). + maxLength: 255 + minLength: 0 + type: string + x-default-description: | + If you specify a reservation ID, the instance is launched under the associated compute capacity reservation. + Using an empty string for this field value causes the instance to be moved out of the capacity reservation. + If you do not specify this parameter, the instance is launched under its current capacity reservation. + dedicatedVmHostId: + description: | + The OCID of the dedicated virtual machine host to place the instance on. + Supported only if this VM instance was already placed on a dedicated virtual machine host + - that is, you can't move an instance from on-demand capacity to dedicated capacity, + nor can you move an instance from dedicated capacity to on-demand capacity. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + extendedMetadata: + additionalProperties: + type: string + description: (opaque JSON object) + description: | + Additional metadata key/value pairs that you provide. They serve the same purpose and + functionality as fields in the `metadata` object. + + They are distinguished from `metadata` fields in that these can be nested JSON objects + (whereas `metadata` fields are string/string maps only). + + The "user_data" field and the "ssh_authorized_keys" field cannot be changed after an instance + has launched. Any request that updates, removes, or adds either of these fields will be + rejected. You must provide the same values for "user_data" and "ssh_authorized_keys" that + already exist on the instance. + + The combined size of the `metadata` and `extendedMetadata` objects can be a maximum of + 32,000 bytes. + type: object + faultDomain: + description: | + A fault domain is a grouping of hardware and infrastructure within an availability domain. + Each availability domain contains three fault domains. Fault domains let you distribute your + instances so that they are not on the same physical hardware within a single availability domain. + A hardware failure or Compute hardware maintenance that affects one fault domain does not affect + instances in other fault domains. + + To get a list of fault domains, use the + [ListFaultDomains](#/en/identity/20160918/FaultDomain/ListFaultDomains) operation in the + Identity and Access Management Service API. + + Example: `FAULT-DOMAIN-1` + 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 + instanceOptions: + $ref: '#/components/schemas/InstanceOptions' + isAIEnterpriseEnabled: + default: false + description: | + Whether to enable AI enterprise on the instance. + type: boolean + launchOptions: + $ref: '#/components/schemas/UpdateLaunchOptions' + metadata: + additionalProperties: + type: string + description: | + Custom metadata key/value string pairs that you provide. Any set of key/value pairs + provided here will completely replace the current set of key/value pairs in the `metadata` + field on the instance. + + The "user_data" field and the "ssh_authorized_keys" field cannot be changed after an instance + has launched. Any request that updates, removes, or adds either of these fields will be + rejected. You must provide the same values for "user_data" and "ssh_authorized_keys" that + already exist on the instance. + + The combined size of the `metadata` and `extendedMetadata` objects can be a maximum of + 32,000 bytes. + type: object + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). + type: object + description: | + [Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels + for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) + (ZPR) policy to control access to ZPR-supported resources. + + Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}` + type: object + shape: + description: | + The shape of the instance. The shape determines the number of CPUs and the amount of memory + allocated to the instance. For more information about how to change shapes, and a list of + shapes that are supported, see + [Editing an Instance](/iaas/Content/Compute/Tasks/resizinginstances.htm). + + For details about the CPUs, memory, and other properties of each shape, see + [Compute Shapes](/iaas/Content/Compute/References/computeshapes.htm). + + The new shape must be compatible with the image that was used to launch the instance. You + can enumerate all available shapes and determine image compatibility by calling + [ListShapes](#/en/iaas/latest/Shape/ListShapes). + + To determine whether capacity is available for a specific shape before you change the shape of an instance, + use the [CreateComputeCapacityReport](#/en/iaas/latest/ComputeCapacityReport/CreateComputeCapacityReport) + operation. + + If the instance is running when you change the shape, the instance is rebooted. + + Example: `VM.Standard2.1` + maxLength: 255 + minLength: 1 + type: string + shapeConfig: + $ref: '#/components/schemas/UpdateInstanceShapeConfigDetails' + sourceDetails: + $ref: '#/components/schemas/UpdateInstanceSourceDetails' + timeMaintenanceRebootDue: + description: | + For a VM instance, resets the scheduled time that the instance will be reboot migrated for + infrastructure maintenance, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + If the instance hasn't been rebooted after this date, Oracle reboots the instance within 24 hours of the time + and date that maintenance is due. + + To get the maximum possible date that a maintenance reboot can be extended, + use [GetInstanceMaintenanceReboot](#/en/iaas/latest/InstanceMaintenanceReboot/GetInstanceMaintenanceReboot). + + Regardless of how the instance is stopped, this flag is reset to empty as soon as the instance reaches the + Stopped state. + + To reboot migrate a bare metal instance, use the [InstanceAction](#/en/iaas/latest/Instance/InstanceAction) operation. + + For more information, see + [Infrastructure Maintenance](/iaas/Content/Compute/References/infrastructure-maintenance.htm). + + Example: `2018-05-25T21:10:29.600Z` + format: date-time + type: string + updateOperationConstraint: + description: | + The parameter acts as a fail-safe to prevent unwanted downtime when updating a running instance. + The default is ALLOW_DOWNTIME. + * `ALLOW_DOWNTIME` - Compute might reboot the instance while updating the instance if a reboot is required. + * `AVOID_DOWNTIME` - If the instance is in running state, Compute tries to update the instance without rebooting + it. If the instance requires a reboot to be updated, an error is returned and the instance + is not updated. If the instance is stopped, it is updated and remains in the stopped state. + enum: + - ALLOW_DOWNTIME + - AVOID_DOWNTIME + type: string + type: object + ChangeInstanceCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the instance to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + InstanceCredentials: + description: The credentials for a particular instance. + properties: + password: + description: The password for the username. + maxLength: 255 + minLength: 1 + type: string + username: + description: The username. + maxLength: 255 + minLength: 1 + type: string + required: + - username + - password + type: object + Device: + description: Device Path corresponding to the block devices attached to instances having a name and isAvailable flag. + properties: + isAvailable: + description: The flag denoting whether device is available. + type: boolean + name: + description: The device name. + maxLength: 100 + minLength: 3 + type: string + required: + - name + - isAvailable + type: object + InstanceMaintenanceReboot: + description: The maximum possible date and time that a maintenance reboot can be extended. + properties: + timeMaintenanceRebootDueMax: + description: | + The maximum extension date and time for the maintenance reboot, in the format defined by + [RFC3339](https://tools.ietf.org/html/rfc3339). + The range for the maintenance extension is between 1 and 14 days from the initial scheduled maintenance date. + Example: `2018-05-25T21:10:29.600Z` + format: date-time + type: string + required: + - timeMaintenanceRebootDueMax + type: object + MeasuredBootReport: + description: The measured boot report for a shielded instance. + properties: + isPolicyVerificationSuccessful: + description: | + Whether the verification succeeded, and the new values match the expected values. + type: boolean + measurements: + $ref: '#/components/schemas/MeasuredBootReportMeasurements' + required: + - isPolicyVerificationSuccessful + type: object + Shape: + description: | + A compute instance shape that can be used in [LaunchInstance](#/en/iaas/latest/Instance/LaunchInstance). + For more information, see [Overview of the Compute Service](/iaas/Content/Compute/Concepts/computeoverview.htm) and + [Compute Shapes](/iaas/Content/Compute/References/computeshapes.htm). + properties: + availabilityDomain: + description: The shape's availability domain. + maxLength: 255 + minLength: 1 + type: string + baselineOcpuUtilizations: + description: | + For a subcore burstable VM, the supported baseline OCPU utilization for instances that use this shape. + items: + enum: + - BASELINE_1_8 + - BASELINE_1_2 + - BASELINE_1_1 + minimum: 0 + type: string + type: array + billingType: + description: | + How instances that use this shape are charged. + enum: + - ALWAYS_FREE + - LIMITED_FREE + - PAID + type: string + gpuDescription: + description: | + A short description of the graphics processing unit (GPU) available for this shape. + + If the shape does not have any GPUs, this field is `null`. + type: string + gpus: + description: | + The number of GPUs available for this shape. + minimum: 0 + type: integer + isBilledForStoppedInstance: + description: | + Whether billing continues when the instances that use this shape are in the stopped state. + type: boolean + isFlexible: + description: | + Whether the shape supports creating flexible instances. A [flexible shape](/iaas/Content/Compute/References/computeshapes.htm#flexible) + is a shape that lets you customize the number of OCPUs and the amount of memory when launching or resizing your instance. + type: boolean + isLiveMigrationSupported: + description: | + Whether live migration is supported for this shape. + type: boolean + isSubcore: + description: | + Whether the shape supports creating subcore or burstable instances. A [burstable instance](/iaas/Content/Compute/References/burstable-instances.htm) + is a virtual machine (VM) instance that provides a baseline level of CPU performance with the ability to burst to a higher level to support occasional + spikes in usage. + type: boolean + localDiskDescription: + description: | + A short description of the local disks available for this shape. + + If the shape does not have any local disks, this field is `null`. + maxLength: 255 + minLength: 1 + type: string + localDisks: + description: | + The number of local disks available for this shape. + minimum: 0 + type: integer + localDisksTotalSizeInGBs: + description: | + The aggregate size of the local disks available for this shape, in gigabytes. + + If the shape does not have any local disks, this field is `null`. + format: float + minimum: 0 + type: number + maxVnicAttachmentOptions: + $ref: '#/components/schemas/ShapeMaxVnicAttachmentOptions' + maxVnicAttachments: + description: | + The maximum number of VNIC attachments available for this shape. + minimum: 0 + type: integer + memoryInGBs: + description: | + The default amount of memory available for this shape, in gigabytes. + format: float + minimum: 0 + type: number + memoryOptions: + $ref: '#/components/schemas/ShapeMemoryOptions' + minTotalBaselineOcpusRequired: + description: | + For a subcore burstable VM, the minimum total baseline OCPUs required. The total baseline OCPUs is equal to + baselineOcpuUtilization chosen multiplied by the number of OCPUs chosen. + format: int32 + minimum: 0 + type: number + networkPorts: + description: | + The number of physical network interface card (NIC) ports available for this shape. + minimum: 0 + type: integer + networkingBandwidthInGbps: + description: | + The networking bandwidth available for this shape, in gigabits per second. + format: float + minimum: 0 + type: number + networkingBandwidthOptions: + $ref: '#/components/schemas/ShapeNetworkingBandwidthOptions' + ocpuOptions: + $ref: '#/components/schemas/ShapeOcpuOptions' + ocpus: + description: | + The default number of OCPUs available for this shape. + format: float + minimum: 0 + type: number + platformConfigOptions: + $ref: '#/components/schemas/ShapePlatformConfigOptions' + platformNames: + description: | + The list of platform names that can be used for this shapes + items: + type: string + type: array + processorDescription: + description: | + A short description of the shape's processor (CPU). + maxLength: 255 + minLength: 1 + type: string + quotaNames: + description: | + The list of of compartment quotas for the shape. + items: + type: string + type: array + rdmaBandwidthInGbps: + description: | + The networking bandwidth available for the remote direct memory access (RDMA) network for this shape, in + gigabits per second. + minimum: 0 + type: integer + rdmaPorts: + description: | + The number of networking ports available for the remote direct memory access (RDMA) network between nodes in + a high performance computing (HPC) cluster network. If the shape does not support cluster networks, this + value is `0`. + minimum: 0 + type: integer + recommendedAlternatives: + description: | + The list of shapes and shape details (if applicable) that Oracle recommends that you use as an alternative to the current shape. + items: + $ref: '#/components/schemas/ShapeAlternativeObject' + type: array + resizeCompatibleShapes: + description: | + The list of compatible shapes that this shape can be changed to. For more information, + see [Changing the Shape of an Instance](/iaas/Content/Compute/Tasks/resizinginstances.htm). + items: + type: string + type: array + shape: + description: | + The name of the shape. You can enumerate all available shapes by calling + [ListShapes](#/en/iaas/latest/Shape/ListShapes). + maxLength: 255 + minLength: 1 + type: string + required: + - shape + type: object + VnicAttachment: + description: | + Represents an attachment between a VNIC and an instance. For more information, see + [Virtual Network Interface Cards (VNICs)](/iaas/Content/Network/Tasks/managingVNICs.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + properties: + availabilityDomain: + description: | + The availability domain of the instance. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The OCID of the compartment the VNIC attachment is in, which is the same + compartment the instance is in. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + id: + description: The OCID of the VNIC attachment. + maxLength: 255 + minLength: 1 + type: string + instanceId: + description: The OCID of the instance. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the VNIC attachment. + enum: + - ATTACHING + - ATTACHED + - DETACHING + - DETACHED + type: string + nicIndex: + description: | + Which physical network interface card (NIC) the VNIC uses. + Certain bare metal instance shapes have two active physical NICs (0 and 1). If + you add a secondary VNIC to one of these instances, you can specify which NIC + the VNIC will use. For more information, see + [Virtual Network Interface Cards (VNICs)](/iaas/Content/Network/Tasks/managingVNICs.htm). + format: int32 + maximum: 31 + minimum: 0 + type: integer + subnetId: + description: The OCID of the subnet to create the VNIC in. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the VNIC attachment was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + vlanId: + description: | + The OCID of the VLAN to create the VNIC in. Creating the VNIC in a VLAN (instead + of a subnet) is possible only if you are an Oracle Cloud VMware Solution customer. + See [Vlan](#/en/iaas/latest/Vlan). + + An error is returned if the instance already has a VNIC attached to it from this VLAN. + maxLength: 255 + minLength: 1 + type: string + vlanTag: + description: | + The Oracle-assigned VLAN tag of the attached VNIC. Available after the + attachment process is complete. + + However, if the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution, + the `vlanTag` value is instead the value of the `vlanTag` attribute for the VLAN. + See [Vlan](#/en/iaas/latest/Vlan). + + Example: `0` + format: int32 + type: integer + vnicId: + description: | + The OCID of the VNIC. Available after the attachment process is complete. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - instanceId + - lifecycleState + - availabilityDomain + - timeCreated + type: object + AttachVnicDetails: + properties: + createVnicDetails: + $ref: '#/components/schemas/CreateVnicDetails' + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + instanceId: + description: The OCID of the instance. + maxLength: 255 + minLength: 1 + type: string + nicIndex: + description: | + Which physical network interface card (NIC) the VNIC will use. Defaults to 0. + Certain bare metal instance shapes have two active physical NICs (0 and 1). If + you add a secondary VNIC to one of these instances, you can specify which NIC + the VNIC will use. For more information, see + [Virtual Network Interface Cards (VNICs)](/iaas/Content/Network/Tasks/managingVNICs.htm). + format: int32 + maximum: 31 + minimum: 0 + type: integer + required: + - instanceId + - createVnicDetails + type: object + VolumeAttachment: + description: | + A base object for all types of attachments between a storage volume and an instance. + For specific details about iSCSI attachments, see + [IScsiVolumeAttachment Reference](#/en/iaas/latest/IScsiVolumeAttachment/). + + For general information about volume attachments, see + [Overview of Block Volume Storage](/iaas/Content/Block/Concepts/overview.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you + supply string values using the API. + discriminator: + propertyName: attachmentType + properties: + attachmentType: + description: The type of volume attachment. + maxLength: 255 + minLength: 1 + type: string + availabilityDomain: + description: | + The availability domain of an instance. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment. + maxLength: 255 + minLength: 1 + type: string + device: + description: The device name. + maxLength: 100 + minLength: 3 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + id: + description: The OCID of the volume attachment. + maxLength: 255 + minLength: 1 + type: string + instanceId: + description: The OCID of the instance the volume is attached to. + maxLength: 255 + minLength: 1 + type: string + isMultipath: + description: Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment. + type: boolean + isPvEncryptionInTransitEnabled: + description: | + Whether in-transit encryption for the data volume's paravirtualized attachment is enabled or not. + type: boolean + isReadOnly: + description: Whether the attachment was created in read-only mode. + type: boolean + isShareable: + description: | + Whether the attachment should be created in shareable mode. If an attachment + is created in shareable mode, then other instances can attach the same volume, provided + that they also create their attachments in shareable mode. Only certain volume types can + be attached in shareable mode. Defaults to false if not specified. + type: boolean + isVolumeCreatedDuringLaunch: + description: | + Flag indicating if this volume was created for the customer as part of a simplified launch. + Used to determine whether the volume requires deletion on instance termination. + type: boolean + iscsiLoginState: + description: | + The iscsi login state of the volume attachment. For a Iscsi volume attachment, + all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state. + enum: + - UNKNOWN + - LOGGING_IN + - LOGIN_SUCCEEDED + - LOGIN_FAILED + - LOGGING_OUT + - LOGOUT_SUCCEEDED + - LOGOUT_FAILED + type: string + lifecycleState: + description: The current state of the volume attachment. + enum: + - ATTACHING + - ATTACHED + - DETACHING + - DETACHED + type: string + timeCreated: + description: | + The date and time the volume was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + volumeId: + description: The OCID of the volume. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - attachmentType + - instanceId + - volumeId + - lifecycleState + - compartmentId + - availabilityDomain + - timeCreated + type: object + AttachVolumeDetails: + discriminator: + propertyName: type + properties: + device: + description: The device name. To retrieve a list of devices for a given instance, see [ListInstanceDevices](#/en/iaas/latest/Device/ListInstanceDevices). + maxLength: 100 + minLength: 3 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + instanceId: + description: | + The OCID of the instance. For AttachVolume operation, this is a required field for the request, + see [AttachVolume](#/en/iaas/latest/VolumeAttachment/AttachVolume). + maxLength: 255 + minLength: 1 + type: string + isReadOnly: + description: Whether the attachment was created in read-only mode. + type: boolean + isShareable: + description: | + Whether the attachment should be created in shareable mode. If an attachment + is created in shareable mode, then other instances can attach the same volume, provided + that they also create their attachments in shareable mode. Only certain volume types can + be attached in shareable mode. Defaults to false if not specified. + type: boolean + type: + description: | + The type of volume. The only supported values are "iscsi" and "paravirtualized". + maxLength: 255 + minLength: 1 + type: string + volumeId: + description: | + The OCID of the volume. If CreateVolumeDetails is specified, this field must be omitted from the request. + maxLength: 255 + minLength: 1 + type: string + required: + - instanceId + - volumeId + - type + type: object + UpdateVolumeAttachmentDetails: + description: details for updating a volume attachment. + properties: + iscsiLoginState: + description: | + The iscsi login state of the volume attachment. For a multipath volume attachment, + all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state. + enum: + - UNKNOWN + - LOGGING_IN + - LOGIN_SUCCEEDED + - LOGIN_FAILED + - LOGGING_OUT + - LOGOUT_SUCCEEDED + - LOGOUT_FAILED + type: string + type: object + Error: + properties: + code: + description: | + A short error code that defines the error, meant for programmatic parsing. See + [API Errors](/iaas/Content/API/References/apierrors.htm). + type: string + message: + description: A human-readable error message. + type: string + messageArguments: + additionalProperties: + type: string + description: | + The values to be substituted into the `originalMessageTemplate`, expressed as a string-to-string map. + type: object + originalMessage: + description: A human-readable error string in English. This value might be different from the `message` field. + type: string + originalMessageTemplate: + description: | + The template for the `originalMessage` in ICU message format, but without the values to be substituted. + type: string + required: + - code + - message + type: object + CreateClusterNetworkInstancePoolDetails: + description: The data to create an instance pool in a cluster network. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + instanceConfigurationId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance configuration + associated with the instance pool. + maxLength: 255 + minLength: 1 + type: string + size: + description: | + The number of instances that should be in the instance pool. + type: integer + required: + - instanceConfigurationId + - size + type: object + ClusterNetworkPlacementConfigurationDetails: + description: The location for where the instance pools in a cluster network will place instances. + properties: + availabilityDomain: + description: | + The availability domain to place instances. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + primarySubnetId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the primary subnet to place instances. This field is deprecated. + Use `primaryVnicSubnets` instead to set VNIC data for instances in the pool. + maxLength: 255 + minLength: 1 + type: string + primaryVnicSubnets: + $ref: '#/components/schemas/InstancePoolPlacementPrimarySubnet' + secondaryVnicSubnets: + description: The set of secondary VNIC data for instances in the pool. + items: + $ref: '#/components/schemas/InstancePoolPlacementSecondaryVnicSubnet' + type: array + uniqueItems: true + required: + - availabilityDomain + type: object + UpdateClusterNetworkInstancePoolDetails: + description: The data to update an instance pool within a cluster network. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool. + maxLength: 255 + minLength: 1 + type: string + instanceConfigurationId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance configuration associated with the instance pool. + maxLength: 255 + minLength: 1 + type: string + size: + description: | + The number of instances that should be in the instance pool. + + To determine whether capacity is available for a specific shape before you resize an instance pool, + use the [CreateComputeCapacityReport](#/en/iaas/latest/ComputeCapacityReport/CreateComputeCapacityReport) + operation. + type: integer + required: + - id + type: object + InstancePoolInstanceLoadBalancerBackend: + description: Represents the load balancer Backend that is configured for an instance pool instance. + properties: + backendHealthStatus: + description: The health of the backend as observed by the load balancer. + enum: + - OK + - WARNING + - CRITICAL + - UNKNOWN + type: string + backendName: + description: The name of the backend in the backend set. + maxLength: 255 + minLength: 1 + type: string + backendSetName: + description: The name of the backend set on the load balancer. + maxLength: 255 + minLength: 1 + type: string + loadBalancerId: + description: The OCID of the load balancer attached to the instance pool. + maxLength: 255 + minLength: 1 + type: string + required: + - loadBalancerId + - backendSetName + - backendName + - backendHealthStatus + type: object + CreateCapacityReportShapeAvailabilityDetails: + description: | + Information about the shapes in a capacity report. + properties: + faultDomain: + description: | + The fault domain for the capacity report. + + If you do not specify a fault domain, the capacity report includes information about all fault domains. + maxLength: 255 + minLength: 1 + type: string + instanceShape: + description: | + The shape that you want to request a capacity report for. You can enumerate all available shapes by calling + [ListShapes](#/en/iaas/latest/Shape/ListShapes). + maxLength: 255 + minLength: 1 + type: string + instanceShapeConfig: + $ref: '#/components/schemas/CapacityReportInstanceShapeConfig' + required: + - instanceShape + type: object + CapacityReportShapeAvailability: + description: | + Information about the available capacity for a shape. + properties: + availabilityStatus: + description: A flag denoting whether capacity is available. + enum: + - OUT_OF_HOST_CAPACITY + - HARDWARE_NOT_SUPPORTED + - AVAILABLE + type: string + availableCount: + description: The total number of new instances that can be created with the specified shape configuration. + format: int64 + minimum: 0 + type: integer + faultDomain: + description: | + The fault domain for the capacity report. + + If you do not specify the fault domain, the capacity report includes information about all fault domains. + maxLength: 255 + minLength: 1 + type: string + instanceShape: + description: | + The shape that the capacity report was requested for. + maxLength: 255 + minLength: 1 + type: string + instanceShapeConfig: + $ref: '#/components/schemas/CapacityReportInstanceShapeConfig' + type: object + InstanceReservationConfigDetails: + description: | + A template that contains the settings to use when defining the instance capacity configuration. + properties: + clusterConfig: + $ref: '#/components/schemas/ClusterConfigDetails' + clusterPlacementGroupId: + description: The OCID of the cluster placement group for this instance reservation capacity configuration. + maxLength: 255 + minLength: 1 + type: string + faultDomain: + description: | + The fault domain to use for instances created using this capacity configuration. + For more information, see [Fault Domains](/iaas/Content/General/Concepts/regions.htm#fault). + If you do not specify the fault domain, the capacity is available for an instance + that does not specify a fault domain. To change the fault domain for a reservation, + delete the reservation and create a new one in the preferred fault domain. + + To retrieve a list of fault domains, use the `ListFaultDomains` operation in + the [Identity and Access Management Service API](/iaas/api/#/en/identity/20160918/). + + Example: `FAULT-DOMAIN-1` + maxLength: 255 + minLength: 1 + type: string + instanceShape: + description: | + The shape requested when launching instances using reserved capacity. + The shape determines the number of CPUs, amount of memory, + and other resources allocated to the instance. + You can list all available shapes by calling [ListComputeCapacityReservationInstanceShapes](#/en/iaas/computeCapacityReservationInstanceShapes/ListComputeCapacityReservationInstanceShapes). + maxLength: 255 + minLength: 1 + type: string + instanceShapeConfig: + $ref: '#/components/schemas/InstanceReservationShapeConfigDetails' + reservedCount: + description: The total number of instances that can be launched from the capacity configuration. + format: int64 + minimum: 0 + type: integer + required: + - instanceShape + - reservedCount + type: object + InstanceReservationConfig: + description: | + Data that defines the capacity configuration. + properties: + clusterConfig: + $ref: '#/components/schemas/ClusterConfigDetails' + clusterPlacementGroupId: + description: The OCID of the cluster placement group for this instance reservation capacity configuration. + maxLength: 255 + minLength: 1 + type: string + faultDomain: + description: | + The fault domain of this capacity configuration. + If a value is not supplied, this capacity configuration is applicable to all fault domains in the specified availability domain. + For more information, see [Capacity Reservations](/iaas/Content/Compute/Tasks/reserve-capacity.htm). + maxLength: 255 + minLength: 1 + type: string + instanceShape: + description: | + The shape to use when launching instances using compute capacity reservations. The shape determines the number of CPUs, the amount of memory, + and other resources allocated to the instance. + You can list all available shapes by calling [ListComputeCapacityReservationInstanceShapes](#/en/iaas/computeCapacityReservationInstanceShapes/ListComputeCapacityReservationInstanceShapes). + maxLength: 255 + minLength: 1 + type: string + instanceShapeConfig: + $ref: '#/components/schemas/InstanceReservationShapeConfigDetails' + reservedCount: + description: The total number of instances that can be launched from the capacity configuration. + format: int64 + minimum: 0 + type: integer + usedCount: + description: The amount of capacity in use out of the total capacity reserved in this capacity configuration. + format: int64 + minimum: 0 + type: integer + required: + - instanceShape + - reservedCount + - usedCount + type: object + InstanceReservationShapeConfigDetails: + description: | + The shape configuration requested when launching instances in a compute capacity reservation. + + If the parameter is provided, the reservation is created with the resources that you specify. If some + properties are missing or the parameter is not provided, the reservation is created + with the default configuration values for the `shape` that you specify. + + Each shape only supports certain configurable values. If the values that you provide are not valid for the + specified `shape`, an error is returned. + + For more information about customizing the resources that are allocated to flexible shapes, + see [Flexible Shapes](/iaas/Content/Compute/References/computeshapes.htm#flexible). + properties: + memoryInGBs: + description: | + The total amount of memory available to the instance, in gigabytes. + format: float + minimum: 0 + type: number + ocpus: + description: | + The total number of OCPUs available to the instance. + format: float + minimum: 0 + type: number + type: object + ComputeCapacityTopologySummary: + description: | + Summary information for a compute capacity topology. + properties: + availabilityDomain: + description: | + The availability domain of the compute capacity topology. + + Example: `Uocm:US-CHICAGO-1-AD-2` + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the compute capacity topology. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the compute capacity topology. + type: string + x-obmcs-enumref: '#/definitions/ComputeCapacityTopology/lifecycleState' + timeCreated: + description: | + The date and time that the compute capacity topology was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time that the compute capacity topology was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - availabilityDomain + - compartmentId + - id + - lifecycleState + - timeCreated + - timeUpdated + type: object + CreateCapacitySourceDetails: + description: | + A capacity source of bare metal hosts. + discriminator: + propertyName: capacityType + properties: + capacityType: + description: The capacity type of bare metal hosts. + type: string + x-obmcs-enumref: '#/definitions/CapacitySource/capacityType' + required: + - capacityType + type: object + CapacitySource: + description: | + A capacity source of bare metal hosts. + discriminator: + propertyName: capacityType + properties: + capacityType: + description: The capacity type of bare metal hosts. + enum: + - DEDICATED + type: string + required: + - capacityType + type: object + UpdateCapacitySourceDetails: + description: | + A capacity source of bare metal hosts. + discriminator: + propertyName: capacityType + properties: + capacityType: + description: The capacity type of bare metal hosts. + type: string + x-obmcs-enumref: '#/definitions/CapacitySource/capacityType' + required: + - capacityType + type: object + ComputeBareMetalHostSummary: + description: | + Summary information for a compute bare metal host. + properties: + computeCapacityTopologyId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology. + maxLength: 255 + minLength: 1 + type: string + computeHpcIslandId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute HPC island. + maxLength: 255 + minLength: 1 + type: string + computeLocalBlockId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute network block. + maxLength: 255 + minLength: 1 + type: string + computeNetworkBlockId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute local block. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute bare metal host. + maxLength: 255 + minLength: 1 + type: string + instanceId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute instance that runs on the compute bare metal host. + maxLength: 255 + minLength: 1 + type: string + instanceShape: + description: The shape of the compute instance that runs on the compute bare metal host. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: The lifecycle state details of the compute bare metal host. + type: string + x-obmcs-enumref: '#/definitions/ComputeBareMetalHost/lifecycleDetails' + lifecycleState: + description: The current state of the compute bare metal host. + type: string + x-obmcs-enumref: '#/definitions/ComputeBareMetalHost/lifecycleState' + timeCreated: + description: | + The date and time that the compute bare metal host was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time that the compute bare metal host was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - computeCapacityTopologyId + - id + - instanceShape + - lifecycleState + - timeCreated + - timeUpdated + type: object + ComputeHpcIslandSummary: + description: | + Summary information for a compute HPC island. + properties: + computeCapacityTopologyId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute HPC island. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the compute HPC island. + type: string + x-obmcs-enumref: '#/definitions/ComputeHpcIsland/lifecycleState' + timeCreated: + description: | + The date and time that the compute HPC island was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time that the compute HPC island was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + totalComputeBareMetalHostCount: + description: The total number of compute bare metal hosts located in this compute HPC island. + format: int64 + minimum: 0 + type: integer + required: + - computeCapacityTopologyId + - id + - lifecycleState + - timeCreated + - timeUpdated + - totalComputeBareMetalHostCount + type: object + ComputeNetworkBlockSummary: + description: | + Summary information for a compute network block. + properties: + computeCapacityTopologyId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology. + maxLength: 255 + minLength: 1 + type: string + computeHpcIslandId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute HPC island. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute network block. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the compute network block. + type: string + x-obmcs-enumref: '#/definitions/ComputeNetworkBlock/lifecycleState' + timeCreated: + description: | + The date and time that the compute network block was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time that the compute network block was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + totalComputeBareMetalHostCount: + description: The total number of compute bare metal hosts located in the compute network block. + format: int64 + minimum: 0 + type: integer + required: + - computeCapacityTopologyId + - computeHpcIslandId + - id + - lifecycleState + - timeCreated + - timeUpdated + - totalComputeBareMetalHostCount + type: object + ComputeClusterSummary: + description: | + Summary information for a compute cluster. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) + is a remote direct memory access (RDMA) network group. + properties: + availabilityDomain: + description: | + The availability domain the compute cluster is running in. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the compute cluster. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the compute cluster. + type: string + x-obmcs-enumref: '#/definitions/ComputeCluster/lifecycleState' + timeCreated: + description: | + The date and time the compute cluster was created, + in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - availabilityDomain + - compartmentId + - id + - lifecycleState + - timeCreated + type: object + ImageCapabilitySchemaDescriptor: + description: | + Image Capability Schema Descriptor is a type of capability for an image. + discriminator: + propertyName: descriptorType + properties: + descriptorType: + description: | + The image capability schema descriptor type for the capability + type: string + source: + enum: + - GLOBAL + - IMAGE + type: string + required: + - descriptorType + - source + type: object + ComputeGpuMemoryClusterSummary: + description: Summary model for listing Compute GPU Memory Clusters. + properties: + availabilityDomain: + description: | + The availability domain of GPU Memory Cluster. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the compute GPU Memory Cluster. + compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + gpuMemoryFabricId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the GPU memory fabric. + maxLength: 255 + minLength: 1 + type: string + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique GPU Memory Cluster + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the compute GPU Memory Cluster. + type: string + x-obmcs-enumref: '#/definitions/ComputeGpuMemoryCluster/lifecycleState' + size: + description: | + The size represents the total number of instances in the GPU Memory Cluster, including both running instances and those still in the process of launching. + format: int64 + minimum: 0 + type: integer + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }` + type: object + timeCreated: + description: | + The date and time the boot volume was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - availabilityDomain + - lifecycleState + - timeCreated + type: object + CreateComputeGpuMemoryClusterScaleConfig: + description: | + Configuration settings for GPU Memory Cluster scaling. + properties: + isDownsizeEnabled: + description: | + Enables downsizing towards the target size. + type: boolean + isUpsizeEnabled: + description: | + Enables upsizing towards the target size. + type: boolean + targetSize: + description: | + The configured target size for the GPU Memory Cluster. + format: int64 + minimum: 0 + type: integer + required: + - isUpsizeEnabled + type: object + ComputeGpuMemoryClusterScaleConfig: + description: | + Configuration settings for GPU Memory Cluster scaling. + properties: + isDownsizeEnabled: + description: | + Whether downsizing is enabled. + type: boolean + isUpsizeEnabled: + description: | + Whether upsizing is enabled. + type: boolean + targetSize: + description: | + The configured target size for the GPU Memory Cluster. + format: int64 + minimum: 0 + type: integer + type: object + UpdateComputeGpuMemoryClusterScaleConfig: + description: | + Configuration settings for GPU Memory Cluster scaling. + properties: + isDownsizeEnabled: + description: | + Enables downsizing towards the target size. + type: boolean + isUpsizeEnabled: + description: | + Enables upsizing towards the target size. + type: boolean + targetSize: + description: | + The configured target size for the GPU Memory Cluster. + format: int64 + minimum: 0 + type: integer + type: object + ComputeGpuMemoryClusterInstanceSummary: + description: | + The customer facing GPU Memory Cluster instance object details. + properties: + availabilityDomain: + description: | + The availability domain of the GPU Memory Cluster instance. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the compartment + compartment. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + faultDomain: + description: The fault domain the GPU Memory Cluster instance is running in. + maxLength: 255 + minLength: 1 + type: string + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique GPU Memory Cluster instance + maxLength: 255 + minLength: 1 + type: string + instanceConfigurationId: + description: | + Configuration to be used for this GPU Memory Cluster instance. + maxLength: 255 + minLength: 1 + type: string + instanceShape: + description: | + The shape of an instance. The shape determines the number of CPUs, amount of memory, + and other resources allocated to the instance. The shape determines the number of CPUs, + the amount of memory, and other resources allocated to the instance. + You can list all available shapes by calling [ListShapes](#/en/iaas/latest/Shape/ListShapes). + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: | + The lifecycle state of the GPU Memory Cluster instance + enum: + - MOVING + - PROVISIONING + - RUNNING + - STARTING + - STOPPING + - STOPPED + - SUSPENDING + - SUSPENDED + - CREATING_IMAGE + - TERMINATING + - TERMINATED + type: string + region: + description: The region that contains the availability domain the instance is running in. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the GPU Memory Cluster instance was created. + + Example: `2016-09-15T21:10:29.600Z` + format: date-time + type: string + type: object + ComputeGpuMemoryFabricSummary: + description: | + Summary information for a compute GPU memory fabric. + properties: + availableHostCount: + description: The total number of available bare metal hosts located in this compute GPU memory fabric. + format: int64 + minimum: 0 + type: integer + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the compartment. This should always be the + root compartment. + maxLength: 255 + minLength: 1 + type: string + computeHpcIslandId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique HPC Island + maxLength: 255 + minLength: 1 + type: string + computeLocalBlockId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Local Block + maxLength: 255 + minLength: 1 + type: string + computeNetworkBlockId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Network Block + maxLength: 255 + minLength: 1 + type: string + currentFirmwareBundleId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for current firmware bundle + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + fabricHealth: + description: | + The health state of the GPU memory fabric + type: string + x-obmcs-enumref: '#/definitions/ComputeGpuMemoryFabric/fabricHealth' + firmwareUpdateState: + description: | + The state of Memory Fabric Firmware update + enum: + - WILL_UPDATE + - NO_UPDATE + - SKIP_RECYCLE_ENABLED + 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 + healthyHostCount: + description: The total number of healthy bare metal hosts located in this compute GPU memory fabric. + format: int64 + minimum: 0 + type: integer + hostPlatformName: + description: | + The host platform identifier used for bundle queries + maxLength: 255 + minLength: 1 + type: string + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique GPU memory fabric + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: | + The lifecycle state of the GPU memory fabric + type: string + x-obmcs-enumref: '#/definitions/ComputeGpuMemoryFabric/lifecycleState' + memoryFabricPreferences: + $ref: '#/components/schemas/MemoryFabricPreferencesDescriptor' + switchPlatformName: + description: | + The switch platform identifier used for bundle queries + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }` + type: object + targetFirmwareBundleId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for targeted firmware bundle + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time that the compute GPU memory fabric record was created, in the format defined by [RFC3339] + (https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + totalHostCount: + description: The total number of bare metal hosts located in this compute GPU memory fabric. + format: int64 + minimum: 0 + type: integer + required: + - id + - compartmentId + - computeHpcIslandId + - computeNetworkBlockId + - computeLocalBlockId + - lifecycleState + - fabricHealth + - totalHostCount + - timeCreated + type: object + MemoryFabricPreferencesDescriptor: + description: | + The preference object specified by customer. Contains customerDesiredFirmwareBundleId, fabricRecycleLevel. + properties: + customerDesiredFirmwareBundleId: + description: | + The desired firmware bundle id on the GPU memory fabric. + type: string + fabricRecycleLevel: + description: | + The recycle level of GPU memory fabric. + enum: + - FULL_RECYCLE + - SKIP_RECYCLE + - OPPORTUNISTIC_FULL_RECYCLE + type: string + type: object + ComputeHostGroupSummary: + description: | + Summary information for a compute host group. + properties: + availabilityDomain: + description: | + The availability domain of a host group. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The OCID of the compartment that contains host group. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique host group + maxLength: 255 + minLength: 1 + type: string + isTargetedPlacementRequired: + description: A flag that allows customers to restrict placement for hosts attached to the group. If true, the only way to place on hosts is to target the specific host group. + type: boolean + lifecycleState: + description: The current state of the compute host group + type: string + x-obmcs-enumref: '#/definitions/ComputeHostGroup/lifecycleState' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{"foo-namespace": {"bar-key": "value"}}` + type: object + timeCreated: + description: | + The date and time the host group was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time the host group was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - availabilityDomain + - id + - displayName + - compartmentId + - timeCreated + - lifecycleState + - isTargetedPlacementRequired + type: object + HostGroupConfiguration: + description: Host group configuration + properties: + firmwareBundleId: + description: The OCID for firmware bundle + maxLength: 255 + minLength: 1 + type: string + recycleLevel: + description: | + Preferred recycle level for hosts associated with the reservation config. + * `SKIP_RECYCLE` - Skips host wipe. + * `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior. + enum: + - SKIP_RECYCLE + - FULL_RECYCLE + type: string + state: + description: The state of the host group configuration. + enum: + - VALID + - INVALID + type: string + target: + description: Either the platform name or compute shape that the configuration is targeting + maxLength: 255 + minLength: 1 + type: string + type: object + ComputeHostSummary: + description: | + Summary information for a compute host. + properties: + availabilityDomain: + description: | + The availability domain of the compute host. + + Example: `Uocm:US-CHICAGO-1-AD-2` + maxLength: 255 + minLength: 1 + type: string + capacityReservationId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Capacity Reserver that is currently on host + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the compartment. This should always be the root + compartment. + maxLength: 255 + minLength: 1 + type: string + computeHostGroupId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique host group + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + faultDomain: + description: | + A fault domain is a grouping of hardware and infrastructure within an availability domain. + Each availability domain contains three fault domains. Fault domains let you distribute your + instances so that they are not on the same physical hardware within a single availability domain. + A hardware failure or Compute hardware maintenance that affects one fault domain does not affect + instances in other fault domains. + + This field is the Fault domain of the host + 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 + gpuMemoryFabricId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique GPU Memory Fabric + maxLength: 255 + minLength: 1 + type: string + hasImpactedComponents: + description: | + While listing a host the user will know if they have an impacted component or not. + The user will have to issue a get host to see details. + type: boolean + health: + description: | + The heathy state of the host + type: string + x-obmcs-enumref: '#/definitions/ComputeHost/health' + hpcIslandId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique HPC Island + maxLength: 255 + minLength: 1 + type: string + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique host + maxLength: 255 + minLength: 1 + type: string + instanceId: + description: | + The public [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Virtual Machine or Bare Metal instance + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: | + The lifecycle state of the host + type: string + x-obmcs-enumref: '#/definitions/ComputeHost/lifecycleState' + localBlockId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Local Block + maxLength: 255 + minLength: 1 + type: string + networkBlockId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Network Block + maxLength: 255 + minLength: 1 + type: string + platform: + description: | + The platform of the host + maxLength: 255 + minLength: 1 + type: string + recycleDetails: + $ref: '#/components/schemas/RecycleDetails' + shape: + description: | + The shape of host + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time that the compute host record was created, in the format defined by [RFC3339](https://tools + .ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time that the compute host record was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - compartmentId + - availabilityDomain + - id + - faultDomain + - shape + - health + - lifecycleState + - hasImpactedComponents + - timeCreated + - timeUpdated + type: object + ComputeHostConfigurationData: + description: | + Compute Host Configuration Data + properties: + checkDetails: + $ref: '#/components/schemas/ComputeHostConfigurationCheckDetails' + timeLastApply: + description: The time that was last applied. + format: date-time + type: string + type: object + RecycleDetails: + description: | + Shows details about the last recycle performed on this host. + properties: + computeHostGroupId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host group this host was attached to at the time of recycle. + maxLength: 255 + minLength: 1 + type: string + recycleLevel: + description: | + Preferred recycle level for hosts associated with the reservation config. + * `SKIP_RECYCLE` - Skips host wipe. + * `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior. + enum: + - SKIP_RECYCLE + - FULL_RECYCLE + type: string + type: object + SupportedCapabilities: + description: | + Specifies the capabilities that the Dedicated Virtual Machine Host (DVMH) Shape or Virtual Machine Instance Shape could support. + properties: + isBurstableSupported: + default: false + description: | + Specifies if the Dedicated Virtual Machine Host (DVMH) is to running only Burstable VMs. If `true`, only Burstable VMs can be launched. If `false`, Burstable VMs cannot be launched. + type: boolean + isMemoryEncryptionSupported: + default: false + description: | + Whether the DVMH shape could support confidential VMs or the VM instance shape could be confidential. + type: boolean + required: + - isMemoryEncryptionSupported + type: object + CapacityConfig: + description: | + Specifies the capacity configs that the Dedicated Virtual Machine Host (DVMH) Shape could support. + properties: + capacityBins: + description: | + A list of total CPU and memory per capacity bucket. + items: + $ref: '#/components/schemas/CapacityBinPreview' + maxItems: 25 + minItems: 0 + type: array + capacityConfigName: + description: | + The name of each capacity config. + maxLength: 255 + minLength: 1 + type: string + isDefault: + default: false + description: | + Whether this capacity config is the default config. + type: boolean + supportedCapabilities: + $ref: '#/components/schemas/SupportedCapabilities' + type: object + PlacementConstraintDetails: + description: | + The details for providing placement constraints. + discriminator: + propertyName: type + properties: + type: + description: | + The type for the placement constraints. + Use `COMPUTE_BARE_METAL_HOST` when specifying the compute bare metal host OCID. + Use `HOST_GROUP` when specifying the compute host group OCID. + type: string + required: + - type + type: object + CapacityBin: + description: | + Total and remaining CPU and memory capacity for each capacity bucket. + properties: + capacityIndex: + description: | + Zero-based index for the corresponding capacity bucket. + format: int32 + maximum: 24 + minimum: 0 + type: integer + remainingMemoryInGBs: + description: | + The remaining memory of the capacity bucket, in GBs. + format: float + minimum: 0 + type: number + remainingOcpus: + description: | + The available OCPUs of the capacity bucket. + format: float + minimum: 0 + type: number + supportedShapes: + description: | + List of VMI shapes supported on each capacity bucket. + items: + type: string + maxItems: 25 + minItems: 1 + type: array + totalMemoryInGBs: + description: | + The total memory of the capacity bucket, in GBs. + format: float + minimum: 0 + type: number + totalOcpus: + description: | + The total OCPUs of the capacity bucket. + format: float + minimum: 0 + type: number + required: + - capacityIndex + - totalOcpus + - remainingOcpus + - totalMemoryInGBs + - remainingMemoryInGBs + - supportedShapes + type: object + FirmwareBundleSummary: + description: Summary of a firmware bundle, returned in list operations. + properties: + allowableTransitions: + $ref: '#/components/schemas/FirmwareBundleTransitions' + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment of this firmware bundle. + maxLength: 255 + minLength: 1 + type: string + description: + description: A brief description or metadata about this firmware bundle. + type: string + displayName: + description: The user-friendly name of this firmware bundle. + type: string + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this firmware bundle. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the firmware bundle. + type: string + x-obmcs-enumref: '#/definitions/FirmwareBundle/lifecycleState' + platforms: + description: A map of platforms to pinned firmware versions. + items: + $ref: '#/components/schemas/PlatformVersions' + type: array + timeCreated: + description: | + The date and time the firmware bundle was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time the firmware bundle was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - displayName + - platforms + - compartmentId + - timeCreated + - timeUpdated + - lifecycleState + type: object + FirmwareBundleTransitions: + description: A map of firmware bundle upgrades/downgrades validated by OCI. + properties: + downgrades: + description: An array of [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of validated firmware bundle downgrades. + items: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the downgrade firmware bundle. + maxLength: 255 + minLength: 1 + type: string + type: array + upgrades: + description: An array of [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of validated firmware bundle upgrades. + items: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the upgrade firmware bundle. + maxLength: 255 + minLength: 1 + type: string + type: array + type: object + PlatformVersions: + description: A platform's pinned firmware versions. + properties: + platform: + description: The name of the platform supported by this bundle. + type: string + versions: + description: An array of pinned components and their respective firmware versions. + items: + $ref: '#/components/schemas/ComponentVersion' + type: array + type: object + InstanceAgentFeatures: + description: Oracle Cloud Agent features supported on the image. + properties: + isManagementSupported: + description: | + This attribute is not used. + type: boolean + isMonitoringSupported: + description: | + This attribute is not used. + type: boolean + type: object + LaunchOptions: + description: | + Options for tuning the compatibility and performance of VM shapes. The values that you specify override any + default values. + properties: + bootVolumeType: + description: | + Emulation type for the boot volume. + * `ISCSI` - ISCSI attached block storage device. + * `SCSI` - Emulated SCSI disk. + * `IDE` - Emulated IDE disk. + * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data + volumes on platform images. + * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block + storage volumes on platform images. + enum: + - ISCSI + - SCSI + - IDE + - VFIO + - PARAVIRTUALIZED + type: string + firmware: + description: | + Firmware used to boot VM. Select the option that matches your operating system. + * `BIOS` - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating + systems that boot using MBR style bootloaders. + * `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the + default for platform images. + enum: + - BIOS + - UEFI_64 + type: string + isConsistentVolumeNamingEnabled: + description: Whether to enable consistent volume naming feature. Defaults to false. + type: boolean + isPvEncryptionInTransitEnabled: + description: | + Deprecated. Instead use `isPvEncryptionInTransitEnabled` in + [LaunchInstanceDetails](#/en/iaas/latest/datatypes/LaunchInstanceDetails). + type: boolean + networkType: + description: | + Emulation type for the physical network interface card (NIC). + * `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver. + * `VFIO` - Direct attached Virtual Function network controller. This is the networking type + when you launch an instance using hardware-assisted (SR-IOV) networking. + * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. + * `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type. + enum: + - E1000 + - VFIO + - PARAVIRTUALIZED + - ACCELERATEDPV + type: string + remoteDataVolumeType: + description: | + Emulation type for volume. + * `ISCSI` - ISCSI attached block storage device. + * `SCSI` - Emulated SCSI disk. + * `IDE` - Emulated IDE disk. + * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data + volumes on platform images. + * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block + storage volumes on platform images. + enum: + - ISCSI + - SCSI + - IDE + - VFIO + - PARAVIRTUALIZED + type: string + type: object + ImageSourceDetails: + discriminator: + propertyName: sourceType + properties: + operatingSystem: + maxLength: 255 + minLength: 1 + type: string + operatingSystemVersion: + maxLength: 255 + minLength: 1 + type: string + sourceImageType: + description: | + The format of the image to be imported. Only monolithic + images are supported. This attribute is not used for exported Oracle images with the OCI image format. + enum: + - QCOW2 + - VMDK + type: string + sourceType: + description: | + The source type for the image. Use `objectStorageTuple` when specifying the namespace, + bucket name, and object name. Use `objectStorageUri` when specifying the Object Storage URL. + type: string + required: + - sourceType + type: object + ImageMemoryConstraints: + description: For a flexible image and shape, the amount of memory supported for instances that use this image. + properties: + maxInGBs: + description: The maximum amount of memory, in gigabytes. + minimum: 0 + type: integer + minInGBs: + description: The minimum amount of memory, in gigabytes. + minimum: 0 + type: integer + type: object + ImageOcpuConstraints: + description: OCPU options for an image and shape. + properties: + max: + description: The maximum number of OCPUs supported for this image and shape. + minimum: 0 + type: integer + min: + description: The minimum number of OCPUs supported for this image and shape. + minimum: 0 + type: integer + type: object + InstanceAgentConfig: + description: Configuration options for the Oracle Cloud Agent software running on the instance. + properties: + areAllPluginsDisabled: + default: false + description: | + Whether Oracle Cloud Agent can run all of the available plugins. + This includes the management and monitoring plugins. + + For more information about the available plugins, see + [Managing Plugins with Oracle Cloud Agent](/iaas/Content/Compute/Tasks/manage-plugins.htm). + type: boolean + isManagementDisabled: + default: false + description: | + Whether Oracle Cloud Agent can run all the available management plugins. + + These are the management plugins: OS Management Service Agent and Compute Instance + Run Command. + + The management plugins are controlled by this parameter and by the per-plugin + configuration in the `pluginsConfig` object. + + - If `isManagementDisabled` is true, all of the management plugins are disabled, regardless of + the per-plugin configuration. + - If `isManagementDisabled` is false, all of the management plugins are enabled. You + can optionally disable individual management plugins by providing a value in the `pluginsConfig` + object. + type: boolean + isMonitoringDisabled: + default: false + description: | + Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the + monitoring plugins. + + These are the monitoring plugins: Compute Instance Monitoring + and Custom Logs Monitoring. + + The monitoring plugins are controlled by this parameter and by the per-plugin + configuration in the `pluginsConfig` object. + + - If `isMonitoringDisabled` is true, all of the monitoring plugins are disabled, regardless of + the per-plugin configuration. + - If `isMonitoringDisabled` is false, all of the monitoring plugins are enabled. You + can optionally disable individual monitoring plugins by providing a value in the `pluginsConfig` + object. + type: boolean + pluginsConfig: + description: The configuration of plugins associated with this instance. + items: + $ref: '#/components/schemas/InstanceAgentPluginConfigDetails' + maxLength: 128 + type: array + type: object + InstanceAvailabilityConfig: + description: | + Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware. + properties: + isLiveMigrationPreferred: + description: | + Whether to live migrate supported VM instances to a healthy physical VM host without + disrupting running instances during infrastructure maintenance events. If null, Oracle + chooses the best option for migrating the VM during infrastructure maintenance events. + type: boolean + recoveryAction: + default: RESTORE_INSTANCE + description: | + The lifecycle state for an instance when it is recovered after infrastructure maintenance. + * `RESTORE_INSTANCE` - The instance is restored to the lifecycle state it was in before the maintenance event. + If the instance was running, it is automatically rebooted. This is the default action when a value is not set. + * `STOP_INSTANCE` - The instance is recovered in the stopped state. + enum: + - RESTORE_INSTANCE + - STOP_INSTANCE + type: string + type: object + InstanceOptions: + description: Optional mutable instance options + properties: + areLegacyImdsEndpointsDisabled: + description: | + Whether to disable the legacy (/v1) instance metadata service endpoints. + Customers who have migrated to /v2 should set this to true for added security. + Default is false. + type: boolean + type: object + LicensingConfig: + description: Configuration of the Operating System license. + properties: + licenseType: + description: | + License Type for the OS license. + * `OCI_PROVIDED` - OCI provided license (e.g. metered $/OCPU-hour). + * `BRING_YOUR_OWN_LICENSE` - Bring your own license. + enum: + - OCI_PROVIDED + - BRING_YOUR_OWN_LICENSE + type: string + osVersion: + description: The Operating System version of the license config. + type: string + type: + description: Operating System type of the Configuration. + enum: + - WINDOWS + type: string + type: object + PlatformConfig: + description: | + The platform configuration for the instance. + discriminator: + propertyName: type + properties: + isMeasuredBootEnabled: + default: false + description: | + Whether the Measured Boot feature is enabled on the instance. + type: boolean + isMemoryEncryptionEnabled: + default: false + description: | + Whether the instance is a confidential instance. If this value is `true`, the instance is a confidential instance. The default value is `false`. + type: boolean + isSecureBootEnabled: + default: false + description: | + Whether Secure Boot is enabled on the instance. + type: boolean + isTrustedPlatformModuleEnabled: + default: false + description: | + Whether the Trusted Platform Module (TPM) is enabled on the instance. + type: boolean + type: + description: | + The type of platform being configured. + enum: + - AMD_MILAN_BM + - AMD_MILAN_BM_GPU + - AMD_ROME_BM + - AMD_ROME_BM_GPU + - GENERIC_BM + - INTEL_ICELAKE_BM + - INTEL_SKYLAKE_BM + - AMD_VM + - INTEL_VM + type: string + required: + - type + type: object + PreemptibleInstanceConfigDetails: + description: | + Configuration options for preemptible instances. + properties: + preemptionAction: + $ref: '#/components/schemas/PreemptionAction' + required: + - preemptionAction + type: object + InstanceShapeConfig: + description: | + The shape configuration for an instance. The shape configuration determines + the resources allocated to an instance. + properties: + baselineOcpuUtilization: + description: | + The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a + non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`. + + The following values are supported: + - `BASELINE_1_8` - baseline usage is 1/8 of an OCPU. + - `BASELINE_1_2` - baseline usage is 1/2 of an OCPU. + - `BASELINE_1_1` - baseline usage is the entire OCPU. This represents a non-burstable instance. + enum: + - BASELINE_1_8 + - BASELINE_1_2 + - BASELINE_1_1 + type: string + gpuDescription: + description: | + A short description of the instance's graphics processing unit (GPU). + + If the instance does not have any GPUs, this field is `null`. + type: string + gpus: + description: | + The number of GPUs available to the instance. + minimum: 0 + type: integer + localDiskDescription: + description: | + A short description of the local disks available to this instance. + + If the instance does not have any local disks, this field is `null`. + maxLength: 255 + minLength: 1 + type: string + localDisks: + description: | + The number of local disks available to the instance. + minimum: 0 + type: integer + localDisksTotalSizeInGBs: + description: | + The aggregate size of all local disks, in gigabytes. + + If the instance does not have any local disks, this field is `null`. + format: float + minimum: 0 + type: number + maxVnicAttachments: + description: | + The maximum number of VNIC attachments for the instance. + minimum: 0 + type: integer + memoryInGBs: + description: | + The total amount of memory available to the instance, in gigabytes. + format: float + minimum: 0 + type: number + networkingBandwidthInGbps: + description: | + The networking bandwidth available to the instance, in gigabits per second. + format: float + minimum: 0 + type: number + ocpus: + description: | + The total number of OCPUs available to the instance. + format: float + minimum: 0 + type: number + processorDescription: + description: | + A short description of the instance's processor (CPU). + maxLength: 255 + minLength: 1 + type: string + resourceManagement: + description: | + This field is reserved for internal use. + enum: + - DYNAMIC + - STATIC + type: string + vcpus: + description: | + The total number of VCPUs available to the instance. This can be used instead of OCPUs, + in which case the actual number of OCPUs will be calculated based on this value + and the actual hardware. This must be a multiple of 2. + format: int32 + minimum: 0 + type: integer + type: object + InstanceSourceDetails: + discriminator: + propertyName: sourceType + properties: + sourceType: + description: | + The source type for the instance. + Use `image` when specifying the image OCID. Use `bootVolume` when specifying + the boot volume OCID. + type: string + required: + - sourceType + type: object + InstancePoolLifecycleManagementDetails: + description: | + The lifecycle management options for the instance pool. + properties: + lifecycleActions: + $ref: '#/components/schemas/InstancePoolLifecycleActionsDetails' + required: + - lifecycleActions + type: object + CreateInstancePoolPlacementConfigurationDetails: + description: The location for where an instance pool will place instances. + properties: + availabilityDomain: + description: | + The availability domain to place instances. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + computeClusterId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the + [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) that the instance will be created in. + + Make sure the compute cluster belongs to the same availability domain as specified in placement configuration otherwise the request will be rejected with 400. + Once this field is set, it cannot be updated. Also any update to the availability domain in placement configuration will be blocked. + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + faultDomains: + description: | + The fault domains to place instances. + + If you don't provide any values, the system makes a best effort to distribute + instances across all fault domains based on capacity. + + To distribute the instances evenly across selected fault domains, provide a + set of fault domains. For example, you might want instances to be evenly + distributed if your applications require high availability. + + To get a list of fault domains, use the + [ListFaultDomains](#/en/identity/20160918/FaultDomain/ListFaultDomains) operation + in the Identity and Access Management Service API. + + Example: `[FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3]` + items: + type: string + type: array + uniqueItems: true + primarySubnetId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the primary subnet in which to place instances. This field is deprecated. + Use `primaryVnicSubnets` instead to set VNIC data for instances in the pool. + maxLength: 255 + minLength: 1 + type: string + primaryVnicSubnets: + $ref: '#/components/schemas/InstancePoolPlacementPrimarySubnet' + secondaryVnicSubnets: + description: The set of secondary VNIC data for instances in the pool. + items: + $ref: '#/components/schemas/InstancePoolPlacementSecondaryVnicSubnet' + type: array + uniqueItems: true + required: + - availabilityDomain + type: object + InstancePoolPlacementConfiguration: + description: The location for where an instance pool will place instances. + properties: + availabilityDomain: + description: | + The availability domain to place instances. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + computeClusterId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the + [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) that the instance will be created in. + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + faultDomains: + description: | + The fault domains to place instances. + + If you don't provide any values, the system makes a best effort to distribute + instances across all fault domains based on capacity. + + To distribute the instances evenly across selected fault domains, provide a + set of fault domains. For example, you might want instances to be evenly + distributed if your applications require high availability. + + To get a list of fault domains, use the + [ListFaultDomains](#/en/identity/20160918/FaultDomain/ListFaultDomains) operation + in the Identity and Access Management Service API. + + Example: `[FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3]` + items: + type: string + type: array + uniqueItems: true + primarySubnetId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the primary subnet in which to place instances. This field is deprecated. + Use `primaryVnicSubnets` instead to set VNIC data for instances in the pool. + maxLength: 255 + minLength: 1 + type: string + primaryVnicSubnets: + $ref: '#/components/schemas/InstancePoolPlacementPrimarySubnet' + secondaryVnicSubnets: + description: The set of secondary VNIC data for instances in the pool. + items: + $ref: '#/components/schemas/InstancePoolPlacementSecondaryVnicSubnet' + type: array + uniqueItems: true + required: + - availabilityDomain + type: object + UpdateInstancePoolPlacementConfigurationDetails: + description: The location for where an instance pool will place instances. + properties: + availabilityDomain: + description: | + The availability domain to place instances. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + faultDomains: + description: | + The fault domains to place instances. + + If you don't provide any values, the system makes a best effort to distribute + instances across all fault domains based on capacity. + + To distribute the instances evenly across selected fault domains, provide a + set of fault domains. For example, you might want instances to be evenly + distributed if your applications require high availability. + + To get a list of fault domains, use the + [ListFaultDomains](#/en/identity/20160918/FaultDomain/ListFaultDomains) operation + in the Identity and Access Management Service API. + + Example: `[FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3]` + items: + type: string + type: array + uniqueItems: true + primarySubnetId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the primary subnet in which to place instances. This field is deprecated. + Use `primaryVnicSubnets` instead to set VNIC data for instances in the pool. + maxLength: 255 + minLength: 1 + type: string + primaryVnicSubnets: + $ref: '#/components/schemas/InstancePoolPlacementPrimarySubnet' + secondaryVnicSubnets: + description: The set of secondary VNIC data for instances in the pool. + items: + $ref: '#/components/schemas/InstancePoolPlacementSecondaryVnicSubnet' + type: array + uniqueItems: true + required: + - availabilityDomain + type: object + LaunchInstanceAgentConfigDetails: + description: Configuration options for the Oracle Cloud Agent software running on the instance. + properties: + areAllPluginsDisabled: + default: false + description: | + Whether Oracle Cloud Agent can run all the available plugins. + This includes the management and monitoring plugins. + + To get a list of available plugins, use the + [ListInstanceagentAvailablePlugins](#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) + operation in the Oracle Cloud Agent API. For more information about the available plugins, see + [Managing Plugins with Oracle Cloud Agent](/iaas/Content/Compute/Tasks/manage-plugins.htm). + type: boolean + isManagementDisabled: + default: false + description: | + Whether Oracle Cloud Agent can run all the available management plugins. + Default value is false (management plugins are enabled). + + These are the management plugins: OS Management Service Agent and Compute Instance + Run Command. + + The management plugins are controlled by this parameter and by the per-plugin + configuration in the `pluginsConfig` object. + + - If `isManagementDisabled` is true, all of the management plugins are disabled, regardless of + the per-plugin configuration. + - If `isManagementDisabled` is false, all of the management plugins are enabled. You + can optionally disable individual management plugins by providing a value in the `pluginsConfig` + object. + type: boolean + isMonitoringDisabled: + default: false + description: | + Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the + monitoring plugins. Default value is false (monitoring plugins are enabled). + + These are the monitoring plugins: Compute Instance Monitoring + and Custom Logs Monitoring. + + The monitoring plugins are controlled by this parameter and by the per-plugin + configuration in the `pluginsConfig` object. + + - If `isMonitoringDisabled` is true, all of the monitoring plugins are disabled, regardless of + the per-plugin configuration. + - If `isMonitoringDisabled` is false, all of the monitoring plugins are enabled. You + can optionally disable individual monitoring plugins by providing a value in the `pluginsConfig` + object. + type: boolean + pluginsConfig: + description: The configuration of plugins associated with this instance. + items: + $ref: '#/components/schemas/InstanceAgentPluginConfigDetails' + maxLength: 128 + type: array + type: object + LaunchInstanceAvailabilityConfigDetails: + description: | + Options for VM migration during infrastructure maintenance events and for defining + the availability of a VM instance after a maintenance event that impacts the underlying hardware. + properties: + isLiveMigrationPreferred: + description: | + Whether to live migrate supported VM instances to a healthy physical VM host without + disrupting running instances during infrastructure maintenance events. If null, Oracle + chooses the best option for migrating the VM during infrastructure maintenance events. + type: boolean + recoveryAction: + default: RESTORE_INSTANCE + description: | + The lifecycle state for an instance when it is recovered after infrastructure maintenance. + * `RESTORE_INSTANCE` - The instance is restored to the lifecycle state it was in before the maintenance event. + If the instance was running, it is automatically rebooted. This is the default action when a value is not set. + * `STOP_INSTANCE` - The instance is recovered in the stopped state. + enum: + - RESTORE_INSTANCE + - STOP_INSTANCE + type: string + type: object + CreateVnicDetails: + description: | + Contains properties for a VNIC. You use this object when creating the + primary VNIC during instance launch or when creating a secondary VNIC. + For more information about VNICs, see + [Virtual Network Interface Cards (VNICs)](/iaas/Content/Network/Tasks/managingVNICs.htm). + properties: + assignIpv6Ip: + default: false + description: | + Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled + subnet. Default: False. When provided you may optionally provide an IPv6 prefix + (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` + is not provided then an IPv6 prefix is chosen + for you. + type: boolean + assignPrivateDnsRecord: + description: | + Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record + registration for the VNIC. If set to true, the DNS record will be registered. The default + value is true. + + If you specify a `hostnameLabel`, then `assignPrivateDnsRecord` must be set to true. + type: boolean + assignPublicIp: + description: | + Whether the VNIC should be assigned a public IP address. Defaults to whether + the subnet is public or private. If not set and the VNIC is being created + in a private subnet (that is, where `prohibitPublicIpOnVnic` = true in the + [Subnet](#/en/iaas/latest/Subnet/)), then no public IP address is assigned. + If not set and the subnet is public (`prohibitPublicIpOnVnic` = false), then + a public IP address is assigned. If set to true and + `prohibitPublicIpOnVnic` = true, an error is returned. + + **Note:** This public IP address is associated with the primary private IP + on the VNIC. For more information, see + [IP Addresses](/iaas/Content/Network/Tasks/managingIPaddresses.htm). + + **Note:** There's a limit to the number of [public IPs](#/en/iaas/latest/PublicIp/) + a VNIC or instance can have. If you try to create a secondary VNIC + with an assigned public IP for an instance that has already + reached its public IP limit, an error is returned. For information + about the public IP limits, see + [Public IP Addresses](/iaas/Content/Network/Tasks/managingpublicIPs.htm). + + Example: `false` + + If you specify a `vlanId`, then `assignPublicIp` must be set to false. See + [Vlan](#/en/iaas/latest/Vlan). + type: boolean + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + hostnameLabel: + description: | + The hostname for the VNIC's primary private IP. Used for DNS. The value is the hostname + portion of the primary private IP's fully qualified domain name (FQDN) + (for example, `bminstance1` in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`). + Must be unique across all VNICs in the subnet and comply with + [RFC 952](https://tools.ietf.org/html/rfc952) and + [RFC 1123](https://tools.ietf.org/html/rfc1123). + The value appears in the [Vnic](#/en/iaas/latest/Vnic/) object and also the + [PrivateIp](#/en/iaas/latest/PrivateIp/) object returned by + [ListPrivateIps](#/en/iaas/latest/PrivateIp/ListPrivateIps) and + [GetPrivateIp](#/en/iaas/latest/PrivateIp/GetPrivateIp). + + For more information, see + [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). + + When launching an instance, use this `hostnameLabel` instead + of the deprecated `hostnameLabel` in + [LaunchInstanceDetails](#/en/iaas/latest/requests/LaunchInstanceDetails). + If you provide both, the values must match. + + Example: `bminstance1` + + If you specify a `vlanId`, the `hostnameLabel` cannot be specified. VNICs on a VLAN + can not be assigned a hostname. See [Vlan](#/en/iaas/latest/Vlan). + maxLength: 63 + minLength: 1 + type: string + ipv6AddressIpv6SubnetCidrPairDetails: + description: | + A list of IPv6 prefix ranges from which the VNIC is assigned an IPv6 address. + You can provide only the prefix ranges from which OCI selects an available + address from the range. You can optionally choose to leave the prefix range empty + and instead provide the specific IPv6 address within that range to use. + items: + $ref: '#/components/schemas/Ipv6AddressIpv6SubnetCidrPairDetails' + type: array + nsgIds: + description: | + A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more + information about NSGs, see + [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/). + + If a `vlanId` is specified, the `nsgIds` cannot be specified. The `vlanId` + indicates that the VNIC will belong to a VLAN instead of a subnet. With VLANs, + all VNICs in the VLAN belong to the NSGs that are associated with the VLAN. + See [Vlan](#/en/iaas/latest/Vlan). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + privateIp: + description: | + A private IP address of your choice to assign to the VNIC. Must be an + available IP address within the subnet's CIDR. If you don't specify a + value, Oracle automatically assigns a private IP address from the subnet. + This is the VNIC's *primary* private IP address. The value appears in + the [Vnic](#/en/iaas/latest/Vnic/) object and also the + [PrivateIp](#/en/iaas/latest/PrivateIp/) object returned by + [ListPrivateIps](#/en/iaas/latest/PrivateIp/ListPrivateIps) and + [GetPrivateIp](#/en/iaas/latest/PrivateIp/GetPrivateIp). + + + If you specify a `vlanId`, the `privateIp` cannot be specified. + See [Vlan](#/en/iaas/latest/Vlan). + + If you specify a 'privateIpId', the 'privateIp' cannot be specified. + + Example: `10.0.3.3` + maxLength: 46 + minLength: 1 + type: string + privateIpId: + description: | + An [OCID](/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved IP address to use for this VNIC. + maxLength: 255 + minLength: 1 + type: string + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). + type: object + description: | + [Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels + for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) + (ZPR) policy to control access to ZPR-supported resources. + + Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}` + type: object + skipSourceDestCheck: + description: | + Whether the source/destination check is disabled on the VNIC. + Defaults to `false`, which means the check is performed. For information + about why you would skip the source/destination check, see + [Using a Private IP as a Route Target](/iaas/Content/Network/Tasks/managingroutetables.htm#privateip). + + + If you specify a `vlanId`, the `skipSourceDestCheck` cannot be specified because the + source/destination check is always disabled for VNICs in a VLAN. See + [Vlan](#/en/iaas/latest/Vlan). + + Example: `true` + type: boolean + subnetCidr: + description: | + One of the IPv4 CIDR blocks allocated to the subnet. Represents the IP range + from which the VNIC's private IP address will be assigned if `privateIp` or + `privateIpId` is not specified. + Either this field or the `privateIp` (or `privateIpId`, if applicable) field + must be provided, but not both simultaneously. + Example: `192.168.1.0/28` + maxLength: 18 + minLength: 9 + type: string + subnetId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create the VNIC in. When launching an instance, + use this `subnetId` instead of the deprecated `subnetId` in + [LaunchInstanceDetails](#/en/iaas/latest/requests/LaunchInstanceDetails). + At least one of them is required; if you provide both, the values must match. + + If you are an Oracle Cloud VMware Solution customer and creating a secondary + VNIC in a VLAN instead of a subnet, provide a `vlanId` instead of a `subnetId`. + If you provide both a `vlanId` and `subnetId`, the request fails. + maxLength: 255 + minLength: 1 + type: string + vlanId: + description: | + Provide this attribute only if you are an Oracle Cloud VMware Solution + customer and creating a secondary VNIC in a VLAN. The value is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. + See [Vlan](#/en/iaas/latest/Vlan). + + Provide a `vlanId` instead of a `subnetId`. If you provide both a + `vlanId` and `subnetId`, the request fails. + maxLength: 255 + minLength: 1 + type: string + type: object + LaunchAttachVolumeDetails: + description: The details of the volume to attach. + discriminator: + propertyName: type + properties: + device: + description: The device name. To retrieve a list of devices for a given instance, see [ListInstanceDevices](#/en/iaas/latest/Device/ListInstanceDevices). + maxLength: 100 + minLength: 3 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + isReadOnly: + description: Whether the attachment was created in read-only mode. + type: boolean + isShareable: + default: false + description: | + Whether the attachment should be created in shareable mode. If an attachment + is created in shareable mode, then other instances can attach the same volume, provided + that they also create their attachments in shareable mode. Only certain volume types can + be attached in shareable mode. Defaults to false if not specified. + type: boolean + launchCreateVolumeDetails: + $ref: '#/components/schemas/LaunchCreateVolumeDetails' + type: + description: The type of volume attachment. Currently, the only supported values are "iscsi" and "paravirtualized". + maxLength: 255 + minLength: 1 + type: string + volumeId: + description: | + The OCID of the volume. If CreateVolumeDetails is specified, this field must be omitted from the request. + maxLength: 255 + minLength: 1 + type: string + required: + - type + type: object + LaunchInstanceLicensingConfig: + description: The license config requested for the instance. + discriminator: + propertyName: type + properties: + licenseType: + default: OCI_PROVIDED + description: | + License Type for the OS license. + * `OCI_PROVIDED` - OCI provided license (e.g. metered $/OCPU-hour). + * `BRING_YOUR_OWN_LICENSE` - Bring your own license. + enum: + - OCI_PROVIDED + - BRING_YOUR_OWN_LICENSE + type: string + type: + description: Operating System type of the Configuration. + enum: + - WINDOWS + type: string + required: + - type + type: object + LaunchInstancePlatformConfig: + description: | + The platform configuration requested for the instance. + + If you provide the parameter, the instance is created with the platform configuration that you specify. + For any values that you omit, the instance uses the default configuration values for the `shape` that you + specify. If you don't provide the parameter, the default values for the `shape` are used. + + Each shape only supports certain configurable values. If the values that you provide are not valid for the + specified `shape`, an error is returned. + + For more information about shielded instances, see + [Shielded Instances](/iaas/Content/Compute/References/shielded-instances.htm). + + For more information about BIOS settings for bare metal instances, see + [BIOS Settings for Bare Metal Instances](/iaas/Content/Compute/References/bios-settings.htm). + discriminator: + propertyName: type + properties: + isMeasuredBootEnabled: + default: false + description: | + Whether the Measured Boot feature is enabled on the instance. + type: boolean + isMemoryEncryptionEnabled: + default: false + description: | + Whether the instance is a confidential instance. If this value is `true`, the instance is a confidential instance. The default value is `false`. + type: boolean + isSecureBootEnabled: + default: false + description: | + Whether Secure Boot is enabled on the instance. + type: boolean + isTrustedPlatformModuleEnabled: + default: false + description: | + Whether the Trusted Platform Module (TPM) is enabled on the instance. + type: boolean + type: + description: | + The type of platform being configured. + enum: + - AMD_MILAN_BM + - AMD_MILAN_BM_GPU + - AMD_ROME_BM + - AMD_ROME_BM_GPU + - GENERIC_BM + - INTEL_ICELAKE_BM + - INTEL_SKYLAKE_BM + - AMD_VM + - INTEL_VM + type: string + required: + - type + type: object + LaunchInstanceShapeConfigDetails: + description: | + The shape configuration requested for the instance. + + If the parameter is provided, the instance is created with the resources that you specify. If some + properties are missing or the entire parameter is not provided, the instance is created + with the default configuration values for the `shape` that you specify. + + Each shape only supports certain configurable values. If the values that you provide are not valid for the + specified `shape`, an error is returned. + properties: + baselineOcpuUtilization: + description: | + The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a + non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`. + + The following values are supported: + - `BASELINE_1_8` - baseline usage is 1/8 of an OCPU. + - `BASELINE_1_2` - baseline usage is 1/2 of an OCPU. + - `BASELINE_1_1` - baseline usage is an entire OCPU. This represents a non-burstable instance. + enum: + - BASELINE_1_8 + - BASELINE_1_2 + - BASELINE_1_1 + type: string + memoryInGBs: + description: | + The total amount of memory available to the instance, in gigabytes. + format: float + minimum: 0 + type: number + nvmes: + description: | + The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. + format: int32 + maximum: 7 + minimum: 1 + type: integer + ocpus: + description: | + The total number of OCPUs available to the instance. + format: float + minimum: 0 + type: number + resourceManagement: + description: | + This field is reserved for internal use. + enum: + - DYNAMIC + - STATIC + type: string + vcpus: + description: | + The total number of VCPUs available to the instance. This can be used instead of OCPUs, + in which case the actual number of OCPUs will be calculated based on this value + and the actual hardware. This must be a multiple of 2. + format: int32 + minimum: 0 + type: integer + type: object + UpdateInstanceAgentConfigDetails: + description: Configuration options for the Oracle Cloud Agent software running on the instance. + properties: + areAllPluginsDisabled: + default: false + description: | + Whether Oracle Cloud Agent can run all the available plugins. + This includes the management and monitoring plugins. + + To get a list of available plugins, use the + [ListInstanceagentAvailablePlugins](#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) + operation in the Oracle Cloud Agent API. For more information about the available plugins, see + [Managing Plugins with Oracle Cloud Agent](/iaas/Content/Compute/Tasks/manage-plugins.htm). + type: boolean + isManagementDisabled: + default: false + description: | + Whether Oracle Cloud Agent can run all the available management plugins. + + These are the management plugins: OS Management Service Agent and Compute Instance + Run Command. + + The management plugins are controlled by this parameter and by the per-plugin + configuration in the `pluginsConfig` object. + + - If `isManagementDisabled` is true, all of the management plugins are disabled, regardless of + the per-plugin configuration. + - If `isManagementDisabled` is false, all of the management plugins are enabled. You + can optionally disable individual management plugins by providing a value in the `pluginsConfig` + object. + type: boolean + isMonitoringDisabled: + default: false + description: | + Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the + monitoring plugins. + + These are the monitoring plugins: Compute Instance Monitoring + and Custom Logs Monitoring. + + The monitoring plugins are controlled by this parameter and by the per-plugin + configuration in the `pluginsConfig` object. + + - If `isMonitoringDisabled` is true, all of the monitoring plugins are disabled, regardless of + the per-plugin configuration. + - If `isMonitoringDisabled` is false, all of the monitoring plugins are enabled. You + can optionally disable individual monitoring plugins by providing a value in the `pluginsConfig` + object. + type: boolean + pluginsConfig: + description: The configuration of plugins associated with this instance. + items: + $ref: '#/components/schemas/InstanceAgentPluginConfigDetails' + maxLength: 128 + type: array + type: object + UpdateInstanceAvailabilityConfigDetails: + description: | + Options for defining the availability of a VM instance after a maintenance event that impacts the underlying + hardware, including whether to live migrate supported VM instances when possible without sending a prior customer notification. + properties: + isLiveMigrationPreferred: + description: | + Whether to live migrate supported VM instances to a healthy physical VM host without + disrupting running instances during infrastructure maintenance events. If null, Oracle + chooses the best option for migrating the VM during infrastructure maintenance events. + type: boolean + recoveryAction: + default: RESTORE_INSTANCE + description: | + The lifecycle state for an instance when it is recovered after infrastructure maintenance. + * `RESTORE_INSTANCE` - The instance is restored to the lifecycle state it was in before the maintenance event. + If the instance was running, it is automatically rebooted. This is the default action when a value is not set. + * `STOP_INSTANCE` - The instance is recovered in the stopped state. + enum: + - RESTORE_INSTANCE + - STOP_INSTANCE + type: string + type: object + UpdateLaunchOptions: + description: | + Options for tuning the compatibility and performance of VM shapes. + properties: + bootVolumeType: + description: | + Emulation type for the boot volume. + * `ISCSI` - ISCSI attached block storage device. + * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block + storage volumes on platform images. + + Before you change the boot volume attachment type, detach all block volumes and VNICs except for + the boot volume and the primary VNIC. + + If the instance is running when you change the boot volume attachment type, it will be rebooted. + + **Note:** Some instances might not function properly if you change the boot volume attachment type. After + the instance reboots and is running, connect to it. If the connection fails or the OS doesn't behave + as expected, the changes are not supported. Revert the instance to the original boot volume attachment type. + enum: + - ISCSI + - PARAVIRTUALIZED + type: string + isPvEncryptionInTransitEnabled: + description: | + Whether to enable in-transit encryption for the volume's paravirtualized attachment. + To enable in-transit encryption for block volumes and boot volumes, this field must be set to `true`. + + Data in transit is transferred over an internal and highly secure network. If you have specific + compliance requirements related to the encryption of the data while it is moving between the + instance and the boot volume or the block volume, you can enable in-transit encryption. + In-transit encryption is not enabled by default. + + All boot volumes and block volumes are encrypted at rest. + + For more information, see [Block Volume Encryption](/iaas/Content/Block/Concepts/overview.htm#Encrypti). + type: boolean + networkType: + description: | + Emulation type for the physical network interface card (NIC). + * `VFIO` - Direct attached Virtual Function network controller. This is the networking type + when you launch an instance using hardware-assisted (SR-IOV) networking. + * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. + * `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type. + + Before you change the networking type, detach all VNICs and block volumes except for the primary + VNIC and the boot volume. + + The image must have paravirtualized drivers installed. For more information, see + [Editing an Instance](/iaas/Content/Compute/Tasks/resizinginstances.htm). + + If the instance is running when you change the network type, it will be rebooted. + + **Note:** Some instances might not function properly if you change the networking type. After + the instance reboots and is running, connect to it. If the connection fails or the OS doesn't behave + as expected, the changes are not supported. Revert the instance to the original networking type. + enum: + - VFIO + - PARAVIRTUALIZED + - ACCELERATEDPV + type: string + type: object + UpdateInstanceShapeConfigDetails: + description: | + The shape configuration requested for the instance. If provided, the instance will be updated + with the resources specified. In the case where some properties are missing, + the missing values will be set to the default for the provided `shape`. + + Each shape only supports certain configurable values. If the `shape` is provided + and the configuration values are invalid for that new `shape`, an error will be returned. + If no `shape` is provided and the configuration values are invalid for the instance's + existing shape, an error will be returned. + properties: + baselineOcpuUtilization: + description: | + The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a + non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`. + + The following values are supported: + - `BASELINE_1_8` - baseline usage is 1/8 of an OCPU. + - `BASELINE_1_2` - baseline usage is 1/2 of an OCPU. + - `BASELINE_1_1` - baseline usage is an entire OCPU. This represents a non-burstable instance. + enum: + - BASELINE_1_8 + - BASELINE_1_2 + - BASELINE_1_1 + type: string + memoryInGBs: + description: | + The total amount of memory available to the instance, in gigabytes. + format: float + minimum: 0 + type: number + nvmes: + description: | + The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. + format: int32 + maximum: 7 + minimum: 1 + type: integer + ocpus: + description: | + The total number of OCPUs available to the instance. + format: float + minimum: 0 + type: number + resourceManagement: + description: | + This field is reserved for internal use. + enum: + - DYNAMIC + - STATIC + type: string + vcpus: + description: | + The total number of VCPUs available to the instance. This can be used instead of OCPUs, + in which case the actual number of OCPUs will be calculated based on this value + and the actual hardware. This must be a multiple of 2. + format: int32 + minimum: 0 + type: integer + type: object + UpdateInstanceSourceDetails: + description: The details for updating the instance source. + discriminator: + propertyName: sourceType + properties: + isPreserveBootVolumeEnabled: + default: true + description: | + Whether to preserve the boot volume that was previously attached to the instance after a successful replacement of that boot volume. + type: boolean + sourceType: + description: | + The source type for the instance. + Use `image` when specifying the image OCID. Use `bootVolume` when specifying + the boot volume OCID. + type: string + required: + - sourceType + type: object + MeasuredBootReportMeasurements: + description: | + A list of Trusted Platform Module (TPM) Platform Configuration Register (PCR) entries. + properties: + actual: + description: The list of actual PCR entries measured during boot. + items: + $ref: '#/components/schemas/MeasuredBootEntry' + type: array + policy: + description: The list of expected PCR entries to use during verification. + items: + $ref: '#/components/schemas/MeasuredBootEntry' + type: array + type: object + ShapeMaxVnicAttachmentOptions: + description: | + For a flexible shape, the number of VNIC attachments that are available for instances that use this shape. + + If this field is null, then this shape has a fixed maximum number of VNIC attachments equal to `maxVnicAttachments`. + properties: + defaultPerOcpu: + description: | + The default number of VNIC attachments allowed per OCPU. + format: float + minimum: 0 + type: number + max: + description: | + The highest maximum value of VNIC attachments. + format: float + minimum: 0 + type: number + min: + description: | + The lowest maximum value of VNIC attachments. + minimum: 0 + type: integer + type: object + ShapeMemoryOptions: + description: | + For a flexible shape, the amount of memory available for instances that use this shape. + + If this field is null, then this shape has a fixed amount of memory equivalent to `memoryInGBs`. + properties: + defaultPerOcpuInGBs: + description: | + The default amount of memory per OCPU available for this shape, in gigabytes. + format: float + minimum: 0 + type: number + maxInGBs: + description: | + The maximum amount of memory, in gigabytes. + format: float + minimum: 0 + type: number + maxPerOcpuInGBs: + description: | + The maximum amount of memory per OCPU available for this shape, in gigabytes. + exclusiveMinimum: true + format: float + minimum: 0 + type: number + minInGBs: + description: | + The minimum amount of memory, in gigabytes. + format: float + minimum: 0 + type: number + minPerOcpuInGBs: + description: | + The minimum amount of memory per OCPU available for this shape, in gigabytes. + exclusiveMinimum: true + format: float + minimum: 0 + type: number + type: object + ShapeNetworkingBandwidthOptions: + description: | + For a flexible shape, the amount of networking bandwidth available for instances that use this shape. + + If this field is null, then this shape has a fixed amount of bandwidth equivalent to `networkingBandwidthInGbps`. + properties: + defaultPerOcpuInGbps: + description: | + The default amount of networking bandwidth per OCPU, in gigabits per second. + format: float + minimum: 0 + type: number + maxInGbps: + description: | + The maximum amount of networking bandwidth, in gigabits per second. + format: float + minimum: 0 + type: number + minInGbps: + description: | + The minimum amount of networking bandwidth, in gigabits per second. + format: float + minimum: 0 + type: number + type: object + ShapeOcpuOptions: + description: | + For a flexible shape, the number of OCPUs available for instances that use this shape. + + If this field is null, then this shape has a fixed number of OCPUs equal to `ocpus`. + properties: + max: + description: | + The maximum number of OCPUs. + format: float + minimum: 0 + type: number + min: + description: | + The minimum number of OCPUs. + format: float + minimum: 0 + type: number + type: object + ShapePlatformConfigOptions: + description: | + The list of supported platform configuration options for this shape. + properties: + accessControlServiceOptions: + $ref: '#/components/schemas/ShapeAccessControlServiceEnabledPlatformOptions' + inputOutputMemoryManagementUnitOptions: + $ref: '#/components/schemas/ShapeInputOutputMemoryManagementUnitEnabledPlatformOptions' + measuredBootOptions: + $ref: '#/components/schemas/ShapeMeasuredBootOptions' + memoryEncryptionOptions: + $ref: '#/components/schemas/ShapeMemoryEncryptionOptions' + numaNodesPerSocketPlatformOptions: + $ref: '#/components/schemas/ShapeNumaNodesPerSocketPlatformOptions' + percentageOfCoresEnabledOptions: + $ref: '#/components/schemas/PercentageOfCoresEnabledOptions' + secureBootOptions: + $ref: '#/components/schemas/ShapeSecureBootOptions' + symmetricMultiThreadingOptions: + $ref: '#/components/schemas/ShapeSymmetricMultiThreadingEnabledPlatformOptions' + trustedPlatformModuleOptions: + $ref: '#/components/schemas/ShapeTrustedPlatformModuleOptions' + type: + description: | + The type of platform being configured. + enum: + - AMD_MILAN_BM + - AMD_MILAN_BM_GPU + - AMD_ROME_BM + - AMD_ROME_BM_GPU + - GENERIC_BM + - INTEL_ICELAKE_BM + - INTEL_SKYLAKE_BM + - AMD_VM + - INTEL_VM + type: string + virtualInstructionsOptions: + $ref: '#/components/schemas/ShapeVirtualInstructionsEnabledPlatformOptions' + type: object + ShapeAlternativeObject: + description: | + The shape that Oracle recommends you to use an alternative to the current shape. + properties: + shapeName: + description: | + The name of the shape. + type: string + required: + - shapeName + type: object + InstancePoolPlacementPrimarySubnet: + description: Details about the IPv6 primary subnet. + properties: + ipv6AddressIpv6SubnetCidrPairDetails: + description: | + A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. + You can provide only the prefix ranges and OCI will select an available + address from the range. You can optionally choose to leave the prefix range empty + and instead provide the specific IPv6 address that should be used from within that range. + items: + $ref: '#/components/schemas/InstancePoolPlacementIpv6AddressIpv6SubnetCidrDetails' + type: array + isAssignIpv6Ip: + default: false + description: | + Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled + subnet. Default: False. When provided you may optionally provide an IPv6 prefix + (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` + is not provided then an IPv6 prefix is chosen + for you. + type: boolean + subnetId: + description: The subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC. + maxLength: 255 + minLength: 1 + type: string + required: + - subnetId + type: object + InstancePoolPlacementSecondaryVnicSubnet: + description: The secondary VNIC object for the placement configuration for an instance pool. + properties: + ipv6AddressIpv6SubnetCidrPairDetails: + description: | + A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. + You can provide only the prefix ranges and OCI will select an available + address from the range. You can optionally choose to leave the prefix range empty + and instead provide the specific IPv6 address that should be used from within that range. + items: + $ref: '#/components/schemas/InstancePoolPlacementIpv6AddressIpv6SubnetCidrDetails' + type: array + isAssignIpv6Ip: + default: false + description: | + Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled + subnet. Default: False. When provided you may optionally provide an IPv6 prefix + (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` + is not provided then an IPv6 prefix is chosen + for you. + type: boolean + subnetId: + description: The subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + The display name of the VNIC. This is also used to match against the instance configuration defined + secondary VNIC. + maxLength: 255 + minItems: 1 + minLength: 1 + type: string + required: + - subnetId + type: object + CapacityReportInstanceShapeConfig: + description: | + The shape configuration for a shape in a capacity report. + properties: + baselineOcpuUtilization: + description: | + The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a + non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`. + + The following values are supported: + - `BASELINE_1_8` - baseline usage is 1/8 of an OCPU. + - `BASELINE_1_2` - baseline usage is 1/2 of an OCPU. + - `BASELINE_1_1` - baseline usage is an entire OCPU. This represents a non-burstable instance. + enum: + - BASELINE_1_8 + - BASELINE_1_2 + - BASELINE_1_1 + type: string + memoryInGBs: + description: | + The total amount of memory available to the instance, in gigabytes. + format: float + minimum: 0 + type: number + nvmes: + description: | + The number of NVMe drives to be used for storage. + format: int32 + maximum: 7 + minimum: 1 + type: integer + ocpus: + description: | + The total number of OCPUs available to the instance. + format: float + minimum: 0 + type: number + type: object + ClusterConfigDetails: + description: | + The HPC cluster configuration requested when launching instances in a compute capacity reservation. + + If the parameter is provided, the reservation is created with the HPC island and a list of HPC blocks that you + specify. If a list of HPC blocks are missing or not provided, the reservation is created with any HPC blocks in + the HPC island that you specify. If the values of HPC island or HPC block that you provide are not valid, an error + is returned. + properties: + hpcIslandId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the HPC island. + maxLength: 255 + minLength: 1 + type: string + networkBlockIds: + description: The list of OCIDs of the network blocks. + items: + type: string + type: array + required: + - hpcIslandId + type: object + ComputeHostConfigurationCheckDetails: + description: | + Compute Host Group Configuration Details Check + properties: + configurationState: + description: | + The current state of the host configuration. The Host is either | + CONFORMANT - current state matches the desired configuration + NON_CONFORMANT - current state does not match the desired configuration + PRE_APPLYING, APPLYING, CHECKING- transitional states + UNKNOWN - current state is unknown + enum: + - CONFORMANT + - NON_CONFORMANT + - CHECKING + - PRE_APPLYING + - APPLYING + - UNKNOWN + type: string + x-obmcs-top-level-enum: '#/definitions/ConfigurationState' + firmwareBundleId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique firmware bundle associated with the Host Configuration. + maxLength: 255 + minLength: 1 + type: string + recycleLevel: + description: | + Preferred recycle level for hosts associated with the reservation config. + * `SKIP_RECYCLE` - Skips host wipe. + * `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior. + enum: + - SKIP_RECYCLE + - FULL_RECYCLE + type: string + type: + description: The type of configuration + enum: + - FIRMWARE + - RECYCLE + type: string + type: object + CapacityBinPreview: + description: | + Total CPU and memory capacity for each capacity bucket. + properties: + capacityIndex: + description: | + Zero-based index for the corresponding capacity bucket. + format: int32 + maximum: 24 + minimum: 0 + type: integer + supportedShapes: + description: | + List of VMI shapes supported on each capacity bucket. + items: + type: string + maxItems: 25 + minItems: 1 + type: array + totalMemoryInGBs: + description: | + The total memory of the capacity bucket, in GBs. + format: float + minimum: 0 + type: number + totalOcpus: + description: | + The total OCPUs of the capacity bucket. + format: float + minimum: 0 + type: number + required: + - capacityIndex + - totalOcpus + - totalMemoryInGBs + - supportedShapes + type: object + ComponentVersion: + description: Represents a specific component type and its associated firmware versions. + properties: + componentType: + description: The type of component. + type: string + version: + description: A list of firmware versions associated with this component type. + items: + type: string + type: array + required: + - componentType + - version + type: object + InstanceAgentPluginConfigDetails: + description: The configuration of plugins associated with this instance. + properties: + desiredState: + description: | + Whether the plugin should be enabled or disabled. + + To enable the monitoring and management plugins, the `isMonitoringDisabled` and + `isManagementDisabled` attributes must also be set to false. + enum: + - ENABLED + - DISABLED + type: string + name: + description: | + The plugin name. To get a list of available plugins, use the + [ListInstanceagentAvailablePlugins](#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) + operation in the Oracle Cloud Agent API. For more information about the available plugins, see + [Managing Plugins with Oracle Cloud Agent](/iaas/Content/Compute/Tasks/manage-plugins.htm). + maxLength: 255 + minLength: 1 + type: string + required: + - name + - desiredState + type: object + PreemptionAction: + description: | + The action to run when the preemptible instance is interrupted for eviction. + discriminator: + propertyName: type + properties: + type: + description: The type of action to run when the instance is interrupted for eviction. + enum: + - TERMINATE + type: string + required: + - type + type: object + InstancePoolLifecycleActionsDetails: + description: | + The lifecycle actions for the instance pool. + minProperties: 1 + properties: + preTermination: + $ref: '#/components/schemas/InstancePoolPreTerminationActionDetails' + type: object + Ipv6AddressIpv6SubnetCidrPairDetails: + description: | + Details to assign an IPv6 subnet prefix and IPv6 address on VNIC creation. + properties: + ipv6Address: + description: | + An IPv6 address of your choice. Must be an available IPv6 address within the subnet's prefix. + If an IPv6 address is not provided: + - Oracle will automatically assign an IPv6 address from the subnet's IPv6 prefix if and only if there is only one IPv6 prefix on the subnet. + - Oracle will automatically assign an IPv6 address from the subnet's IPv6 Oracle GUA prefix if it exists on the subnet. + maxLength: 45 + minLength: 1 + type: string + x-default-description: 'null' + ipv6Id: + description: | + An [OCID](/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use. + maxLength: 255 + minLength: 1 + type: string + ipv6SubnetCidr: + description: | + The IPv6 prefix allocated to the subnet. + maxLength: 45 + minLength: 1 + type: string + x-default-description: 'null' + type: object + LaunchCreateVolumeDetails: + description: Define a volume that will be created and attached or attached to an instance on creation. + discriminator: + propertyName: volumeCreationType + properties: + volumeCreationType: + description: Specifies the method for volume creation. + enum: + - ATTRIBUTES + type: string + required: + - volumeCreationType + type: object + MeasuredBootEntry: + description: | + One Trusted Platform Module (TPM) Platform Configuration Register (PCR) entry. The entry might be measured during boot, + or specified in a policy. + properties: + hashAlgorithm: + description: The type of algorithm used to calculate the hash. + type: string + pcrIndex: + description: The index of the policy. + type: string + value: + description: The hashed PCR value. + type: string + type: object + ShapeAccessControlServiceEnabledPlatformOptions: + description: | + Configuration options for the Access Control Service. + properties: + allowedValues: + description: | + Whether the Access Control Service can be enabled. + items: + type: boolean + maxItems: 2 + minItems: 1 + type: array + isDefaultEnabled: + description: | + Whether the Access Control Service is enabled by default. + type: boolean + type: object + ShapeInputOutputMemoryManagementUnitEnabledPlatformOptions: + description: | + Configuration options for the input-output memory management unit (IOMMU). + properties: + allowedValues: + description: | + Whether the input-output memory management unit can be enabled. + items: + type: boolean + maxItems: 2 + minItems: 1 + type: array + isDefaultEnabled: + description: | + Whether the input-output memory management unit is enabled by default. + type: boolean + type: object + ShapeMeasuredBootOptions: + description: | + Configuration options for the Measured Boot feature. + properties: + allowedValues: + description: | + Boolean values that indicate whether the Measured Boot feature can be enabled or disabled. + items: + type: boolean + maxItems: 2 + minItems: 1 + type: array + isDefaultEnabled: + description: | + Whether the Measured Boot feature is enabled by default. + type: boolean + type: object + ShapeMemoryEncryptionOptions: + description: | + Configuration options for memory encryption. + properties: + allowedValues: + description: | + Whether memory encryption can be enabled. + items: + type: boolean + type: array + isDefaultEnabled: + description: | + Whether memory encryption is enabled by default. + type: boolean + type: object + ShapeNumaNodesPerSocketPlatformOptions: + description: | + Configuration options for NUMA nodes per socket. + properties: + allowedValues: + description: | + The supported values for this platform configuration property. + items: + enum: + - NPS0 + - NPS1 + - NPS2 + - NPS4 + - NPS6 + type: string + maxItems: 5 + minItems: 1 + type: array + defaultValue: + description: | + The default NUMA nodes per socket configuration. + type: string + type: object + PercentageOfCoresEnabledOptions: + description: | + Configuration options for the percentage of cores enabled. + properties: + defaultValue: + description: | + The default percentage of cores enabled. + maximum: 100 + minimum: 0 + type: integer + max: + description: | + The maximum allowed percentage of cores enabled. + maximum: 100 + minimum: 0 + type: integer + min: + description: | + The minimum allowed percentage of cores enabled. + maximum: 100 + minimum: 0 + type: integer + type: object + ShapeSecureBootOptions: + description: | + Configuration options for Secure Boot. + properties: + allowedValues: + description: | + Boolean values that indicate whether Secure Boot can be enabled or disabled. + items: + type: boolean + maxItems: 2 + minItems: 1 + type: array + isDefaultEnabled: + description: | + Whether Secure Boot is enabled by default. + type: boolean + type: object + ShapeSymmetricMultiThreadingEnabledPlatformOptions: + description: | + Configuration options for symmetric multithreading (also called simultaneous multithreading or SMT). + properties: + allowedValues: + description: | + Whether symmetric multithreading can be enabled. + items: + type: boolean + maxItems: 2 + minItems: 1 + type: array + isDefaultEnabled: + description: | + Whether symmetric multithreading is enabled by default. + type: boolean + type: object + ShapeTrustedPlatformModuleOptions: + description: | + Configuration options for the Trusted Platform Module (TPM). + properties: + allowedValues: + description: | + Boolean values that indicate whether the Trusted Platform Module can be enabled or disabled. + items: + type: boolean + maxItems: 2 + minItems: 1 + type: array + isDefaultEnabled: + description: | + Whether the Trusted Platform Module is enabled by default. + type: boolean + type: object + ShapeVirtualInstructionsEnabledPlatformOptions: + description: | + Configuration options for the virtualization instructions. + properties: + allowedValues: + description: | + Whether virtualization instructions can be enabled. + items: + type: boolean + maxItems: 2 + minItems: 1 + type: array + isDefaultEnabled: + description: | + Whether virtualization instructions are enabled by default. + type: boolean + type: object + InstancePoolPlacementSubnetDetails: + description: Base details about the IPv6 subnet. + properties: + ipv6AddressIpv6SubnetCidrPairDetails: + description: | + A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. + You can provide only the prefix ranges and OCI will select an available + address from the range. You can optionally choose to leave the prefix range empty + and instead provide the specific IPv6 address that should be used from within that range. + items: + $ref: '#/components/schemas/InstancePoolPlacementIpv6AddressIpv6SubnetCidrDetails' + type: array + isAssignIpv6Ip: + default: false + description: | + Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled + subnet. Default: False. When provided you may optionally provide an IPv6 prefix + (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` + is not provided then an IPv6 prefix is chosen + for you. + type: boolean + subnetId: + description: The subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC. + maxLength: 255 + minLength: 1 + type: string + required: + - subnetId + type: object + InstancePoolPreTerminationActionDetails: + description: | + The data for pre-termination action for an instance pool + properties: + isEnabled: + description: | + Whether pre-termination action is enabled or not. + type: boolean + onTimeout: + $ref: '#/components/schemas/InstancePoolPreTerminationActionHandleTimeoutDetails' + timeout: + description: | + The timeout in seconds for pre-termination action for an instance pool. + type: integer + required: + - isEnabled + - timeout + - onTimeout + type: object + InstancePoolPlacementIpv6AddressIpv6SubnetCidrDetails: + description: | + Optional. Used to specify from which subnet prefixes an IPv6 address should be allocated, or to assign valid available IPv6 addresses. + properties: + ipv6SubnetCidr: + description: | + Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. + maxLength: 45 + minLength: 1 + type: string + type: object + InstancePoolPreTerminationActionHandleTimeoutDetails: + description: | + Options to handle timeout for pre-termination action. + properties: + preserveBlockVolumeMode: + description: | + Whether the block volume should be preserved after termination. + enum: + - PRESERVE_ALWAYS + - PRESERVE_ON_TIMEOUT + - DELETE_ALWAYS + type: string + preserveBootVolumeMode: + description: | + Whether the boot volume should be preserved after termination. + enum: + - PRESERVE_ALWAYS + - PRESERVE_ON_TIMEOUT + - DELETE_ALWAYS + type: string + required: + - preserveBlockVolumeMode + - preserveBootVolumeMode + type: object + ListAppCatalogListingsResponse: + type: object + properties: + app_catalog_listings: + type: array + items: + $ref: '#/components/schemas/AppCatalogListingSummary' + ListAppCatalogListingResourceVersionsResponse: + type: object + properties: + app_catalog_listing_resource_versions: + type: array + items: + $ref: '#/components/schemas/AppCatalogListingResourceVersionSummary' + ListAppCatalogSubscriptionsResponse: + type: object + properties: + app_catalog_subscriptions: + type: array + items: + $ref: '#/components/schemas/AppCatalogSubscriptionSummary' + ListBootVolumeAttachmentsResponse: + type: object + properties: + boot_volume_attachments: + type: array + items: + $ref: '#/components/schemas/BootVolumeAttachment' + ListClusterNetworksResponse: + type: object + properties: + cluster_networks: + type: array + items: + $ref: '#/components/schemas/ClusterNetworkSummary' + ListClusterNetworkInstancesResponse: + type: object + properties: + cluster_network_instances: + type: array + items: + $ref: '#/components/schemas/InstanceSummary' + ListComputeCapacityReservationInstanceShapesResponse: + type: object + properties: + compute_capacity_reservation_instance_shapes: + type: array + items: + $ref: '#/components/schemas/ComputeCapacityReservationInstanceShapeSummary' + ListComputeCapacityReservationsResponse: + type: object + properties: + compute_capacity_reservations: + type: array + items: + $ref: '#/components/schemas/ComputeCapacityReservationSummary' + ListComputeCapacityReservationInstancesResponse: + type: object + properties: + compute_capacity_reservation_instances: + type: array + items: + $ref: '#/components/schemas/CapacityReservationInstanceSummary' + ListComputeGlobalImageCapabilitySchemasResponse: + type: object + properties: + compute_global_image_capability_schemas: + type: array + items: + $ref: '#/components/schemas/ComputeGlobalImageCapabilitySchemaSummary' + ListComputeGlobalImageCapabilitySchemaVersionsResponse: + type: object + properties: + compute_global_image_capability_schema_versions: + type: array + items: + $ref: '#/components/schemas/ComputeGlobalImageCapabilitySchemaVersionSummary' + ListComputeImageCapabilitySchemasResponse: + type: object + properties: + compute_image_capability_schemas: + type: array + items: + $ref: '#/components/schemas/ComputeImageCapabilitySchemaSummary' + ListDedicatedVmHostInstanceShapesResponse: + type: object + properties: + dedicated_vm_host_instance_shapes: + type: array + items: + $ref: '#/components/schemas/DedicatedVmHostInstanceShapeSummary' + ListDedicatedVmHostShapesResponse: + type: object + properties: + dedicated_vm_host_shapes: + type: array + items: + $ref: '#/components/schemas/DedicatedVmHostShapeSummary' + ListDedicatedVmHostsResponse: + type: object + properties: + dedicated_vm_hosts: + type: array + items: + $ref: '#/components/schemas/DedicatedVmHostSummary' + ListDedicatedVmHostInstancesResponse: + type: object + properties: + dedicated_vm_host_instances: + type: array + items: + $ref: '#/components/schemas/DedicatedVmHostInstanceSummary' + ListImagesResponse: + type: object + properties: + images: + type: array + items: + $ref: '#/components/schemas/Image' + ListImageShapeCompatibilityEntriesResponse: + type: object + properties: + image_shape_compatibility_entries: + type: array + items: + $ref: '#/components/schemas/ImageShapeCompatibilitySummary' + ListInstanceConfigurationsResponse: + type: object + properties: + instance_configurations: + type: array + items: + $ref: '#/components/schemas/InstanceConfigurationSummary' + ListInstanceConsoleConnectionsResponse: + type: object + properties: + instance_console_connections: + type: array + items: + $ref: '#/components/schemas/InstanceConsoleConnection' + ListConsoleHistoriesResponse: + type: object + properties: + console_histories: + type: array + items: + $ref: '#/components/schemas/ConsoleHistory' + ListInstanceMaintenanceEventsResponse: + type: object + properties: + instance_maintenance_events: + type: array + items: + $ref: '#/components/schemas/InstanceMaintenanceEventSummary' + ListInstancePoolsResponse: + type: object + properties: + instance_pools: + type: array + items: + $ref: '#/components/schemas/InstancePoolSummary' + ListInstancePoolInstancesResponse: + type: object + properties: + instance_pool_instances: + type: array + items: + $ref: '#/components/schemas/InstanceSummary' + ListInstancesResponse: + type: object + properties: + instances: + type: array + items: + $ref: '#/components/schemas/Instance' + ListInstanceDevicesResponse: + type: object + properties: + instance_devices: + type: array + items: + $ref: '#/components/schemas/Device' + ListShapesResponse: + type: object + properties: + shapes: + type: array + items: + $ref: '#/components/schemas/Shape' + ListVnicAttachmentsResponse: + type: object + properties: + vnic_attachments: + type: array + items: + $ref: '#/components/schemas/VnicAttachment' + ListVolumeAttachmentsResponse: + type: object + properties: + volume_attachments: + type: array + items: + $ref: '#/components/schemas/VolumeAttachment' + responses: + '400': + description: Bad Request + 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' + '401': + description: Unauthorized + 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' + '404': + description: Not Found + 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' + '409': + description: Conflict + 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' + '412': + description: Precondition Failed + 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' + '429': + description: Too many requests + 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' + '500': + description: Internal Server 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' + DefaultError: + description: An error has occurred. + 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' + parameters: + PaginationLimitQueryParam: + description: | + For list pagination. The maximum number of results per page, or items to return in a paginated + "List" call. For important details about how pagination works, see + [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + + Example: `50` + in: query + name: limit + x-default-description: The default maximum results per page varies by API. + schema: + type: integer + minimum: 1 + maximum: 100 + PaginationTokenQueryParam: + description: | + For list pagination. The value of the `opc-next-page` response header from the previous "List" + call. For important details about how pagination works, see + [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + in: query + name: page + schema: + type: string + minLength: 1 + maxLength: 4096 + SortOrderQueryParam: + description: | + The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order + is case sensitive. + in: query + name: sortOrder + required: false + x-default-description: The default sort order varies by API. + schema: + type: string + enum: + - ASC + - DESC + default: ASC + FilterByPublisherNameQueryParam: + description: | + A filter to return only the publisher that matches the given publisher name exactly. + in: query + name: publisherName + required: false + schema: + type: string + minLength: 1 + maxLength: 64 + FilterByPublisherTypeQueryParam: + description: | + A filter to return only publishers that match the given publisher type exactly. Valid types are OCI, ORACLE, TRUSTED, STANDARD. + in: query + name: publisherType + required: false + schema: + type: string + minLength: 1 + maxLength: 64 + FilterByDisplayNameQueryParam: + description: | + A filter to return only resources that match the given display name exactly. + in: query + name: displayName + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + ListingIdPathParam: + description: The OCID of the listing. + in: path + name: listingId + required: true + schema: + type: string + ResourceVersionPathParam: + description: Listing Resource Version. + in: path + name: resourceVersion + required: true + schema: + type: string + ListingIdQueryParam: + description: The OCID of the listing. + in: query + name: listingId + required: true + schema: + type: string + CompartmentIdQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. + in: query + name: compartmentId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ResourceVersionQueryParam: + description: Listing Resource Version. + in: query + name: resourceVersion + required: true + schema: + type: string + SortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for + TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME + sort order is case sensitive. + + **Note:** In general, some "List" operations (for example, `ListInstances`) let you + optionally filter by availability domain if the scope of the resource type is within a + single availability domain. If you call one of these "List" operations without specifying + an availability domain, the resources are grouped by availability domain, then sorted. + in: query + name: sortBy + required: false + x-default-description: The default field to sort by varies by API. + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + FilterByListingIdQueryParam: + description: | + A filter to return only the listings that matches the given listing id. + in: query + name: listingId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + RetryTokenHeader: + description: | + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + may be rejected). + in: header + name: opc-retry-token + schema: + type: string + minLength: 1 + maxLength: 64 + RequiredAvailabilityDomainQueryParam: + description: | + The name of the availability domain. + + Example: `Uocm:PHX-AD-1` + in: query + name: availabilityDomain + required: true + schema: + type: string + InstanceIdQueryParam: + description: The OCID of the instance. + in: query + name: instanceId + schema: + type: string + BootVolumeIdQueryParam: + description: The OCID of the boot volume. + in: query + name: bootVolumeId + schema: + type: string + BootVolumeAttachmentIdPathParam: + description: The OCID of the boot volume attachment. + in: path + name: bootVolumeAttachmentId + required: true + schema: + type: string + 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 + schema: + type: string + ClusterNetworkIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster network. + in: path + name: clusterNetworkId + required: true + schema: + type: string + RequestIdHeader: + description: | + Unique identifier for the request. + If you need to contact Oracle about a particular request, please provide the request ID. + in: header + name: opc-request-id + schema: + type: string + pattern: '[A-Za-z0-9\-_\.]+' + AvailabilityDomainQueryParam: + description: | + The name of the availability domain. + + Example: `Uocm:PHX-AD-1` + in: query + name: availabilityDomain + required: false + schema: + type: string + CapacityReservationLifecycleStateQueryParam: + description: A filter to only return resources that match the given lifecycle state. + in: query + name: lifecycleState + required: false + x-default-description: The default value varies for this API + x-obmcs-enumref: '#/definitions/ComputeCapacityReservation/lifecycleState' + schema: + type: string + ComputeCapacityReservationIdPathParam: + description: The OCID of the compute capacity reservation. + in: path + name: capacityReservationId + required: true + schema: + type: string + CompartmentIdOptionalQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. + in: query + name: compartmentId + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + ComputeCapacityTopologyIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology. + in: path + name: computeCapacityTopologyId + required: true + schema: + type: string + ComputeHpcIslandIdQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute HPC island. + in: query + name: computeHpcIslandId + required: false + schema: + type: string + ComputeNetworkBlockIdQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute network block. + in: query + name: computeNetworkBlockId + required: false + schema: + type: string + ComputeLocalBlockIdQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute local block. + in: query + name: computeLocalBlockId + required: false + schema: + type: string + ComputeClusterIdPathParam: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster. + A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory + access (RDMA) network group. + in: path + name: computeClusterId + required: true + schema: + type: string + ComputeImageCapabilityCompartmentIdQueryParam: + description: | + A filter to return only resources that match the given compartment OCID exactly. + in: query + name: compartmentId + required: false + x-default-description: publicCompartment + schema: + type: string + minLength: 1 + maxLength: 255 + ComputeGlobalImageCapabilitySchemaIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute global image capability schema + in: path + name: computeGlobalImageCapabilitySchemaId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ComputeGlobalImageCapabilitySchemaVersionNamePathParam: + description: The name of the compute global image capability schema version + in: path + name: computeGlobalImageCapabilitySchemaVersionName + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ComputeGpuMemoryClusterIdQueryParam: + description: | + A filter to return only the listings that matches the given GPU memory cluster id. + in: query + name: computeGpuMemoryClusterId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + ComputeGpuMemoryFabricIdQueryParam: + description: | + A filter to return only the listings that matches the given GPU memory fabric id. + in: query + name: computeGpuMemoryFabricId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + ComputeClusterIdQueryParam: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster. + A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory + access (RDMA) network group. + in: query + name: computeClusterId + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + ComputeGpuMemoryClusterIdPathParam: + description: The OCID of the compute GPU memory cluster. + in: path + name: computeGpuMemoryClusterId + required: true + schema: + type: string + ComputeGpuMemoryFabricLifecycleStateQueryParam: + description: | + A filter to return ComputeGpuMemoryFabricSummary resources that match the given lifecycle state. + in: query + name: computeGpuMemoryFabricLifecycleState + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/ComputeGpuMemoryFabric/lifecycleState' + schema: + type: string + ComputeGpuMemoryFabricHealthQueryParam: + description: | + A filter to return ComputeGpuMemoryFabricSummary resources that match the given fabric health. + in: query + name: computeGpuMemoryFabricHealth + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/ComputeGpuMemoryFabric/fabricHealth' + schema: + type: string + ComputeGpuMemoryFabricIdPathParam: + description: The OCID of the compute GPU memory fabric. + in: path + name: computeGpuMemoryFabricId + required: true + schema: + type: string + ComputeHostGroupIdParam: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host group. + in: path + name: computeHostGroupId + required: true + schema: + type: string + ComputeHostNetworkResourceQueryParam: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host network resoruce. + - Customer-unique HPC island ID + - Customer-unique network block ID + - Customer-unique local block ID + in: query + name: networkResourceId + required: false + schema: + type: string + ComputeHostLifecycleStateParam: + description: | + A filter to return only ComputeHostSummary resources that match the given Compute Host lifecycle State OCID exactly. + in: query + name: computeHostLifecycleState + x-default-description: 'null' + schema: + type: string + ComputeHostHealthParam: + description: | + A filter to return only ComputeHostSummary resources that match the given Compute Host health State OCID exactly. + in: query + name: computeHostHealth + x-default-description: 'null' + schema: + type: string + ComputeHostGroupIdQueryParam: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host group. + in: query + name: computeHostGroupId + required: false + x-default-description: 'null' + schema: + type: string + ComputeHostInSubtreeQueryParam: + description: | + When set to true, all the compartments in the tenancy are traversed + and the hosts in the specified tenancy and its compartments are fetched. + Default is false. + in: query + name: computeHostInSubtree + required: false + schema: + type: boolean + default: false + ComputeHostIdPathParam: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host. + in: path + name: computeHostId + required: true + schema: + type: string + ImageIdQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an image. + in: query + name: imageId + schema: + type: string + ComputeImageCapabilitySchemaIdPathParam: + description: The id of the compute image capability schema or the image ocid + in: path + name: computeImageCapabilitySchemaId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ComputeImageCapabilityMergeQueryParam: + description: | + Merge the image capability schema with the global image capability schema + in: query + name: isMergeEnabled + required: false + schema: + type: boolean + minLength: 1 + maxLength: 64 + default: false + DedicatedVmHostShapeNameQueryParam: + description: | + Dedicated VM host shape name + in: query + name: dedicatedVmHostShape + required: false + schema: + type: string + InstanceShapeNameQueryParam: + description: | + The name for the instance's shape. + in: query + name: instanceShapeName + required: false + schema: + type: string + DedicatedVmHostLifecycleStateQueryParam: + description: A filter to only return resources that match the given lifecycle state. + in: query + name: lifecycleState + required: false + schema: + type: string + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + - DELETED + - FAILED + RemainingMemoryInGBsGreaterThanOrEqualToQueryParam: + description: The remaining memory of the dedicated VM host, in GBs. + in: query + name: remainingMemoryInGBsGreaterThanOrEqualTo + required: false + x-default-description: 'null' + schema: + type: number + format: float + minimum: 0 + RemainingOcpusGreaterThanOrEqualToQueryParam: + description: The available OCPUs of the dedicated VM host. + in: query + name: remainingOcpusGreaterThanOrEqualTo + required: false + x-default-description: 'null' + schema: + type: number + format: float + minimum: 0 + IsMemoryEncryptionEnabledQueryParam: + description: | + A filter to return only confidential Dedicated VM hosts (DVMH) or confidential VM instances on DVMH. + in: query + name: isMemoryEncryptionEnabled + required: false + schema: + type: boolean + DedicatedVmHostIdPathParam: + description: The OCID of the dedicated VM host. + in: path + name: dedicatedVmHostId + required: true + schema: + type: string + DevicePlatformQueryParam: + description: platform name + in: query + name: platform + required: true + schema: + type: string + DefaultBundleQueryParam: + description: If true, return only the default firmware bundle for a given platform. Default is false. + in: query + name: isDefaultBundle + required: false + schema: + type: boolean + default: false + FilterByLifecycleStateQueryParam: + description: | + A filter to return only resources that match the given lifecycle state name exactly. + in: query + name: lifecycleState + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + FirmwareBundleIdPathParam: + description: Unique identifier for the firmware bundle. + in: path + name: firmwareBundleId + required: true + schema: + type: string + OperatingSystemQueryParam: + description: | + The image's operating system. + + Example: `Oracle Linux` + in: query + name: operatingSystem + schema: + type: string + OperatingSystemVersionQueryParam: + description: | + The image's operating system version. + + Example: `7.2` + in: query + name: operatingSystemVersion + schema: + type: string + ShapeNameQueryParam: + description: Shape name. + in: query + name: shape + schema: + type: string + ImageIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image. + in: path + name: imageId + required: true + schema: + type: string + ShapeNamePathParam: + description: Shape name. + in: path + name: shapeName + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + InstanceConfigurationIdPathParam: + description: The OCID of the instance configuration. + in: path + name: instanceConfigurationId + required: true + schema: + type: string + OpcComputeClusterIdHeader: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the + [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) that the instance will be created in. + in: header + name: opc-compute-cluster-id + required: false + x-default-description: 'null' + schema: + type: string + InstanceConsoleConnectionIdPathParam: + description: The OCID of the instance console connection. + in: path + name: instanceConsoleConnectionId + required: true + schema: + type: string + InstanceConsoleHistoryIdPathParam: + description: The OCID of the console history. + in: path + name: instanceConsoleHistoryId + required: true + schema: + type: string + InstanceMaintenanceEventLifecycleStateQueryParam: + description: A filter to only return resources that match the given lifecycle state. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/InstanceMaintenanceEvent/lifecycleState' + schema: + type: string + InstanceMaintenanceEventCorrelationTokenQueryParam: + description: A filter to only return resources that have a matching correlationToken. + in: query + name: correlationToken + required: false + x-default-description: The correlationToken from an InstanceMaintenanceEvent + schema: + type: string + InstanceMaintenanceEventInstanceActionQueryParam: + description: A filter to only return resources that match the given instance action. + in: query + name: instanceAction + required: false + schema: + type: string + TimeWindowStartGreaterThanOrEqualToQueryParam: + description: Starting range to return the maintenances which are not completed (date-time is in [RFC3339](https://tools.ietf.org/html/rfc3339) format). + in: query + name: timeWindowStartGreaterThanOrEqualTo + required: false + schema: + type: string + format: date-time + minLength: 1 + maxLength: 255 + TimeWindowStartLessThanOrEqualToQueryParam: + description: Ending range to return the maintenances which are not completed (date-time is in [RFC3339](https://tools.ietf.org/html/rfc3339) format). + in: query + name: timeWindowStartLessThanOrEqualTo + required: false + schema: + type: string + format: date-time + minLength: 1 + maxLength: 255 + MaintenanceIdPathParam: + description: The OCID of the instance maintenance event. + in: path + name: instanceMaintenanceEventId + required: true + schema: + type: string + InstancePoolIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool. + in: path + name: instancePoolId + required: true + schema: + type: string + InstanceIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance. + in: path + name: instanceId + required: true + schema: + type: string + InstancePoolLoadBalancerAttachmentIdPathParam: + description: The OCID of the load balancer attachment. + in: path + name: instancePoolLoadBalancerAttachmentId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ComputeCapacityReservationIdQueryParam: + description: The OCID of the compute capacity reservation. + in: query + name: capacityReservationId + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + PreserveBootVolumeQueryParam: + description: | + Specifies whether to delete or preserve the boot volume when terminating an instance. + When set to `true`, the boot volume is preserved. The default value is `false`. + in: query + name: preserveBootVolume + required: false + schema: + type: boolean + default: false + PreserveDataVolumesQueryParam: + description: | + Specifies whether to delete or preserve the data volumes created during launch when + terminating an instance. When set to `true`, the data volumes are preserved. The + default value is `true`. + in: query + name: preserveDataVolumesCreatedAtLaunch + required: false + schema: + type: boolean + default: true + RecycleLevelQueryParam: + description: | + This optional parameter overrides recycle level for hosts. The parameter can be used when hosts are associated + with a Capacity Reservation. + * `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior. + in: query + name: recycleLevel + required: false + x-default-description: 'null' + schema: + type: string + enum: + - FULL_RECYCLE + InstanceActionQueryParam: + description: The action to perform on the instance. + in: query + name: action + required: true + x-obmcs-inline-enum: false + schema: + type: string + enum: + - STOP + - START + - SOFTRESET + - RESET + - SOFTSTOP + - SENDDIAGNOSTICINTERRUPT + - DIAGNOSTICREBOOT + - REBOOTMIGRATE + FilterByDeviceAvailabilityQueryParam: + description: | + A filter to return only available devices or only used devices. + in: query + name: isAvailable + required: false + schema: + type: boolean + FilterByDeviceNameQueryParam: + description: | + A filter to return only devices that match the given name exactly. + in: query + name: name + required: false + schema: + type: string + minLength: 3 + maxLength: 9 + VnicIdOptionalQueryParam: + description: The OCID of the VNIC. + in: query + name: vnicId + required: false + schema: + type: string + VnicAttachmentIdPathParam: + description: The OCID of the VNIC attachment. + in: path + name: vnicAttachmentId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + VolumeIdQueryParam: + description: The OCID of the volume. + in: query + name: volumeId + schema: + type: string + VolumeAttachmentIdPathParam: + description: The OCID of the volume attachment. + in: path + name: volumeAttachmentId + required: true + schema: + type: string + x-stackQL-resources: + app_catalog_listings: + id: oci.compute.app_catalog_listings + name: app_catalog_listings + title: App Catalog Listings + methods: + list: + operation: + $ref: '#/paths/~1appCatalogListings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.app_catalog_listings + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAppCatalogListingsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"app_catalog_listings\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1appCatalogListings~1{listingId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/app_catalog_listings/methods/get' + - $ref: '#/components/x-stackQL-resources/app_catalog_listings/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + app_catalog_listing_resource_versions: + id: oci.compute.app_catalog_listing_resource_versions + name: app_catalog_listing_resource_versions + title: App Catalog Listing Resource Versions + methods: + list: + operation: + $ref: '#/paths/~1appCatalogListings~1{listingId}~1resourceVersions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.app_catalog_listing_resource_versions + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAppCatalogListingResourceVersionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"app_catalog_listing_resource_versions\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1appCatalogListings~1{listingId}~1resourceVersions~1{resourceVersion}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/app_catalog_listing_resource_versions/methods/get' + - $ref: '#/components/x-stackQL-resources/app_catalog_listing_resource_versions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + app_catalog_listing_agreements: + id: oci.compute.app_catalog_listing_agreements + name: app_catalog_listing_agreements + title: App Catalog Listing Agreements + methods: + get: + operation: + $ref: '#/paths/~1appCatalogListings~1{listingId}~1resourceVersions~1{resourceVersion}~1agreements/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/app_catalog_listing_agreements/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + app_catalog_subscriptions: + id: oci.compute.app_catalog_subscriptions + name: app_catalog_subscriptions + title: App Catalog Subscriptions + methods: + delete: + operation: + $ref: '#/paths/~1appCatalogSubscriptions/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + list: + operation: + $ref: '#/paths/~1appCatalogSubscriptions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.app_catalog_subscriptions + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAppCatalogSubscriptionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"app_catalog_subscriptions\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1appCatalogSubscriptions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/app_catalog_subscriptions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/app_catalog_subscriptions/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/app_catalog_subscriptions/methods/delete' + replace: [] + boot_volume_attachments: + id: oci.compute.boot_volume_attachments + name: boot_volume_attachments + title: Boot Volume Attachments + methods: + list: + operation: + $ref: '#/paths/~1bootVolumeAttachments~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.boot_volume_attachments + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListBootVolumeAttachmentsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"boot_volume_attachments\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + attach: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1bootVolumeAttachments~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + detach: + operation: + $ref: '#/paths/~1bootVolumeAttachments~1{bootVolumeAttachmentId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1bootVolumeAttachments~1{bootVolumeAttachmentId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/boot_volume_attachments/methods/get' + - $ref: '#/components/x-stackQL-resources/boot_volume_attachments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/boot_volume_attachments/methods/attach' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/boot_volume_attachments/methods/detach' + replace: [] + cluster_networks: + id: oci.compute.cluster_networks + name: cluster_networks + title: Cluster Networks + methods: + list: + operation: + $ref: '#/paths/~1clusterNetworks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.cluster_networks + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListClusterNetworksResponse' + transform: + body: |- + {{- $wrapped := printf "{\"cluster_networks\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1clusterNetworks/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + terminate: + operation: + $ref: '#/paths/~1clusterNetworks~1{clusterNetworkId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1clusterNetworks~1{clusterNetworkId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1clusterNetworks~1{clusterNetworkId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1clusterNetworks~1{clusterNetworkId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cluster_networks/methods/get' + - $ref: '#/components/x-stackQL-resources/cluster_networks/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/cluster_networks/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/cluster_networks/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/cluster_networks/methods/terminate' + replace: [] + cluster_network_instances: + id: oci.compute.cluster_network_instances + name: cluster_network_instances + title: Cluster Network Instances + methods: + list: + operation: + $ref: '#/paths/~1clusterNetworks~1{clusterNetworkId}~1instances/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.cluster_network_instances + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListClusterNetworkInstancesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"cluster_network_instances\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cluster_network_instances/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + compute_capacity_reports: + id: oci.compute.compute_capacity_reports + name: compute_capacity_reports + title: Compute Capacity Reports + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeCapacityReports/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/compute_capacity_reports/methods/create' + update: [] + delete: [] + replace: [] + compute_capacity_reservation_instance_shapes: + id: oci.compute.compute_capacity_reservation_instance_shapes + name: compute_capacity_reservation_instance_shapes + title: Compute Capacity Reservation Instance Shapes + methods: + list: + operation: + $ref: '#/paths/~1computeCapacityReservationInstanceShapes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.compute_capacity_reservation_instance_shapes + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListComputeCapacityReservationInstanceShapesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"compute_capacity_reservation_instance_shapes\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/compute_capacity_reservation_instance_shapes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + compute_capacity_reservations: + id: oci.compute.compute_capacity_reservations + name: compute_capacity_reservations + title: Compute Capacity Reservations + methods: + list: + operation: + $ref: '#/paths/~1computeCapacityReservations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.compute_capacity_reservations + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListComputeCapacityReservationsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"compute_capacity_reservations\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeCapacityReservations/post' + response: + mediaType: application/json + openAPIDocKey: '201' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1computeCapacityReservations~1{capacityReservationId}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1computeCapacityReservations~1{capacityReservationId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeCapacityReservations~1{capacityReservationId}/put' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeCapacityReservations~1{capacityReservationId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/compute_capacity_reservations/methods/get' + - $ref: '#/components/x-stackQL-resources/compute_capacity_reservations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/compute_capacity_reservations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/compute_capacity_reservations/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/compute_capacity_reservations/methods/delete' + replace: [] + compute_capacity_reservation_instances: + id: oci.compute.compute_capacity_reservation_instances + name: compute_capacity_reservation_instances + title: Compute Capacity Reservation Instances + methods: + list: + operation: + $ref: '#/paths/~1computeCapacityReservations~1{capacityReservationId}~1instances/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.compute_capacity_reservation_instances + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListComputeCapacityReservationInstancesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"compute_capacity_reservation_instances\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/compute_capacity_reservation_instances/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + compute_capacity_topologies: + id: oci.compute.compute_capacity_topologies + name: compute_capacity_topologies + title: Compute Capacity Topologies + methods: + list: + operation: + $ref: '#/paths/~1computeCapacityTopologies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeCapacityTopologies/post' + response: + mediaType: application/json + openAPIDocKey: '201' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1computeCapacityTopologies~1{computeCapacityTopologyId}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1computeCapacityTopologies~1{computeCapacityTopologyId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeCapacityTopologies~1{computeCapacityTopologyId}/put' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeCapacityTopologies~1{computeCapacityTopologyId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/compute_capacity_topologies/methods/get' + - $ref: '#/components/x-stackQL-resources/compute_capacity_topologies/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/compute_capacity_topologies/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/compute_capacity_topologies/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/compute_capacity_topologies/methods/delete' + replace: [] + compute_capacity_topology_compute_bare_metal_hosts: + id: oci.compute.compute_capacity_topology_compute_bare_metal_hosts + name: compute_capacity_topology_compute_bare_metal_hosts + title: Compute Capacity Topology Compute Bare Metal Hosts + methods: + list: + operation: + $ref: '#/paths/~1computeCapacityTopologies~1{computeCapacityTopologyId}~1computeBareMetalHosts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/compute_capacity_topology_compute_bare_metal_hosts/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + compute_capacity_topology_compute_hpc_islands: + id: oci.compute.compute_capacity_topology_compute_hpc_islands + name: compute_capacity_topology_compute_hpc_islands + title: Compute Capacity Topology Compute Hpc Islands + methods: + list: + operation: + $ref: '#/paths/~1computeCapacityTopologies~1{computeCapacityTopologyId}~1computeHpcIslands/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/compute_capacity_topology_compute_hpc_islands/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + compute_capacity_topology_compute_network_blocks: + id: oci.compute.compute_capacity_topology_compute_network_blocks + name: compute_capacity_topology_compute_network_blocks + title: Compute Capacity Topology Compute Network Blocks + methods: + list: + operation: + $ref: '#/paths/~1computeCapacityTopologies~1{computeCapacityTopologyId}~1computeNetworkBlocks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/compute_capacity_topology_compute_network_blocks/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + compute_clusters: + id: oci.compute.compute_clusters + name: compute_clusters + title: Compute Clusters + methods: + list: + operation: + $ref: '#/paths/~1computeClusters/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeClusters/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1computeClusters~1{computeClusterId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1computeClusters~1{computeClusterId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeClusters~1{computeClusterId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeClusters~1{computeClusterId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/compute_clusters/methods/get' + - $ref: '#/components/x-stackQL-resources/compute_clusters/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/compute_clusters/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/compute_clusters/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/compute_clusters/methods/delete' + replace: [] + compute_global_image_capability_schemas: + id: oci.compute.compute_global_image_capability_schemas + name: compute_global_image_capability_schemas + title: Compute Global Image Capability Schemas + methods: + list: + operation: + $ref: '#/paths/~1computeGlobalImageCapabilitySchemas/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.compute_global_image_capability_schemas + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListComputeGlobalImageCapabilitySchemasResponse' + transform: + body: |- + {{- $wrapped := printf "{\"compute_global_image_capability_schemas\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1computeGlobalImageCapabilitySchemas~1{computeGlobalImageCapabilitySchemaId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/compute_global_image_capability_schemas/methods/get' + - $ref: '#/components/x-stackQL-resources/compute_global_image_capability_schemas/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + compute_global_image_capability_schema_versions: + id: oci.compute.compute_global_image_capability_schema_versions + name: compute_global_image_capability_schema_versions + title: Compute Global Image Capability Schema Versions + methods: + list: + operation: + $ref: '#/paths/~1computeGlobalImageCapabilitySchemas~1{computeGlobalImageCapabilitySchemaId}~1versions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.compute_global_image_capability_schema_versions + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListComputeGlobalImageCapabilitySchemaVersionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"compute_global_image_capability_schema_versions\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1computeGlobalImageCapabilitySchemas~1{computeGlobalImageCapabilitySchemaId}~1versions~1{computeGlobalImageCapabilitySchemaVersionName}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/compute_global_image_capability_schema_versions/methods/get' + - $ref: '#/components/x-stackQL-resources/compute_global_image_capability_schema_versions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + compute_gpu_memory_clusters: + id: oci.compute.compute_gpu_memory_clusters + name: compute_gpu_memory_clusters + title: Compute Gpu Memory Clusters + methods: + list: + operation: + $ref: '#/paths/~1computeGpuMemoryClusters/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeGpuMemoryClusters/post' + response: + mediaType: application/json + openAPIDocKey: '201' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1computeGpuMemoryClusters~1{computeGpuMemoryClusterId}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1computeGpuMemoryClusters~1{computeGpuMemoryClusterId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeGpuMemoryClusters~1{computeGpuMemoryClusterId}/put' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeGpuMemoryClusters~1{computeGpuMemoryClusterId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/compute_gpu_memory_clusters/methods/get' + - $ref: '#/components/x-stackQL-resources/compute_gpu_memory_clusters/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/compute_gpu_memory_clusters/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/compute_gpu_memory_clusters/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/compute_gpu_memory_clusters/methods/delete' + replace: [] + compute_gpu_memory_cluster_instances: + id: oci.compute.compute_gpu_memory_cluster_instances + name: compute_gpu_memory_cluster_instances + title: Compute Gpu Memory Cluster Instances + methods: + list: + operation: + $ref: '#/paths/~1computeGpuMemoryClusters~1{computeGpuMemoryClusterId}~1instances/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/compute_gpu_memory_cluster_instances/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + compute_gpu_memory_fabrics: + id: oci.compute.compute_gpu_memory_fabrics + name: compute_gpu_memory_fabrics + title: Compute Gpu Memory Fabrics + methods: + list: + operation: + $ref: '#/paths/~1computeGpuMemoryFabrics/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1computeGpuMemoryFabrics~1{computeGpuMemoryFabricId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeGpuMemoryFabrics~1{computeGpuMemoryFabricId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeGpuMemoryFabrics~1{computeGpuMemoryFabricId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/compute_gpu_memory_fabrics/methods/get' + - $ref: '#/components/x-stackQL-resources/compute_gpu_memory_fabrics/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/compute_gpu_memory_fabrics/methods/update' + delete: [] + replace: [] + compute_host_groups: + id: oci.compute.compute_host_groups + name: compute_host_groups + title: Compute Host Groups + methods: + list: + operation: + $ref: '#/paths/~1computeHostGroups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeHostGroups/post' + response: + mediaType: application/json + openAPIDocKey: '201' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1computeHostGroups~1{computeHostGroupId}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1computeHostGroups~1{computeHostGroupId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeHostGroups~1{computeHostGroupId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeHostGroups~1{computeHostGroupId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/compute_host_groups/methods/get' + - $ref: '#/components/x-stackQL-resources/compute_host_groups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/compute_host_groups/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/compute_host_groups/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/compute_host_groups/methods/delete' + replace: [] + compute_hosts: + id: oci.compute.compute_hosts + name: compute_hosts + title: Compute Hosts + methods: + list: + operation: + $ref: '#/paths/~1computeHosts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1computeHosts~1{computeHostId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeHosts~1{computeHostId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + apply_host_configuration: + operation: + $ref: '#/paths/~1computeHosts~1{computeHostId}~1actions~1applyConfiguration/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + attach: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeHosts~1{computeHostId}~1actions~1attachToHostGroup/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeHosts~1{computeHostId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + check_host_configuration: + operation: + $ref: '#/paths/~1computeHosts~1{computeHostId}~1actions~1checkConfiguration/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + detach_compute_host_group_host: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeHosts~1{computeHostId}~1actions~1detachFromHostGroup/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/compute_hosts/methods/get' + - $ref: '#/components/x-stackQL-resources/compute_hosts/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/compute_hosts/methods/attach' + update: + - $ref: '#/components/x-stackQL-resources/compute_hosts/methods/update' + delete: [] + replace: [] + compute_image_capability_schemas: + id: oci.compute.compute_image_capability_schemas + name: compute_image_capability_schemas + title: Compute Image Capability Schemas + methods: + list: + operation: + $ref: '#/paths/~1computeImageCapabilitySchemas/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.compute_image_capability_schemas + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListComputeImageCapabilitySchemasResponse' + transform: + body: |- + {{- $wrapped := printf "{\"compute_image_capability_schemas\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeImageCapabilitySchemas/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1computeImageCapabilitySchemas~1{computeImageCapabilitySchemaId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1computeImageCapabilitySchemas~1{computeImageCapabilitySchemaId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeImageCapabilitySchemas~1{computeImageCapabilitySchemaId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1computeImageCapabilitySchemas~1{computeImageCapabilitySchemaId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/compute_image_capability_schemas/methods/get' + - $ref: '#/components/x-stackQL-resources/compute_image_capability_schemas/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/compute_image_capability_schemas/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/compute_image_capability_schemas/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/compute_image_capability_schemas/methods/delete' + replace: [] + dedicated_vm_host_instance_shapes: + id: oci.compute.dedicated_vm_host_instance_shapes + name: dedicated_vm_host_instance_shapes + title: Dedicated Vm Host Instance Shapes + methods: + list: + operation: + $ref: '#/paths/~1dedicatedVmHostInstanceShapes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.dedicated_vm_host_instance_shapes + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDedicatedVmHostInstanceShapesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"dedicated_vm_host_instance_shapes\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dedicated_vm_host_instance_shapes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dedicated_vm_host_shapes: + id: oci.compute.dedicated_vm_host_shapes + name: dedicated_vm_host_shapes + title: Dedicated Vm Host Shapes + methods: + list: + operation: + $ref: '#/paths/~1dedicatedVmHostShapes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.dedicated_vm_host_shapes + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDedicatedVmHostShapesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"dedicated_vm_host_shapes\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dedicated_vm_host_shapes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dedicated_vm_hosts: + id: oci.compute.dedicated_vm_hosts + name: dedicated_vm_hosts + title: Dedicated Vm Hosts + methods: + list: + operation: + $ref: '#/paths/~1dedicatedVmHosts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.dedicated_vm_hosts + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDedicatedVmHostsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"dedicated_vm_hosts\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dedicatedVmHosts/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1dedicatedVmHosts~1{dedicatedVmHostId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1dedicatedVmHosts~1{dedicatedVmHostId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dedicatedVmHosts~1{dedicatedVmHostId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dedicatedVmHosts~1{dedicatedVmHostId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dedicated_vm_hosts/methods/get' + - $ref: '#/components/x-stackQL-resources/dedicated_vm_hosts/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/dedicated_vm_hosts/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/dedicated_vm_hosts/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/dedicated_vm_hosts/methods/delete' + replace: [] + dedicated_vm_host_instances: + id: oci.compute.dedicated_vm_host_instances + name: dedicated_vm_host_instances + title: Dedicated Vm Host Instances + methods: + list: + operation: + $ref: '#/paths/~1dedicatedVmHosts~1{dedicatedVmHostId}~1instances/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.dedicated_vm_host_instances + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDedicatedVmHostInstancesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"dedicated_vm_host_instances\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dedicated_vm_host_instances/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + firmware_bundles: + id: oci.compute.firmware_bundles + name: firmware_bundles + title: Firmware Bundles + methods: + list: + operation: + $ref: '#/paths/~1firmwareBundles/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1firmwareBundles~1{firmwareBundleId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/firmware_bundles/methods/get' + - $ref: '#/components/x-stackQL-resources/firmware_bundles/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + images: + id: oci.compute.images + name: images + title: Images + methods: + list: + operation: + $ref: '#/paths/~1images/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.images + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListImagesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"images\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1images/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1images~1{imageId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1images~1{imageId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1images~1{imageId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1images~1{imageId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + export_image: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1images~1{imageId}~1actions~1export/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/images/methods/get' + - $ref: '#/components/x-stackQL-resources/images/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/images/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/images/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/images/methods/delete' + replace: [] + image_shape_compatibility_entries: + id: oci.compute.image_shape_compatibility_entries + name: image_shape_compatibility_entries + title: Image Shape Compatibility Entries + methods: + list: + operation: + $ref: '#/paths/~1images~1{imageId}~1shapes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.image_shape_compatibility_entries + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListImageShapeCompatibilityEntriesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"image_shape_compatibility_entries\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1images~1{imageId}~1shapes~1{shapeName}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/image_shape_compatibility_entries/methods/get' + - $ref: '#/components/x-stackQL-resources/image_shape_compatibility_entries/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + shapes: + id: oci.compute.shapes + name: shapes + title: Shapes + methods: + remove_image_shape_compatibility_entry: + operation: + $ref: '#/paths/~1images~1{imageId}~1shapes~1{shapeName}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + add_image_shape_compatibility_entry: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1images~1{imageId}~1shapes~1{shapeName}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + list: + operation: + $ref: '#/paths/~1shapes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.shapes + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListShapesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"shapes\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/shapes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + instance_configurations: + id: oci.compute.instance_configurations + name: instance_configurations + title: Instance Configurations + methods: + list: + operation: + $ref: '#/paths/~1instanceConfigurations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.instance_configurations + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListInstanceConfigurationsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"instance_configurations\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1instanceConfigurations/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1instanceConfigurations~1{instanceConfigurationId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1instanceConfigurations~1{instanceConfigurationId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1instanceConfigurations~1{instanceConfigurationId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1instanceConfigurations~1{instanceConfigurationId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + launch: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1instanceConfigurations~1{instanceConfigurationId}~1actions~1launch/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instance_configurations/methods/get' + - $ref: '#/components/x-stackQL-resources/instance_configurations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/instance_configurations/methods/launch' + - $ref: '#/components/x-stackQL-resources/instance_configurations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/instance_configurations/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/instance_configurations/methods/delete' + replace: [] + instance_console_connections: + id: oci.compute.instance_console_connections + name: instance_console_connections + title: Instance Console Connections + methods: + list: + operation: + $ref: '#/paths/~1instanceConsoleConnections/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.instance_console_connections + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListInstanceConsoleConnectionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"instance_console_connections\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1instanceConsoleConnections/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1instanceConsoleConnections~1{instanceConsoleConnectionId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1instanceConsoleConnections~1{instanceConsoleConnectionId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1instanceConsoleConnections~1{instanceConsoleConnectionId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instance_console_connections/methods/get' + - $ref: '#/components/x-stackQL-resources/instance_console_connections/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/instance_console_connections/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/instance_console_connections/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/instance_console_connections/methods/delete' + replace: [] + console_histories: + id: oci.compute.console_histories + name: console_histories + title: Console Histories + methods: + list: + operation: + $ref: '#/paths/~1instanceConsoleHistories~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.console_histories + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListConsoleHistoriesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"console_histories\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1instanceConsoleHistories~1{instanceConsoleHistoryId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1instanceConsoleHistories~1{instanceConsoleHistoryId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1instanceConsoleHistories~1{instanceConsoleHistoryId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/console_histories/methods/get' + - $ref: '#/components/x-stackQL-resources/console_histories/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/console_histories/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/console_histories/methods/delete' + replace: [] + instance_console_histories: + id: oci.compute.instance_console_histories + name: instance_console_histories + title: Instance Console Histories + methods: + capture_console_history: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1instanceConsoleHistories~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + console_history_contents: + id: oci.compute.console_history_contents + name: console_history_contents + title: Console History Contents + methods: + get: + operation: + $ref: '#/paths/~1instanceConsoleHistories~1{instanceConsoleHistoryId}~1data/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/console_history_contents/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + instance_maintenance_events: + id: oci.compute.instance_maintenance_events + name: instance_maintenance_events + title: Instance Maintenance Events + methods: + list: + operation: + $ref: '#/paths/~1instanceMaintenanceEvents/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.instance_maintenance_events + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListInstanceMaintenanceEventsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"instance_maintenance_events\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1instanceMaintenanceEvents~1{instanceMaintenanceEventId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1instanceMaintenanceEvents~1{instanceMaintenanceEventId}/put' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instance_maintenance_events/methods/get' + - $ref: '#/components/x-stackQL-resources/instance_maintenance_events/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/instance_maintenance_events/methods/update' + delete: [] + replace: [] + instance_pools: + id: oci.compute.instance_pools + name: instance_pools + title: Instance Pools + methods: + list: + operation: + $ref: '#/paths/~1instancePools/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.instance_pools + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListInstancePoolsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"instance_pools\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1instancePools/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + terminate: + operation: + $ref: '#/paths/~1instancePools~1{instancePoolId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1instancePools~1{instancePoolId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1instancePools~1{instancePoolId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + attach: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1instancePools~1{instancePoolId}~1actions~1attachLoadBalancer/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1instancePools~1{instancePoolId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + detach_instance_pool_instance: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1instancePools~1{instancePoolId}~1actions~1detachInstance/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + detach_load_balancer: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1instancePools~1{instancePoolId}~1actions~1detachLoadBalancer/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + reset_instance_pool: + operation: + $ref: '#/paths/~1instancePools~1{instancePoolId}~1actions~1reset/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + softreset_instance_pool: + operation: + $ref: '#/paths/~1instancePools~1{instancePoolId}~1actions~1softreset/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + softstop_instance_pool: + operation: + $ref: '#/paths/~1instancePools~1{instancePoolId}~1actions~1softstop/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + start_instance_pool: + operation: + $ref: '#/paths/~1instancePools~1{instancePoolId}~1actions~1start/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + stop_instance_pool: + operation: + $ref: '#/paths/~1instancePools~1{instancePoolId}~1actions~1stop/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + termination_proceed_instance_pool_instance: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1instancePools~1{instancePoolId}~1actions~1terminationProceed/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instance_pools/methods/get' + - $ref: '#/components/x-stackQL-resources/instance_pools/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/instance_pools/methods/attach' + - $ref: '#/components/x-stackQL-resources/instance_pools/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/instance_pools/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/instance_pools/methods/terminate' + replace: [] + instance_pool_instances: + id: oci.compute.instance_pool_instances + name: instance_pool_instances + title: Instance Pool Instances + methods: + list: + operation: + $ref: '#/paths/~1instancePools~1{instancePoolId}~1instances/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.instance_pool_instances + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListInstancePoolInstancesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"instance_pool_instances\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1instancePools~1{instancePoolId}~1instances~1{instanceId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instance_pool_instances/methods/get' + - $ref: '#/components/x-stackQL-resources/instance_pool_instances/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + instances: + id: oci.compute.instances + name: instances + title: Instances + methods: + attach: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1instancePools~1{instancePoolId}~1instances/post' + response: + mediaType: application/json + openAPIDocKey: '201' + request: + nativeCasing: camel + list: + operation: + $ref: '#/paths/~1instances~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.instances + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListInstancesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"instances\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + launch: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1instances~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + terminate: + operation: + $ref: '#/paths/~1instances~1{instanceId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1instances~1{instanceId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + instance_action: + operation: + $ref: '#/paths/~1instances~1{instanceId}/post' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1instances~1{instanceId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + accept_shielded_integrity_policy: + operation: + $ref: '#/paths/~1instances~1{instanceId}~1actions~1acceptShieldedIntegrityPolicy/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1instances~1{instanceId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instances/methods/get' + - $ref: '#/components/x-stackQL-resources/instances/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/instances/methods/attach' + - $ref: '#/components/x-stackQL-resources/instances/methods/launch' + update: + - $ref: '#/components/x-stackQL-resources/instances/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/instances/methods/terminate' + replace: [] + instance_pool_load_balancer_attachments: + id: oci.compute.instance_pool_load_balancer_attachments + name: instance_pool_load_balancer_attachments + title: Instance Pool Load Balancer Attachments + methods: + get: + operation: + $ref: '#/paths/~1instancePools~1{instancePoolId}~1loadBalancerAttachments~1{instancePoolLoadBalancerAttachmentId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instance_pool_load_balancer_attachments/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + instance_default_credentials: + id: oci.compute.instance_default_credentials + name: instance_default_credentials + title: Instance Default Credentials + methods: + get: + operation: + $ref: '#/paths/~1instances~1{instanceId}~1defaultCredentials/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instance_default_credentials/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + instance_devices: + id: oci.compute.instance_devices + name: instance_devices + title: Instance Devices + methods: + list: + operation: + $ref: '#/paths/~1instances~1{instanceId}~1devices/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.instance_devices + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListInstanceDevicesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"instance_devices\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instance_devices/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + windows_instance_initial_credentials: + id: oci.compute.windows_instance_initial_credentials + name: windows_instance_initial_credentials + title: Windows Instance Initial Credentials + methods: + get: + operation: + $ref: '#/paths/~1instances~1{instanceId}~1initialCredentials/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/windows_instance_initial_credentials/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + instance_maintenance_reboots: + id: oci.compute.instance_maintenance_reboots + name: instance_maintenance_reboots + title: Instance Maintenance Reboots + methods: + get: + operation: + $ref: '#/paths/~1instances~1{instanceId}~1maintenanceReboot/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instance_maintenance_reboots/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + measured_boot_reports: + id: oci.compute.measured_boot_reports + name: measured_boot_reports + title: Measured Boot Reports + methods: + get: + operation: + $ref: '#/paths/~1instances~1{instanceId}~1measuredBootReport/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/measured_boot_reports/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + vnic_attachments: + id: oci.compute.vnic_attachments + name: vnic_attachments + title: Vnic Attachments + methods: + list: + operation: + $ref: '#/paths/~1vnicAttachments~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.vnic_attachments + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVnicAttachmentsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"vnic_attachments\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + attach: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1vnicAttachments~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + detach: + operation: + $ref: '#/paths/~1vnicAttachments~1{vnicAttachmentId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1vnicAttachments~1{vnicAttachmentId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/vnic_attachments/methods/get' + - $ref: '#/components/x-stackQL-resources/vnic_attachments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/vnic_attachments/methods/attach' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/vnic_attachments/methods/detach' + replace: [] + volume_attachments: + id: oci.compute.volume_attachments + name: volume_attachments + title: Volume Attachments + methods: + list: + operation: + $ref: '#/paths/~1volumeAttachments~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.volume_attachments + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVolumeAttachmentsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"volume_attachments\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + attach: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1volumeAttachments~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + detach: + operation: + $ref: '#/paths/~1volumeAttachments~1{volumeAttachmentId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1volumeAttachments~1{volumeAttachmentId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1volumeAttachments~1{volumeAttachmentId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/volume_attachments/methods/get' + - $ref: '#/components/x-stackQL-resources/volume_attachments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/volume_attachments/methods/attach' + update: + - $ref: '#/components/x-stackQL-resources/volume_attachments/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/volume_attachments/methods/detach' + replace: [] +servers: + - url: https://iaas.{region}.oraclecloud.com/20160918 + variables: + region: + default: us-ashburn-1 + description: OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. + x-stackQL-envVar: OCI_REGION +x-stackQL-config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: opc-next-page + location: header diff --git a/providers/src/oci/v00.00.00000/services/container_engine.yaml b/providers/src/oci/v00.00.00000/services/container_engine.yaml new file mode 100644 index 00000000..d104f1f8 --- /dev/null +++ b/providers/src/oci/v00.00.00000/services/container_engine.yaml @@ -0,0 +1,7619 @@ +openapi: 3.0.0 +info: + title: container_engine API + description: oci container_engine API + version: '20180222' +paths: + /addonOptions: + get: + description: Get list of supported addons for a specific kubernetes version. + operationId: ListAddonOptions + parameters: + - $ref: '#/components/parameters/KubernetesVersionQueryParam' + - $ref: '#/components/parameters/AddonNameQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: The optional field to sort the results by. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - NAME + - TIME_CREATED + - description: | + Specifies whether all add-on versions should be displayed. The default value is false. If set to true, the API will return all available add-on versions, including deprecated versions and detailed build numbers. + Please note that the use of deprecated versions, as well as the specification of a particular build of a supported version, is not recommended for standard operations. + in: query + name: shouldShowAllVersions + required: false + schema: + type: boolean + default: false + responses: + '200': + description: A list of addon option summary objects for a specific kubernetes version. + 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/ListAddonOptionsResponse' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Get list of supported addons for a specific kubernetes version. + tags: + - containerEngine + x-obmcs-authz-declarations: + authorizationRequired: false + /clusterOptions/{clusterOptionId}: + get: + description: Get options available for clusters. + operationId: GetClusterOptions + parameters: + - $ref: '#/components/parameters/ClusterOptionIdPathParam' + - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' + - $ref: '#/components/parameters/ShouldListAllPatchVersionsQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The cluster options. + 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/ClusterOptions' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Get cluster options. + tags: + - containerEngine + /clusters: + get: + description: List all the cluster objects in a compartment. + operationId: ListClusters + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/ClusterLifecycleStateFilterQueryParam' + - $ref: '#/components/parameters/NameFilterQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: The optional field to sort the results by. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - ID + - NAME + - TIME_CREATED + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: A list of cluster summary objects. + 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/ListClustersResponse' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: List all cluster objects. + tags: + - containerEngine + post: + description: Create a new cluster. + operationId: CreateCluster + parameters: + - $ref: '#/components/parameters/IdempotencyTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateClusterDetails' + description: The details of the cluster to create. + required: true + responses: + '202': + $ref: '#/components/responses/Accepted' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Create a new cluster. + tags: + - containerEngine + x-related-resource: '#/definitions/Cluster' + /clusters/{clusterId}: + delete: + description: Delete a cluster. + operationId: DeleteCluster + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '202': + $ref: '#/components/responses/Accepted' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Delete a cluster. + tags: + - containerEngine + x-related-resource: '#/definitions/Cluster' + get: + description: Get the details of a cluster. + operationId: GetCluster + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IsOpenIdConnectAuthConfigFileIncludedQueryParam' + responses: + '200': + description: The cluster details. + 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/Cluster' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Get cluster details. + tags: + - containerEngine + put: + description: Update the details of a cluster. + operationId: UpdateCluster + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateClusterDetails' + description: The details of the cluster to update. + required: true + responses: + '202': + $ref: '#/components/responses/Accepted' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Update cluster details. + tags: + - containerEngine + x-related-resource: '#/definitions/Cluster' + /clusters/{clusterId}/actions/completeCredentialRotation: + post: + description: Complete cluster credential rotation. Retire old credentials from kubernetes components. + operationId: CompleteCredentialRotation + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/IdempotencyTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + $ref: '#/components/responses/Accepted' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Complete cluster credential rotation. + tags: + - containerEngine + x-related-resource: '#/definitions/Cluster' + /clusters/{clusterId}/actions/extendEndpointDecommissionRollbackDeadline: + post: + description: | + Extend the rollback deadline of public api endpoint decommission for a cluster. + The operation can only be performed within decommission rollback deadline. + operationId: ExtendEndpointDecommissionRollbackDeadline + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/IdempotencyTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExtendEndpointDecommissionRollbackDeadlineDetails' + description: The details for a kubernetes cluster to extend public api endpoint decommission rollback deadline. + required: true + responses: + '200': + description: The cluster's public api endpoint decommission status details. + 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/PublicApiEndpointDecommissionStatus' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Extend the rollback deadline of public api endpoint decommission for a cluster. + tags: + - containerEngine + x-related-resource: '#/definitions/Cluster' + /clusters/{clusterId}/actions/migrateToNativeVcn: + post: + description: Initiates cluster migration to use native VCN. + operationId: ClusterMigrateToNativeVcn + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterMigrateToNativeVcnDetails' + description: The details for the cluster's migration to native VCN. + required: true + responses: + '202': + $ref: '#/components/responses/Accepted' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Initiates cluster migration to use native VCN. + tags: + - containerEngine + x-related-resource: '#/definitions/Cluster' + /clusters/{clusterId}/actions/rollbackPublicApiEndpointDecommission: + post: + description: | + Rollback public api endpoint decommission for a cluster, legacy kubernetes endpoint will be brought back once the operation is completed. + The operation can only be performed within decommission rollback deadline. + operationId: RollbackPublicApiEndpointDecommission + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/IdempotencyTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + $ref: '#/components/responses/Accepted' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Rollback public api endpoint decommission for a cluster. + tags: + - containerEngine + x-related-resource: '#/definitions/Cluster' + /clusters/{clusterId}/actions/startCredentialRotation: + post: + description: Start cluster credential rotation by adding new credentials, old credentials will still work after this operation. + operationId: StartCredentialRotation + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/IdempotencyTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StartCredentialRotationDetails' + description: The details for a kubernetes cluster to start credential rotation. + required: true + responses: + '202': + $ref: '#/components/responses/Accepted' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Start cluster credential rotation. + tags: + - containerEngine + x-related-resource: '#/definitions/Cluster' + /clusters/{clusterId}/actions/startPublicApiEndpointDecommission: + post: + description: Start public api endpoint decommission for a cluster, legacy kubernetes endpoint will no longer available after this operation. + operationId: StartPublicApiEndpointDecommission + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/IdempotencyTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + $ref: '#/components/responses/Accepted' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Start public api endpoint decommission for a cluster. + tags: + - containerEngine + x-related-resource: '#/definitions/Cluster' + /clusters/{clusterId}/actions/updateEndpointConfig: + post: + description: Update the details of the cluster endpoint configuration. + operationId: UpdateClusterEndpointConfig + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateClusterEndpointConfigDetails' + description: The details of the cluster's endpoint to update. + required: true + responses: + '202': + $ref: '#/components/responses/Accepted' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Update cluster endpoint details. + tags: + - containerEngine + x-related-resource: '#/definitions/Cluster' + /clusters/{clusterId}/addons: + get: + description: List addon for a provisioned cluster. + operationId: ListAddons + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: The optional field to sort the results by. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - NAME + - TIME_CREATED + responses: + '200': + description: A list of addon summary objects. + 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/ListAddonsResponse' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: List addon for a cluster. + tags: + - containerEngine + x-related-resource: '#/definitions/Cluster' + post: + description: Install the specified addon for a cluster. + operationId: InstallAddon + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/IdempotencyTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstallAddonDetails' + description: The details of the addon to be installed. + required: true + responses: + '202': + $ref: '#/components/responses/Accepted' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Install addon for a cluster. + tags: + - containerEngine + x-related-resource: '#/definitions/Cluster' + /clusters/{clusterId}/addons/{addonName}: + delete: + description: Disable addon for a provisioned cluster. + operationId: DisableAddon + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/AddonNamePathParam' + - $ref: '#/components/parameters/IsRemoveExistingAddOnQueryParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '202': + $ref: '#/components/responses/Accepted' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Disable addon for a cluster. + tags: + - containerEngine + x-related-resource: '#/definitions/Cluster' + get: + description: Get the specified addon for a cluster. + operationId: GetAddon + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/AddonNamePathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: Addon details. + 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/Addon' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Get addon details. + tags: + - containerEngine + x-related-resource: '#/definitions/Cluster' + put: + description: Update addon details for a cluster. + operationId: UpdateAddon + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/AddonNamePathParam' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAddonDetails' + description: The details of the addon to be updated. + required: true + responses: + '202': + $ref: '#/components/responses/Accepted' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Update addon details for a cluster. + tags: + - containerEngine + x-related-resource: '#/definitions/Cluster' + /clusters/{clusterId}/credentialRotationStatus: + get: + description: Get cluster credential rotation status. + operationId: GetCredentialRotationStatus + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The cluster credential rotation status details. + 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/CredentialRotationStatus' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Get cluster credential rotation status. + tags: + - containerEngine + /clusters/{clusterId}/kubeconfig/content: + post: + description: Create the Kubeconfig YAML for a cluster. + operationId: CreateKubeconfig + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateClusterKubeconfigContentDetails' + description: The details of the cluster kubeconfig to create. + responses: + '200': + description: | + The output binary file is a standard KubeConfig file. + External Reference Documentation, + https://github.com/kubernetes/kubernetes/blob/release-1.1/docs/user-guide/kubeconfig-file.md + 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/x-yaml: + schema: + format: binary + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Create the cluster kubeconfig. + tags: + - containerEngine + x-related-resource: '#/definitions/Cluster' + /clusters/{clusterId}/migrateToNativeVcnStatus: + get: + description: Get details on a cluster's migration to native VCN. + operationId: GetClusterMigrateToNativeVcnStatus + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The cluster's native vcn migration status details. + 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/ClusterMigrateToNativeVcnStatus' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Get details on a cluster's migration to native VCN. + tags: + - containerEngine + /clusters/{clusterId}/nodes/{nodeId}/actions/reboot: + post: + description: perform reboot action to node in cluster + operationId: RebootClusterNode + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/NodeIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IdempotencyTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RebootClusterNodeDetails' + description: The fields to reboot a node. + required: true + responses: + '202': + $ref: '#/components/responses/Accepted' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: perform reboot action to node in cluster + tags: + - containerEngine + x-related-resource: '#/definitions/Cluster' + /clusters/{clusterId}/nodes/{nodeId}/actions/replaceBootVolume: + post: + description: perform cycle action to node in cluster + operationId: ReplaceBootVolumeClusterNode + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/NodeIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IdempotencyTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ReplaceBootVolumeClusterNodeDetails' + description: The fields to replace boot volume of a node. + required: true + responses: + '202': + $ref: '#/components/responses/Accepted' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: perform boot volume replacement action to node in cluster + tags: + - containerEngine + x-related-resource: '#/definitions/Cluster' + /clusters/{clusterId}/publicApiEndpointDecommissionStatus: + get: + description: Get cluster public api endpoint decommission status. + operationId: GetPublicApiEndpointDecommissionStatus + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The cluster's public api endpoint decommission status details. + 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/PublicApiEndpointDecommissionStatus' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Get cluster public api endpoint decommission status. + tags: + - containerEngine + x-related-resource: '#/definitions/Cluster' + /clusters/{clusterId}/workloadMappings: + get: + description: List workloadMappings for a provisioned cluster. + operationId: ListWorkloadMappings + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: The optional field to sort the results by. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - NAMESPACE + - TIMECREATED + default: NAMESPACE + responses: + '200': + description: A list of workloadMapping summary objects. + 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/ListWorkloadMappingsResponse' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: List workloadMappings for a cluster. + tags: + - containerEngine + x-related-resource: '#/definitions/WorkloadMapping' + post: + description: Create the specified workloadMapping for a cluster. + operationId: CreateWorkloadMapping + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/IdempotencyTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateWorkloadMappingDetails' + description: The details of the workloadMapping to be create. + required: true + responses: + '200': + description: WorkloadMapping Created. + 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/WorkloadMapping' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Create workloadMapping for a cluster. + tags: + - containerEngine + x-related-resource: '#/definitions/WorkloadMapping' + /clusters/{clusterId}/workloadMappings/{workloadMappingId}: + delete: + description: Delete workloadMapping for a provisioned cluster. + operationId: DeleteWorkloadMapping + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/WorkloadMappingIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '204': + description: WorkloadMapping 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 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Delete workloadMapping for a cluster. + tags: + - containerEngine + x-related-resource: '#/definitions/WorkloadMapping' + get: + description: Get the specified workloadMapping for a cluster. + operationId: GetWorkloadMapping + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/WorkloadMappingIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: WorkloadMapping details. + 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/WorkloadMapping' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Get workloadMapping details. + tags: + - containerEngine + x-related-resource: '#/definitions/WorkloadMapping' + put: + description: Update workloadMapping details for a cluster. + operationId: UpdateWorkloadMapping + parameters: + - $ref: '#/components/parameters/ClusterIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/WorkloadMappingIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateWorkloadMappingDetails' + description: The details of the workloadMapping to be updated. + required: true + responses: + '200': + description: WorkloadMapping Updated. + 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/WorkloadMapping' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Update workloadMapping details for a cluster. + tags: + - containerEngine + x-related-resource: '#/definitions/WorkloadMapping' + /nodePoolOptions/{nodePoolOptionId}: + get: + description: Get options available for node pools. + operationId: GetNodePoolOptions + parameters: + - $ref: '#/components/parameters/NodePoolOptionIdPathParam' + - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' + - $ref: '#/components/parameters/ShouldListAllPatchVersionsQueryParam' + - $ref: '#/components/parameters/NodePoolOsTypeQueryParam' + - $ref: '#/components/parameters/NodePoolOsArchQueryParam' + - $ref: '#/components/parameters/NodePoolK8sVersionQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The node pool options. + 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/NodePoolOptions' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Get node pool options. + tags: + - containerEngine + /nodePools: + get: + description: List all the node pools in a compartment, and optionally filter by cluster. + operationId: ListNodePools + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/ClusterIdQueryParam' + - $ref: '#/components/parameters/NameFilterQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: The optional field to sort the results by. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - ID + - NAME + - TIME_CREATED + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/NodePoolLifecycleStateFilterQueryParam' + responses: + '200': + description: A list of node pool summary objects. + 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/ListNodePoolsResponse' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: List all node pools. + tags: + - containerEngine + post: + description: Create a new node pool. + operationId: CreateNodePool + parameters: + - $ref: '#/components/parameters/IdempotencyTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateNodePoolDetails' + description: The details of the node pool to create. + required: true + responses: + '202': + $ref: '#/components/responses/Accepted' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Create a new node pool. + tags: + - containerEngine + x-related-resource: '#/definitions/NodePool' + /nodePools/{nodePoolId}: + delete: + description: Delete a node pool. + operationId: DeleteNodePool + parameters: + - $ref: '#/components/parameters/NodePoolIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/OverrideEvictionGraceDurationQueryParam' + - $ref: '#/components/parameters/IsForceDeletionAfterOverrideGraceDurationQueryParam' + responses: + '202': + $ref: '#/components/responses/Accepted' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Delete a node pool. + tags: + - containerEngine + x-related-resource: '#/definitions/NodePool' + get: + description: Get the details of a node pool. + operationId: GetNodePool + parameters: + - $ref: '#/components/parameters/NodePoolIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The node pool. + 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/NodePool' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Get node pool details. + tags: + - containerEngine + put: + description: Update the details of a node pool. + operationId: UpdateNodePool + parameters: + - $ref: '#/components/parameters/NodePoolIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/OverrideEvictionGraceDurationQueryParam' + - $ref: '#/components/parameters/IsForceDeletionAfterOverrideGraceDurationQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateNodePoolDetails' + description: The fields to update in a node pool. + required: true + responses: + '202': + $ref: '#/components/responses/Accepted' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Update node pool details. + tags: + - containerEngine + x-related-resource: '#/definitions/NodePool' + /nodePools/{nodePoolId}/node/{nodeId}: + delete: + description: Delete node. + operationId: DeleteNode + parameters: + - $ref: '#/components/parameters/NodePoolIdPathParam' + - $ref: '#/components/parameters/NodeIdPathParam' + - $ref: '#/components/parameters/IsDecrementSizeQueryParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/OverrideEvictionGraceDurationQueryParam' + - $ref: '#/components/parameters/IsForceDeletionAfterOverrideGraceDurationQueryParam' + responses: + '202': + $ref: '#/components/responses/Accepted' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Delete node. + tags: + - containerEngine + x-related-resource: '#/definitions/NodePool' + /podShapes: + get: + description: List all the Pod Shapes in a compartment. + operationId: ListPodShapes + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/NameFilterQueryParam' + - $ref: '#/components/parameters/VnpPaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/VnpSortOrderQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + responses: + '200': + description: A list of pod shape summary objects. + 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/ListPodShapesResponse' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: List Pod Shapes. + tags: + - containerEngine + /virtualNodePools: + get: + description: List all the virtual node pools in a compartment, and optionally filter by cluster. + operationId: ListVirtualNodePools + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/ClusterIdQueryParam' + - $ref: '#/components/parameters/NameFilterQueryParam' + - $ref: '#/components/parameters/VnpPaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/VnpSortOrderQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/VirtualNodePoolLifecycleStateFilterQueryParam' + responses: + '200': + description: A list of virtual node pool summary objects. + 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/ListVirtualNodePoolsResponse' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: List all virtual node pools. + tags: + - containerEngine + post: + description: Create a new virtual node pool. + operationId: CreateVirtualNodePool + parameters: + - $ref: '#/components/parameters/IdempotencyTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateVirtualNodePoolDetails' + description: The details of the virtual node pool to create. + required: true + responses: + '202': + $ref: '#/components/responses/Accepted' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Create a new virtual node pool. + tags: + - containerEngine + x-related-resource: '#/definitions/VirtualNodePool' + /virtualNodePools/{virtualNodePoolId}: + delete: + description: Delete a virtual node pool. + operationId: DeleteVirtualNodePool + parameters: + - $ref: '#/components/parameters/VirtualNodePoolIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/OverrideEvictionGraceDurationVnpQueryParam' + - $ref: '#/components/parameters/IsForceDeletionAfterOverrideGraceDurationVnpQueryParam' + responses: + '202': + $ref: '#/components/responses/Accepted' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Delete a virtual node pool. + tags: + - containerEngine + x-related-resource: '#/definitions/VirtualNodePool' + get: + description: Get the details of a virtual node pool. + operationId: GetVirtualNodePool + parameters: + - $ref: '#/components/parameters/VirtualNodePoolIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The virtual node pool. + 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/VirtualNodePool' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Get virtual node pool details. + tags: + - containerEngine + put: + description: Update the details of a virtual node pool. + operationId: UpdateVirtualNodePool + parameters: + - $ref: '#/components/parameters/VirtualNodePoolIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateVirtualNodePoolDetails' + description: The fields to update in a virtual node pool. + required: true + responses: + '202': + $ref: '#/components/responses/Accepted' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Update virtual node pool details. + tags: + - containerEngine + x-related-resource: '#/definitions/VirtualNodePool' + /virtualNodePools/{virtualNodePoolId}/virtualNodes: + get: + description: List virtual nodes in a virtual node pool. + operationId: ListVirtualNodes + parameters: + - $ref: '#/components/parameters/VirtualNodePoolIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/NameFilterQueryParam' + - $ref: '#/components/parameters/VnpPaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/VnpSortOrderQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + responses: + '200': + description: A list of virtual node summary in virtual node pool. + 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/ListVirtualNodesResponse' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: List virtual nodes in a virtual node pool. + tags: + - containerEngine + x-related-resource: '#/definitions/VirtualNodePool' + /virtualNodePools/{virtualNodePoolId}/virtualNodes/{virtualNodeId}: + get: + description: Get the details of a virtual node. + operationId: GetVirtualNode + parameters: + - $ref: '#/components/parameters/VirtualNodePoolIdPathParam' + - $ref: '#/components/parameters/VirtualNodeIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The virtual node. + 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/VirtualNode' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Get virtual node details. + tags: + - containerEngine + x-related-resource: '#/definitions/VirtualNodePool' + /workRequests: + get: + description: List all work requests in a compartment. + operationId: ListWorkRequests + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/ClusterIdQueryParam' + - $ref: '#/components/parameters/ResourceIdQueryParam' + - $ref: '#/components/parameters/ResourceTypeQueryParam' + - $ref: '#/components/parameters/WorkRequestStatusFilterQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: The optional field to sort the results by. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - ID + - OPERATION_TYPE + - STATUS + - TIME_ACCEPTED + - TIME_STARTED + - TIME_FINISHED + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The list of work request summary objects. + 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/ListWorkRequestsResponse' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: List all work requests. + tags: + - containerEngine + /workRequests/{workRequestId}: + delete: + description: Cancel a work request that has not started. + operationId: DeleteWorkRequest + parameters: + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '204': + description: No content. + 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 + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/IncorrectState' + '412': + $ref: '#/components/responses/NoEtagMatch' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Cancel a work request. + tags: + - containerEngine + x-related-resource: '#/definitions/WorkRequest' + get: + description: Get the details of a work request. + operationId: GetWorkRequest + parameters: + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The work request. + 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 + retry-after: + description: the number of seconds to should wait before polling this endpoint again + schema: + type: integer + content: + application/json: + schema: + $ref: '#/components/schemas/WorkRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Get work request details. + tags: + - containerEngine + /workRequests/{workRequestId}/errors: + get: + description: Get the errors of a work request. + operationId: ListWorkRequestErrors + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The list of errors for the work request. + 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/ListWorkRequestErrorsResponse' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Get work request errors. + tags: + - containerEngine + /workRequests/{workRequestId}/logs: + get: + description: Get the logs of a work request. + operationId: ListWorkRequestLogs + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The list of logs for the work request. + 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/ListWorkRequestLogsResponse' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Get work request logs. + tags: + - containerEngine +components: + schemas: + AddonOptionSummary: + description: The properties that define addon summary. + properties: + addonGroup: + description: Addon group info, a namespace concept that groups addons with similar functionalities. + example: oke/cluster-network + type: string + addonSchemaVersion: + description: Addon definition schema version to validate addon. + example: '0.1' + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + example: + Operations: + CostCenter: 42 + type: object + description: + description: Description on the addon. + example: BlaBla + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + isEssential: + description: Is it an essential addon for cluster operation or not. + example: true + type: boolean + lifecycleState: + description: The life cycle state of the addon. + enum: + - ACTIVE + - INACTIVE + example: ACTIVE + type: string + name: + description: Name of the addon and it would be unique. + example: flannel + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + timeCreated: + description: The time the work request was created. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + versions: + description: The resources this work request affects. + items: + $ref: '#/components/schemas/AddonVersions' + type: array + required: + - versions + - name + - isEssential + - lifecycleState + type: object + ClusterOptions: + description: Options for creating or updating clusters. + properties: + clusterPodNetworkOptions: + description: Available CNIs and network options for existing and new node pools of the cluster + items: + $ref: '#/components/schemas/ClusterPodNetworkOptionDetails' + maxItems: 255 + type: array + uniqueItems: true + x-default-description: when unspecified in case of updates, the current value of this field will be preserved, else value set to null + kubernetesVersions: + description: Available Kubernetes versions. + items: + example: v1.9.4 + type: string + type: array + type: object + ClusterSummary: + description: The properties that define a cluster summary. + properties: + availableKubernetesUpgrades: + description: Available Kubernetes versions to which the clusters masters may be upgraded. + items: + example: v1.9.4 + type: string + type: array + clusterPodNetworkOptions: + description: Available CNIs and network options for existing and new node pools of the cluster + items: + $ref: '#/components/schemas/ClusterPodNetworkOptionDetails' + maxItems: 255 + type: array + uniqueItems: true + x-default-description: 'null' + compartmentId: + description: The OCID of the compartment in which the cluster exists. + example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + example: + Operations: + CostCenter: 42 + type: object + endpointConfig: + $ref: '#/components/schemas/ClusterEndpointConfig' + endpoints: + $ref: '#/components/schemas/ClusterEndpoints' + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + id: + description: The OCID of the cluster. + example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw + type: string + imagePolicyConfig: + $ref: '#/components/schemas/ImagePolicyConfig' + kubernetesVersion: + description: The version of Kubernetes running on the cluster masters. + example: v1.9.4 + type: string + lifecycleDetails: + description: Details about the state of the cluster masters. + example: waiting for node pools + type: string + lifecycleState: + description: The state of the cluster masters. For more information, see [Monitoring Clusters](/Content/ContEng/Tasks/contengmonitoringclusters.htm) + enum: + - CREATING + - ACTIVE + - FAILED + - DELETING + - DELETED + - UPDATING + example: UPDATING + type: string + x-obmcs-top-level-enum: '#/definitions/ClusterLifecycleState' + metadata: + $ref: '#/components/schemas/ClusterMetadata' + name: + description: The name of the cluster. + example: My Cluster Summary + type: string + options: + $ref: '#/components/schemas/ClusterCreateOptions' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + type: + description: Type of cluster. Values can be BASIC_CLUSTER or ENHANCED_CLUSTER. For more information, see [Cluster Types](/Content/ContEng/Tasks/contengcomparingenhancedwithbasicclusters_topic.htm) + enum: + - BASIC_CLUSTER + - ENHANCED_CLUSTER + example: ENHANCED_CLUSTER + type: string + x-obmcs-top-level-enum: '#/definitions/ClusterType' + vcnId: + description: The OCID of the virtual cloud network (VCN) in which the cluster exists + example: ocid1.vcn.oc1.iad.aaaaaaaa5e3hn7hk6y63awlhbvlhsumkn5p3ficbjcevbnoylvptcpkxtsaa + type: string + type: object + CreateClusterDetails: + description: The properties that define a request to create a cluster. + properties: + clusterPodNetworkOptions: + description: Available CNIs and network options for existing and new node pools of the cluster + items: + $ref: '#/components/schemas/ClusterPodNetworkOptionDetails' + maxItems: 255 + type: array + uniqueItems: true + x-default-description: 'null' + compartmentId: + description: The OCID of the compartment in which to create the cluster. + example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + example: + Operations: + CostCenter: 42 + type: object + endpointConfig: + $ref: '#/components/schemas/CreateClusterEndpointConfigDetails' + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + imagePolicyConfig: + $ref: '#/components/schemas/CreateImagePolicyConfigDetails' + kmsKeyId: + description: | + The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption. + When used, `kubernetesVersion` must be at least `v1.13.0`. + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + kubernetesVersion: + description: The version of Kubernetes to install into the cluster masters. + example: v1.9.4 + type: string + name: + description: The name of the cluster. Avoid entering confidential information. + example: My Cluster + type: string + options: + $ref: '#/components/schemas/ClusterCreateOptions' + type: + description: Type of cluster + enum: + - BASIC_CLUSTER + - ENHANCED_CLUSTER + example: ENHANCED_CLUSTER + type: string + x-obmcs-top-level-enum: '#/definitions/ClusterType' + vcnId: + description: The OCID of the virtual cloud network (VCN) in which to create the cluster. + example: ocid1.vcn.oc1.iad.aaaaaaaa5e3hn7hk6y63awlhbvlhsumkn5p3ficbjcevbnoylvptcpkxtsaa + type: string + required: + - name + - compartmentId + - vcnId + - kubernetesVersion + type: object + Cluster: + description: A Kubernetes cluster. Avoid entering confidential information. + properties: + availableKubernetesUpgrades: + description: Available Kubernetes versions to which the clusters masters may be upgraded. + items: + example: v1.9.4 + type: string + type: array + clusterPodNetworkOptions: + description: Available CNIs and network options for existing and new node pools of the cluster + items: + $ref: '#/components/schemas/ClusterPodNetworkOptionDetails' + maxItems: 255 + type: array + uniqueItems: true + x-default-description: 'null' + compartmentId: + description: The OCID of the compartment in which the cluster exists. + example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + example: + Operations: + CostCenter: 42 + type: object + endpointConfig: + $ref: '#/components/schemas/ClusterEndpointConfig' + endpoints: + $ref: '#/components/schemas/ClusterEndpoints' + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + id: + description: The OCID of the cluster. + example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw + type: string + imagePolicyConfig: + $ref: '#/components/schemas/ImagePolicyConfig' + kmsKeyId: + description: The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption. + type: string + kubernetesVersion: + description: The version of Kubernetes running on the cluster masters. + example: v1.9.4 + type: string + lifecycleDetails: + description: Details about the state of the cluster masters. + example: waiting for node pools + type: string + lifecycleState: + description: The state of the cluster masters. For more information, see [Monitoring Clusters](/Content/ContEng/Tasks/contengmonitoringclusters.htm) + enum: + - CREATING + - ACTIVE + - FAILED + - DELETING + - DELETED + - UPDATING + example: UPDATING + type: string + x-obmcs-top-level-enum: '#/definitions/ClusterLifecycleState' + metadata: + $ref: '#/components/schemas/ClusterMetadata' + name: + description: The name of the cluster. + example: My Cluster + type: string + openIdConnectDiscoveryEndpoint: + description: | + The cluster-specific OpenID Connect Discovery endpoint + example: https://objectstorage.us-ashburn-1.oci.customer-oci.com/n/id9y6mi8tcky/b/oidc/o/a1936058-8b1c-4527-b21c-6766527236f6/.well-known/openid-configuration + type: string + openIdConnectDiscoveryKey: + description: | + The cluster-specific OpenID Connect Discovery Key to derive the DiscoveryEndpoint + example: a1936058-8b1c-4527-b21c-6766527236f6 + type: string + options: + $ref: '#/components/schemas/ClusterCreateOptions' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + type: + description: Type of cluster + enum: + - BASIC_CLUSTER + - ENHANCED_CLUSTER + example: ENHANCED_CLUSTER + type: string + x-obmcs-top-level-enum: '#/definitions/ClusterType' + vcnId: + description: The OCID of the virtual cloud network (VCN) in which the cluster exists. + example: ocid1.vcn.oc1.iad.aaaaaaaa5e3hn7hk6y63awlhbvlhsumkn5p3ficbjcevbnoylvptcpkxtsaa + type: string + type: object + UpdateClusterDetails: + description: The properties that define a request to update a cluster. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + imagePolicyConfig: + $ref: '#/components/schemas/UpdateImagePolicyConfigDetails' + kubernetesVersion: + description: The version of Kubernetes to which the cluster masters should be upgraded. + example: v1.9.4 + type: string + name: + description: The new name for the cluster. Avoid entering confidential information. + example: My Updated Cluster + type: string + options: + $ref: '#/components/schemas/UpdateClusterOptionsDetails' + type: + description: Type of cluster + enum: + - BASIC_CLUSTER + - ENHANCED_CLUSTER + example: ENHANCED_CLUSTER + type: string + x-obmcs-top-level-enum: '#/definitions/ClusterType' + type: object + ExtendEndpointDecommissionRollbackDeadlineDetails: + description: The properties that define a request to extend the rollback deadline for a public api endpoint decommission. + properties: + rollbackDeadlineDelay: + description: | + The optional override delay of the rollback deadline once decommission is finished. + maximum to 30 days could be added. Once Deadline is passed, rollback will not able to be launched. + example: P1DT6H + format: x-obmcs-duration + type: string + required: + - rollbackDeadlineDelay + type: object + PublicApiEndpointDecommissionStatus: + description: Information regarding a cluster's public api endpoint decommission. + properties: + status: + description: The current public api endpoint decommission status of the cluster. + enum: + - PENDING + - IN_PROGRESS + - ROLLING_BACK + - DECOMMISSIONED + - FINALIZED + - DECOMMISSION_FAILED + - ROLLBACK_FAILED + example: IN_PROGRESS + type: string + timeDecommissionRollbackDeadline: + description: | + The date and time of rollback deadline for public api endpoint decommission. + Once the date is passed, rollback is not able to be launched. + example: '2025-07-21T16:11:29Z' + format: date-time + type: string + required: + - timeDecommissionRollbackDeadline + - status + type: object + ClusterMigrateToNativeVcnDetails: + description: The properties that define a request to migrate a cluster to Native VCN. + properties: + decommissionDelayDuration: + description: The optional override of the non-native endpoint decommission time after migration is complete. Defaults to 30 days. + example: P1DT6H + format: x-obmcs-duration + type: string + endpointConfig: + $ref: '#/components/schemas/ClusterEndpointConfig' + required: + - endpointConfig + type: object + StartCredentialRotationDetails: + description: Properties that define a request to start credential rotation on a kubernetes cluster. + properties: + autoCompletionDelayDuration: + description: The duration in days(in ISO 8601 notation eg. P5D) after which the old credentials should be retired. Maximum delay duration is 90 days. + example: P5D + maxLength: 255 + minLength: 1 + type: string + required: + - autoCompletionDelayDuration + type: object + UpdateClusterEndpointConfigDetails: + description: The properties that define a request to update a cluster endpoint config. + properties: + isPublicIpEnabled: + default: false + description: Whether the cluster should be assigned a public IP address. Defaults to false. If set to true on a private subnet, the cluster update will fail. + type: boolean + nsgIds: + description: | + A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see [NetworkSecurityGroup](#/en/iaas/20160918/NetworkSecurityGroup/). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). + type: object + description: | + [Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels + for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) + (ZPR) policy to control access to ZPR-supported resources. + type: object + type: object + AddonSummary: + description: The properties that define an addon summary. + properties: + addonError: + $ref: '#/components/schemas/AddonError' + currentInstalledVersion: + description: current installed version of the addon + example: x.y.z + type: string + lifecycleState: + description: The state of the addon. + enum: + - CREATING + - ACTIVE + - DELETING + - DELETED + - UPDATING + - NEEDS_ATTENTION + - FAILED + example: UPDATING + type: string + x-obmcs-top-level-enum: '#/definitions/AddonLifecycleState' + name: + description: The name of the addon. + example: Flannel + type: string + timeCreated: + description: The time the cluster was created. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + version: + description: selected addon version, or null indicates autoUpdate + example: x.y.z + type: string + required: + - name + - lifecycleState + type: object + InstallAddonDetails: + description: The properties that define to install/enable addon on a cluster + properties: + addonName: + description: The name of the addon. + example: flannel + type: string + configurations: + description: Addon configuration details. + items: + $ref: '#/components/schemas/AddonConfiguration' + type: array + isOverrideExisting: + default: false + description: Whether or not to override an existing addon installation. Defaults to false. If set to true, any existing addon installation would be overridden as per new installation details. + example: 'true' + type: boolean + version: + description: The version of addon to be installed. + example: 2.2.2 + type: string + required: + - addonName + type: object + Addon: + description: The properties that define an addon. + properties: + addonError: + $ref: '#/components/schemas/AddonError' + configurations: + description: Addon configuration details. + items: + $ref: '#/components/schemas/AddonConfiguration' + type: array + currentInstalledVersion: + description: current installed version of the addon + example: x.y.z + type: string + lifecycleState: + description: The state of the addon. + enum: + - CREATING + - ACTIVE + - DELETING + - DELETED + - UPDATING + - NEEDS_ATTENTION + - FAILED + example: UPDATING + type: string + x-obmcs-top-level-enum: '#/definitions/AddonLifecycleState' + name: + description: The name of the addon. + example: flannel + type: string + timeCreated: + description: The time the cluster was created. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + version: + description: selected addon version, or null indicates autoUpdate + example: x.y.z + type: string + required: + - lifecycleState + - name + type: object + UpdateAddonDetails: + description: The properties that define to update addon details. + properties: + configurations: + description: Addon configuration details. + items: + $ref: '#/components/schemas/AddonConfiguration' + type: array + version: + description: The version of the installed addon. + example: 2.2.2 + type: string + type: object + CredentialRotationStatus: + description: Information regarding cluster's credential rotation. + properties: + status: + description: | + Credential rotation status of a kubernetes cluster + IN_PROGRESS: Issuing new credentials to kubernetes cluster control plane and worker nodes or retiring old credentials from kubernetes cluster control plane and worker nodes. + WAITING: Waiting for customer to invoke the complete rotation action or the automcatic complete rotation action. + COMPLETED: New credentials are functional on kuberentes cluster. + enum: + - IN_PROGRESS + - WAITING + - COMPLETED + type: string + statusDetails: + description: | + Details of a kuberenetes cluster credential rotation status: + ISSUING_NEW_CREDENTIALS: Credential rotation is in progress. Starting to issue new credentials to kubernetes cluster control plane and worker nodes. + NEW_CREDENTIALS_ISSUED: New credentials are added. At this stage cluster has both old and new credentials and is awaiting old credentials retirement. + RETIRING_OLD_CREDENTIALS: Retirement of old credentials is in progress. Starting to remove old credentials from kubernetes cluster control plane and worker nodes. + COMPLETED: Credential rotation is complete. Old credentials are retired. + enum: + - ISSUING_NEW_CREDENTIALS + - NEW_CREDENTIALS_ISSUED + - RETIRING_OLD_CREDENTIALS + - COMPLETED + type: string + timeAutoCompletionScheduled: + description: The time by which retirement of old credentials should start. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + required: + - status + - statusDetails + type: object + CreateClusterKubeconfigContentDetails: + description: The properties that define a request to create a cluster kubeconfig. + properties: + endpoint: + description: The endpoint to target. A cluster may have multiple endpoints exposed but the kubeconfig can only target one at a time. + enum: + - LEGACY_KUBERNETES + - PUBLIC_ENDPOINT + - PRIVATE_ENDPOINT + - VCN_HOSTNAME + example: PUBLIC_ENDPOINT + type: string + expiration: + description: | + Deprecated. This field is no longer used. + example: null + type: integer + x-default-description: null + tokenVersion: + default: 2.0.0 + description: | + The version of the kubeconfig token. Supported value 2.0.0 + example: 2.0.0 + type: string + type: object + ClusterMigrateToNativeVcnStatus: + description: Information regarding a cluster's move to Native VCN. + properties: + state: + description: The current migration status of the cluster. + enum: + - NOT_STARTED + - REQUESTED + - IN_PROGRESS + - PENDING_DECOMMISSION + - COMPLETED + example: IN_PROGRESS + type: string + timeDecommissionScheduled: + description: The date and time the non-native VCN is due to be decommissioned. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + required: + - state + type: object + RebootClusterNodeDetails: + description: The properties that define a node reboot action. + properties: + nodeEvictionSettings: + $ref: '#/components/schemas/NodeEvictionSettings' + type: object + ReplaceBootVolumeClusterNodeDetails: + description: The properties that define a node boot volume replacement action. + properties: + nodeEvictionSettings: + $ref: '#/components/schemas/NodeEvictionSettings' + type: object + WorkloadMappingSummary: + description: The properties that define an workloadMapping summary. + properties: + clusterId: + description: The OCID of the cluster. + example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + id: + description: The ocid of the workloadMapping. + example: ocid1.workloadmapping.ocX.us-ashburn-1.xtrdsa56sjasa72321 + type: string + lifecycleState: + description: The state of the workloadMapping. + enum: + - CREATING + - ACTIVE + - FAILED + - DELETING + - DELETED + - UPDATING + example: UPDATING + type: string + x-obmcs-top-level-enum: '#/definitions/WorkloadMappingLifecycleState' + mappedCompartmentId: + description: The OCID of the mapped customer compartment. + example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq + type: string + mappedTenancyId: + description: The OCID of the mapped customer tenancy. + example: ocid1.tenancy.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq + type: string + namespace: + description: The namespace of the workloadMapping. + example: kube-proxy + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + timeCreated: + description: The time the cluster was created. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + required: + - id + - clusterId + - namespace + - mappedTenancyId + - mappedCompartmentId + - timeCreated + - lifecycleState + type: object + CreateWorkloadMappingDetails: + description: The properties that define a workloadMapping + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + mappedCompartmentId: + description: The OCID of the mapped customer compartment. + example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq + type: string + namespace: + description: The namespace of the workloadMapping. + example: kube-proxy + type: string + required: + - namespace + - mappedCompartmentId + type: object + WorkloadMapping: + description: The properties that define an workloadMapping. + properties: + clusterId: + description: The OCID of the cluster. + example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + id: + description: The ocid of the workloadMapping. + example: ocid1.workloadmapping.ocX.us-ashburn-1.xtrdsa56sjasa72321 + type: string + lifecycleState: + description: The state of the workloadMapping. + enum: + - CREATING + - ACTIVE + - FAILED + - DELETING + - DELETED + - UPDATING + example: UPDATING + type: string + x-obmcs-top-level-enum: '#/definitions/WorkloadMappingLifecycleState' + mappedCompartmentId: + description: The OCID of the mapped customer compartment. + example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq + type: string + mappedTenancyId: + description: The OCID of the mapped customer tenancy. + example: ocid1.tenancy.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq + type: string + namespace: + description: The namespace of the workloadMapping. + example: kube-proxy + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + timeCreated: + description: The time the cluster was created. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + required: + - id + - clusterId + - namespace + - mappedTenancyId + - mappedCompartmentId + - timeCreated + - lifecycleState + type: object + UpdateWorkloadMappingDetails: + description: The properties that define a workloadMapping + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + mappedCompartmentId: + description: The OCID of the mapped customer compartment. + example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq + type: string + type: object + NodePoolOptions: + description: Options for creating or updating node pools. + properties: + images: + description: | + Deprecated. See sources. + When creating a node pool using the `CreateNodePoolDetails` object, only image names contained in this + property can be passed to the `nodeImageName` property. + items: + example: Oracle-Linux-7.4 + type: string + type: array + kubernetesVersions: + description: Available Kubernetes versions. + items: + example: v1.9.4 + type: string + type: array + shapes: + description: Available shapes for nodes. + items: + example: VM.Standard2.4 + type: string + type: array + sources: + description: Available source of the node. + items: + $ref: '#/components/schemas/NodeSourceOption' + type: array + type: object + NodePoolSummary: + description: The properties that define a node pool summary. + properties: + clusterId: + description: The OCID of the cluster to which this node pool is attached. + example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw + type: string + compartmentId: + description: The OCID of the compartment in which the node pool exists. + example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + id: + description: The OCID of the node pool. + example: ocid1.nodepool.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq + type: string + initialNodeLabels: + description: A list of key/value pairs to add to nodes after they join the Kubernetes cluster. + items: + $ref: '#/components/schemas/KeyValue' + type: array + kubernetesVersion: + description: The version of Kubernetes running on the nodes in the node pool. + example: v1.9.4 + type: string + lifecycleDetails: + description: Details about the state of the nodepool. + type: string + lifecycleState: + description: The state of the nodepool. For more information, see [Monitoring Clusters](/Content/ContEng/Tasks/contengmonitoringclusters.htm) + enum: + - DELETED + - CREATING + - ACTIVE + - UPDATING + - DELETING + - FAILED + - INACTIVE + - NEEDS_ATTENTION + example: ACTIVE + type: string + x-obmcs-top-level-enum: '#/definitions/NodePoolLifecycleState' + name: + description: The name of the node pool. + example: My Node Pool + type: string + networkLaunchType: + description: Emulation type for the physical network interface card (NIC) for nodes + enum: + - VFIO + - E1000 + - PARAVIRTUALIZED + type: string + x-obmcs-top-level-enum: '#/definitions/NetworkLaunchType' + nodeConfigDetails: + $ref: '#/components/schemas/NodePoolNodeConfigDetails' + nodeEvictionNodePoolSettings: + $ref: '#/components/schemas/NodeEvictionNodePoolSettings' + nodeImageId: + description: | + Deprecated. see `nodeSource`. The OCID of the image running on the nodes in the node pool. + example: ocid1.image.oc1.phx.aaaaaaaanclh465xnfvajjojj5bbjzqytunslgvnyvf3fepiiltalnglekoa + type: string + nodeImageName: + description: | + Deprecated. see `nodeSource`. The name of the image running on the nodes in the node pool. + example: Oracle-Linux-7.4 + type: string + nodePoolCyclingDetails: + $ref: '#/components/schemas/NodePoolCyclingDetails' + nodeShape: + description: The name of the node shape of the nodes in the node pool. + example: VM.Standard2.4 + type: string + nodeShapeConfig: + $ref: '#/components/schemas/NodeShapeConfig' + nodeSource: + $ref: '#/components/schemas/NodeSourceOption' + nodeSourceDetails: + $ref: '#/components/schemas/NodeSourceDetails' + primaryVnic: + $ref: '#/components/schemas/NodePoolPrimaryVnicDetails' + quantityPerSubnet: + description: The number of nodes in each subnet. + example: 1 + format: int32 + type: integer + secondaryVnics: + description: A list of secondary vnics to attach to nodes + items: + $ref: '#/components/schemas/NodePoolSecondaryVnicDetails' + maxItems: 64 + type: array + sshPublicKey: + description: The SSH public key on each node in the node pool on launch. + example: ssh-rsa AAAAB3NzaC1yc2abc123... + type: string + subnetIds: + description: The OCIDs of the subnets in which to place nodes for this node pool. + items: + type: string + type: array + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + type: object + CreateNodePoolDetails: + description: The properties that define a request to create a node pool. + properties: + clusterId: + description: The OCID of the cluster to which this node pool is attached. + example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw + type: string + compartmentId: + description: The OCID of the compartment in which the node pool exists. + example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + initialNodeLabels: + description: A list of key/value pairs to add to nodes after they join the Kubernetes cluster. + items: + $ref: '#/components/schemas/KeyValue' + type: array + kubernetesVersion: + description: The version of Kubernetes to install on the nodes in the node pool. + example: v1.9.4 + type: string + name: + description: The name of the node pool. Avoid entering confidential information. + example: My Node Pool + type: string + networkLaunchType: + description: Emulation type for the physical network interface card (NIC) for nodes + enum: + - VFIO + - E1000 + - PARAVIRTUALIZED + type: string + x-default-description: 'null' + x-obmcs-top-level-enum: '#/definitions/NetworkLaunchType' + nodeConfigDetails: + $ref: '#/components/schemas/CreateNodePoolNodeConfigDetails' + nodeEvictionNodePoolSettings: + $ref: '#/components/schemas/NodeEvictionNodePoolSettings' + nodeImageName: + description: | + Deprecated. Use `nodeSourceDetails` instead. + If you specify values for both, this value is ignored. + The name of the image running on the nodes in the node pool. + example: Oracle-Linux-7.4 + type: string + nodeMetadata: + additionalProperties: + type: string + description: A list of key/value pairs to add to each underlying OCI instance in the node pool on launch. + type: object + nodePoolCyclingDetails: + $ref: '#/components/schemas/NodePoolCyclingDetails' + nodeShape: + description: The name of the node shape of the nodes in the node pool. + example: VM.Standard2.4 + type: string + nodeShapeConfig: + $ref: '#/components/schemas/CreateNodeShapeConfigDetails' + nodeSourceDetails: + $ref: '#/components/schemas/NodeSourceDetails' + primaryVnic: + $ref: '#/components/schemas/NodePoolPrimaryVnicDetails' + quantityPerSubnet: + default: 1 + description: | + Optional, default to 1. The number of nodes to create in each subnet specified in subnetIds property. + When used, subnetIds is required. This property is deprecated, use nodeConfigDetails instead. + example: 1 + format: int32 + type: integer + secondaryVnics: + description: A list of secondary vnics to attach to nodes + items: + $ref: '#/components/schemas/NodePoolSecondaryVnicDetails' + maxItems: 64 + type: array + x-default-description: 'null' + sshPublicKey: + description: The SSH public key on each node in the node pool on launch. + example: ssh-rsa AAAAB3NzaC1yc2abc123... + type: string + subnetIds: + description: | + The OCIDs of the subnets in which to place nodes for this node pool. When used, quantityPerSubnet + can be provided. This property is deprecated, use nodeConfigDetails. Exactly one of the + subnetIds or nodeConfigDetails properties must be specified. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + required: + - compartmentId + - clusterId + - name + - nodeShape + type: object + NodePool: + description: A pool of compute nodes attached to a cluster. Avoid entering confidential information. + properties: + clusterId: + description: The OCID of the cluster to which this node pool is attached. + example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw + type: string + compartmentId: + description: The OCID of the compartment in which the node pool exists. + example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + id: + description: The OCID of the node pool. + example: ocid1.nodepool.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq + type: string + initialNodeLabels: + description: A list of key/value pairs to add to nodes after they join the Kubernetes cluster. + items: + $ref: '#/components/schemas/KeyValue' + type: array + kubernetesVersion: + description: The version of Kubernetes running on the nodes in the node pool. + example: v1.9.4 + type: string + lifecycleDetails: + description: Details about the state of the nodepool. + type: string + lifecycleState: + description: The state of the nodepool. For more information, see [Monitoring Clusters](/Content/ContEng/Tasks/contengmonitoringclusters.htm) + enum: + - DELETED + - CREATING + - ACTIVE + - UPDATING + - DELETING + - FAILED + - INACTIVE + - NEEDS_ATTENTION + example: ACTIVE + type: string + x-obmcs-top-level-enum: '#/definitions/NodePoolLifecycleState' + name: + description: The name of the node pool. + example: My Node Pool + type: string + networkLaunchType: + description: Emulation type for the physical network interface card (NIC) for nodes + enum: + - VFIO + - E1000 + - PARAVIRTUALIZED + type: string + x-obmcs-top-level-enum: '#/definitions/NetworkLaunchType' + nodeConfigDetails: + $ref: '#/components/schemas/NodePoolNodeConfigDetails' + nodeEvictionNodePoolSettings: + $ref: '#/components/schemas/NodeEvictionNodePoolSettings' + nodeImageId: + description: | + Deprecated. see `nodeSource`. The OCID of the image running on the nodes in the node pool. + example: ocid1.image.oc1.phx.aaaaaaaanclh465xnfvajjojj5bbjzqytunslgvnyvf3fepiiltalnglekoa + type: string + nodeImageName: + description: | + Deprecated. see `nodeSource`. The name of the image running on the nodes in the node pool. + example: Oracle-Linux-7.4 + type: string + nodeMetadata: + additionalProperties: + type: string + description: A list of key/value pairs to add to each underlying OCI instance in the node pool on launch. + type: object + nodePoolCyclingDetails: + $ref: '#/components/schemas/NodePoolCyclingDetails' + nodeShape: + description: The name of the node shape of the nodes in the node pool. + example: VM.Standard2.4 + type: string + nodeShapeConfig: + $ref: '#/components/schemas/NodeShapeConfig' + nodeSource: + $ref: '#/components/schemas/NodeSourceOption' + nodeSourceDetails: + $ref: '#/components/schemas/NodeSourceDetails' + nodes: + description: The nodes in the node pool. + items: + $ref: '#/components/schemas/Node' + type: array + primaryVnic: + $ref: '#/components/schemas/NodePoolPrimaryVnicDetails' + quantityPerSubnet: + description: The number of nodes in each subnet. + example: 1 + format: int32 + type: integer + secondaryVnics: + description: A list of secondary vnics to attach to nodes + items: + $ref: '#/components/schemas/NodePoolSecondaryVnicDetails' + maxItems: 64 + type: array + sshPublicKey: + description: The SSH public key on each node in the node pool on launch. + example: ssh-rsa AAAAB3NzaC1yc2abc123... + type: string + subnetIds: + description: The OCIDs of the subnets in which to place nodes for this node pool. + items: + type: string + type: array + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + type: object + UpdateNodePoolDetails: + description: The properties that define a request to update a node pool. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + initialNodeLabels: + description: A list of key/value pairs to add to nodes after they join the Kubernetes cluster. + items: + $ref: '#/components/schemas/KeyValue' + type: array + kubernetesVersion: + description: The version of Kubernetes to which the nodes in the node pool should be upgraded. + example: v1.9.4 + type: string + name: + description: The new name for the cluster. Avoid entering confidential information. + example: My Updated Node Pool + type: string + networkLaunchType: + description: Emulation type for the physical network interface card (NIC) for nodes + enum: + - VFIO + - E1000 + - PARAVIRTUALIZED + type: string + x-obmcs-top-level-enum: '#/definitions/NetworkLaunchType' + nodeConfigDetails: + $ref: '#/components/schemas/UpdateNodePoolNodeConfigDetails' + nodeEvictionNodePoolSettings: + $ref: '#/components/schemas/NodeEvictionNodePoolSettings' + nodeMetadata: + additionalProperties: + type: string + description: A list of key/value pairs to add to each underlying OCI instance in the node pool on launch. + type: object + nodePoolCyclingDetails: + $ref: '#/components/schemas/NodePoolCyclingDetails' + nodeShape: + description: The name of the node shape of the nodes in the node pool used on launch. + example: VM.Standard2.4 + type: string + nodeShapeConfig: + $ref: '#/components/schemas/UpdateNodeShapeConfigDetails' + nodeSourceDetails: + $ref: '#/components/schemas/NodeSourceDetails' + primaryVnic: + $ref: '#/components/schemas/NodePoolPrimaryVnicDetails' + quantityPerSubnet: + description: | + The number of nodes to have in each subnet specified in the subnetIds property. This property is deprecated, + use nodeConfigDetails instead. If the current value of quantityPerSubnet is greater than 0, you can only + use quantityPerSubnet to scale the node pool. If the current value of quantityPerSubnet is equal to 0 and + the current value of size in nodeConfigDetails is greater than 0, before you can use quantityPerSubnet, + you must first scale the node pool to 0 nodes using nodeConfigDetails. + example: 1 + format: int32 + type: integer + secondaryVnics: + description: A list of secondary vnics to attach to nodes + items: + $ref: '#/components/schemas/NodePoolSecondaryVnicDetails' + maxItems: 64 + type: array + sshPublicKey: + description: The SSH public key to add to each node in the node pool on launch. + example: ssh-rsa AAAAB3NzaC1yc2abc123... + type: string + subnetIds: + description: | + The OCIDs of the subnets in which to place nodes for this node pool. This property is deprecated, + use nodeConfigDetails instead. Only one of the subnetIds or nodeConfigDetails + properties can be specified. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + type: object + PodShapeSummary: + description: Pod shape. + properties: + memoryOptions: + description: ShapeMemoryOptions. + items: + $ref: '#/components/schemas/ShapeMemoryOptions' + type: array + name: + description: The name of the identifying shape. + maxLength: 255 + minLength: 1 + type: string + networkBandwidthOptions: + description: ShapeNetworkBandwidthOptions. + items: + $ref: '#/components/schemas/ShapeNetworkBandwidthOptions' + type: array + ocpuOptions: + description: Options for OCPU shape. + items: + $ref: '#/components/schemas/ShapeOcpuOptions' + type: array + processorDescription: + description: A short description of the VM's processor (CPU). + type: string + required: + - name + type: object + VirtualNodePoolSummary: + description: The properties that define a virtual node pool summary. + properties: + clusterId: + description: The cluster the virtual node pool is associated with. A virtual node pool can only be associated with one cluster. + example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: Compartment of the virtual node pool. + example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + example: + Operations: + CostCenter: 42 + type: object + displayName: + description: Display name of the virtual node pool. This is a non-unique value. + example: My Virtual Node Pool + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + id: + description: The OCID of the virtual node pool. + example: ocid1.nodepool.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq + maxLength: 255 + minLength: 1 + type: string + initialVirtualNodeLabels: + description: Initial labels that will be added to the Kubernetes Virtual Node object when it registers. This is the same as virtualNodePool resources. + items: + $ref: '#/components/schemas/InitialVirtualNodeLabel' + type: array + kubernetesVersion: + description: The version of Kubernetes running on the nodes in the node pool. + example: v1.9.4 + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Details about the state of the Virtual Node Pool. + example: updating. + type: string + lifecycleState: + description: The state of the Virtual Node Pool. + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + - DELETED + - FAILED + - NEEDS_ATTENTION + type: string + x-obmcs-top-level-enum: '#/definitions/VirtualNodePoolLifecycleState' + nsgIds: + description: List of network security group id's applied to the Virtual Node VNIC. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + placementConfigurations: + description: The list of placement configurations which determines where Virtual Nodes will be provisioned across as it relates to the subnet and availability domains. The size attribute determines how many we evenly spread across these placement configurations + items: + $ref: '#/components/schemas/PlacementConfiguration' + type: array + podConfiguration: + $ref: '#/components/schemas/PodConfiguration' + size: + description: The number of Virtual Nodes that should be in the Virtual Node Pool. The placement configurations determine where these virtual nodes are placed. + format: int32 + minimum: 0 + type: integer + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + taints: + description: A taint is a collection of . These taints will be applied to the Virtual Nodes of this Virtual Node Pool for Kubernetes scheduling. + items: + $ref: '#/components/schemas/Taint' + type: array + timeCreated: + description: The time the virtual node pool was created. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + timeUpdated: + description: The time the virtual node pool was updated. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + virtualNodePoolCyclingDetails: + $ref: '#/components/schemas/VirtualNodePoolCyclingDetails' + virtualNodeTags: + $ref: '#/components/schemas/VirtualNodeTags' + required: + - id + - compartmentId + - clusterId + - displayName + - kubernetesVersion + - placementConfigurations + - podConfiguration + - size + type: object + CreateVirtualNodePoolDetails: + description: The properties that define a request to create a virtual node pool. + properties: + clusterId: + description: The cluster the virtual node pool is associated with. A virtual node pool can only be associated with one cluster. + example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: Compartment of the virtual node pool. + example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + example: + Operations: + CostCenter: 42 + type: object + displayName: + description: Display name of the virtual node pool. This is a non-unique value. + example: My Virtual Node Pool + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + initialVirtualNodeLabels: + description: Initial labels that will be added to the Kubernetes Virtual Node object when it registers. + items: + $ref: '#/components/schemas/InitialVirtualNodeLabel' + type: array + nsgIds: + description: List of network security group id's applied to the Virtual Node VNIC. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + placementConfigurations: + description: The list of placement configurations which determines where Virtual Nodes will be provisioned across as it relates to the subnet and availability domains. The size attribute determines how many we evenly spread across these placement configurations + items: + $ref: '#/components/schemas/PlacementConfiguration' + minItems: 1 + type: array + podConfiguration: + $ref: '#/components/schemas/PodConfiguration' + size: + description: The number of Virtual Nodes that should be in the Virtual Node Pool. The placement configurations determine where these virtual nodes are placed. + format: int32 + minimum: 0 + type: integer + taints: + description: A taint is a collection of . These taints will be applied to the Virtual Nodes of this Virtual Node Pool for Kubernetes scheduling. + items: + $ref: '#/components/schemas/Taint' + type: array + virtualNodePoolCyclingDetails: + $ref: '#/components/schemas/VirtualNodePoolCyclingDetails' + virtualNodeTags: + $ref: '#/components/schemas/VirtualNodeTags' + required: + - compartmentId + - clusterId + - displayName + - placementConfigurations + - podConfiguration + - size + type: object + VirtualNodePool: + description: A pool of virtual nodes attached to a cluster. + properties: + clusterId: + description: The cluster the virtual node pool is associated with. A virtual node pool can only be associated with one cluster. + example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: Compartment of the virtual node pool. + example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + example: + Operations: + CostCenter: 42 + type: object + displayName: + description: Display name of the virtual node pool. This is a non-unique value. + example: My Virtual Node Pool + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + id: + description: The OCID of the virtual node pool. + example: ocid1.virtualnodepool.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq + maxLength: 255 + minLength: 1 + type: string + initialVirtualNodeLabels: + description: Initial labels that will be added to the Kubernetes Virtual Node object when it registers. This is the same as virtualNodePool resources. + items: + $ref: '#/components/schemas/InitialVirtualNodeLabel' + type: array + kubernetesVersion: + description: The version of Kubernetes running on the nodes in the node pool. + example: v1.9.4 + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Details about the state of the Virtual Node Pool. + example: updating. + type: string + lifecycleState: + description: The state of the Virtual Node Pool. + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + - DELETED + - FAILED + - NEEDS_ATTENTION + type: string + x-obmcs-top-level-enum: '#/definitions/VirtualNodePoolLifecycleState' + nsgIds: + description: List of network security group id's applied to the Virtual Node VNIC. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + placementConfigurations: + description: The list of placement configurations which determines where Virtual Nodes will be provisioned across as it relates to the subnet and availability domains. The size attribute determines how many we evenly spread across these placement configurations + items: + $ref: '#/components/schemas/PlacementConfiguration' + type: array + podConfiguration: + $ref: '#/components/schemas/PodConfiguration' + size: + description: The number of Virtual Nodes that should be in the Virtual Node Pool. The placement configurations determine where these virtual nodes are placed. + format: int32 + minimum: 0 + type: integer + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + taints: + description: A taint is a collection of . These taints will be applied to the Virtual Nodes of this Virtual Node Pool for Kubernetes scheduling. + items: + $ref: '#/components/schemas/Taint' + type: array + timeCreated: + description: The time the virtual node pool was created. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + timeUpdated: + description: The time the virtual node pool was updated. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + virtualNodePoolCyclingDetails: + $ref: '#/components/schemas/VirtualNodePoolCyclingDetails' + virtualNodeTags: + $ref: '#/components/schemas/VirtualNodeTags' + required: + - id + - compartmentId + - clusterId + - displayName + - kubernetesVersion + - placementConfigurations + - podConfiguration + - size + type: object + UpdateVirtualNodePoolDetails: + description: The properties that define a request to update a virtual node pool. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + example: + Operations: + CostCenter: 42 + type: object + displayName: + description: Display name of the virtual node pool. This is a non-unique value. + example: My Virtual Node Pool + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + initialVirtualNodeLabels: + description: Initial labels that will be added to the Kubernetes Virtual Node object when it registers. + items: + $ref: '#/components/schemas/InitialVirtualNodeLabel' + type: array + nsgIds: + description: List of network security group id's applied to the Virtual Node VNIC. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + placementConfigurations: + description: The list of placement configurations which determines where Virtual Nodes will be provisioned across as it relates to the subnet and availability domains. The size attribute determines how many we evenly spread across these placement configurations + items: + $ref: '#/components/schemas/PlacementConfiguration' + minItems: 1 + type: array + podConfiguration: + $ref: '#/components/schemas/PodConfiguration' + size: + description: The number of Virtual Nodes that should be in the Virtual Node Pool. The placement configurations determine where these virtual nodes are placed. + format: int32 + minimum: 0 + type: integer + taints: + description: A taint is a collection of . These taints will be applied to the Virtual Nodes of this Virtual Node Pool for Kubernetes scheduling. + items: + $ref: '#/components/schemas/Taint' + type: array + virtualNodePoolCyclingDetails: + $ref: '#/components/schemas/VirtualNodePoolCyclingDetails' + virtualNodeTags: + $ref: '#/components/schemas/VirtualNodeTags' + type: object + VirtualNodeSummary: + description: The properties that define a virtual node summary. + properties: + availabilityDomain: + description: The name of the availability domain in which this virtual node is placed + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + example: + Operations: + CostCenter: 42 + type: object + displayName: + description: The name of the virtual node. + example: My Kubernetes virtual Node + maxLength: 255 + minLength: 1 + type: string + faultDomain: + description: The fault domain of this virtual node. + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + id: + description: The ocid of the virtual node. + example: ocid1.virtualnode.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgyswgycdoy3tcmtctmyw + maxLength: 255 + minLength: 1 + type: string + kubernetesVersion: + description: The version of Kubernetes this virtual node is running. + example: v1.9.4 + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Details about the state of the Virtual Node. + type: string + lifecycleState: + description: The state of the Virtual Node. + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + - DELETED + - FAILED + - NEEDS_ATTENTION + type: string + x-obmcs-top-level-enum: '#/definitions/VirtualNodeLifecycleState' + nsgIds: + description: NSG Ids applied to virtual node vnic. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + privateIp: + description: The private IP address of this Virtual Node. + type: string + subnetId: + description: The OCID of the subnet in which this Virtual Node is placed. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + timeCreated: + description: The time at which the virtual node was created. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + virtualNodeError: + description: An error that may be associated with the virtual node. + type: string + virtualNodePoolId: + description: The ocid of the virtual node pool this virtual node belongs to. + example: ocid1.virtualnodepool.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq + maxLength: 255 + minLength: 1 + type: string + required: + - id + - virtualNodePoolId + - displayName + type: object + VirtualNode: + description: The properties that define a virtual node. + properties: + availabilityDomain: + description: The name of the availability domain in which this virtual node is placed + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + example: + Operations: + CostCenter: 42 + type: object + displayName: + description: The name of the virtual node. + example: My Kubernetes virtual Node + maxLength: 255 + minLength: 1 + type: string + faultDomain: + description: The fault domain of this virtual node. + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + id: + description: The ocid of the virtual node. + example: ocid1.virtualnode.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgyswgycdoy3tcmtctmyw + maxLength: 255 + minLength: 1 + type: string + kubernetesVersion: + description: The version of Kubernetes this virtual node is running. + example: v1.9.4 + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Details about the state of the Virtual Node. + type: string + lifecycleState: + description: The state of the Virtual Node. + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + - DELETED + - FAILED + - NEEDS_ATTENTION + type: string + x-obmcs-top-level-enum: '#/definitions/VirtualNodeLifecycleState' + nsgIds: + description: NSG Ids applied to virtual node vnic. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + privateIp: + description: The private IP address of this Virtual Node. + type: string + subnetId: + description: The OCID of the subnet in which this Virtual Node is placed. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + timeCreated: + description: The time at which the virtual node was created. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + virtualNodeError: + description: An error that may be associated with the virtual node. + type: string + virtualNodePoolId: + description: The ocid of the virtual node pool this virtual node belongs to. + example: ocid1.virtualnodepool.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq + maxLength: 255 + minLength: 1 + type: string + required: + - id + - virtualNodePoolId + - displayName + type: object + WorkRequestSummary: + description: The properties that define a work request summary. + properties: + compartmentId: + description: The OCID of the compartment in which the work request exists. + example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq + type: string + id: + description: The OCID of the work request. + example: ocid1.clustersworkrequest.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq + type: string + operationType: + description: The type of work the work request is doing. + enum: + - CLUSTER_CREATE + - CLUSTER_UPDATE + - CLUSTER_DELETE + - CREATE_NAMESPACE + - NODEPOOL_CREATE + - NODEPOOL_UPDATE + - NODEPOOL_DELETE + - NODEPOOL_RECONCILE + - NODEPOOL_CYCLING + - WORKREQUEST_CANCEL + - VIRTUALNODEPOOL_CREATE + - VIRTUALNODEPOOL_UPDATE + - VIRTUALNODEPOOL_DELETE + - VIRTUALNODE_DELETE + - VIRTUALNODEPOOL_CYCLING + - ENABLE_ADDON + - UPDATE_ADDON + - DISABLE_ADDON + - RECONCILE_ADDON + - CLUSTER_NODE_REBOOT + - CLUSTER_NODE_REPLACE_BOOT_VOLUME + - START_PUBLIC_API_ENDPOINT_DECOMMISSION + - ROLLBACK_PUBLIC_API_ENDPOINT_DECOMMISSION + example: CLUSTER_UPDATE + type: string + x-obmcs-top-level-enum: '#/definitions/WorkRequestOperationType' + resources: + description: The resources this work request affects. + items: + $ref: '#/components/schemas/WorkRequestResource' + type: array + status: + description: The current status of the work request. + enum: + - ACCEPTED + - IN_PROGRESS + - FAILED + - SUCCEEDED + - CANCELING + - CANCELED + example: IN_PROGRESS + type: string + x-obmcs-top-level-enum: '#/definitions/WorkRequestStatus' + timeAccepted: + description: The time the work request was accepted. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + timeFinished: + description: The time the work request was finished. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + timeStarted: + description: The time the work request was started. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + type: object + WorkRequest: + description: An asynchronous work request. + properties: + compartmentId: + description: The OCID of the compartment in which the work request exists. + example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq + type: string + id: + description: The OCID of the work request. + example: ocid1.clustersworkrequest.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq + type: string + operationType: + description: The type of work the work request is doing. + enum: + - CLUSTER_CREATE + - CLUSTER_UPDATE + - CLUSTER_DELETE + - CREATE_NAMESPACE + - NODEPOOL_CREATE + - NODEPOOL_UPDATE + - NODEPOOL_DELETE + - NODEPOOL_RECONCILE + - NODEPOOL_CYCLING + - WORKREQUEST_CANCEL + - VIRTUALNODEPOOL_CREATE + - VIRTUALNODEPOOL_UPDATE + - VIRTUALNODEPOOL_DELETE + - VIRTUALNODE_DELETE + - VIRTUALNODEPOOL_CYCLING + - ENABLE_ADDON + - UPDATE_ADDON + - DISABLE_ADDON + - RECONCILE_ADDON + - CLUSTER_NODE_REBOOT + - CLUSTER_NODE_REPLACE_BOOT_VOLUME + - START_PUBLIC_API_ENDPOINT_DECOMMISSION + - ROLLBACK_PUBLIC_API_ENDPOINT_DECOMMISSION + example: CLUSTER_UPDATE + type: string + x-obmcs-top-level-enum: '#/definitions/WorkRequestOperationType' + resources: + description: The resources this work request affects. + items: + $ref: '#/components/schemas/WorkRequestResource' + type: array + status: + description: The current status of the work request. + enum: + - ACCEPTED + - IN_PROGRESS + - FAILED + - SUCCEEDED + - CANCELING + - CANCELED + example: IN_PROGRESS + type: string + x-obmcs-top-level-enum: '#/definitions/WorkRequestStatus' + timeAccepted: + description: The time the work request was accepted. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + timeFinished: + description: The time the work request was finished. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + timeStarted: + description: The time the work request was started. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + type: object + WorkRequestError: + description: Errors related to a specific work request. + properties: + code: + description: A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm). + example: UnknownError + type: string + message: + description: A human-readable error string. + example: error validating payload + type: string + timestamp: + description: The date and time the error occurred. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + required: + - code + - message + - timestamp + type: object + WorkRequestLogEntry: + description: Log entries related to a specific work request. + properties: + message: + description: The description of an action that occurred. + example: error validating payload + type: string + timestamp: + description: The date and time the log entry occurred. + example: '2017-07-21T16:11:29Z' + type: string + type: object + AddonVersions: + description: The properties that define a work request resource. + properties: + configurations: + description: Addon version configuration details. + items: + $ref: '#/components/schemas/AddonVersionConfiguration' + type: array + description: + description: Information about the addon version. + example: Information about addon version and if any recent changes + type: string + kubernetesVersionFilters: + $ref: '#/components/schemas/KubernetesVersionsFilters' + status: + description: Current state of the addon, only active will be visible to customer, visibility of versions in other status will be filtered based on limits property. + enum: + - ACTIVE + - DEPRECATED + - PREVIEW + - RECALLED + example: ACTIVE + type: string + versionNumber: + description: Version number, need be comparable within an addon. + example: x.y.z + type: string + type: object + Error: + description: The properties that define an error. + properties: + code: + description: A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm). + example: UnknownError + type: string + message: + description: A human-readable error string. + example: error validating payload + type: string + required: + - code + - message + type: object + ClusterPodNetworkOptionDetails: + description: The CNI type and relevant network details potentially applicable to the node pools of the cluster + discriminator: + propertyName: cniType + properties: + cniType: + description: The CNI used by the node pools of this cluster + enum: + - OCI_VCN_IP_NATIVE + - FLANNEL_OVERLAY + maxLength: 255 + minLength: 1 + type: string + required: + - cniType + type: object + ClusterEndpointConfig: + description: The properties that define the network configuration for the Cluster endpoint. + properties: + isPublicIpEnabled: + default: false + description: Whether the cluster should be assigned a public IP address. Defaults to false. If set to true on a private subnet, the cluster provisioning will fail. + type: boolean + nsgIds: + description: | + A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see [NetworkSecurityGroup](#/en/iaas/20160918/NetworkSecurityGroup/). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). + type: object + description: | + [Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels + for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) + (ZPR) policy to control access to ZPR-supported resources. + type: object + subnetId: + description: The OCID of the regional subnet in which to place the Cluster endpoint. + type: string + type: object + ClusterEndpoints: + description: The properties that define endpoints for a cluster. + properties: + ipv6Endpoint: + description: The IPv6 networking Kubernetes API server endpoint. + example: https://yourIPv6Endpoint + type: string + kubernetes: + description: The non-native networking Kubernetes API server endpoint. + example: https://yourkubernetes + type: string + privateEndpoint: + description: The private native networking Kubernetes API server endpoint. + example: https://yourPrivateEndpoint + type: string + publicEndpoint: + description: The public native networking Kubernetes API server endpoint, if one was requested. + example: https://yourPublicEndpoint + type: string + vcnHostnameEndpoint: + description: | + The FQDN assigned to the Kubernetes API private endpoint. + Example: 'https://yourVcnHostnameEndpoint' + example: https://clusterinfo.subnetLabel.vcnLabel.oraclevcn.com:6443 + type: string + type: object + ImagePolicyConfig: + description: The properties that define a image verification policy. + properties: + isPolicyEnabled: + default: false + description: Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime. + type: boolean + keyDetails: + description: A list of KMS key details. + items: + $ref: '#/components/schemas/KeyDetails' + type: array + type: object + ClusterMetadata: + description: The properties that define meta data for a cluster. + properties: + createdByUserId: + description: The user who created the cluster. + example: ocid1.user.oc1..aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq + type: string + createdByWorkRequestId: + description: The OCID of the work request which created the cluster. + example: ocid1.clustersworkrequest.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq + type: string + deletedByUserId: + description: The user who deleted the cluster. + example: ocid1.user.oc1..aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq + type: string + deletedByWorkRequestId: + description: The OCID of the work request which deleted the cluster. + example: ocid1.clustersworkrequest.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq + type: string + timeCreated: + description: The time the cluster was created. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + timeCredentialExpiration: + description: The time until which the cluster credential is valid. + example: '2023-07-21T16:11:29Z' + format: date-time + type: string + timeDeleted: + description: The time the cluster was deleted. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + timeUpdated: + description: The time the cluster was updated. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + updatedByUserId: + description: The user who updated the cluster. + example: ocid1.user.oc1..aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq + type: string + updatedByWorkRequestId: + description: The OCID of the work request which updated the cluster. + example: ocid1.clustersworkrequest.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq + type: string + type: object + ClusterCreateOptions: + description: The properties that define extra options for a cluster. + properties: + addOns: + $ref: '#/components/schemas/AddOnOptions' + admissionControllerOptions: + $ref: '#/components/schemas/AdmissionControllerOptions' + ipFamilies: + description: IP family to use for single stack or define the order of IP families for dual-stack + items: + enum: + - IPv4 + - IPv6 + type: string + type: array + x-default-description: Default legacy behavior will be just IPv4 when property not provided + kubernetesNetworkConfig: + $ref: '#/components/schemas/KubernetesNetworkConfig' + openIdConnectDiscovery: + $ref: '#/components/schemas/OpenIdConnectDiscovery' + openIdConnectTokenAuthenticationConfig: + $ref: '#/components/schemas/OpenIdConnectTokenAuthenticationConfig' + persistentVolumeConfig: + $ref: '#/components/schemas/PersistentVolumeConfigDetails' + serviceLbConfig: + $ref: '#/components/schemas/ServiceLbConfigDetails' + serviceLbSubnetIds: + description: The OCIDs of the subnets used for Kubernetes services load balancers. + items: + example: ocid1.subnet.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3ofzxtlyit + type: string + type: array + type: object + CreateClusterEndpointConfigDetails: + description: The properties that define the network configuration for the Cluster endpoint. + properties: + isPublicIpEnabled: + default: false + description: Whether the cluster should be assigned a public IP address. Defaults to false. If set to true on a private subnet, the cluster provisioning will fail. + type: boolean + nsgIds: + description: | + A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see [NetworkSecurityGroup](#/en/iaas/20160918/NetworkSecurityGroup/). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). + type: object + description: | + [Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels + for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) + (ZPR) policy to control access to ZPR-supported resources. + type: object + subnetId: + description: The OCID of the regional subnet in which to place the Cluster endpoint. + type: string + type: object + CreateImagePolicyConfigDetails: + description: The properties that define a image verification policy. + properties: + isPolicyEnabled: + default: false + description: Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime. + type: boolean + keyDetails: + description: A list of KMS key details. + items: + $ref: '#/components/schemas/KeyDetails' + type: array + type: object + UpdateImagePolicyConfigDetails: + description: The properties that define a image verification policy. + properties: + isPolicyEnabled: + default: false + description: Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime. + type: boolean + keyDetails: + description: A list of KMS key details. + items: + $ref: '#/components/schemas/KeyDetails' + type: array + type: object + UpdateClusterOptionsDetails: + description: The properties that define extra options updating a cluster. + properties: + admissionControllerOptions: + $ref: '#/components/schemas/AdmissionControllerOptions' + openIdConnectDiscovery: + $ref: '#/components/schemas/OpenIdConnectDiscovery' + openIdConnectTokenAuthenticationConfig: + $ref: '#/components/schemas/OpenIdConnectTokenAuthenticationConfig' + persistentVolumeConfig: + $ref: '#/components/schemas/PersistentVolumeConfigDetails' + serviceLbConfig: + $ref: '#/components/schemas/ServiceLbConfigDetails' + type: object + AddonError: + description: The error info of the addon. + properties: + code: + description: A short error code that defines the upstream error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm). + example: LimitExceeded + type: string + message: + description: A human-readable error string of the upstream error. + example: error validating payload + type: string + status: + description: The status of the HTTP response encountered in the upstream error. + example: '429' + type: string + type: object + AddonConfiguration: + description: Defines the configuration of available addons for a cluster + properties: + key: + description: configuration key name + example: foo + maxLength: 255 + minLength: 1 + type: string + value: + description: configuration value name + example: bar + maxLength: 8191 + minLength: 1 + type: string + type: object + NodeEvictionSettings: + description: Node Eviction Configuration + properties: + evictionGraceDuration: + description: | + Duration after which OKE will give up eviction of the pods on the node. PT0M will indicate you want to perform node action without cordon and drain. + Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M + example: PT30M + type: string + isForceActionAfterGraceDuration: + default: false + description: If the node action should be performed if not all the pods can be evicted in the grace period + type: boolean + type: object + NodeSourceOption: + description: The source option for the node. + discriminator: + propertyName: sourceType + properties: + sourceName: + description: | + The user-friendly name of the entity corresponding to the OCID. + maxLength: 255 + minLength: 1 + type: string + sourceType: + description: | + The source type of this option. + `IMAGE` means the OCID is of an image. + enum: + - IMAGE + type: string + x-obmcs-top-level-enum: '#/definitions/NodeSourceType' + required: + - sourceType + type: object + KeyValue: + description: The properties that define a key value pair. + properties: + key: + description: The key of the pair. + example: mykey + type: string + value: + description: The value of the pair. + example: myvalue + type: string + type: object + NodePoolNodeConfigDetails: + description: The size and placement configuration of nodes in the node pool. + properties: + computeClusterId: + description: The OCID of the Compute Cluster to be associated with the worker node instance. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + isPvEncryptionInTransitEnabled: + default: false + description: Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false. + type: boolean + kmsKeyId: + description: The OCID of the Key Management Service key assigned to the boot volume. + type: string + nodePoolPodNetworkOptionDetails: + $ref: '#/components/schemas/NodePoolPodNetworkOptionDetails' + nsgIds: + description: | + The OCIDs of the Network Security Group(s) to associate nodes for this node pool with. For more information about NSGs, see [NetworkSecurityGroup](#/en/iaas/20160918/NetworkSecurityGroup/). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + placementConfigs: + description: | + The placement configurations for the node pool. Provide one placement + configuration for each availability domain in which you intend to launch a node. + + To use the node pool with a regional subnet, provide a placement configuration for + each availability domain, and include the regional subnet in each placement + configuration. + items: + $ref: '#/components/schemas/NodePoolPlacementConfigDetails' + type: array + size: + description: | + The number of nodes in the node pool. + format: int32 + type: integer + type: object + NodeEvictionNodePoolSettings: + description: Node Eviction Details configuration + properties: + evictionGraceDuration: + description: | + Duration after which OKE will give up eviction of the pods on the node. PT0M will indicate you want to delete the node without cordon and drain. + Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M + example: PT30M + type: string + isForceActionAfterGraceDuration: + default: false + description: If the node action should be performed if not all the pods can be evicted in the grace period + type: boolean + isForceDeleteAfterGraceDuration: + default: false + description: If the underlying compute instance should be deleted if you cannot evict all the pods in grace period + type: boolean + type: object + NodePoolCyclingDetails: + description: Node Pool Cycling Details + properties: + cycleModes: + description: | + An ordered list of cycle modes that should be performed on the OKE nodes. + items: + $ref: '#/components/schemas/CycleMode' + maxItems: 1 + type: array + isNodeCyclingEnabled: + default: false + description: If cycling operation should be performed on the nodes in the node pool. + type: boolean + maximumSurge: + default: '1' + description: | + Maximum additional new compute instances that would be temporarily created and added to nodepool during the cycling nodepool process. + OKE supports both integer and percentage input. + Defaults to 1, Ranges from 0 to Nodepool size or 0% to 100% + example: 10% + maxLength: 4 + minLength: 1 + type: string + maximumUnavailable: + default: '0' + description: | + Maximum active nodes that would be terminated from nodepool during the cycling nodepool process. + OKE supports both integer and percentage input. + Defaults to 0, Ranges from 0 to Nodepool size or 0% to 100% + example: '2' + maxLength: 4 + minLength: 1 + type: string + type: object + NodeShapeConfig: + description: The shape configuration of the nodes. + properties: + memoryInGBs: + description: | + The total amount of memory available to each node, in gigabytes. + format: float + minimum: 0 + type: number + x-default-description: 'null' + ocpus: + description: | + The total number of OCPUs available to each node in the node pool. + See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. + format: float + minimum: 0 + type: number + type: object + NodeSourceDetails: + description: The details of the node's source. + discriminator: + propertyName: sourceType + properties: + sourceType: + description: | + The source type for the node. + Use `IMAGE` when specifying an OCID of an image. + enum: + - IMAGE + type: string + x-obmcs-top-level-enum: '#/definitions/NodeSourceType' + required: + - sourceType + type: object + NodePoolPrimaryVnicDetails: + description: Details for node's primary VNIC + properties: + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). + type: object + description: | + [Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels + for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) + (ZPR) policy to control access to ZPR-supported resources. + type: object + type: object + NodePoolSecondaryVnicDetails: + description: Details for secondary vnic attachments to Nodes + properties: + createVnicDetails: + $ref: '#/components/schemas/CreateVnicDetails' + displayName: + description: Display name for vnic attachment + maxLength: 255 + minLength: 1 + type: string + nicIndex: + description: Which physical network interface card (NIC) the VNIC will use + maximum: 31 + minimum: 0 + type: integer + required: + - createVnicDetails + type: object + CreateNodePoolNodeConfigDetails: + description: The size and placement configuration of nodes in the node pool. + properties: + computeClusterId: + description: The OCID of the Compute Cluster to be associated with the worker node instance. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + isPvEncryptionInTransitEnabled: + default: false + description: Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false. + type: boolean + kmsKeyId: + description: The OCID of the Key Management Service key assigned to the boot volume. + type: string + nodePoolPodNetworkOptionDetails: + $ref: '#/components/schemas/NodePoolPodNetworkOptionDetails' + nsgIds: + description: | + The OCIDs of the Network Security Group(s) to associate nodes for this node pool with. For more information about NSGs, see [NetworkSecurityGroup](#/en/iaas/20160918/NetworkSecurityGroup/). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + placementConfigs: + description: | + The placement configurations for the node pool. Provide one placement + configuration for each availability domain in which you intend to launch a node. + + To use the node pool with a regional subnet, provide a placement configuration for + each availability domain, and include the regional subnet in each placement + configuration. + items: + $ref: '#/components/schemas/NodePoolPlacementConfigDetails' + type: array + size: + description: | + The number of nodes that should be in the node pool. + format: int32 + type: integer + required: + - size + - placementConfigs + type: object + CreateNodeShapeConfigDetails: + description: The shape configuration of the nodes. + properties: + memoryInGBs: + description: | + The total amount of memory available to each node, in gigabytes. + format: float + minimum: 0 + type: number + x-default-description: 'null' + ocpus: + description: | + The total number of OCPUs available to each node in the node pool. + See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. + format: float + minimum: 0 + type: number + type: object + Node: + description: The properties that define a node. + properties: + availabilityDomain: + description: The name of the availability domain in which this node is placed. + example: Rubf:PHX-AD-1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + example: + Operations: + CostCenter: 42 + type: object + faultDomain: + description: The fault domain of this node. + example: FAULT-DOMAIN-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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + id: + description: The OCID of the compute instance backing this node. + example: ocid1.instance.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgyswgycdoy3tcmtctmyw + type: string + kubernetesVersion: + description: The version of Kubernetes this node is running. + example: v1.9.4 + type: string + lifecycleDetails: + description: Details about the state of the node. + example: waiting for SSH + type: string + lifecycleState: + description: The state of the node. For more information, see [Monitoring Clusters](/Content/ContEng/Tasks/contengmonitoringclusters.htm) + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + - DELETED + - FAILING + - INACTIVE + example: UPDATING + type: string + name: + description: The name of the node. + example: My Kubernetes Node + type: string + nodeError: + $ref: '#/components/schemas/NodeError' + nodePoolId: + description: The OCID of the node pool to which this node belongs. + example: ocid1.nodepool.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq + type: string + privateIp: + description: The private IP address of this node. + example: 10.0.1.1 + type: string + publicIp: + description: The public IP address of this node. + example: 129.1.2.3 + type: string + subnetId: + description: The OCID of the subnet in which this node is placed. + example: ocid1.subnet.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3ofzxtlyit + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + type: object + UpdateNodePoolNodeConfigDetails: + description: The size and placement configuration of nodes in the node pool. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + isPvEncryptionInTransitEnabled: + default: false + description: Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false. + type: boolean + kmsKeyId: + description: The OCID of the Key Management Service key assigned to the boot volume. + type: string + nodePoolPodNetworkOptionDetails: + $ref: '#/components/schemas/NodePoolPodNetworkOptionDetails' + nsgIds: + description: | + The OCIDs of the Network Security Group(s) to associate nodes for this node pool with. For more information about NSGs, see [NetworkSecurityGroup](#/en/iaas/20160918/NetworkSecurityGroup/). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + placementConfigs: + description: | + The placement configurations for the node pool. Provide one placement + configuration for each availability domain in which you intend to launch a node. + + To use the node pool with a regional subnet, provide a placement configuration for + each availability domain, and include the regional subnet in each placement + configuration. + items: + $ref: '#/components/schemas/NodePoolPlacementConfigDetails' + type: array + size: + description: | + The number of nodes in the node pool. + format: int32 + type: integer + type: object + UpdateNodeShapeConfigDetails: + description: The shape configuration of the nodes. + properties: + memoryInGBs: + description: | + The total amount of memory available to each node, in gigabytes. + format: float + minimum: 0 + type: number + x-default-description: 'null' + ocpus: + description: | + The total number of OCPUs available to each node in the node pool. + See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. + format: float + minimum: 0 + type: number + type: object + ShapeMemoryOptions: + description: Memory properties. + properties: + defaultPerOcpuInGBs: + description: The default amount of memory per OCPU available for this shape, in gigabytes. + format: float + minimum: 0 + type: number + maxInGBs: + description: The maximum amount of memory, in gigabytes. + format: float + minimum: 0 + type: number + maxPerOcpuInGBs: + description: The maximum amount of memory per OCPU available for this shape, in gigabytes. + format: float + minimum: 0 + type: number + minInGBs: + description: The minimum amount of memory, in gigabytes. + format: float + minimum: 0 + type: number + minPerOcpuInGBs: + description: The minimum amount of memory per OCPU available for this shape, in gigabytes. + format: float + minimum: 0 + type: number + type: object + ShapeNetworkBandwidthOptions: + description: Properties of network bandwidth. + properties: + defaultPerOcpuInGbps: + description: The default amount of networking bandwidth per OCPU, in gigabits per second. + format: float + minimum: 0 + type: number + maxInGbps: + description: The maximum amount of networking bandwidth, in gigabits per second. + format: float + minimum: 0 + type: number + minInGbps: + description: The minimum amount of networking bandwidth, in gigabits per second. + format: float + minimum: 0 + type: number + type: object + ShapeOcpuOptions: + description: Properties of OCPUs. + properties: + max: + description: The maximum number of OCPUs. + format: float + minimum: 0 + type: number + min: + description: The minimum number of OCPUs. + format: float + minimum: 0 + type: number + type: object + InitialVirtualNodeLabel: + description: The properties that define a key value pair. + properties: + key: + description: The key of the pair. + example: mykey + type: string + value: + description: The value of the pair. + example: myvalue + type: string + type: object + PlacementConfiguration: + description: The information of virtual node placement in the virtual node pool. + properties: + availabilityDomain: + description: | + The availability domain in which to place virtual nodes. + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + faultDomain: + description: The fault domain of this virtual node. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + subnetId: + description: The OCID of the subnet in which to place virtual nodes. + maxLength: 255 + minLength: 1 + type: string + required: + - availabilityDomain + - subnetId + type: object + PodConfiguration: + description: The pod configuration for pods run on virtual nodes of this virtual node pool. + properties: + nsgIds: + description: List of network security group IDs applied to the Pod VNIC. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + shape: + description: Shape of the pods. + type: string + subnetId: + description: The regional subnet where pods' VNIC will be placed. + maxLength: 255 + minLength: 1 + type: string + required: + - subnetId + - shape + type: object + Taint: + description: taints + properties: + effect: + description: The effect of the pair. + example: myeffect + type: string + key: + description: The key of the pair. + example: mykey + type: string + value: + description: The value of the pair. + example: myvalue + type: string + type: object + VirtualNodePoolCyclingDetails: + description: Virtual Node Pool Cycling Details + properties: + isVirtualNodeCyclingEnabled: + default: false + description: If virtual nodes in the virtual nodepool will be cycled to have new changes. + type: boolean + maximumSurge: + default: '1' + description: | + Maximum additional new virtual nodes that would be temporarily created and added to virtual nodepool during the cycling virtual nodepool process. + OKE supports both integer and percentage input. + Defaults to 1, Ranges from 0 to Virtual Nodepool size or 0% to 100% + example: 10% + maxLength: 4 + minLength: 1 + type: string + maximumUnavailable: + default: '0' + description: | + Maximum active virtual nodes that would be terminated from virtual nodepool during the cycling virtual nodepool process. + OKE supports both integer and percentage input. + Defaults to 0, Ranges from 0 to Virtual Nodepool size or 0% to 100% + example: '2' + maxLength: 4 + minLength: 1 + type: string + type: object + VirtualNodeTags: + description: The tags associated to the virtual nodes in this virtual node pool. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + type: object + WorkRequestResource: + description: The properties that define a work request resource. + properties: + actionType: + description: The way in which this resource was affected by the work tracked by the work request. + enum: + - CREATED + - UPDATED + - DELETED + - RELATED + - IN_PROGRESS + - FAILED + - CANCELED_CREATE + - CANCELED_UPDATE + - CANCELED_DELETE + example: CREATED + type: string + entityType: + description: The resource type the work request affects. + example: cluster + type: string + entityUri: + description: The URI path on which the user can issue a GET request to access the resource metadata. + example: /20180401/clusters/ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw + type: string + identifier: + description: The OCID of the resource the work request affects. + example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw + type: string + type: object + AddonVersionConfiguration: + description: Addon version configuration details. + properties: + description: + description: Information about the addon version configuration. + example: Addon version configuration information + type: string + displayName: + description: Display name of addon version. + example: LabelName + type: string + isRequired: + description: If the the configuration is required or not. + example: true + type: boolean + key: + description: Addon configuration key + example: labels + type: string + value: + description: Addon configuration value + example: value + type: string + type: object + KubernetesVersionsFilters: + description: The range of kubernetes versions an addon can be configured. + properties: + exactKubernetesVersions: + description: | + The exact version of kubernetes that are compatible. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + uniqueItems: true + maximumVersion: + description: The latest kubernetes version. + example: 1.23.0 + type: string + minimalVersion: + description: The earliest kubernetes version. + example: 1.11.0 + type: string + type: object + KeyDetails: + description: The properties that define the kms keys used by OKE for Image Signature verification. + properties: + kmsKeyId: + description: | + The OCIDs of the KMS key that will be used to verify whether the images are signed by an approved source. + maxLength: 255 + minLength: 1 + type: string + type: object + AddOnOptions: + description: The properties that define options for supported add-ons. + properties: + isKubernetesDashboardEnabled: + description: Whether or not to enable the Kubernetes Dashboard add-on. + example: true + type: boolean + isTillerEnabled: + description: Whether or not to enable the Tiller add-on. + example: true + type: boolean + type: object + AdmissionControllerOptions: + description: The properties that define supported admission controllers. + properties: + isPodSecurityPolicyEnabled: + default: false + description: Whether or not to enable the Pod Security Policy admission controller. + example: false + type: boolean + type: object + KubernetesNetworkConfig: + description: The properties that define the network configuration for Kubernetes. + properties: + podsCidr: + default: 10.244.0.0/16 + description: The CIDR block for Kubernetes pods. Optional, defaults to 10.244.0.0/16. + example: 10.244.0.0/16 + type: string + servicesCidr: + default: 10.96.0.0/16 + description: The CIDR block for Kubernetes services. Optional, defaults to 10.96.0.0/16. + example: 10.96.0.0/16 + type: string + type: object + OpenIdConnectDiscovery: + description: | + The property that define the status of the OIDC Discovery feature for a cluster. + properties: + isOpenIdConnectDiscoveryEnabled: + default: false + description: | + Whether the cluster has OIDC Discovery enabled. Defaults to false. If set to true, the cluster will be assigned a public OIDC Discovery endpoint. + type: boolean + type: object + OpenIdConnectTokenAuthenticationConfig: + description: | + The properties that configure OIDC token authentication in kube-apiserver. + For more information, see [Configuring the API Server](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#using-flags). + properties: + caCertificate: + description: | + A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate. + minLength: 0 + type: string + clientId: + description: | + A client id that all tokens must be issued for. + example: kubernetes + maxLength: 100 + minLength: 0 + type: string + configurationFile: + description: | + A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info [here](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#using-authentication-configuration) + minLength: 0 + type: string + groupsClaim: + description: | + JWT claim to use as the user's group. If the claim is present it must be an array of strings. + example: groups + maxLength: 100 + minLength: 0 + type: string + groupsPrefix: + description: | + Prefix prepended to group claims to prevent clashes with existing names (such as system:groups). + example: 'oidc:' + maxLength: 100 + minLength: 0 + type: string + isOpenIdConnectAuthEnabled: + default: false + description: | + Whether the cluster has OIDC Auth Config enabled. Defaults to false. + type: boolean + issuerUrl: + description: | + URL of the provider that allows the API server to discover public signing keys. + Only URLs that use the https:// scheme are accepted. This is typically the provider's discovery URL, + changed to have an empty path. + example: https://idp.com + maxLength: 2048 + minLength: 0 + type: string + requiredClaims: + description: | + A key=value pair that describes a required claim in the ID Token. If set, the claim is verified to be present + in the ID Token with a matching value. Repeat this flag to specify multiple claims. + example: '["claim1=value1"]' + items: + $ref: '#/components/schemas/KeyValue' + maxLength: 50 + minLength: 0 + type: array + signingAlgorithms: + description: | + The signing algorithms accepted. Default is ["RS256"]. + items: + example: '["RS256"]' + maxLength: 100 + minLength: 1 + type: string + maxLength: 10 + minLength: 1 + type: array + usernameClaim: + description: | + JWT claim to use as the user name. By default sub, which is expected to be a unique identifier of the end + user. Admins can choose other claims, such as email or name, depending on their provider. However, claims + other than email will be prefixed with the issuer URL to prevent naming clashes with other plugins. + example: sub + maxLength: 100 + type: string + usernamePrefix: + description: | + Prefix prepended to username claims to prevent clashes with existing names (such as system:users). + For example, the value oidc: will create usernames like oidc:jane.doe. If this flag isn't provided and + --oidc-username-claim is a value other than email the prefix defaults to ( Issuer URL )# where + ( Issuer URL ) is the value of --oidc-issuer-url. The value - can be used to disable all prefixing. + example: 'oidc:' + maxLength: 100 + minLength: 0 + type: string + required: + - isOpenIdConnectAuthEnabled + type: object + PersistentVolumeConfigDetails: + description: Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC) + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + type: object + ServiceLbConfigDetails: + description: Configuration to be applied to load balancers created by Kubernetes services + properties: + backendNsgIds: + description: | + A list of the OCIDs of the network security groups (NSGs) associated to backends to LBs (pods/nodes/virtual pods, etc.). Rules necessary for LB to backend communication would be added when rule management mode is set to NSG via annotations. see [NetworkSecurityGroup](#/en/iaas/20160918/NetworkSecurityGroup/). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + type: object + NodePoolPodNetworkOptionDetails: + description: The CNI type and relevant network details for the pods of a given node pool + discriminator: + propertyName: cniType + properties: + cniType: + description: The CNI plugin used by this node pool + enum: + - OCI_VCN_IP_NATIVE + - FLANNEL_OVERLAY + maxLength: 255 + minLength: 1 + type: string + required: + - cniType + type: object + NodePoolPlacementConfigDetails: + description: The location where a node pool will place nodes. + properties: + availabilityDomain: + description: | + The availability domain in which to place nodes. + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + capacityReservationId: + description: The OCID of the compute capacity reservation in which to place the compute instance. + maxLength: 255 + minLength: 0 + type: string + faultDomains: + description: | + A list of fault domains in which to place nodes. + items: + maxLength: 255 + minLength: 0 + type: string + maxItems: 3 + type: array + uniqueItems: true + hostGroupId: + description: The OCID of the Host Group to be associated with the worker node instance. + maxLength: 255 + minLength: 0 + type: string + preemptibleNodeConfig: + $ref: '#/components/schemas/PreemptibleNodeConfigDetails' + subnetId: + description: The OCID of the subnet in which to place nodes. + maxLength: 255 + minLength: 1 + type: string + required: + - availabilityDomain + - subnetId + type: object + CycleMode: + description: | + BOOT_VOLUME_REPLACE cycling swaps the boot volume on the same node, while INSTANCE_REPLACE cycling deletes and recreates a new node with the changes applied. + Only a subset of fields (kubernetesVersion, imageId, bootVolumeSizeInGBs, nodeMetadata, sshPublicKey) can be changed with BOOT_VOLUME_REPLACE cycling. + The cycling operation will attempt to bring all nodes in the NodePool in sync with the NodePool specification. If BOOT_VOLUME_REPLACE cycling mode is chosen, and the node needs changes to fields that can not be updated via a BOOT_VOLUME_REPLACE cycle, the cycle attempt for that node will fail. The operation has to be retried with cycle mode changed to INSTANCE_REPLACE in this case. + enum: + - BOOT_VOLUME_REPLACE + - INSTANCE_REPLACE + type: string + CreateVnicDetails: + description: The properties of the secondary vnics + properties: + applicationResources: + description: | + The application resource that corresponds to this secondary vnic. Used to map pods to this specific vnic for scheduling + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 1 + type: array + uniqueItems: true + assignIpv6Ip: + description: | + Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet + type: boolean + assignPublicIp: + description: | + Whether the VNIC should be assigned a public IP address + type: boolean + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + example: + Operations: + CostCenter: 42 + type: object + displayName: + description: Display name for secondary vnic + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + example: + Department: Finance + type: object + ipCount: + description: | + The number of ip addresses to attach to secondary vnic + minimum: 1 + type: integer + x-default-description: when unspecified, ipCount will default to 256 when an ipv6 single stack subnet is specified and default to 32 in all other cases + ipv6AddressIpv6SubnetCidrPairDetails: + description: | + A list of IPv6 prefixes from which the VNIC should be assigned an IPv6 address. You can provide only the prefix + and OCI selects an available address from the range. You can optionally choose to leave the prefix range empty + and instead provide the specific IPv6 address that should be used from within that range. + items: + $ref: '#/components/schemas/Ipv6AddressIpv6SubnetCidrPairDetails' + type: array + nsgIds: + description: | + A list of the OCIDs of the network security groups (NSGs) to add the VNIC to + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). + type: object + description: | + [Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels + for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) + (ZPR) policy to control access to ZPR-supported resources. + type: object + skipSourceDestCheck: + description: | + Whether the source/destination check is disabled on the VNIC + type: boolean + subnetId: + description: the ocid of the subnet to create the vnic in + maxLength: 255 + minLength: 1 + type: string + required: + - subnetId + type: object + NodeError: + description: The properties that define an upstream error while managing a node. + properties: + code: + description: A short error code that defines the upstream error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm). + example: LimitExceeded + type: string + message: + description: A human-readable error string of the upstream error. + example: error validating payload + type: string + opc-request-id: + description: Unique Oracle-assigned identifier for the upstream request. If you need to contact Oracle about a particular upstream request, please provide the request ID. + example: BDA258F920471CFA70CF3655A836EAC3/AC26D111CE04292D5398192DCACCD85F/D74FF67547281CFA70CF3655A60B6DF5 + type: string + status: + description: The status of the HTTP response encountered in the upstream error. + example: '429' + type: string + required: + - code + - message + type: object + PreemptibleNodeConfigDetails: + description: Configuration options for preemptible nodes. + properties: + preemptionAction: + $ref: '#/components/schemas/PreemptionAction' + required: + - preemptionAction + type: object + Ipv6AddressIpv6SubnetCidrPairDetails: + description: | + Used to specify from which subnet prefixes an IPv6 address should be allocated, or to assign valid available IPv6 addresses + properties: + ipv6Address: + description: | + An IPv6 address of your choice. Must be an available IPv6 address within the subnet's prefix + maxLength: 45 + minLength: 1 + type: string + ipv6SubnetCidr: + description: | + The IPv6 prefix allocated to the subnet + maxLength: 45 + minLength: 1 + type: string + type: object + PreemptionAction: + description: The action to run when the preemptible node is interrupted for eviction. + discriminator: + propertyName: type + properties: + type: + description: The type of action to run when the instance is interrupted for eviction. + enum: + - TERMINATE + type: string + required: + - type + type: object + ListAddonOptionsResponse: + type: object + properties: + addon_options: + type: array + items: + $ref: '#/components/schemas/AddonOptionSummary' + ListClustersResponse: + type: object + properties: + clusters: + type: array + items: + $ref: '#/components/schemas/ClusterSummary' + ListAddonsResponse: + type: object + properties: + addons: + type: array + items: + $ref: '#/components/schemas/AddonSummary' + ListWorkloadMappingsResponse: + type: object + properties: + workload_mappings: + type: array + items: + $ref: '#/components/schemas/WorkloadMappingSummary' + ListNodePoolsResponse: + type: object + properties: + node_pools: + type: array + items: + $ref: '#/components/schemas/NodePoolSummary' + ListPodShapesResponse: + type: object + properties: + pod_shapes: + type: array + items: + $ref: '#/components/schemas/PodShapeSummary' + ListVirtualNodePoolsResponse: + type: object + properties: + virtual_node_pools: + type: array + items: + $ref: '#/components/schemas/VirtualNodePoolSummary' + ListVirtualNodesResponse: + type: object + properties: + virtual_nodes: + type: array + items: + $ref: '#/components/schemas/VirtualNodeSummary' + ListWorkRequestsResponse: + type: object + properties: + work_requests: + type: array + items: + $ref: '#/components/schemas/WorkRequestSummary' + ListWorkRequestErrorsResponse: + type: object + properties: + work_request_errors: + type: array + items: + $ref: '#/components/schemas/WorkRequestError' + ListWorkRequestLogsResponse: + type: object + properties: + work_request_logs: + type: array + items: + $ref: '#/components/schemas/WorkRequestLogEntry' + responses: + NotAuthenticated: + description: Unauthorized + 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' + NotAuthorizedOrNotFound: + description: Not Found + 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' + TooManyRequests: + description: Too Many Requests + 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' + InternalServerError: + description: Internal Server 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' + DefaultError: + description: An error has occurred. + 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' + Accepted: + description: Accepted + 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 of the work request handling the operation. + schema: + type: string + BadRequest: + description: Bad Request + 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' + IncorrectState: + description: Conflict + 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' + NoEtagMatch: + description: Precondition Failed + 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' + parameters: + KubernetesVersionQueryParam: + description: The kubernetes version to fetch the addons. + in: query + name: kubernetesVersion + required: true + schema: + type: string + AddonNameQueryParam: + description: The name of the addon. + in: query + name: addonName + required: false + schema: + type: string + RequestIdHeader: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact + Oracle about a particular request, please provide the request ID. + in: header + name: opc-request-id + schema: + type: string + PaginationLimitQueryParam: + description: | + For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. + 1 is the minimum, 1000 is the maximum. For important details about how pagination works, + see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + in: query + name: limit + schema: + type: integer + minimum: 1 + maximum: 1000 + default: 100 + PaginationTokenQueryParam: + description: | + For list pagination. The value of the `opc-next-page` response header from the previous "List" call. + For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + in: query + name: page + schema: + type: string + SortOrderQueryParam: + description: The optional order in which to sort the results. + in: query + name: sortOrder + required: false + x-default-description: | + The default value depends upon `sortBy`, and + in general is 'DESC' when sorting by time and 'ASC' otherwise. + x-obmcs-top-level-enum: '#/definitions/SortOrder' + schema: + type: string + enum: + - ASC + - DESC + ClusterOptionIdPathParam: + description: The id of the option set to retrieve. Use "all" get all options, or use a cluster ID to get options specific to the provided cluster. + in: path + name: clusterOptionId + required: true + schema: + type: string + CompartmentIdOptionalQueryParam: + description: The OCID of the compartment. + in: query + name: compartmentId + required: false + x-default-description: 'null' + schema: + type: string + ShouldListAllPatchVersionsQueryParam: + description: Option to show all kubernetes patch versions + in: query + name: shouldListAllPatchVersions + required: false + schema: + type: boolean + default: true + CompartmentIdQueryParam: + description: The OCID of the compartment. + in: query + name: compartmentId + required: true + schema: + type: string + ClusterLifecycleStateFilterQueryParam: + description: A cluster lifecycle state to filter on. Can have multiple parameters of this name. For more information, see [Monitoring Clusters](/Content/ContEng/Tasks/contengmonitoringclusters.htm) + in: query + name: lifecycleState + required: false + explode: true + schema: + type: array + items: + enum: + - CREATING + - ACTIVE + - FAILED + - DELETING + - DELETED + - UPDATING + type: string + x-obmcs-top-level-enum: '#/definitions/ClusterLifecycleState' + NameFilterQueryParam: + description: The name to filter on. + in: query + name: name + schema: + type: string + IdempotencyTokenHeader: + description: | + A token you supply to uniquely identify the request and provide idempotency if + the request is retried. Idempotency tokens expire after 24 hours. + in: header + name: opc-retry-token + schema: + type: string + minLength: 1 + maxLength: 64 + ClusterIdPathParam: + description: The OCID of the cluster. + in: path + name: clusterId + required: true + schema: + type: string + 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 + schema: + type: string + IsOpenIdConnectAuthConfigFileIncludedQueryParam: + description: | + Boolean value to determine if the OpenIdConnectAuth configuration file should be displayed for the provided cluster. + in: query + name: shouldIncludeOidcConfigFile + required: false + x-default-description: 'null' + schema: + type: boolean + AddonNamePathParam: + description: The name of the addon. + in: path + name: addonName + required: true + schema: + type: string + IsRemoveExistingAddOnQueryParam: + description: Whether existing addon resources should be deleted or not. True would remove the underlying resources completely. + in: query + name: isRemoveExistingAddOn + required: true + schema: + type: boolean + NodeIdPathParam: + description: The OCID of the compute instance. + in: path + name: nodeId + required: true + schema: + type: string + WorkloadMappingIdPathParam: + description: The OCID of the workloadMapping. + in: path + name: workloadMappingId + required: true + schema: + type: string + NodePoolOptionIdPathParam: + description: The id of the option set to retrieve. Use "all" get all options, or use a cluster ID to get options specific to the provided cluster. + in: path + name: nodePoolOptionId + required: true + schema: + type: string + NodePoolOsTypeQueryParam: + description: Filter node pool options by OS type. + in: query + name: nodePoolOsType + required: false + x-default-description: options for all OS type + schema: + type: string + enum: + - OL7 + - OL8 + - UBUNTU + NodePoolOsArchQueryParam: + description: Filter node pool options by OS architecture. + in: query + name: nodePoolOsArch + required: false + x-default-description: options for all OS architectures + schema: + type: string + enum: + - X86_64 + - AARCH64 + NodePoolK8sVersionQueryParam: + description: Filter node pool options by Kubernetes version. + in: query + name: nodePoolK8sVersion + required: false + x-default-description: options for all K8s versions + schema: + type: string + ClusterIdQueryParam: + description: The OCID of the cluster. + in: query + name: clusterId + schema: + type: string + NodePoolLifecycleStateFilterQueryParam: + description: A list of nodepool lifecycle states on which to filter on, matching any of the list items (OR logic). eg. [ACTIVE, DELETING]. For more information, see [Monitoring Clusters](/Content/ContEng/Tasks/contengmonitoringclusters.htm) + in: query + name: lifecycleState + required: false + explode: true + schema: + type: array + items: + enum: + - DELETED + - CREATING + - ACTIVE + - UPDATING + - DELETING + - FAILED + - INACTIVE + - NEEDS_ATTENTION + type: string + x-obmcs-top-level-enum: '#/definitions/NodePoolLifecycleState' + NodePoolIdPathParam: + description: The OCID of the node pool. + in: path + name: nodePoolId + required: true + schema: + type: string + OverrideEvictionGraceDurationQueryParam: + description: | + Duration after which OKE will give up eviction of the pods on the node. + PT0M will indicate you want to delete the node without cordon and drain. Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M + in: query + name: overrideEvictionGraceDuration + required: false + x-default-description: PT60M + schema: + type: string + format: x-obmcs-duration + IsForceDeletionAfterOverrideGraceDurationQueryParam: + description: If the underlying compute instance should be deleted if you cannot evict all the pods in grace period + in: query + name: isForceDeletionAfterOverrideGraceDuration + required: false + x-default-description: 'null' + schema: + type: boolean + IsDecrementSizeQueryParam: + description: If the nodepool should be scaled down after the node is deleted. + in: query + name: isDecrementSize + required: false + schema: + type: boolean + default: true + AvailabilityDomainQueryParam: + description: The availability domain of the pod shape. + in: query + name: availabilityDomain + required: false + schema: + type: string + VnpPaginationLimitQueryParam: + description: | + For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. + 1 is the minimum, 1000 is the maximum. For important details about how pagination works, + see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + in: query + name: limit + schema: + type: integer + minimum: 1 + maximum: 1000 + default: 100 + VnpSortOrderQueryParam: + description: The optional order in which to sort the results. + in: query + name: sortOrder + required: false + x-obmcs-top-level-enum: '#/definitions/SortOrder' + schema: + type: string + enum: + - ASC + - DESC + default: ASC + SortByQueryParam: + description: The optional field to sort the results by. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - ID + - NAME + - TIME_CREATED + default: NAME + VirtualNodePoolLifecycleStateFilterQueryParam: + description: A virtual node pool lifecycle state to filter on. Can have multiple parameters of this name. + in: query + name: lifecycleState + required: false + explode: true + schema: + type: array + items: + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + - DELETED + - FAILED + - NEEDS_ATTENTION + type: string + x-obmcs-top-level-enum: '#/definitions/VirtualNodePoolLifecycleState' + VirtualNodePoolIdPathParam: + description: The OCID of the virtual node pool. + in: path + name: virtualNodePoolId + required: true + schema: + type: string + OverrideEvictionGraceDurationVnpQueryParam: + description: | + Duration after which SKE will give up eviction of the pods on the node. + PT0M will indicate you want to delete the virtual node without cordon and drain. Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M + in: query + name: overrideEvictionGraceDurationVnp + required: false + x-default-description: PT60M + schema: + type: string + format: x-obmcs-duration + IsForceDeletionAfterOverrideGraceDurationVnpQueryParam: + description: If the underlying virtual node should be force deleted if all the pods are not evicted in the evictionGraceDuration. + in: query + name: isForceDeletionAfterOverrideGraceDurationVnp + required: false + x-default-description: 'null' + schema: + type: boolean + VirtualNodeIdPathParam: + description: The OCID of the virtual node. + in: path + name: virtualNodeId + required: true + schema: + type: string + ResourceIdQueryParam: + description: The OCID of the resource associated with a work request + in: query + name: resourceId + schema: + type: string + ResourceTypeQueryParam: + description: Type of the resource associated with a work request + in: query + name: resourceType + schema: + type: string + enum: + - CLUSTER + - NODEPOOL + WorkRequestStatusFilterQueryParam: + description: A work request status to filter on. Can have multiple parameters of this name. + in: query + name: status + required: false + explode: true + schema: + type: array + items: + type: string + WorkRequestIdPathParam: + description: The OCID of the work request. + in: path + name: workRequestId + required: true + schema: + type: string + x-stackQL-resources: + addon_options: + id: oci.container_engine.addon_options + name: addon_options + title: Addon Options + methods: + list: + operation: + $ref: '#/paths/~1addonOptions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.addon_options + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAddonOptionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"addon_options\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/addon_options/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + cluster_options: + id: oci.container_engine.cluster_options + name: cluster_options + title: Cluster Options + methods: + get: + operation: + $ref: '#/paths/~1clusterOptions~1{clusterOptionId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cluster_options/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + clusters: + id: oci.container_engine.clusters + name: clusters + title: Clusters + methods: + list: + operation: + $ref: '#/paths/~1clusters/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.clusters + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListClustersResponse' + transform: + body: |- + {{- $wrapped := printf "{\"clusters\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1clusters/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1clusters~1{clusterId}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1clusters~1{clusterId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1clusters~1{clusterId}/put' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + complete_credential_rotation: + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1actions~1completeCredentialRotation/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + extend_endpoint_decommission_rollback_deadline: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1actions~1extendEndpointDecommissionRollbackDeadline/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + cluster_migrate_to_native_vcn: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1actions~1migrateToNativeVcn/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + rollback_public_api_endpoint_decommission: + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1actions~1rollbackPublicApiEndpointDecommission/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + start_credential_rotation: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1actions~1startCredentialRotation/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + start_public_api_endpoint_decommission: + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1actions~1startPublicApiEndpointDecommission/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/clusters/methods/get' + - $ref: '#/components/x-stackQL-resources/clusters/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/clusters/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/clusters/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/clusters/methods/delete' + replace: [] + cluster_endpoint_configs: + id: oci.container_engine.cluster_endpoint_configs + name: cluster_endpoint_configs + title: Cluster Endpoint Configs + methods: + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1actions~1updateEndpointConfig/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/cluster_endpoint_configs/methods/update' + delete: [] + replace: [] + addons: + id: oci.container_engine.addons + name: addons + title: Addons + methods: + list: + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1addons/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.addons + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAddonsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"addons\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + install_addon: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1addons/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + disable_addon: + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1addons~1{addonName}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1addons~1{addonName}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1addons~1{addonName}/put' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/addons/methods/get' + - $ref: '#/components/x-stackQL-resources/addons/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/addons/methods/update' + delete: [] + replace: [] + credential_rotation_status: + id: oci.container_engine.credential_rotation_status + name: credential_rotation_status + title: Credential Rotation Status + methods: + get: + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1credentialRotationStatus/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/credential_rotation_status/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + kubeconfigs: + id: oci.container_engine.kubeconfigs + name: kubeconfigs + title: Kubeconfigs + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1kubeconfig~1content/post' + response: + mediaType: application/x-yaml + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/kubeconfigs/methods/create' + update: [] + delete: [] + replace: [] + cluster_migrate_to_native_vcn_status: + id: oci.container_engine.cluster_migrate_to_native_vcn_status + name: cluster_migrate_to_native_vcn_status + title: Cluster Migrate To Native Vcn Status + methods: + get: + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1migrateToNativeVcnStatus/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cluster_migrate_to_native_vcn_status/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + nodes: + id: oci.container_engine.nodes + name: nodes + title: Nodes + methods: + reboot_cluster_node: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1nodes~1{nodeId}~1actions~1reboot/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + replace_boot_volume_cluster_node: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1nodes~1{nodeId}~1actions~1replaceBootVolume/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1nodePools~1{nodePoolId}~1node~1{nodeId}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/nodes/methods/delete' + replace: [] + public_api_endpoint_decommission_status: + id: oci.container_engine.public_api_endpoint_decommission_status + name: public_api_endpoint_decommission_status + title: Public Api Endpoint Decommission Status + methods: + get: + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1publicApiEndpointDecommissionStatus/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/public_api_endpoint_decommission_status/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + workload_mappings: + id: oci.container_engine.workload_mappings + name: workload_mappings + title: Workload Mappings + methods: + list: + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1workloadMappings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.workload_mappings + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListWorkloadMappingsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"workload_mappings\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1workloadMappings/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1workloadMappings~1{workloadMappingId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1workloadMappings~1{workloadMappingId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1clusters~1{clusterId}~1workloadMappings~1{workloadMappingId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/workload_mappings/methods/get' + - $ref: '#/components/x-stackQL-resources/workload_mappings/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/workload_mappings/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/workload_mappings/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/workload_mappings/methods/delete' + replace: [] + node_pool_options: + id: oci.container_engine.node_pool_options + name: node_pool_options + title: Node Pool Options + methods: + get: + operation: + $ref: '#/paths/~1nodePoolOptions~1{nodePoolOptionId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/node_pool_options/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + node_pools: + id: oci.container_engine.node_pools + name: node_pools + title: Node Pools + methods: + list: + operation: + $ref: '#/paths/~1nodePools/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.node_pools + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListNodePoolsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"node_pools\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1nodePools/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1nodePools~1{nodePoolId}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1nodePools~1{nodePoolId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1nodePools~1{nodePoolId}/put' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/node_pools/methods/get' + - $ref: '#/components/x-stackQL-resources/node_pools/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/node_pools/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/node_pools/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/node_pools/methods/delete' + replace: [] + pod_shapes: + id: oci.container_engine.pod_shapes + name: pod_shapes + title: Pod Shapes + methods: + list: + operation: + $ref: '#/paths/~1podShapes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.pod_shapes + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListPodShapesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"pod_shapes\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pod_shapes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + virtual_node_pools: + id: oci.container_engine.virtual_node_pools + name: virtual_node_pools + title: Virtual Node Pools + methods: + list: + operation: + $ref: '#/paths/~1virtualNodePools/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.virtual_node_pools + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVirtualNodePoolsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"virtual_node_pools\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1virtualNodePools/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1virtualNodePools~1{virtualNodePoolId}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1virtualNodePools~1{virtualNodePoolId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1virtualNodePools~1{virtualNodePoolId}/put' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/virtual_node_pools/methods/get' + - $ref: '#/components/x-stackQL-resources/virtual_node_pools/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/virtual_node_pools/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/virtual_node_pools/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/virtual_node_pools/methods/delete' + replace: [] + virtual_nodes: + id: oci.container_engine.virtual_nodes + name: virtual_nodes + title: Virtual Nodes + methods: + list: + operation: + $ref: '#/paths/~1virtualNodePools~1{virtualNodePoolId}~1virtualNodes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.virtual_nodes + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVirtualNodesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"virtual_nodes\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1virtualNodePools~1{virtualNodePoolId}~1virtualNodes~1{virtualNodeId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/virtual_nodes/methods/get' + - $ref: '#/components/x-stackQL-resources/virtual_nodes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + work_requests: + id: oci.container_engine.work_requests + name: work_requests + title: Work Requests + methods: + list: + operation: + $ref: '#/paths/~1workRequests/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.work_requests + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListWorkRequestsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"work_requests\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1workRequests~1{workRequestId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1workRequests~1{workRequestId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/work_requests/methods/get' + - $ref: '#/components/x-stackQL-resources/work_requests/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/work_requests/methods/delete' + replace: [] + work_request_errors: + id: oci.container_engine.work_request_errors + name: work_request_errors + title: Work Request Errors + methods: + list: + operation: + $ref: '#/paths/~1workRequests~1{workRequestId}~1errors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.work_request_errors + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListWorkRequestErrorsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"work_request_errors\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/work_request_errors/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + work_request_logs: + id: oci.container_engine.work_request_logs + name: work_request_logs + title: Work Request Logs + methods: + list: + operation: + $ref: '#/paths/~1workRequests~1{workRequestId}~1logs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.work_request_logs + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListWorkRequestLogsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"work_request_logs\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/work_request_logs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://containerengine.{region}.oci.oraclecloud.com/20180222 + variables: + region: + default: us-ashburn-1 + description: OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. + x-stackQL-envVar: OCI_REGION +x-stackQL-config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: opc-next-page + location: header diff --git a/providers/src/oci/v00.00.00000/services/database.yaml b/providers/src/oci/v00.00.00000/services/database.yaml new file mode 100644 index 00000000..6ea71eb5 --- /dev/null +++ b/providers/src/oci/v00.00.00000/services/database.yaml @@ -0,0 +1,72326 @@ +openapi: 3.0.0 +info: + title: database API + description: oci database API + version: '20160918' +paths: + /applicationVip: + get: + description: | + Gets a list of application virtual IP (VIP) addresses on a cloud VM cluster. + operationId: ListApplicationVips + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/CloudVmClusterIdQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListApplicationVipsSortByQueryParam' + - $ref: '#/components/parameters/ListApplicationVipsFilterByLifecycleStateQueryParam' + responses: + '200': + description: The list of application virtual IP (VIP) addresses on the specified cloud VM cluster. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListApplicationVipsResponse' + application-json: + examples: + response: + value: | + [{ + "cloudVmClusterId" : "ocid1.cloudvmcluster.oc1.phx.", + "ipAddress" : "0.0.0.0", + "id" : "ocid1.applicationvip.oc1.phx.", + "hostnameLabel" : "host123456", + "lifecycleState" : "ACTIVE", + "subnetId" : "ocid1.subnet.oc1.phx.", + "timeAssigned" : "2021-12-14T01:59:07.030Z" + }] + '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/DefaultError' + summary: Gets a list of application virtual IP (VIP) addresses on a cloud VM cluster. + tags: + - database + x-example: | + GET /20160918/applicationVip?limit=100 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + post: + description: | + Creates a new application virtual IP (VIP) address in the specified cloud VM cluster based on the request parameters you provide. + operationId: CreateApplicationVip + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateApplicationVipDetails' + description: Request to create a new application virtual IP (VIP) address. + required: true + responses: + '200': + description: The request was successfully received and an application virtual IP (VIP) address is being created. + 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/ApplicationVip' + application-json: + examples: + response: + value: | + { + "cloudVmClusterId" : "ocid1.cloudvmcluster.oc1.phx.", + "ipAddress" : "0.0.0.0", + "id" : "ocid1.applicationvip.oc1.phx.", + "hostnameLabel" : "host123456", + "lifecycleState" : "ACTIVE", + "subnetId" : "ocid1.subnet.oc1.phx.", + "timeAssigned" : "2021-12-14T01:59:07.030Z" + } + '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/DefaultError' + summary: Creates a new application virtual IP (VIP) address. + tags: + - database + x-example: | + POST /20160918/applicationVip + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /applicationVip/{applicationVipId}: + delete: + description: | + Deletes and deregisters the specified application virtual IP (VIP) address. + operationId: DeleteApplicationVip + parameters: + - $ref: '#/components/parameters/ApplicationVipIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '204': + description: The request to delete the specified application virtual IP (VIP) address was accepted. + 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 + '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/DefaultError' + summary: DeleteApplicationVip + tags: + - database + x-example: | + DELETE /20160918/applicationVip/<applicationVipId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ApplicationVip' + get: + description: Gets information about a specified application virtual IP (VIP) address. + operationId: GetApplicationVip + parameters: + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ApplicationVipIdPathParam' + responses: + '200': + description: The application virtual IP (VIP) address details. + 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/ApplicationVip' + application-json: + examples: + response: + value: | + { + "cloudVmClusterId" : "ocid1.cloudvmcluster.oc1.phx.", + "ipAddress" : "0.0.0.0", + "id" : "ocid1.applicationvip.oc1.phx.", + "hostnameLabel" : "host123456", + "lifecycleState" : "ACTIVE", + "lifecycleDetails" : null, + "subnetId" : "ocid1.subnet.oc1.phx.", + "timeAssigned" : "2021-12-14T01:59:07.030Z" + } + '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/DefaultError' + summary: GetApplicationVip + tags: + - database + x-example: | + GET /20160918/applicationVip/<applicationVipId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /autonomousContainerDatabaseBackups: + get: + description: | + Gets a list of Autonomous Container Database backups by using either the 'autonomousDatabaseId' or 'compartmentId' as your query parameter. + operationId: ListAutonomousContainerDatabaseBackups + parameters: + - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' + - $ref: '#/components/parameters/optionalAutonomousContainerDatabaseIdQueryParam' + - $ref: '#/components/parameters/OptionalIsRemoteQueryParam' + - $ref: '#/components/parameters/ListAutonomousContainerDatabaseBackupsFilterByInfrastructureTypeQueryParam' + - $ref: '#/components/parameters/listAutonomousContainerDatabaseBackupsFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/listAutonomousContainerDatabaseBackupsSortByQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + responses: + '200': + description: A list of all of the Autonomous Container Database Backups in the specified compartment. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/AutonomousContainerDatabaseBackupCollection' + application-json: + examples: + response: + value: | + [{ + "compartmentId" : "ocid1.tenancy.oc1..", + "acdDisplayName" : "ACD1", + "displayName" : "Automatic_Backup", + "autonomousContainerDatabaseId" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "id" : "ocid1.autonomouscontainerdatabasebackup.oc1.phx.", + "type" : "FULL", + "lifecycleDetails" : null, + "lifecycleState" : "ACTIVE", + "timeStarted" : "2016-11-22T19:25:42.755Z" + }] + '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/DefaultError' + summary: ListAutonomousContainerDatabaseBackups + tags: + - database + x-example: | + GET /20160918/autonomousContainerDatabaseBackups?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousContainerDatabaseBackup' + /autonomousContainerDatabaseVersions: + get: + description: Gets a list of supported Autonomous Container Database versions. + operationId: ListAutonomousContainerDatabaseVersions + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ServiceComponentQueryParam' + responses: + '200': + description: Supported Autonomous Container Database versions for provisioning new databases. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListAutonomousContainerDatabaseVersionsResponse' + application-json: + examples: + response: + value: | + [ + { + "version" : "19.15.1.0.1", + "supportedApps" : + [ + { + "releaseDate": "2022-09-12 06:24:34 +00:00", + "endOfSupport": "2023-09-12 06:24:34 +00:00", + "supportedAppName" : "ADBD_GENERIC", + "isCertified": true + } + ] + }, + { + "version" : "19.16.1.0.1", + "supportedApps" : + [ + { + "releaseDate": "2022-09-23 06:24:34 +00:00", + "endOfSupport": "2023-09-23 06:24:34 +00:00", + "supportedAppName" : "ADBD_EBS", + "isCertified": true + }, + { + "releaseDate": "2022-08-02 06:24:34 +00:00", + "endOfSupport": "2023-08-02 06:24:34 +00:00", + "supportedAppName" : "ADBD_GENERIC", + "isCertified": true + } + ] + } + ] + '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/DefaultError' + summary: Gets a list of supported Autonomous Container Database versions. + tags: + - database + x-example: | + GET /20220914/autonomousContainerDatabaseVersions?compartmentId=<compartmentId>&serviceComponent=<serviceComponent>&limit=100 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-authz-declarations: + authorizationRequired: false + /autonomousContainerDatabases: + get: + description: | + Gets a list of the Autonomous Container Databases in the specified compartment. + operationId: ListAutonomousContainerDatabases + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/optionalAutonomousExadataInfrastructureIdQueryParam' + - $ref: '#/components/parameters/OptionalAutonomousVmClusterIdQueryParam' + - $ref: '#/components/parameters/ListAutonomousContainerDatabasesFilterByInfrastructureTypeQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/ListAutonomousContainerDatabasesSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListAutonomousContainerDatabasesFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByAvailabilityDomainQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/FilterByServiceLevelAgreementTypeQueryParam' + - $ref: '#/components/parameters/OptionalCloudAutonomousVmClusterIdQueryParam' + responses: + '200': + description: A list of all of the Autonomous Container Databases in the specified compartment. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/Content/API/Concepts/usingapi.htm#nine). + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you must contact Oracle about + a particular request, then provide the request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ListAutonomousContainerDatabasesResponse' + application-json: + examples: + response: + value: | + [{ + "compartmentId" : "ocid1.tenancy.oc1..", + "dbUniqueName" : "containerdatabases1", + "displayName" : "containerdatabases1", + "serviceLevelAgreementType" : "AUTONOMOUS_DATAGUARD", + "id" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "cloudAutonomousVmClusterId" : "ocid1.cloudautonomousvmcluster.oc1.", + "lifecycleDetails" : null, + "lifecycleState" : "AVAILABLE", + "timeCreated" : "2016-11-22T19:25:42.755Z", + "patchModel" : "RELEASE_UPDATES", + "backupConfig" : { + "recoveryWindowInDays" : 30 + } + }, { + "compartmentId" : "ocid1.tenancy.oc1..", + "dbUniqueName" : "containerdatabases2", + "displayName" : "containerdatabases2", + "serviceLevelAgreementType" : "STANDARD", + "id" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "cloudAutonomousVmClusterId" : "ocid1.cloudautonomousvmcluster.oc1.", + "lifecycleDetails" : null, + "lifecycleState" : "AVAILABLE", + "timeCreated" : "2016-11-22T19:49:54.146Z", + "patchModel" : "RELEASE_UPDATE_REVISIONS", + "backupConfig" : { + "recoveryWindowInDays" : 30 + } + }] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListAutonomousContainerDatabases + tags: + - database + x-example: | + GET /20160918/autonomousContainerDatabases?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousContainerDatabase' + post: + description: | + Creates an Autonomous Container Database in the specified Autonomous Exadata Infrastructure. + operationId: CreateAutonomousContainerDatabase + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAutonomousContainerDatabaseBase' + description: Request to create an Autonomous Container Database in a specified Autonomous Exadata Infrastructure or in Autonomous VM Cluster. + required: true + responses: + '200': + description: The request was successfully received and the creation of the Autonomous Container Database is in progress. + 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 must contact Oracle about + a particular request, then provide the request ID. + schema: + type: string + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousContainerDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "dbUniquename" : "containerdatabases1", + "displayName" : "containerdatabases1", + "serviceLevelAgreementType" : "AUTONOMOUS_DATAGUARD", + "id" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "cloudAutonomousVmClusterId" : "ocid1.cloudautonomousvmcluster.oc1.", + "lifecycleDetails" : null, + "lifecycleState" : "PROVISIONING", + "timeCreated" : "2016-11-22T19:25:42.755Z", + "patchModel" : "RELEASE_UPDATES", + "backupConfig" : { + "backupDestinationDetails" : [], + "recoveryWindowInDays" : 30 + } + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateAutonomousContainerDatabase + tags: + - database + x-example: | + Example I (ADB on Dedicated Infra): + POST /20160918/autonomousContainerDatabases + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "maintenanceWindowDetails":{ + "daysOfWeek":[ + { + "name":"SUNDAY" + }, + { + "name":"SATURDAY" + } + ], + "months":[ + { + "name":"FEBRUARY" + }, + { + "name":"MARCH" + }, + { + "name":"MAY" + }, + { + "name":"JULY" + }, + { + "name":"AUGUST" + }, + { + "name":"SEPTEMBER" + }, + { + "name":"OCTOBER" + }, + { + "name":"NOVEMBER" + } + ], + "preference":"CUSTOM_PREFERENCE", + "weeksOfMonth":[ + 1, + 2, + 3, + 4 + ], + "hoursOfDay":[ + 0, + 20 + ] + }, + "serviceLevelAgreementType":"AUTONOMOUS_DATAGUARD", + "compartmentId":"ocid1.tenancy.oc1..<unique_ID>", + "displayName":"containerDatabase2", + "patchModel":"RELEASE_UPDATES", + "backupConfig":{ + "recoveryWindowInDays":30 + }, + "cloudAutonomousVmClusterId":"ocid1.cloudautonomousvmcluster.oc1.<unique_ID>", + "peerAutonomousExadataInfrastructureId":"ocid1.autonomousexadatainfrastructure.oc1.<unique_ID>", + "protectionMode":"MAXIMUM_PERFORMANCE", + "peerAutonomousContainerDatabaseDisplayName":"StandbyContainerDatabase2", + "peerAutonomousContainerDatabaseCompartmentId": "ocid1.tenancy.oc1..<unique_ID>", + "standbyMaintenanceBufferInDays":7, + "versionPreference": "LATEST_RELEASE_UPDATE", + "definedTags":{ + }, + "freeformTags":{ + "Mytagname":"tagValue" + }, + "kmsKeyId":"ocid1.key.oc1.<unique_ID>", + "vaultId":"ocid1.vault.oc1.<unique_ID>", + "isFipsEnabled":true + } + Example II (ADB on Cloud at Customer): + POST /20160918/autonomousContainerDatabases + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "definedTags": {}, + "freeformTags": {}, + "maintenanceWindowDetails": { + "daysOfWeek": [ + { + "name": "SUNDAY" + } + ], + "months": [ + { + "name": "FEBRUARY" + }, + { + "name": "MAY" + }, + { + "name": "AUGUST" + }, + { + "name": "JANUARY" + } + ], + "preference": "CUSTOM_PREFERENCE", + "weeksOfMonth": [ + 2 + ], + "hoursOfDay": [ + 0 + ] + }, + "autonomousVmClusterId": "ocid1.autonomousvmcluster.oc1.phx.<unique_ID>", + "compartmentId": "ocid.compartment.oc1..<unique_ID>", + "displayName": "ACD-202107131033", + "backupConfig": { + "backupDestinationDetails": [ + { + "id": "ocid1.backupdestination.oc1.phx.", + "type": "RECOVERY_APPLIANCE", + "vpcUser": "vpcUserName", + "vpcPassword": "<password>", + "isZeroDataLossEnabled": true + } + ] + }, + "dbUniqueName": "containerDatabse1", + "patchModel" : "RELEASE_UPDATES", + "peerAutonomousContainerDatabaseCompartmentId": "ocid1.tenancy.oc1..<unique_ID>", + "peerAutonomousContainerDatabaseDisplayName": "Standby ACD-202107131033", + "peerAutonomousVmClusterId": "ocid1.autonomousvmcluster.oc1.phx.<unique_ID>", + "protectionMode": "MAXIMUM_PERFORMANCE", + "serviceLevelAgreementType": "AUTONOMOUS_DATAGUARD", + "peerAutonomousContainerDatabaseBackupConfig": { + "backupDestinationDetails": [ + { + "id": "", + "type": "OBJECT_STORE", + "internetProxy": "http://example.proxy.com:80" + } + ], + "recoveryWindowInDays": "7" + }, + "keyStoreId": "ocid1.dbkeystore.oc1.phx.<unique_ID>", + "standbyMaintenanceBufferInDays": 7, + "versionPreference": "LATEST_RELEASE_UPDATE" + } + /autonomousContainerDatabases/{autonomousContainerDatabaseId}: + delete: + description: Terminates an Autonomous Container Database, which permanently deletes the container database and any databases within the container database. The database data is local to the Autonomous Exadata Infrastructure and will be lost when the container database is terminated. Oracle recommends that you back up any data in the Autonomous Container Database prior to terminating it. + operationId: TerminateAutonomousContainerDatabase + parameters: + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The request to delete the Autonomous Container Database was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: TerminiateAutonomousContainerDatabase + tags: + - database + x-example: | + DELETE /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousContainerDatabase' + get: + description: Gets information about the specified Autonomous Container Database. + operationId: GetAutonomousContainerDatabase + parameters: + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + responses: + '200': + description: The Autonomous Container Database. + 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/AutonomousContainerDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "dbUniqueName" : "containerdatabases1", + "displayName" : "containerdatabases1", + "serviceLevelAgreementType" : "AUTONOMOUS_DATAGUARD", + "id" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "cloudAutonomousVmClusterId" : "ocid1.cloudautonomousvmcluster.oc1.", + "lifecycleDetails" : null, + "lifecycleState" : "AVAILABLE", + "timeCreated" : "2016-11-22T19:25:42.755Z", + "patchModel" : "RELEASE_UPDATES", + "backupConfig" : { + "backupDestinationDetails" : [], + "recoveryWindowInDays" : 30 + } + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetAutonomousContainerDatabase + tags: + - database + x-example: | + GET /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: Updates the properties of an Autonomous Container Database, such as display name, maintenance preference, backup retention, and tags. + operationId: UpdateAutonomousContainerDatabase + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAutonomousContainerDatabaseDetails' + description: Request to update the properties of an Autonomous Container Database. + required: true + responses: + '200': + description: The request was successfully received and the Autonomous Container Database update is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousContainerDatabase' + application-json: + examples: + response: + value: | + Response to example I: + { + "compartmentId" : "ocid1.tenancy.oc1..", + "dbUniqueName" : "containerdatabases1", + "displayName" : "containerdatabases1", + "serviceLevelAgreementType" : "AUTONOMOUS_DATAGUARD", + "id" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "cloudAutonomousVmClusterId" : "ocid1.cloudautonomousvmcluster.oc1.", + "lifecycleDetails" : null, + "lifecycleState" : "UPDATING", + "timeCreated" : "2016-11-22T19:25:42.755Z", + "patchModel" : "RELEASE_UPDATES", + "backupConfig" : { + "backupDestinationDetails" : [], + "recoveryWindowInDays" : 30 + } + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateAutonomousContainerDatabase + tags: + - database + x-example: | + PUT /latest/autonomousContainerDatabases/<autonomousContainerDatabaseId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName" : "new Display name" + } + /autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/addStandby: + post: + description: | + Add a standby Autonomous Container Database. For more information about Autonomous Data Guard,see + [Protect Critical Databases from Failures and Disasters Using Autonomous Data Guard](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbau/GUID-C57B9A6E-7471-4CDC-8F10-B8386538E31C). + operationId: AddStandbyAutonomousContainerDatabase + parameters: + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddStandbyAutonomousContainerDatabaseDetails' + description: Request to Add Standy Autonomous Container Database Dataguard. + required: true + responses: + '202': + description: The request was successfully received and add standby action is being performed. + 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 + opc-work-request-id: + description: Unique Oracle-assigned identifier of the work request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousContainerDatabase' + '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/DefaultError' + summary: AddStandbyAutonomousContainerDatabase + tags: + - database + x-example: | + POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/dataguard/action/addStandby + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "role" : "PRIMARY<unique_ID>" + } + x-obmcs-terraform: + actionType: MANAGEMENT_RESOURCE + x-related-resource: '#/definitions/AutonomousContainerDatabase' + /autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/changeCompartment: + post: + description: | + Move the Autonomous Container Database and its dependent resources to the specified compartment. + For more information about moving Autonomous Container Databases, see + [Moving Database Resources to a Different Compartment](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/raqyy/#articletitle.html). + operationId: ChangeAutonomousContainerDatabaseCompartment + parameters: + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeCompartmentDetails' + description: Request to move Autonomous Container Database to a different compartment + required: true + responses: + '202': + description: The request was successfully received and the change compartment action is being performed. + 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 + opc-work-request-id: + description: Unique Oracle-assigned identifier of the work 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeAutonomousContainerDatabaseCompartment + tags: + - database + x-example: | + POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/action/changeCompartment + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid.compartment.oc1..<unique_ID>" + } + x-related-resource: '#/definitions/AutonomousContainerDatabase' + /autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/changeDataguardRole: + post: + description: | + **Deprecated.** Use the [ConvertStandbyAutonomousContainerDatabase](#/en/database/latest/AutonomousContainerDatabase/ConvertStandbyAutonomousContainerDatabase) operation to switch the Autonomous Container Database (ACD) role between Standby and Snapshot Standby. + For more information about changing ACD Role, see + [Convert Physical Standby to Snapshot Standby](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-D3B503F1-0032-4B0D-9F00-ACAE8151AB80) and [Convert Snapshot Standby to Physical Standby](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-E8D7E0EE-8244-467D-B33A-1BC6F969A0A4). + operationId: ChangeDataguardRole + parameters: + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeDataguardRoleDetails' + description: Request to Change the Autonomous Container Database Dataguard role. + required: true + responses: + '202': + description: The request was successfully received and the dataguard role change action is being performed. + 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 + opc-work-request-id: + description: Unique Oracle-assigned identifier of the work request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousContainerDatabase' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeAutonomousContainerDatabaseDatagardRole + tags: + - database + x-example: | + POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/action/changeDataguardRole + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "role" : "SNAPSHOT_STANDBY<unique_ID>" + } + x-related-resource: '#/definitions/AutonomousContainerDatabase' + /autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/editDataguard: + post: + description: | + Modify Autonomous Container Database Data Guard settings such as protection mode, automatic failover, and fast start failover lag limit. For more information, see + [Update Autonomous Container Database Dataguard](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-3A936EC7-7A49-4FD2-9F39-8DB6B22011CE). + operationId: EditAutonomousContainerDatabaseDataguard + parameters: + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EditAutonomousContainerDatabaseDataguardDetails' + description: Request Edit Autonomous Container Database Dataguard. + required: true + responses: + '202': + description: The request was successfully received and convert standby action is being performed. + 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 + opc-work-request-id: + description: Unique Oracle-assigned identifier of the work request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousContainerDatabase' + '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/DefaultError' + summary: EditAutonomousContainerDatabaseDataguard + tags: + - database + x-example: | + POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/dataguard/actions/updateDataguard + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "role" : "PRIMARY<unique_ID>" + } + x-obmcs-terraform: + actionType: UPDATE_FIELD + x-related-resource: '#/definitions/AutonomousContainerDatabase' + /autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/failover: + post: + description: | + Performs failover to a standby Autonomous Container Database (ACD) identified by the autonomousContainerDatabaseId parameter. This standby ACD will become the new primary ACD when the failover completes successfully. For more information, see + [Fail Over to the Standby in an Autonomous Data Guard Configuration](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-C8FFA343-223C-4F41-9656-AEC356AD90A0). + operationId: FailoverAutonomousContainerDatabaseDataguard + parameters: + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '202': + description: The request was accepted for processing. + 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 must contact Oracle about + a particular request, then provide the request ID. + schema: + type: string + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousContainerDatabase' + application-json: + examples: + response: + value: | + Response to example I: + { + "compartmentId" : "ocid1.tenancy.oc1..", + "dbUniqueName" : "containerdatabases1", + "displayName" : "containerdatabases1", + "serviceLevelAgreementType" : "AUTONOMOUS_DATAGUARD", + "id" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "cloudAutonomousVmClusterId" : "ocid1.cloudautonomousvmcluster.oc1.", + "lifecycleDetails" : null, + "lifecycleState" : "UPDATING", + "timeCreated" : "2016-11-22T19:25:42.755Z", + "patchModel" : "RELEASE_UPDATES", + "backupConfig" : { + "backupDestinationDetails" : [], + "recoveryWindowInDays" : 30 + } + } + '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/DefaultError' + summary: Failover Autonomous Container Database of an Primary Autonomous Data Guard into a standby role. + tags: + - database + x-example: | + POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/actions/failover + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/AutonomousContainerDatabase' + /autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/reinstate: + post: + description: | + Reinstates a disabled standby Autonomous Container Database (ACD), identified by the autonomousContainerDatabaseId parameter to an active standby ACD. For more information, see + [Reinstate the Disabled Standby in an Autonomous Data Guard Configuration](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-B5C6A90D-72E3-4F32-988D-8AECC0A2D947). + operationId: ReinstateAutonomousContainerDatabaseDataguard + parameters: + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '202': + description: The request was accepted for processing. + 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 must contact Oracle about + a particular request, then provide the request ID. + schema: + type: string + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousContainerDatabase' + application-json: + examples: + response: + value: | + Response to example I: + { + "compartmentId" : "ocid1.tenancy.oc1..", + "dbUniqueName" : "containerdatabases1", + "displayName" : "containerdatabases1", + "serviceLevelAgreementType" : "AUTONOMOUS_DATAGUARD", + "id" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "cloudAutonomousVmClusterId" : "ocid1.cloudautonomousvmcluster.oc1.", + "lifecycleDetails" : null, + "lifecycleState" : "UPDATING", + "timeCreated" : "2016-11-22T19:25:42.755Z", + "patchModel" : "RELEASE_UPDATES", + "backupConfig" : { + "backupDestinationDetails" : [], + "recoveryWindowInDays" : 30 + } + } + '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/DefaultError' + summary: Reinstates the primary Autonomous Container Database of an Autonomous Data Guard Association into a standby role. + tags: + - database + x-example: | + POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/actions/reinstate + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/AutonomousContainerDatabase' + /autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/restart: + post: + description: | + Rolling restarts the specified Autonomous Container Database. + operationId: RestartAutonomousContainerDatabase + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RestartAutonomousContainerDatabaseDetails' + description: Request details to restart the Autonomous Container Database with force option. + responses: + '200': + description: The request was successfully received and the Autonomous Container Database will be restarted. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousContainerDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "dbUniqueName" : "containerdatabases1", + "displayName" : "containerdatabases1", + "serviceLevelAgreementType" : "STANDARD", + "id" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "autonomousExadataInfrastructureId" : "ocid1.autonomousexadatainfrastructure.oc1.", + "lifecycleDetails" : null, + "lifecycleState" : "RESTARTING", + "timeCreated" : "2016-11-22T19:25:42.755Z", + "patchModel" : "RELEASE_UPDATES", + "maintenanceWindow" : "ANY", + "backupConfig" : { + "backupDestinationDetails" : [], + "recoveryWindowInDays" : 30 + } + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Rolling restarts the specified Autonomous Container Database. + tags: + - database + x-example: | + POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/actions/restart + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousContainerDatabase' + /autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/rotateKey: + post: + description: Creates a new version of an existing [Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) key. + operationId: RotateAutonomousContainerDatabaseEncryptionKey + parameters: + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RotateAutonomousContainerDatabaseEncryptionKeyDetails' + description: Key details provided by the user for rotate key operation for Autonomous AI Database. + responses: + '202': + description: | + The request was successfully received and the key is being rotated. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousContainerDatabase' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Rotate Key + tags: + - database + x-example: | + POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/actions/rotateKey + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousContainerDatabase' + /autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/snapshotStandby: + post: + description: | + Convert the standby Autonomous Container Database (ACD) between physical standby and snapshot standby ACD. For more information about converting standby ACDs, see + [Convert Physical Standby to Snapshot Standby](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-D3B503F1-0032-4B0D-9F00-ACAE8151AB80) and [Convert Snapshot Standby to Physical Standby](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-E8D7E0EE-8244-467D-B33A-1BC6F969A0A4). + operationId: ConvertStandbyAutonomousContainerDatabase + parameters: + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConvertStandbyAutonomousContainerDatabaseDetails' + description: Request to Convert Standby Autonomous Container Database . + required: true + responses: + '202': + description: The request was successfully received and convert standby action is being performed. + 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 + opc-work-request-id: + description: Unique Oracle-assigned identifier of the work request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousContainerDatabase' + '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/DefaultError' + summary: ConvertStandbyAutonomousContainerDatabase + tags: + - database + x-example: | + POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/dataguard/actions/snapshotStandby + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "role" : "STANDBY<unique_ID>" + } + x-obmcs-terraform: + actionType: MANAGEMENT_RESOURCE + x-related-resource: '#/definitions/AutonomousContainerDatabase' + /autonomousContainerDatabases/{autonomousContainerDatabaseId}/actions/switchover: + post: + description: | + Switchover an Autonomous Container Database (ACD), identified by the autonomousContainerDatabaseId parameter, to an active standby ACD. This standby ACD will become the new primary ACD when the switchover completes successfully. For more information, see + [Switch Roles in an Autonomous Data Guard Configuration](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-A2AB31F6-D52D-493C-9BA7-D87A0F17078F). + operationId: SwitchoverAutonomousContainerDatabaseDataguard + parameters: + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '202': + description: The request was accepted for processing. + 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 must contact Oracle about + a particular request, then provide the request ID. + schema: + type: string + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousContainerDatabase' + application-json: + examples: + response: + value: | + Response to example I: + { + "compartmentId" : "ocid1.tenancy.oc1..", + "dbUniqueName" : "containerdatabases1", + "displayName" : "containerdatabases1", + "serviceLevelAgreementType" : "AUTONOMOUS_DATAGUARD", + "id" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "cloudAutonomousVmClusterId" : "ocid1.cloudautonomousvmcluster.oc1.", + "lifecycleDetails" : null, + "lifecycleState" : "UPDATING", + "timeCreated" : "2016-11-22T19:25:42.755Z", + "patchModel" : "RELEASE_UPDATES", + "backupConfig" : { + "backupDestinationDetails" : [], + "recoveryWindowInDays" : 30 + } + } + '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/DefaultError' + summary: Switchover Autonomous Container Database between Primary and Standby Autonomous Container Database. + tags: + - database + x-example: | + POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/actions/switchover + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/AutonomousContainerDatabase' + /autonomousContainerDatabases/{autonomousContainerDatabaseId}/autonomousContainerDatabaseDataguardAssociations: + get: + description: | + **Deprecated.** Use the [ListAutonomousContainerDatabases](#/en/database/latest/AutonomousContainerDatabase/ListAutonomousContainerDatabases) operation to get a list of the Autonomous Container Databases (ACDs)with Autonomous Data Guard-enabled associated with the specified ACD. + operationId: ListAutonomousContainerDatabaseDataguardAssociations + parameters: + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + responses: + '200': + description: All the Autonomous Container Databases enabled with Autonomous Data Guard associated with the specified Autonomous Container Database. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/Content/API/Concepts/usingapi.htm#nine). + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you must contact Oracle about + a particular request, then provide the request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ListAutonomousContainerDatabaseDataguardAssociationsResponse' + application-json: + examples: + response: + value: | + [{ + "id" : "ocid1.autonomouscontainerdatabasesdataguardassociation.oc1.phx.", + "autonomousContainerDatabaseId" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "role" : "PRIMARY", + "peerRole" : "STANDBY", + "peerAutonomousContainerDatabaseId" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "lifecycleDetails" : null, + "lifecycleState" : "PROVISIONING", + "timeCreated" : "2016-11-22T19:25:42.755Z" + }, { + "id" : "ocid1.autonomouscontainerdatabasedataguardassocation.oc1.phx.", + "autonomousContainerDatabaseId" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "role" : "STANDBY", + "peerRole" : "PRIMARY", + "peerAutonomousContainerDatabaseId" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "lifecycleDetails" : null, + "lifecycleState" : "AVAILABLE", + "timeCreated" : "2016-11-22T19:25:30.755Z" + }] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListAutonomousContainerDatabaseDataguardAssociations + tags: + - database + x-example: | + GET /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/autonomousContainerDatabaseDataguardAssociations?limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousContainerDatabaseDataguardAssociation' + post: + description: | + **Deprecated.** Use the [AddStandbyAutonomousContainerDatabase](#/en/database/latest/AutonomousContainerDatabase/AddStandbyAutonomousContainerDatabase) operation to create a new Autonomous Data Guard association. An Autonomous Data Guard association represents the replication relationship between the + specified Autonomous Container database and a peer Autonomous Container database. For more information, see [Using Oracle Data Guard](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbau/#articletitle.html). + operationId: CreateAutonomousContainerDatabaseDataguardAssociation + parameters: + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAutonomousContainerDatabaseDataguardAssociationDetails' + description: A request to create an Autonomous Data Guard association. + required: true + responses: + '200': + description: The request was accepted for processing. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousContainerDatabaseDataguardAssociation' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.autonomouscontainerdatabasedataguardassocation.oc1.phx.", + "autonomousContainerDatabaseId" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "role" : "STANDBY", + "peerRole" : "PRIMARY", + "peerAutonomousContainerDatabaseId" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "lifecycleDetails" : null, + "lifecycleState" : "AVAILABLE", + "timeCreated" : "2016-11-22T19:25:30.755Z" + } + '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/DefaultError' + summary: Create a Autonomous Data Guard association. + tags: + - database + x-example: | + POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/autonomousContainerDatabaseDataguardAssociations + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "protectionMode" : "MAXIMUM_PERFORMANCE" + "peerAutonomousContainerDatabaseDisplayName" : "STANDBY_ACD", + "peerCloudAutonomousVmClusterId" : "ocid1.cloudautonomousvmcluster.oc1." + } + /autonomousContainerDatabases/{autonomousContainerDatabaseId}/autonomousContainerDatabaseDataguardAssociations/{autonomousContainerDatabaseDataguardAssociationId}: + get: + description: | + **Deprecated.** Use the [GetAutonomousContainerDatabase](#/en/database/latest/AutonomousContainerDatabase/GetAutonomousContainerDatabase) operation to get the details of an Autonomous Container Database (ACD) enabled with Autonomous Data Guard associated with the specified ACD. + operationId: GetAutonomousContainerDatabaseDataguardAssociation + parameters: + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/AutonomousContainerDatabaseDataguardAssociationIdPathParam' + responses: + '200': + description: The Autonomous Container Database with Autonomous Data Guard enabled association information for the specified Autonomous Data Guard association OCID. + 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 must contact Oracle about + a particular request, then provide the request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousContainerDatabaseDataguardAssociation' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.autonomouscontainerdatabasedataguardassocation.oc1.phx.", + "autonomousContainerDatabaseId" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "role" : "STANDBY", + "peerRole" : "PRIMARY", + "peerAutonomousContainerDatabaseId" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "lifecycleDetails" : null, + "lifecycleState" : "AVAILABLE", + "timeCreated" : "2016-11-22T19:25:30.755Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetAutonomousContainerDatabaseDataguardAssociation + tags: + - database + x-example: | + GET /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/autonomousContainerDatabaseDataguardAssociations/<autonomousContainerDatabaseDataguardAssociationId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousContainerDatabaseDataguardAssociation' + put: + description: | + **Deprecated.** Use the [EditAutonomousContainerDatabaseDataguard](#/en/database/latest/AutonomousContainerDatabase/EditAutonomousContainerDatabaseDataguard) operation to update an Autonomous Data Guard association. + operationId: UpdateAutonomousContainerDatabaseDataguardAssociation + parameters: + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/AutonomousContainerDatabaseDataguardAssociationIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAutonomousContainerDatabaseDataGuardAssociationDetails' + description: A request to update Data Guard association of a database. + required: true + responses: + '200': + description: The request was accepted for processing. + 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 must contact Oracle about + a particular request, then provide the request ID. + schema: + type: string + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousContainerDatabaseDataguardAssociation' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.autonomouscontainerdatabasedataguardassocation.oc1.phx.", + "autonomousContainerDatabaseId" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "role" : "PRIMARY", + "peerRole" : "STANDBY", + "peerAutonomousContainerDatabaseId" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "lifecycleDetails" : null, + "lifecycleState" : "UPDATING", + "timeCreated" : "2016-11-22T19:25:30.755Z" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateAutonomousContainerDatabaseDataguardAssociation + tags: + - database + x-example: | + PUT /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/autonomousContainerDatabaseDataguardAssociation/<autonomousContainerDatabaseDataguardAssociationIdactions>/update + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousContainerDatabaseDataguardAssociation' + /autonomousContainerDatabases/{autonomousContainerDatabaseId}/autonomousContainerDatabaseDataguardAssociations/{autonomousContainerDatabaseDataguardAssociationId}/actions/failover: + post: + description: | + **Deprecated.** Use the [FailoverAutonomousContainerDatabaseDataguard](#/en/database/latest/AutonomousContainerDatabase/FailoverAutonomousContainerDatabaseDataguard) operation to fail over the standby Autonomous Container Database (ACD) to the primary ACD after the existing primary ACD fails or becomes unreachable. + + A failover can result in data loss, depending on the protection mode in effect at the time the primary Autonomous Container Database fails. + operationId: FailoverAutonomousContainerDatabaseDataguardAssociation + parameters: + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/AutonomousContainerDatabaseDataguardAssociationIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '200': + description: The request was accepted for processing. + 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 must contact Oracle about + a particular request, then provide the request ID. + schema: + type: string + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousContainerDatabaseDataguardAssociation' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.autonomouscontainerdatabasedataguardassocation.oc1.phx.", + "autonomousContainerDatabaseId" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "role" : "STANDBY", + "peerRole" : "PRIMARY", + "peerAutonomousContainerDatabaseId" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "lifecycleDetails" : null, + "lifecycleState" : "ROLE_CHANGE_IN_PROGRESS", + "timeCreated" : "2016-11-22T19:25:30.755Z" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Fails over to a standby Autonomous Container Database to the primary Autonomous Container Database role. + tags: + - database + x-example: | + POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/autonomousContainerDatabaseDataguardAssociations/<autonomousContainerDatabaseDataguardAssociationIdactions>/actions/failover + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousContainerDatabaseDataguardAssociation' + /autonomousContainerDatabases/{autonomousContainerDatabaseId}/autonomousContainerDatabaseDataguardAssociations/{autonomousContainerDatabaseDataguardAssociationId}/actions/migrate: + post: + description: | + Migrate Autonomous Container Database, identified by the autonomousContainerDatabaseId parameter. + operationId: MigrateAutonomousContainerDatabaseDataguardAssociation + parameters: + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/AutonomousContainerDatabaseDataguardAssociationIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '202': + description: The request was accepted for processing. + 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 must contact Oracle about + a particular request, then provide the request ID. + schema: + type: string + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousContainerDatabaseDataguardAssociation' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.autonomouscontainerdatabasedataguardassocation.oc1.phx.", + "autonomousContainerDatabaseId" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "role" : "PRIMARY", + "peerRole" : "STANDBY", + "peerAutonomousContainerDatabaseId" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "lifecycleDetails" : null, + "lifecycleState" : "TERMINATED", + "timeCreated" : "2016-11-22T19:25:30.755Z" + } + '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/DefaultError' + summary: Migrate the primary Autonomous Container Database of an Autonomous Data Guard Association into a standby role. + tags: + - database + x-example: | + POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/autonomousContainerDatabaseDataguardAssociation/<autonomousContainerDatabaseDataguardAssociationIdactions>/actions/reinstate + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/AutonomousContainerDatabaseDataguardAssociation' + /autonomousContainerDatabases/{autonomousContainerDatabaseId}/autonomousContainerDatabaseDataguardAssociations/{autonomousContainerDatabaseDataguardAssociationId}/actions/reinstate: + post: + description: | + **Deprecated.** Use the [ReinstateAutonomousContainerDatabaseDataguard](#/en/database/latest/AutonomousContainerDatabase/ReinstateAutonomousContainerDatabaseDataguard) operation to reinstate a disabled standby Autonomous Container Database (ACD), identified by the autonomousContainerDatabaseId parameter, to an active standby ACD. + operationId: ReinstateAutonomousContainerDatabaseDataguardAssociation + parameters: + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/AutonomousContainerDatabaseDataguardAssociationIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '200': + description: The request was accepted for processing. + 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 must contact Oracle about + a particular request, then provide the request ID. + schema: + type: string + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousContainerDatabaseDataguardAssociation' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.autonomouscontainerdatabasedataguardassocation.oc1.phx.", + "autonomousContainerDatabaseId" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "role" : "STANDBY", + "peerRole" : "PRIMARY", + "peerAutonomousContainerDatabaseId" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "lifecycleDetails" : null, + "lifecycleState" : "ROLE_CHANGE_IN_PROGRESS", + "timeCreated" : "2016-11-22T19:25:30.755Z" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Reinstates the primary Autonomous Container Database of an Autonomous Data Guard Association into a standby role. + tags: + - database + x-example: | + POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/autonomousContainerDatabaseDataguardAssociation/<autonomousContainerDatabaseDataguardAssociationIdactions>/actions/reinstate + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousContainerDatabaseDataguardAssociation' + /autonomousContainerDatabases/{autonomousContainerDatabaseId}/autonomousContainerDatabaseDataguardAssociations/{autonomousContainerDatabaseDataguardAssociationId}/actions/switchover: + post: + description: | + **Deprecated.** Use the [SwitchoverAutonomousContainerDatabaseDataguard](#/en/database/latest/AutonomousContainerDatabase/SwitchoverAutonomousContainerDatabaseDataguard) operation to switches over the primary Autonomous Container Database (ACD) of an Autonomous Data Guard peer association to standby role. The standby ACD associated with autonomousContainerDatabaseDataguardAssociationId assumes the primary ACD role. + + A switchover incurs no data loss. + operationId: SwitchoverAutonomousContainerDatabaseDataguardAssociation + parameters: + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/AutonomousContainerDatabaseDataguardAssociationIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '200': + description: The request was accepted for processing. + 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 must contact Oracle about + a particular request, then provide the request ID. + schema: + type: string + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousContainerDatabaseDataguardAssociation' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.autonomouscontainerdatabasedataguardassocation.oc1.phx.", + "autonomousContainerDatabaseId" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "role" : "STANDBY", + "peerRole" : "PRIMARY", + "peerAutonomousContainerDatabaseId" : "ocid1.autonomouscontainerdatabase.oc1.phx.", + "lifecycleDetails" : null, + "lifecycleState" : "ROLE_CHANGE_IN_PROGRESS", + "timeCreated" : "2016-11-22T19:25:30.755Z" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Switches the primary Autonomous Container Database of an Autonomous Data Guard association to standby role. + tags: + - database + x-example: | + POST /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/autonomousContainerDatabaseDataguardAssociation/<autonomousContainerDatabaseDataguardAssociationIdactions>/actions/switchover + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousContainerDatabaseDataguardAssociation' + /autonomousContainerDatabases/{autonomousContainerDatabaseId}/patches: + get: + description: | + Lists the patches applicable to the requested container database. + operationId: ListContainerDatabasePatches + parameters: + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/AutonomousPatchTypeQueryParam' + responses: + '200': + description: A list of the patch packages. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListContainerDatabasePatchesResponse' + application-json: + examples: + response: + value: | + [ + { + "availableActions" : ["APPLY"], + "description" : "Patch PSU as released on 201611", + "id" : "ocid1.autonomousdbpatch.oc1.phx.", + "lastAction" : "APPLY", + "lifecycleDetails" : "A failure message that can be displayed to the user", + "lifecycleState" : "FAILED", + "timeReleased" : "2017-02-16T01:50:07.0001", + "type" : "BUNDLE", + "version" : "20170127" + }, + { + "availableActions" : ["APPLY"], + "description" : "Patch PSU as released on 20170127", + "id" : "ocid1.autonomousdbpatch.oc1.phx.", + "lastAction" : null, + "lifecycleDetails" : null, + "lifecycleState" : "AVAILABLE", + "timeReleased" : "2017-02-17T09:20:01.0007", + "type" : "BUNDLE", + "version" : "20170127" + } + ] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListContainerDatabasePatches + tags: + - database + x-example: | + GET /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/patches?limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousPatch' + /autonomousContainerDatabases/{autonomousContainerDatabaseId}/resourceUsage: + get: + description: | + Get resource usage details for the specified Autonomous Container Database. + operationId: GetAutonomousContainerDatabaseResourceUsage + parameters: + - $ref: '#/components/parameters/AutonomousContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: Get the Autonomous Container Database resource usage details. + 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/AutonomousContainerDatabaseResourceUsage' + application-json: + examples: + response: + value: | + { + "displayName" : "autonomousContainerDatabase", + "id" : "ocid1.autonomousContainerDatabase.oc1.", + "availableCpus" : 10, + "reclaimableCpus" : 10, + "provisionedCpus" : 10, + "reservedCpus" : 10, + "usedCpus" : 10, + "largestProvisionableAutonomousDatabaseInCpus": 50, + "provisionableCpus":[ + "1", + "2" + ], + "autonomousContainerDatabaseVmUsage" : [ + { + "displayName" : "autonomousVirtualMachine", + "id" : "autonomousVirtualMachine", + "availableCpus" : 6, + "reclaimableCpus" : 4, + "provisionedCpus" : 4, + "reservedCpus" : 3, + "usedCpus" : 5 + }, + { + "displayName" : "autonomousVirtualMachine", + "id" : "autonomousVirtualMachine", + "availableCpus" : 4, + "reclaimableCpus" : 6, + "provisionedCpus" : 6, + "reservedCpus" : 7, + "usedCpus" : 5 + } + ] + } + '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/DefaultError' + summary: GetAutonomousContainerDatabaseResourceUsage + tags: + - database + x-example: | + GET /20160918/autonomousContainerDatabases/<autonomousContainerDatabaseId>/resourceUsage + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousContainerDatabase' + /autonomousDatabaseBackups: + get: + description: | + Gets a list of Autonomous AI Database backups based on either the `autonomousDatabaseId` or `compartmentId` specified as a query parameter. + operationId: ListAutonomousDatabaseBackups + parameters: + - $ref: '#/components/parameters/optionalautonomousDatabaseIdQueryParam' + - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/listAutonomousDatabaseBackupsSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/listAutonomousDatabaseBackupsFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/FilterByBackupTypeQueryParam' + - $ref: '#/components/parameters/FilterByBackupDestinationIdQueryParam' + - $ref: '#/components/parameters/FilterByKeyStoreIdQueryParam' + - $ref: '#/components/parameters/FilterByInfrastructureTypeQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: A list of Autonomous AI Database backups. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListAutonomousDatabaseBackupsResponse' + application-json: + examples: + response: + value: | + [ + { + "compartmentId" : "ocid1.tenancy.oc1..", + "autonomousDatabaseId" : "ocid1.autonomousdatabase.oc1.phx.", + "displayName" : "Monthly Backup", + "type" : "FULL", + "isAutomatic" : true, + "id" : "ocid1.autonomousdatabasebackup.oc1.phx.", + "lifecycleState" : "CREATING", + "databaseSizeInTBs" : 1, + "timeStarted" : "2016-11-23T01:59:07.032Z", + "timeEnded" : null + } + ] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Gets a list of Autonomous AI Database backups. + tags: + - database + x-example: | + GET /20160918/autonomousDatabaseBackups?autonomousDatabaseId=<autonomousDatabaseId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabaseBackup' + post: + description: | + Creates a new Autonomous AI Database backup for the specified database based on the provided request parameters. + operationId: CreateAutonomousDatabaseBackup + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAutonomousDatabaseBackupDetails' + description: Request to create a new Autonomous AI Database backup. + required: true + responses: + '200': + description: The request was successfully received and the Autonomous AI Database backup operation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousDatabaseBackup' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "autonomousDatabaseId" : "ocid1.autonomousdatabase.oc1.phx.", + "displayName" : "manual backup", + "id" : "ocid1.autonomousdatabasebackup.oc1.phx.", + "type" : "FULL", + "isAutomatic" : true, + "lifecycleState" : "CREATING", + "databaseSizeInTBs" : 1, + "timeStarted" : "2016-11-23T01:59:07.032Z", + "timeEnded" : null + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Creates a new Autonomous AI Database backup for the specified database. + tags: + - database + x-example: | + POST /20160918/autonomousDatabaseBackups + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "autonomousDatabaseId" : "ocid1.autonomousdatabase.oc1.phx.<unique_ID>", + "displayName" : "Monthly Backup" + } + /autonomousDatabaseBackups/{autonomousDatabaseBackupId}: + delete: + description: Deletes a long-term backup. You cannot delete other backups using this API. + operationId: DeleteAutonomousDatabaseBackup + parameters: + - $ref: '#/components/parameters/autonomousDatabaseBackupIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '204': + description: The request to delete the backup was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteAutonomousDatabaseBackup + tags: + - database + x-example: | + DELETE /20160918/autonomousDatabaseBackups/<autonomousDatabaseBackupId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabaseBackup' + get: + description: Gets information about the specified Autonomous AI Database backup. + operationId: GetAutonomousDatabaseBackup + parameters: + - $ref: '#/components/parameters/autonomousDatabaseBackupIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The Autonomous AI Database backup. + 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/AutonomousDatabaseBackup' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "autonomousDatabaseId" : "ocid1.autonomousdatabase.oc1.phx.", + "displayName" : "Monthly Backup", + "type" : "FULL", + "isAutomatic" : true, + "id" : "ocid1.autonomousdatabasebackup.oc1.phx.", + "lifecycleState" : "CREATING", + "databaseSizeInTBs" : 1, + "timeStarted" : "2016-11-23T01:59:07.032Z", + "timeEnded" : null + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Gets information about the specified Autonomous AI Database backup. + tags: + - database + x-example: | + GET /20160918/autonomousDatabaseBackups/<autonomousDatabaseBackupId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabaseBackup' + put: + description: | + Updates the Autonomous AI Database backup of the specified database based on the request parameters. + operationId: UpdateAutonomousDatabaseBackup + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/autonomousDatabaseBackupIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAutonomousDatabaseBackupDetails' + description: Request to update an existing Autonomous AI Database backup. + required: true + responses: + '202': + description: The backup update request was received and is being performed on the backup schema. + 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, provide the request ID. + schema: + type: string + opc-work-request-id: + description: Unique Oracle-assigned identifier for the work request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousDatabaseBackup' + '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/DefaultError' + summary: Updates an existing Autonomous AI Database backup of the specified database. + tags: + - database + x-example: | + PUT /20160918/autonomousDatabaseBackups/<autonomousDatabaseBackupId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "retentionPeriodInDays" : 365 + } + x-related-resource: '#/definitions/AutonomousDatabaseBackup' + /autonomousDatabaseCharacterSets: + get: + description: Gets a list of supported character sets. + operationId: ListAutonomousDatabaseCharacterSets + parameters: + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/isSharedQueryParam' + - $ref: '#/components/parameters/isDedicatedQueryParam' + - $ref: '#/components/parameters/characterSetTypeQueryParam' + responses: + '200': + description: Supported Oracle Autonomous AI Database character sets. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListAutonomousDatabaseCharacterSetsResponse' + application-json: + examples: + response: + value: | + [ + { + "characterSet" : "ascii" + }, { + "characterSet" : "UTF8" + } + ] + default: + $ref: '#/components/responses/DefaultError' + summary: ListAutonomousDatabaseCharacterSets + tags: + - database + x-example: | + GET /20160918/autonomousDatabaseCharacterSets? + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-authz-declarations: + authorizationRequired: false + x-related-resource: '#/definitions/AutonomousDatabaseCharacterSets' + /autonomousDatabaseSoftwareImages: + get: + description: | + Gets a list of the Autonomous AI Database Software Images in the specified compartment. + operationId: ListAutonomousDatabaseSoftwareImages + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListAutonomousDatabaseSoftwareImagesSortByQueryParam' + - $ref: '#/components/parameters/ListAutonomousDatabaseSoftwareImagesFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/ListAutonomousDatabaseSoftwareImagesFilterByImageShapeFamilyQueryParam' + responses: + '200': + description: Retrieved the list of all the Autonomous AI Database Software Images. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/AutonomousDatabaseSoftwareImageCollection' + application-json: + examples: + response: + value: | + [ + { + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "databaseiamge1", + "id" : "ocid1.autonomousdatabasesoftwareimage.oc1.phx.", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails": null, + "timeCreated" : "2016-11-22T19:25:42.755Z" + } + ] + '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/DefaultError' + summary: ListAutonomousDatabaseSoftwareImages + tags: + - database + x-example: | + Example I: + GET /20160918/autonomousDatabaseSoftwareImages?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabaseSoftwareImage' + post: + description: | + create Autonomous AI Database Software Image in the specified compartment. + operationId: CreateAutonomousDatabaseSoftwareImage + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAutonomousDatabaseSoftwareImageDetails' + description: Request to create Autonomous AI Database Software Image. + required: true + responses: + '200': + description: The request was successfully received and the Autonomous AI Database Software Image creation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousDatabaseSoftwareImage' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "image1", + "id" : "ocid1.autonomousdatabasesoftwareimage.oc1.phx.", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails": null, + "timeCreated" : "2016-11-22T19:25:42.755Z" + } + '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/DefaultError' + summary: CreateAutonomousDatabaseSoftwareImage + tags: + - database + x-example: | + Example I: + POST /20160918/autonomousDatabaseSoftwareImages + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.tenancy.oc1..<unique_ID>", + "displayName" : "image1" + "sourceCdbId" : "ocid1.autonomouscontainerdatabase.oc1.phx." + } + /autonomousDatabaseSoftwareImages/{autonomousDatabaseSoftwareImageId}: + delete: + description: Delete an Autonomous AI Database Software Image + operationId: DeleteAutonomousDatabaseSoftwareImage + parameters: + - $ref: '#/components/parameters/AutonomousDatabaseSoftwareImageIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '204': + description: The request to delete Autonomous AI Database Software Image was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: DeleteAutonomousDatabaseSoftwareImage + tags: + - database + x-example: | + DELETE /20160918/autonomousDatabaseSoftwareImages/<autonomousDatabaseSoftwareImageId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabaseSoftwareImage' + get: + description: Gets information about the specified Autonomous AI Database Software Image. + operationId: GetAutonomousDatabaseSoftwareImage + parameters: + - $ref: '#/components/parameters/AutonomousDatabaseSoftwareImageIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The Autonomous AI Database Software Image. + 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/AutonomousDatabaseSoftwareImage' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "databaseimage1", + "id" : "ocid1.autonomousdatabasesoftwareimage.oc1.phx.", + "lifecycleState" : "AVAILABLE", + "timeCreated" : "2016-11-22T19:25:42.755Z" + } + '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/DefaultError' + summary: GetAutonomousDatabaseSoftwareImage + tags: + - database + x-example: | + GET /20160918/autonomousDatabaseSoftwareImages/<autonomousDatabaseSoftwareImageId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: Updates the properties of an Autonomous AI Database Software Image, like add tags + operationId: UpdateAutonomousDatabaseSoftwareImage + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/AutonomousDatabaseSoftwareImageIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAutonomousDatabaseSoftwareImageDetails' + description: Request to update the properties of an Autonomous AI Database Software Image. + required: true + responses: + '200': + description: The Autonomous AI Database Software Image. + 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/AutonomousDatabaseSoftwareImage' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "image1", + "freeformTags" : {"Department": "Finance"}, + "id" : "ocid1.autonomousdatabasesoftwareimage.oc1.phx.", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails": null, + "timeCreated" : "2016-11-22T19:25:42.755Z" + } + '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/DefaultError' + summary: UpdateAutonomousDatabaseSoftwareImage + tags: + - database + x-example: | + PUT /20160918/autonomousDatabaseSoftwareImages/<autonomousDatabaseSoftwareImageId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "freeformTags" : {"Department": "Finance"} + } + /autonomousDatabaseSoftwareImages/{autonomousDatabaseSoftwareImageId}/actions/changeCompartment: + post: + description: | + Move the Autonomous AI Database Software Image and its dependent resources to the specified compartment. + operationId: ChangeAutonomousDatabaseSoftwareImageCompartment + parameters: + - $ref: '#/components/parameters/AutonomousDatabaseSoftwareImageIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeAutonomousDatabaseSoftwareImageCompartmentDetails' + description: Request to move Autonomous AI Database Software Image to a different compartment + required: true + responses: + '202': + description: The request was successfully received and the change compartment action is being performed. + 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 + opc-work-request-id: + description: Unique Oracle-assigned identifier of the work 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/DefaultError' + summary: ChangeAutonomousDatabaseSoftwareImageCompartment + tags: + - database + x-example: | + POST /20160918/autonomousDatabaseSoftwareImages/<autonomousDatabaseSoftwareImageId>/actions/changeCompartment + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid.compartment.oc1..<unique_ID>" + } + x-related-resource: '#/definitions/AutonomousDatabaseSoftwareImage' + /autonomousDatabases: + get: + description: | + Gets a list of Autonomous AI Databases based on the query parameters specified. + operationId: ListAutonomousDatabases + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/optionalAutonomousContainerDatabaseIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/listAutonomousDatabasesSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListAutonomousDatabasesFilterByInfrastructureTypeQueryParam' + - $ref: '#/components/parameters/listAutonomousDatabasesFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/listAutonomousDatabasesFilterByLifecycleStateNotEqualToQueryParam' + - $ref: '#/components/parameters/listAutonomousDatabasesFilterByDbWorkloadQueryParam' + - $ref: '#/components/parameters/listAutonomousDatabasesFilterByDbVersionQueryParam' + - $ref: '#/components/parameters/isFreeTierQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/refreshableCloneQueryParam' + - $ref: '#/components/parameters/isDataGuardEnabledQueryParam' + - $ref: '#/components/parameters/isResourcePoolLeaderParam' + - $ref: '#/components/parameters/resourcePoolLeaderIdParam' + responses: + '200': + description: The list of Autonomous AI Databases was retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListAutonomousDatabasesResponse' + application-json: + examples: + response: + value: | + [{ + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "example_autonomous_database", + "id" : "ocid1.autonomousdatabase.oc1.phx.", + "dbName" : "adatabasedb1", + "lifecycleState" : "PROVISIONING", + "timeCreated" : "2018-03-23T00:59:07.032Z", + "cpuCoreCount" : 8, + "dataStorageSizeInTBs" : 1, + "licenseModel" : "LICENSE_INCLUDED", + "serviceConsoleUrl" : "https://adwc.uscom-east-1.oraclecloud.com/console/index.html?tenant_name=iam-ocid1.tenancy.oc1..&database_name=adwdb1" + }, { + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "second_example_autonomous_database", + "id" : "ocid1.autonomousdatabase.oc1.phx.", + "dbName" : "adatabasedb2", + "lifecycleState" : "PROVISIONING", + "timeCreated" : "2018-03-23T01:59:07.032Z", + "cpuCoreCount" : 4, + "dataStorageSizeInTBs" : 100, + "licenseModel" : "LICENSE_INCLUDED", + "serviceConsoleUrl" : "https://adwc.uscom-east-1.oraclecloud.com/console/index.html?tenant_name=iam-ocid1.tenancy.oc1..&database_name=adwdb1" + }] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Gets a list of Autonomous AI Database. + tags: + - database + x-example: | + GET /20160918/autonomousDatabases?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabase' + post: + description: | + Creates a new Autonomous AI Database. + operationId: CreateAutonomousDatabase + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAutonomousDatabaseBase' + description: Request to create a new Autonomous AI Database. + required: true + responses: + '200': + description: The request was successfully received and a database is being provisioned. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId": "ocid1.tenancy.oc1..", + "displayName": "example_autonomous_database", + "id": "ocid1.autonomousdatabase.oc1.phx.", + "dbName": "adatabasedb1", + "lifecycleState": "PROVISIONING", + "timeCreated": "2016-11-23T01:59:07.032Z", + "cpuCoreCount": 8, + "dataStorageSizeInTBs": 1, + "licenseModel": "LICENSE_INCLUDED", + "serviceConsoleUrl": "https://adwc.uscom-east-1.oraclecloud.com/console/index.html?tenant_name=iam-ocid1.tenancy.oc1..&database_name=adwdb1", + "resourcePoolSummary": + { + "poolSize": 64 + } + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Creates a new Autonomous AI Database. + tags: + - database + x-example: | + Example I - creates a new Autonomous AI Database: + POST /20160918/autonomousDatabases + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid.compartment.oc1..<unique_ID>", + "displayName": "example_autonomous_database", + "dbName": "adatabasedb1", + "adminPassword": "<password>", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTBs": 1 + } + Example II - creates an Autonomous AI Database by cloning an existing one: + POST /20160918/autonomousDatabases + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid.compartment.oc1..<unique_ID>", + "displayName" : "example_autonomous_database", + "dbName" : "adatabasedb1", + "adminPassword" : "<password>", + "computeModel" : "ECPU", + "computeCount" : 2, + "dataStorageSizeInTBs" : 1, + "source" : "DATABASE", + "sourceId" : "ocid1.autonomousdatabase.oc1.phx..<unique_ID>", + "cloneType" : "FULL" + } + Example III - creates an Autonomous AI Database refreshable clone: + POST /20160918/autonomousDatabases + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid.compartment.oc1..<unique_ID>", + "displayName" : "example_autonomous_database_refreshable_clone", + "dbName" : "adatabasedb1", + "computeModel" : "ECPU", + "computeCount" : 2, + "source" : "CLONE_TO_REFRESHABLE", + "sourceId" : "ocid1.autonomousdatabase.oc1.phx..<unique_ID>", + } + Example IV - creates a standby Autonomous AI Database for a cross-region Autonomous Data Guard association: + POST /20160918/autonomousDatabases + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid.compartment.oc1..<unique_ID>", + "sourceId" : "ocid1.autonomousdatabase.oc1.iad..<unique_ID>", + "source" : "CROSS_REGION_DATAGUARD" + } + Example VII - Create a resourcePool while creating Autonomous AI Database: + POST /20160918/autonomousDatabases + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid.compartment.oc1..<unique_ID>", + "displayName": "example_autonomous_database", + "dbName": "adatabasedb1", + "adminPassword": "<password>", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTBs": 1 + "resourcePoolSummary": + { + "poolSize": 64 + } + } + Example VIII - Join a resourcePool while creating Autonomous AI Database: + POST /20160918/autonomousDatabases + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid.compartment.oc1..<unique_ID>", + "displayName": "example_autonomous_database", + "dbName": "adatabasedb1", + "adminPassword": "<password>", + "computeModel": "ECPU", + "computeCount": 2, + "dataStorageSizeInTBs": 1 + "resourcePoolLeaderId": "ocid1.autonomousdatabase.oc1.phx..<unique_ID>" + } + /autonomousDatabases/actions/listResourcePoolShapes: + post: + description: Lists available resource pools shapes. + operationId: ResourcePoolShapes + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The Autonomous AI Database collections. + headers: + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ResourcePoolShapeCollection' + application-json: + examples: + response: + value: | + [ + { + "shape": 64 + }, + { + "shape": 128 + }, + { + "shape": 256 + }, + { + "shape": 512 + } + ] + '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/DefaultError' + summary: Lists resource pool shapes for Autonomous AI Database Serverless databases. + tags: + - database + x-example: | + POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/listResourcePoolShapes + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-authz-declarations: + authorizationRequired: false + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/wallet: + get: + description: | + Gets the Autonomous AI Database regional wallet details. + operationId: GetAutonomousDatabaseRegionalWallet + parameters: + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The Autonomous AI Database regional wallet details are being retrieved. + 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/AutonomousDatabaseWallet' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Get the regional wallet details for Autonomous AI Databases. + tags: + - database + x-example: | + GET /20160918/autonomousDatabases/wallet + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabaseWallet' + put: + description: | + Updates the Autonomous AI Database regional wallet. + operationId: UpdateAutonomousDatabaseRegionalWallet + parameters: + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAutonomousDatabaseWalletDetails' + description: Request to update the properties of Autonomous AI Database regional wallet. + required: true + responses: + '202': + description: The request was successfully received and the wallet rotation is in progress. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application-json: + examples: + response: + value: | + { + "timeWalletRotated" : "2019-06-23T00:59:07.032Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Update the regional wallet for Autonomous AI Database. + tags: + - database + x-example: | + PUT /latest/autonomousDatabases/wallet + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "gracePeriod" : 1, + "shouldRotate" : true + } + x-related-resource: '#/definitions/AutonomousDatabaseWallet' + /autonomousDatabases/{autonomousDatabaseId}: + delete: + description: | + Deletes the specified Autonomous AI Database. + operationId: DeleteAutonomousDatabase + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/mustDeleteAssociatedLongTermBackupsQueryParam' + responses: + '204': + description: The request to delete the Autonomous AI Database was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Deletes the specified Autonomous AI Database. + tags: + - database + x-example: | + DELETE /20160918/autonomousDatabases/<autonomousDatabaseId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabase' + get: + description: | + Gets the details of the specified Autonomous AI Database. + operationId: GetAutonomousDatabase + parameters: + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: Get the details of the specified Autonomous AI Database. + 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/AutonomousDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "example_autonomous_database", + "id" : "ocid1.autonomousdatabase.oc1.phx.", + "dbName" : "adatabasedb1", + "lifecycleState" : "AVAILABLE", + "timeCreated" : "2016-11-23T01:59:07.032Z", + "cpuCoreCount" : 20, + "dataStorageSizeInTBs" : 1, + "licenseModel" : "LICENSE_INCLUDED", + "serviceConsoleUrl" : "https://adwc.uscom-east-1.oraclecloud.com/console/index.html?tenant_name=iam-ocid1.tenancy.oc1..&database_name=adwdb1", + "preferredCommunicationLanguageLocale" : "en-US" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Gets the details of the specified Autonomous AI Database. + tags: + - database + x-example: | + GET /20160918/autonomousDatabases/<autonomousDatabaseId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabase' + put: + description: | + Updates one or more attributes of the specified Autonomous AI Database. See the UpdateAutonomousDatabaseDetails resource for a full list of attributes that can be updated. + operationId: UpdateAutonomousDatabase + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAutonomousDatabaseDetails' + description: Request to update the properties of an Autonomous AI Database. + required: true + responses: + '200': + description: The request was successfully received and the database update is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId": "ocid1.tenancy.oc1..", + "displayName": "example_autonomous_database", + "id": "ocid1.autonomousdatabase.oc1.phx.", + "dbName": "adatabasedb1", + "lifecycleState": "SCALE_IN_PROGRESS", + "timeCreated": "2016-11-23T01:59:07.032Z", + "cpuCoreCount": 20, + "dataStorageSizeInTBs": 1, + "isAutoScalingForStorageEnabled": true, + "licenseModel": "LICENSE_INCLUDED", + "serviceConsoleUrl": "https://adwc.uscom-east-1.oraclecloud.com/console/index.html?tenant_name=iam-ocid1.tenancy.oc1..&database_name=adwdb1", + "resourcePoolLeaderId": "ocid1.autonomousdatabase.oc1.phx..<unique_ID>", + "timeOfJoiningResourcePool": "2016-11-23T01:59:07.032Z" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Updates the specified Autonomous AI Database with new OCPU core count and size. + tags: + - database + x-example: | + PUT /latest/autonomousDatabases/<autonomousDatabaseId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "cpuCoreCount" : 20, + "isAutoScalingForStorageEnabled": true + } + Example II - Join a resourcePool through update Autonomous AI Database: + POST /20160918/autonomousDatabases + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "resourcePoolLeaderId": "ocid1.autonomousdatabase.oc1.phx..<unique_ID>" + } + Example III - Depart from a resourcePool through update Autonomous AI Database: + POST /20160918/autonomousDatabases + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "resourcePoolLeaderId": "" + } + Example IV - change compute size of the resource pool: + POST /20160918/autonomousDatabases + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "resourcePoolSummary": + { + "poolSize": 64 + } + } + + Example V - delete resource pool: + POST /20160918/autonomousDatabases + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "resourcePoolSummary": + { + + } + } + /autonomousDatabases/{autonomousDatabaseId}/actions/changeCompartment: + post: + description: | + Move the Autonomous AI Database and its dependent resources to the specified compartment. + For more information about moving Autonomous AI Databases, see + [Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes). + operationId: ChangeAutonomousDatabaseCompartment + parameters: + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeCompartmentDetails' + description: Request to move Autonomous AI Database to a different compartment + required: true + responses: + '202': + description: The request was successfully received and the change compartment action is being performed. + 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 + opc-work-request-id: + description: Unique Oracle-assigned identifier of the work 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeAutonomousDatabaseCompartment + tags: + - database + x-example: | + POST /20160918/autonomousDatabases/<autonomousDatabaseId>/action/changeCompartment + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid.compartment.oc1..<unique_ID>" + } + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/actions/changeDisasterRecoveryConfiguration: + put: + description: This operation updates the cross-region disaster recovery (DR) details of the standby Autonomous AI Database Serverless database, and must be run on the standby side. + operationId: ChangeDisasterRecoveryConfiguration + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeDisasterRecoveryConfigurationDetails' + description: Request to update the cross-region disaster recovery (DR) details of the standby Autonomous AI Database Serverless database. + required: true + responses: + '202': + description: The request was successfully received, and the database update is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "example_autonomous_database", + "id" : "ocid1.autonomousdatabase.oc1.phx.", + "dbName" : "adatabasedb1", + "lifecycleState" : "UPDATING", + "timeCreated" : "2016-11-23T01:59:07.032Z", + "cpuCoreCount" : 5, + "dataStorageSizeInTBs" : 10, + "licenseModel" : "LICENSE_INCLUDED", + "remoteDisasterRecoveryConfiguration": { + "disasterRecoveryType": "ADG" + } + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Updates the cross-region disaster recovery (DR) details of the standby Autonomous AI Database Serverless database. + tags: + - database + x-example: | + PUT /latest/autonomousDatabases/<autonomousDatabaseId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "disasterRecoveryType" : "ADG" + } + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/actions/changeSubscription: + post: + description: | + Associate an Autonomous AI Database with a different subscription. + operationId: ChangeAutonomousDatabaseSubscription + parameters: + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeAutonomousDatabaseSubscriptionDetails' + description: Associate an Autonomous AI Database with a different subscription. + required: true + responses: + '202': + description: The request was successfully received and the update subscription action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Associate an Autonomous AI Database with a different subscription. + tags: + - database + x-example: | + POST /20160918/autonomousDatabases/<autonomousDatabaseId>/action/changeSubscription + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "subscriptionId": "ocid1.subscription.oc1..<unique_ID>" + } + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/actions/configureAutonomousDatabaseVaultKey: + post: + description: | + Configures the Autonomous AI Database Vault service [key](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). + operationId: ConfigureAutonomousDatabaseVaultKey + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigureAutonomousDatabaseVaultKeyDetails' + description: Configuration details for the Autonomous AI Database Vault service [key](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). + required: true + responses: + '202': + description: | + The request was successfully received and the Autonomous AI Database vault key was successfully configured. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Configure Autonomous AI Database Vault Key. + tags: + - database + x-example: | + POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/configureAutonomousDatabaseVaultKey + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/actions/configureSaasAdminUser: + post: + description: This operation updates SaaS administrative user configuration of the Autonomous AI Database. + operationId: ConfigureSaasAdminUser + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigureSaasAdminUserDetails' + description: Request to update SaaS administrative user configuration of the Autonomous AI Database. + required: true + responses: + '202': + description: Request was successfully received and this Autonomous AI Database will update SaaS administrative user configuration. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "example_autonomous_database", + "id" : "ocid1.autonomousdatabase.oc1.phx.", + "dbName" : "adatabasedb1", + "lifecycleState" : "UPDATING", + "timeCreated" : "2018-03-23T00:59:07.032Z", + "cpuCoreCount" : 2, + "dataStorageSizeInTBs" : 2, + "licenseModel" : "LICENSE_INCLUDED" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Updates configuration of SaaS administrative user. + tags: + - database + x-example: | + POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/configureSaasAdminUser + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "isEnabled": "true", + "password": "mockPassword" + } + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/actions/deregisterDataSafe: + post: + description: | + Asynchronously deregisters this Autonomous AI Database with Data Safe. + operationId: DeregisterAutonomousDatabaseDataSafe + parameters: + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeregisterAutonomousDatabaseDataSafeDetails' + description: Details for deregistering an Autonomous AI Database with Data Safe. + responses: + '202': + description: | + Request was successfully received and this Autonomous AI Database will be deregistered with Data Safe. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Asynchronously deregisters Data Safe for this Autonomous AI Database. + tags: + - database + x-example: | + POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/deregisterDataSafe + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "pdbAdminPassword":<password>", + } + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/actions/disableDatabaseManagement: + post: + description: | + Disables Database Management for the Autonomous AI Database resource. + operationId: DisableAutonomousDatabaseManagement + parameters: + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '202': + description: | + Request successfully received and Database Management will be disabled for this Autonomous AI Database. + headers: + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you must contact Oracle about + a particular request, then provide the request ID. + schema: + type: string + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Disables DatabaseManagement for the Autonomous AI Database resource. + tags: + - database + x-example: | + POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/disableDatabaseManagement + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/actions/disableOperationsInsights: + post: + description: | + Disables Operations Insights for the Autonomous AI Database resource. + operationId: DisableAutonomousDatabaseOperationsInsights + parameters: + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '202': + description: | + Request successfully received and Operations is disabled for this Autonomous AI Database. + headers: + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you must contact Oracle about + a particular request, then provide the request ID. + schema: + type: string + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Disables Operations Insights for the Autonomous AI Database resource. + tags: + - database + x-example: | + POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/disableOperationsInsights + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/actions/enableDatabaseManagement: + post: + description: | + Enables Database Management for Autonomous AI Database. + operationId: EnableAutonomousDatabaseManagement + parameters: + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '202': + description: | + Request was successfully received and this Autonomous AI Database will enable Database Management. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Enables Database Management for Autonomous AI Database. + tags: + - database + x-example: | + POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/enableDatabaseManagement + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/actions/enableOperationsInsights: + post: + description: | + Enables the specified Autonomous AI Database with Operations Insights. + operationId: EnableAutonomousDatabaseOperationsInsights + parameters: + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '202': + description: | + Request was successfully received and this Autonomous AI Database will enable Operations Insights. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Enables the specified Autonomous AI Database with Operations Insights. + tags: + - database + x-example: | + POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/enableOperationsInsights + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/actions/failover: + post: + description: | + Initiates a failover of the specified Autonomous AI Database to the associated peer database. Applicable only to databases with Disaster Recovery enabled. + This API should be called in the remote region where the peer database resides. + Below parameter is optional: + - `peerDbId` + Use this parameter to specify the database OCID of the Disaster Recovery peer, which is located in a different (remote) region from the current peer database. + If this parameter is not provided, the failover will happen in the same region. + operationId: FailOverAutonomousDatabase + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/OptionalPeerAutonomousDatabaseIdQueryParam' + responses: + '200': + description: The request was successfully received and the Autonomous AI Database will fail over. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "example_autonomous_database", + "id" : "ocid1.autonomousdatabase.oc1.phx.", + "dbName" : "adatabasedb1", + "lifecycleState" : "UPDATING", + "timeCreated" : "2018-03-23T00:59:07.032Z", + "cpuCoreCount" : 8, + "dataStorageSizeInTBs" : 1, + "licenseModel" : "LICENSE_INCLUDED", + "serviceConsoleUrl" : "https://adwc.uscom-east-1.oraclecloud.com/console/index.html?tenant_name=iam-ocid1.tenancy.oc1..&database_name=adwdb1", + "isDataGuardEnabled" : true, + "isFailoverEnabled" : true + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Fails over AutonomousDatabase to a Standby. + tags: + - database + x-example: | + Example I - Local Failover: + POST /20160918/autonomousDatabases/ocid1.autonomousdatabase.oc1.phx..<unique_ID>/actions/failover + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + Example II - Cross-Region Failover: + POST /20160918/autonomousDatabases/ocid1.autonomousdatabase.oc1.phx..<unique_ID>/actions/failover + Host: database.us-ashburn-1.oraclecloud.com + <authorization and other headers> + { + "peerDbId": "ocid1.autonomousdatabase.oc1.iad..<unique_ID>" + } + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/actions/generateWallet: + post: + description: | + Creates and downloads a wallet for the specified Autonomous AI Database. + operationId: GenerateAutonomousDatabaseWallet + parameters: + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GenerateAutonomousDatabaseWalletDetails' + description: Request to create a new Autonomous AI Database wallet. + required: true + responses: + '200': + description: A wallet for the specified Autonomous AI Database is being retrieved. + headers: + content-length: + description: Size of the file. + schema: + type: integer + format: int64 + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + last-modified: + description: The date and time the wallet was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. + schema: + type: string + format: date-time + 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/octet-stream: + schema: + format: binary + type: string + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Creates and downloads a wallet for the specified Autonomous AI Database. + tags: + - database + x-example: | + POST /20160918/autonomousDatabases/<autonomousDatabaseId>/generateWallet + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/actions/getSaasAdminUserStatus: + post: + description: This operation gets SaaS administrative user status of the Autonomous AI Database. + operationId: SaasAdminUserStatus + parameters: + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: SaaS administrative user status. + 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/SaasAdminUserStatus' + application-json: + examples: + response: + value: | + { + "isEnabled": "true", + "accessType": "READ_ONLY", + "timeSaasAdminUserEnabled": "2016-11-23T01:59:07.032Z" + } + '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/DefaultError' + summary: Gets status of SaaS administrative user. + tags: + - database + x-example: | + POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/getSaasAdminUserStatus + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/actions/importTransportableTablespace: + post: + description: | + Imports transportable tablespace for the specified Autonomous AI Database. + operationId: ImportTransportableTablespace + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ImportTransportableTablespaceDetails' + description: Details for importing transportable tablespace for the Autonomous AI Database. + required: true + responses: + '202': + description: Request received successfully. Import transportable tablespace for the Autonomous AI Database is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "example_autonomous_database", + "id" : "ocid1.autonomousdatabase.oc1.phx.", + "dbName" : "adatabasedb1", + "lifecycleState" : "TRANSPORTING", + "timeCreated" : "2018-03-23T00:59:07.032Z", + "cpuCoreCount" : 8, + "dataStorageSizeInTBs" : 4, + "actualUsedDataStorageSizeInTBs" : 4.5, + "allocatedStorageSizeInTBs" : 5, + "licenseModel" : "LICENSE_INCLUDED", + "serviceConsoleUrl" : "https://adwc.uscom-east-1.oraclecloud.com/console/index.html?tenant_name=iam-ocid1.tenancy.oc1..&database_name=adwdb1" + } + '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/DefaultError' + summary: Imports transportable tablespace for the specified Autonomous AI Database. + tags: + - database + x-example: | + POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/importTransportTablespace + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "ttsBundleUrl" : "https://swiftobjectstorage..oraclecloud.com/v1///tts_bundle.tgz" + } + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/actions/refresh: + post: + description: | + Initiates a data refresh for an Autonomous AI Database refreshable clone. Data is refreshed from the source database to the point of a specified timestamp. + operationId: AutonomousDatabaseManualRefresh + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousDatabaseManualRefreshDetails' + description: Request details for manually refreshing an Autonomous AI Database refreshable clone. + required: true + responses: + '200': + description: The request was successfully received and the refresh operation for the Autonomous AI Database refreshable clone is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1.", + "displayName" : "example_autonomous_database", + "id" : "ocid1.autonomousdatabase.oc1.phx.", + "dbName" : "adatabasedb1", + "lifecycleState" : "UPDATING", + "timeCreated" : "2018-03-23T00:59:07.032Z", + "cpuCoreCount" : 8, + "dataStorageSizeInTBs" : 1, + "licenseModel" : "LICENSE_INCLUDED", + "serviceConsoleUrl" : "https://adwc.uscom-east-1.oraclecloud.com/console/index.html?tenant_name=iam-ocid1.tenancy.oc1..&database_name=adwdb1", + "isDataGuardEnabled" : true, + "isFailOverEnabled" : true + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Refresh an Autonomous AI Database refreshable clone. + tags: + - database + x-example: | + POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/refresh + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/actions/registerDataSafe: + post: + description: | + Asynchronously registers this Autonomous AI Database with Data Safe. + operationId: RegisterAutonomousDatabaseDataSafe + parameters: + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegisterAutonomousDatabaseDataSafeDetails' + description: Request to register an Autonomous AI Database with Data Safe. + responses: + '202': + description: | + Request was successfully received and this Autonomous AI Database is being registered with Data Safe. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Asynchronously registers this Autonomous AI Database with Data Safe. + tags: + - database + x-example: | + POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/registerDataSafe + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "pdbAdminPassword":<password>", + } + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/actions/restart: + post: + description: | + Restarts the specified Autonomous AI Database. + operationId: RestartAutonomousDatabase + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalIsOnlineRestartQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RestartAutonomousDatabaseDetails' + description: Request details to restart the Autonomous Database with force option. + responses: + '200': + description: The request was successfully received and the Autonomous AI Database will be restarted. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "example_autonomous_database", + "id" : "ocid1.autonomousdatabase.oc1.phx.", + "dbName" : "adatabasedb1", + "lifecycleState" : "RESTARTING", + "timeCreated" : "2018-03-23T00:59:07.032Z", + "cpuCoreCount" : 8, + "dataStorageSizeInTBs" : 1, + "licenseModel" : "LICENSE_INCLUDED", + "serviceConsoleUrl" : "https://adwc.uscom-east-1.oraclecloud.com/console/index.html?tenant_name=iam-ocid1.tenancy.oc1..&database_name=adwdb1" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Restarts the specified Autonomous AI Database. + tags: + - database + x-example: | + POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/restart + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/actions/restore: + post: + description: | + Restores an Autonomous AI Database based on the provided request parameters. + operationId: RestoreAutonomousDatabase + parameters: + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RestoreAutonomousDatabaseDetails' + description: Request to perform an Autonomous AI Database restore. + required: true + responses: + '200': + description: The request was successfully received and the Autonomous AI Database restore is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "example_autonomous_database", + "id" : "ocid1.autonomousdatabase.oc1.phx.", + "dbName" : "adatabasedb1", + "lifecycleState" : "RESTORING", + "timeCreated" : "2018-03-23T00:59:07.032Z", + "cpuCoreCount" : 8, + "dataStorageSizeInTBs" : 1, + "licenseModel" : "LICENSE_INCLUDED", + "serviceConsoleUrl" : "https://adwc.uscom-east-1.oraclecloud.com/console/index.html?tenant_name=iam-ocid1.tenancy.oc1..&database_name=adwdb1" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Restores an Autonomous AI Database based on the provided request parameters. + tags: + - database + x-example: | + POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/restore + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "timestamp" : "2018-04-11T01:59:07.032Z" + } + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/actions/rotateKey: + post: + description: Rotate existing AutonomousDatabase [Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) key. + operationId: RotateAutonomousDatabaseEncryptionKey + parameters: + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RotateAutonomousDatabaseEncryptionKeyDetails' + description: Key details provided by the user for rotate key operation for Autonomous AI Database. + responses: + '202': + description: | + The request was successfully received and the key is being rotated. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousDatabase' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Rotate Key + tags: + - database + x-example: | + POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/rotateKey + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/actions/shrink: + post: + description: | + This operation shrinks the current allocated storage down to the current actual used data storage (actualUsedDataStorageSizeInTBs). The if the base storage value for the database (dataStorageSizeInTBs) is larger than the actualUsedDataStorageSizeInTBs value, you are billed for the base storage value. + operationId: ShrinkAutonomousDatabase + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + responses: + '202': + description: The request was successfully received and the storage shrink operation for the Autonomous AI Database is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "example_autonomous_database", + "id" : "ocid1.autonomousdatabase.oc1.phx.", + "dbName" : "adatabasedb1", + "lifecycleState" : "SCALE_IN_PROGRESS", + "timeCreated" : "2018-03-23T00:59:07.032Z", + "cpuCoreCount" : 8, + "dataStorageSizeInTBs" : 4, + "actualUsedDataStorageSizeInTBs" : 4.5, + "allocatedStorageSizeInTBs" : 5, + "licenseModel" : "LICENSE_INCLUDED", + "serviceConsoleUrl" : "https://adwc.uscom-east-1.oraclecloud.com/console/index.html?tenant_name=iam-ocid1.tenancy.oc1..&database_name=adwdb1" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Shrinks the current allocated storage down to the current actual used storage. + tags: + - database + x-example: | + POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/shrink + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/actions/start: + post: + description: | + Starts the specified Autonomous AI Database. + operationId: StartAutonomousDatabase + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + responses: + '200': + description: The request was successfully received and the Autonomous AI Database will be started. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "example_autonomous_database", + "id" : "ocid1.autonomousdatabase.oc1.phx.", + "dbName" : "adatabasedb1", + "lifecycleState" : "STARTING", + "timeCreated" : "2018-03-23T00:59:07.032Z", + "cpuCoreCount" : 8, + "dataStorageSizeInTBs" : 1, + "licenseModel" : "LICENSE_INCLUDED", + "serviceConsoleUrl" : "https://adwc.uscom-east-1.oraclecloud.com/console/index.html?tenant_name=iam-ocid1.tenancy.oc1..&database_name=adwdb1" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Starts the specified Autonomous AI Database. + tags: + - database + x-example: | + POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/start + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/actions/stop: + post: + description: | + Stops the specified Autonomous AI Database. + operationId: StopAutonomousDatabase + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StopAutonomousDatabaseDetails' + description: Request details to stop the Autonomous Database with force option. + responses: + '200': + description: The request was successfully received and the Autonomous AI Database will be stopped. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "example_autonomous_database", + "id" : "ocid1.autonomousdatabase.oc1.phx.", + "dbName" : "adatabasedb1", + "lifecycleState" : "STOPPING", + "timeCreated" : "2018-03-23T00:59:07.032Z", + "cpuCoreCount" : 8, + "dataStorageSizeInTBs" : 1, + "licenseModel" : "LICENSE_INCLUDED", + "serviceConsoleUrl" : "https://adwc.uscom-east-1.oraclecloud.com/console/index.html?tenant_name=iam-ocid1.tenancy.oc1..&database_name=adwdb1" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Stops the specified Autonomous AI Database. + tags: + - database + x-example: | + POST /20160918/autonomousDatabases/<autonomousDatabaseId>/actions/stop + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/actions/switchover: + post: + description: | + Initiates a switchover of the specified Autonomous AI Database to the associated peer database. Applicable only to databases with Disaster Recovery enabled. + This API should be called in the remote region where the peer database resides. + Below parameter is optional: + - `peerDbId` + Use this parameter to specify the database OCID of the Disaster Recovery peer, which is located in a different (remote) region from the current peer database. + If this parameter is not provided, the switchover will happen in the same region. + operationId: SwitchoverAutonomousDatabase + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/OptionalPeerAutonomousDatabaseIdQueryParam' + responses: + '200': + description: The request was successfully received and the Autonomous AI Database switchover operation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1.", + "displayName" : "example_autonomous_database", + "id" : "ocid1.autonomousdatabase.oc1.phx.", + "dbName" : "adatabasedb1", + "lifecycleState" : "UPDATING", + "timeCreated" : "2018-03-23T00:59:07.032Z", + "cpuCoreCount" : 8, + "dataStorageSizeInTBs" : 1, + "licenseModel" : "LICENSE_INCLUDED", + "serviceConsoleUrl" : "https://adwc.uscom-east-1.oraclecloud.com/console/index.html?tenant_name=iam-ocid1.tenancy.oc1..&database_name=adwdb1", + "isDataGuardEnabled" : true, + "isFailoverEnabled" : true + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Switches over AutonomousDatabase to a Standby. + tags: + - database + x-example: | + Example I - Local Switchover: + POST /20160918/autonomousDatabases/ocid1.autonomousdatabase.oc1.phx..<unique_ID>/actions/switchover + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + Example II - Cross-Region Switchover: + POST /20160918/autonomousDatabases/ocid1.autonomousdatabase.oc1.phx..<unique_ID>/actions/switchover + Host: database.us-ashburn-1.oraclecloud.com + <authorization and other headers> + { + "peerDbId": "ocid1.autonomousdatabase.oc1.iad..<unique_ID>" + } + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/autonomousDatabaseDataguardAssociations: + get: + description: | + *Deprecated.* Use the [GetAutonomousContainerDatabase](#/en/database/latest/AutonomousContainerDatabase/GetAutonomousContainerDatabase) operation to get a list of the Autonomous Data Guard-enabled databases associated with the specified Autonomous AI Database. + operationId: ListAutonomousDatabaseDataguardAssociations + parameters: + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + responses: + '200': + description: All the Autonomous Data Guard-enabled databases associated with the specified Autonomous AI Database. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/Content/API/Concepts/usingapi.htm#nine). + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you must contact Oracle about + a particular request, then provide the request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ListAutonomousDatabaseDataguardAssociationsResponse' + application-json: + examples: + response: + value: | + [{ + "id" : "ocid1.autonomousdatabasedataguard.oc1.phx.", + "autonomousDatabaseId" : "ocid1.autonomousdatabase.oc1.phx.", + "role" : "PRIMARY", + "peerRole" : "STANDBY", + "peerAutonomousDatabaseId" : "ocid1.autonomousdatabase.oc1.phx.", + "lifecycleDetails" : null, + "lifecycleState" : "PROVISIONING", + "timeCreated" : "2016-11-22T19:25:42.755Z" + }, { + "id" : "ocid1.autonomousdatabasedataguard.oc1.phx.", + "autonomousDatabaseId" : "ocid1.autonomousdatabase.oc1.phx.", + "role" : "STANDBY", + "peerRole" : "PRIMARY", + "peerAutonomousDatabaseId" : "ocid1.autonomousdatabase.oc1.phx.", + "lifecycleDetails" : null, + "lifecycleState" : "AVAILABLE", + "timeCreated" : "2016-11-22T19:25:30.755Z" + }] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListAutonomousDatabaseDataguardAssociations + tags: + - database + x-example: | + GET /20160918/autonomousDatabases/<autonomousDatabaseId>/autonomousDatabaseDataguardAssociations?limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabaseDataguardAssociation' + /autonomousDatabases/{autonomousDatabaseId}/autonomousDatabaseDataguardAssociations/{autonomousDatabaseDataguardAssociationId}: + get: + description: | + *Deprecated.* Use the [GetAutonomousContainerDatabase](#/en/database/latest/AutonomousContainerDatabase/GetAutonomousContainerDatabase) operation to gets an Autonomous Data Guard-enabled database associated with the specified Autonomous AI Database. + operationId: GetAutonomousDatabaseDataguardAssociation + parameters: + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/AutonomousDatabaseDataguardAssociationIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The Autonomous Data Guard-enabled database associated with the specified Autonomous Data Guard association OCID. + 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 must contact Oracle about + a particular request, then provide the request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousDatabaseDataguardAssociation' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.autonomousdatabasedataguardassocation.oc1.phx.", + "autonomousDatabaseId" : "ocid1.autonomousdatabase.oc1.phx.", + "role" : "STANDBY", + "peerRole" : "PRIMARY", + "peerAutonomousDatabaseId" : "ocid1.autonomousdatabase.oc1.phx.", + "lifecycleDetails" : null, + "lifecycleState" : "AVAILABLE", + "timeCreated" : "2016-11-22T19:25:30.755Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListAutonomousDatabaseDataguardAssociation + tags: + - database + x-example: | + GET /20160918/autonomousDatabases/<autonomousDatabaseId>/autonomousDatabaseDataguardAssociations/<autonomousDatabaseDataguardAssociationId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabaseDataguardAssociation' + /autonomousDatabases/{autonomousDatabaseId}/clones: + get: + description: | + Lists the Autonomous AI Database clones for the specified Autonomous AI Database. + operationId: ListAutonomousDatabaseClones + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/listAutonomousDatabasesFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/listAutonomousDatabasesRefreshableClonesSortByQueryParam' + - $ref: '#/components/parameters/listAutonomousDatabasesFilterByCloneTypeQueryParam' + responses: + '200': + description: The list of Autonomous AI Database clones for the specified Autonomous AI Database was retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListAutonomousDatabaseClonesResponse' + application-json: + examples: + response: + value: | + [{ + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "example_autonomous_database_refreshable_clone", + "id" : "ocid1.autonomousdatabase.oc1.phx.", + "dbName" : "adatabasedb1", + "lifecycleState" : "REFRESHING_READ_ONLY", + "timeCreated" : "2018-03-23T00:59:07.032Z", + "cpuCoreCount" : 8, + "dataStorageSizeInTBs" : 1, + "licenseModel" : "LICENSE_INCLUDED", + "isRefreshableClone" : true, + "serviceConsoleUrl" : "https://adwc.uscom-east-1.oraclecloud.com/console/index.html?tenant_name=iam-ocid1.tenancy.oc1..&database_name=adwdb1" + }, { + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "second_example_autonomous_database_refreshable_clone", + "id" : "ocid1.autonomousdatabase.oc1.phx.", + "dbName" : "adatabasedb2", + "lifecycleState" : "REFRESHING_WHILE_DB_STOPPED", + "timeCreated" : "2018-03-23T01:59:07.032Z", + "cpuCoreCount" : 4, + "dataStorageSizeInTBs" : 100, + "licenseModel" : "LICENSE_INCLUDED", + "isRefreshableClone" : true, + "serviceConsoleUrl" : "https://adwc.uscom-east-1.oraclecloud.com/console/index.html?tenant_name=iam-ocid1.tenancy.oc1..&database_name=adwdb1" + } + ] + '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/DefaultError' + summary: Gets a list of Autonomous AI Database clones. + tags: + - database + x-example: | + GET /20160918/autonomousDatabases/<autonomousDatabaseId>/clones + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/estimateCostSavings: + get: + description: Gets the estimate cost savings of the Autonomous AI Database. + operationId: ListEstimateCostSavings + parameters: + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/IsCpuAutoScaleQueryParam' + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + responses: + '200': + description: List of Cost Estimates. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/EstimateCostSavingsSummaryCollection' + application-json: + examples: + response: + value: | + [ + { "startTime": 1609459200, + "endTime": 1609545600, + "isCpuAutoscale": true, + "estimatedUsageWithoutElasticPool": 120, + "usageWithElasticPool": 90, + "costSavingsWithElasticPool": 0.25 }, + { "startTime": 1609545601, + "endTime": 1609632001, + "cpuAutoscale": true, + "estimatedUsageWithoutElasticPool": 150, + "usageWithElasticPool": 110, + "costSavingsWithElasticPool": 0.30 } + ] + '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/DefaultError' + summary: Gets estimate cost savings of the Autonomous AI Database. + tags: + - database + x-example: | + GET /20160918/autonomousDatabases/<autonomousDatabaseId>/estimateCostSavings + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/peers: + get: + description: | + Lists the Autonomous AI Database peers for the specified Autonomous AI Database. + operationId: ListAutonomousDatabasePeers + parameters: + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + responses: + '200': + description: The list of Autonomous AI Database peers for the specified Autonomous AI Database was retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/AutonomousDatabasePeerCollection' + application-json: + examples: + response: + value: | + { + "items": [ + { + "id": "ocid1.autonomousdatabase.oc1.phx.", + "tenantId": "ocid1.tenancy.oc1.phx." + }, + { + "id": "ocid1.autonomousdatabase.oc1.iad.", + "tenantId": "ocid1.tenancy.oc1.iad." + } + ] + } + '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/DefaultError' + summary: Gets a list of Autonomous AI Database peers. + tags: + - database + x-example: | + GET /20160918/autonomousDatabases/<autonomousDatabaseId>/peers + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/refreshableClones: + get: + description: | + Lists the OCIDs of the Autonomous AI Database local and connected remote refreshable clones with the region where they exist for the specified source database. + operationId: ListAutonomousDatabaseRefreshableClones + parameters: + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + responses: + '200': + description: A list of Autonomous AI Database clone OCIDs and the region where they exist was retrieved for the specified source database. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/RefreshableCloneCollection' + application-json: + examples: + response: + value: | + [ + { + "id" : "ocid1.autonomousdatabase.oc1.phx.", + "region" : "PHX" + }, + { + "id" : "ocid1.autonomousdatabase.oc1.phx.", + "region" : "PHX" + }, + { + "id" : "ocid1.autonomousdatabase.oc1.iad.", + "region" : "IAD" + } + ] + '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/DefaultError' + summary: Gets the list of Autonomous AI Database refreshable clone OCIDs and the region they exist. + tags: + - database + x-example: | + GET /20160918/autonomousDatabases/<autonomousDatabaseId>/listRefreshableClones + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/resourcePoolMembers: + get: + description: | + Lists the OCIDs of the Autonomous AI Database resource pool members for the specified Autonomous AI Database leader. + operationId: ListResourcePoolMembers + parameters: + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + responses: + '200': + description: A list of Autonomous AI Database resource pool member OCIDs was retrieved for the specified Autonomous AI Database leader. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ResourcePoolMemberCollection' + application-json: + examples: + response: + value: | + [ + { + "id" : "ocid1.autonomousdatabase.oc1.phx." + }, + { + "id" : "ocid1.autonomousdatabase.oc1.phx." + }, + { + "id" : "ocid1.autonomousdatabase.oc1.iad." + } + ] + '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/DefaultError' + summary: Lists the OCIDs of the Autonomous AI Database resource pool members for the specified Autonomous AI Database leader. + tags: + - database + x-example: | + GET /20160918/autonomousDatabases/<autonomousDatabaseId>/resourcePoolMembers + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabase' + /autonomousDatabases/{autonomousDatabaseId}/wallet: + get: + description: | + Gets the wallet details for the specified Autonomous AI Database. + operationId: GetAutonomousDatabaseWallet + parameters: + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The wallet details for the specified Autonomous AI Database are being retrieved. + 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/AutonomousDatabaseWallet' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Get the wallet for the specified Autonomous AI Database. + tags: + - database + x-example: | + GET /20160918/autonomousDatabases/<autonomousDatabaseId>/wallet + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousDatabaseWallet' + put: + description: | + Updates the wallet for the specified Autonomous AI Database. + operationId: UpdateAutonomousDatabaseWallet + parameters: + - $ref: '#/components/parameters/autonomousDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAutonomousDatabaseWalletDetails' + description: Request to update the properties of an Autonomous AI Database wallet. + required: true + responses: + '202': + description: The request was successfully received and the wallet rotation is in progress. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application-json: + examples: + response: + value: | + { + "timeWalletRotated" : "2019-06-23T00:59:07.032Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Updates the wallet for the specified Autonomous AI Database. + tags: + - database + x-example: | + PUT /latest/autonomousDatabases/<autonomousDatabaseId>/wallet + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "gracePeriod" : 1, + "shouldRotate" : true + } + x-related-resource: '#/definitions/AutonomousDatabaseWallet' + /autonomousDbPreviewVersions: + get: + description: | + Gets a list of supported Autonomous AI Database versions. Note that preview version software is only available for + Autonomous AI Database Serverless (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) databases. + operationId: ListAutonomousDbPreviewVersions + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/listAutonomousDbPreviewVersionSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: Supported Autonomous AI Database versions. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListAutonomousDbPreviewVersionsResponse' + application-json: + examples: + response: + value: | + [ + { + "version" : "18.4.0.0", + "previewBeginDate" : "2019-04-23T01:59:07.030Z", + "previewEndDate" : "2019-07-23T01:59:07.030Z", + "details" : "2019-04-23T01:59:07.030Z", + "dbWorkload" : "DW" + } + ] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Gets a list of supported Autonomous AI Database versions. + tags: + - database + x-example: | + GET /20160918/autonomousDbPreviewVersions?compartmentId=<compartmentId>&limit=100 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-authz-declarations: + authorizationRequired: false + /autonomousDbVersions: + get: + description: Gets a list of supported Autonomous AI Database versions. + operationId: ListAutonomousDbVersions + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/listAutonomousDatabasesFilterByDbWorkloadQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: Supported Autonomous AI Database versions. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListAutonomousDbVersionsResponse' + application-json: + examples: + response: + value: | + [ + { + "version" : "18.4.0.0", + "dbWorkload" : "DW", + "isDedicated" : false + ,"isFreeTierEnabled" : false + ,"isPaidEnabled" : true, + "isDefaultForFree" : false, + "isDefaultForPaid" : true + } + ] + '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/DefaultError' + summary: Gets a list of supported Autonomous AI Database versions. + tags: + - database + x-example: | + GET /20160918/autonomousDbVersions?compartmentId=<compartmentId>&limit=100 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-authz-declarations: + authorizationRequired: false + /autonomousExadataInfrastructureShapes: + get: + description: | + **Deprecated.** + operationId: ListAutonomousExadataInfrastructureShapes + parameters: + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: Supported Autonomous Exadata Infrastructure system shapes. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListAutonomousExadataInfrastructureShapesResponse' + application-json: + examples: + response: + value: | + [{ + "availableCoreCount" : 84, + "shape" : "Exadata.Quarter1.84" + }, { + "availableCoreCount" : 168, + "shape" : "Exadata.Half1.168" + }, { + "availableCoreCount" : 336, + "shape" : "Exadata.Full1.336" + }] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListAutonomousExadataInfrastructureShapes + tags: + - database + x-example: | + GET /20160918/autonomousExadataInfrastructureShapes?availabilityDomain=<availabilityDomain>&compartmentId=<compartmentId>&limit=100 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-authz-declarations: + authorizationRequired: false + /autonomousExadataInfrastructures: + get: + description: | + **Deprecated.** Use the [ListCloudExadataInfrastructures](#/en/database/latest/CloudExadataInfrastructure/ListCloudExadataInfrastructures) operation to list Exadata Infrastructures in the Oracle cloud and the [ListCloudAutonomousVmClusters](#/en/database/latest/CloudAutonomousVmCluster/ListCloudAutonomousVmClusters) operation to list Autonomous Exadata VM clusters. + operationId: ListAutonomousExadataInfrastructures + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/ListAutonomousExadataInfrastructuresSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListAutonomousExadataInfrastructuresFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByAvailabilityDomainQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + responses: + '200': + description: A list of all the Autonomous Exadata Infrastructure resources. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListAutonomousExadataInfrastructuresResponse' + application-json: + examples: + response: + value: | + [{ + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1.", + "displayName" : "tst1dbsys", + "domain" : "my.company.com", + "hostname" : "apollo", + "id" : "ocid1.autonomousexadatainfrastructure.oc1.", + "licenseModel" : "LICENSE_INCLUDED", + "lifecycleDetails" : null, + "lifecycleState" : "AVAILABLE", + "shape" : "Exadata.Quarter2.92", + "subnetId" : "ocid1.subnet.oc1.", + "timeCreated" : "2016-11-22T19:25:42.755Z" + }, { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1.", + "displayName" : "tst2dbsys", + "domain" : "my.company.com", + "hostname" : "artemis", + "id" : "ocid1.autonomousexadatainfrastructure.oc1.", + "licenseModel" : "BRING_YOUR_OWN_LICENSE", + "lifecycleDetails" : null, + "lifecycleState" : "AVAILABLE", + "shape" : "Exadata.Full1.336", + "subnetId" : "ocid1.subnet.oc1.", + "timeCreated" : "2016-11-22T19:49:54.146Z" + }] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListAutonomousExadataInfrastructures + tags: + - database + x-example: | + GET /20160918/autonomousExadataInfrastructure?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousExadataInfrastructure' + post: + description: | + **Deprecated** To create a new Autonomous AI Database system on dedicated Exadata Infrastructure, use the [CreateCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/CreateCloudExadataInfrastructure) and [CreateCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/CreateCloudAutonomousVmCluster) operations instead. Note that to create an Autonomous VM cluster, you must have an existing Exadata Infrastructure resource to contain the VM cluster. + operationId: LaunchAutonomousExadataInfrastructure + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LaunchAutonomousExadataInfrastructureDetails' + description: | + **Deprecated.** Use the [CreateCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/CreateCloudExadataInfrastructure) or [CreateCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/CreateCloudAutonomousVmCluster) operations instead. + required: true + responses: + '200': + description: The request was successfully received and the Autonomous Exadata Infrastructure launch is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousExadataInfrastructure' + application-json: + examples: + response: + value: | + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1.", + "displayName" : "tst3dbsys", + "domain" : "my.company.com", + "hostname" : "athena", + "id" : "ocid1.autonomousexadatainfrastructure.oc1.", + "licenseModel" : "LICENSE_INCLUDED", + "lifecycleDetails" : null, + "lifecycleState" : "PROVISIONING", + "shape" : "Exadata.Full1.336", + "subnetId" : "ocid1.subnet.oc1.", + "timeCreated" : "2016-11-23T01:59:07.030Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: LaunchAutonomousExadataInfrastructure + tags: + - database + x-example: | + POST /20160918/autonomousExadataInfrastructure + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1.<unique_ID>", + "displayName" : "tst3dbsys", + "domain" : "my.company.com", + "shape" : "Exadata.Half1.168", + "subnetId" : "ocid1.subnet.oc1.<unique_ID>" + } + /autonomousExadataInfrastructures/{autonomousExadataInfrastructureId}: + delete: + description: | + **Deprecated.** To terminate an Exadata Infrastructure resource in the Oracle cloud, use the [DeleteCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/DeleteCloudExadataInfrastructure) operation. To delete an Autonomous Exadata VM cluster in the Oracle cloud, use the [DeleteCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/DeleteCloudAutonomousVmCluster) operation. + operationId: TerminateAutonomousExadataInfrastructure + parameters: + - $ref: '#/components/parameters/AutonomousExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The request to terminate the Autonomous Exadata Infrastructure was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: TerminateAutonomousExadataInfrastructure + tags: + - database + x-example: | + DELETE /20160918/autonomousExadataInfrastructure/<autonomousExadataInfrastructureId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousExadataInfrastructure' + get: + description: | + **Deprecated.** Use the [GetCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/GetCloudExadataInfrastructure) operation to get details of an Exadata Infrastructure resource and the [GetCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/GetCloudAutonomousVmCluster) operation to get details of an Autonomous Exadata VM cluster. + operationId: GetAutonomousExadataInfrastructure + parameters: + - $ref: '#/components/parameters/AutonomousExadataInfrastructureIdPathParam' + responses: + '200': + description: The Autonomous Exadata Infrastructure details. + 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/AutonomousExadataInfrastructure' + application-json: + examples: + response: + value: | + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1.", + "displayName" : "tst3dbsys", + "domain" : "my.company.com", + "hostname" : "athena", + "id" : "ocid1.autonomousexadatainfrastructure.oc1.", + "licenseModel" : "LICENSE_INCLUDED", + "lifecycleDetails" : null, + "lifecycleState" : "PROVISIONING", + "shape" : "Exadata.Full1.336", + "subnetId" : "ocid1.subnet.oc1.", + "scanDnsName" : "tst3dbsys.my.company.com", + "zoneId" : "ocid1.zone.oc1.", + "timeCreated" : "2016-11-23T01:59:07.030Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetAutonomousExadataInfrastructure + tags: + - database + x-example: | + GET /20160918/autonomousExadataInfrastructure/<autonomousExadataInfrastructureId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + **Deprecated.** Use the [UpdateCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/UpdateCloudExadataInfrastructure) operation to update an Exadata Infrastructure resource and [UpdateCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/UpdateCloudAutonomousVmCluster) operation to update an Autonomous Exadata VM cluster. + operationId: UpdateAutonomousExadataInfrastructure + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/AutonomousExadataInfrastructureIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAutonomousExadataInfrastructureDetails' + description: Request to update the properties of a Autonomous Exadata Infrastructure. + required: true + responses: + '200': + description: The request was successfully received and the Autonomous Exadata Infrastructure update is in-progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousExadataInfrastructure' + application-json: + examples: + response: + value: | + Response to example I: + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1.", + "displayName" : "tst3dbsys", + "domain" : "my.company.com", + "hostname" : "athena", + "id" : "ocid1.autonomousexadatainfrastructure.oc1.", + "lifecycleDetails" : null, + "lifecycleState" : "UPDATING", + "shape" : "Exadata.Full1.336", + "subnetId" : "ocid1.subnet.oc1.", + "timeCreated" : "2016-11-23T01:59:07.030Z" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateAutonomousExadataInfrastructure + tags: + - database + x-example: | + PUT /latest/autonomousExadataInfrastructures/<autonomousExadataInfrastructureId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName" : "new displayname" + } + /autonomousExadataInfrastructures/{autonomousExadataInfrastructureId}/actions/changeCompartment: + post: + description: | + **Deprecated.** Use the [ChangeCloudExadataInfrastructureCompartment](#/en/database/latest/CloudExadataInfrastructure/ChangeCloudExadataInfrastructureCompartment) operation to move an Exadata infrastructure resource to a different compartment and [ChangeCloudAutonomousVmClusterCompartment](#/en/database/latest/CloudAutonomousVmCluster/ChangeCloudAutonomousVmClusterCompartment) operation to move an Autonomous Exadata VM cluster to a different compartment. + For more information, see + [Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes). + operationId: ChangeAutonomousExadataInfrastructureCompartment + parameters: + - $ref: '#/components/parameters/AutonomousExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeCompartmentDetails' + description: Request to move an Autonomous Exadata Infrastructure resource to a different compartment. + required: true + responses: + '202': + description: The request was successfully received and the change compartment action is being performed. + 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 + opc-work-request-id: + description: Unique Oracle-assigned identifier of the work 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeAutonomousExadataInfrastructureCompartment + tags: + - database + x-example: | + POST /20160918/autonomousExadataInfrastructure/<autonomousExadataInfrastructureId>/action/changeCompartment + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid.compartment.oc1..<unique_ID>" + } + x-related-resource: '#/definitions/AutonomousExadataInfrastructure' + /autonomousExadataInfrastructures/{autonomousExadataInfrastructureId}/actions/rotateOrdsCerts: + post: + description: | + **Deprecated.** Use the [RotateCloudAutonomousVmClusterOrdsCerts](#/en/database/latest/CloudAutonomousVmCluster/RotateCloudAutonomousVmClusterOrdsCerts) to rotate Oracle REST Data Services (ORDS) certs for an Autonomous Exadata VM cluster instead. + operationId: RotateOrdsCerts + parameters: + - $ref: '#/components/parameters/AutonomousExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + description: The request was successfully received and the ORDS cert rotation is in progress. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Rotate ORDS certs for Autonomous Exadata Infrastructure. + tags: + - database + x-example: | + POST /20160918/autonomousExadataInfrastructure/<autonomousExadataInfrastructureId>/actions/rotateOrdsCerts + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousExadataInfrastructure' + /autonomousExadataInfrastructures/{autonomousExadataInfrastructureId}/actions/rotateSslCerts: + post: + description: | + **Deprecated.** Use the [RotateCloudAutonomousVmClusterSslCerts](#/en/database/latest/CloudAutonomousVmCluster/RotateCloudAutonomousVmClusterSslCerts) to rotate SSL certs for an Autonomous Exadata VM cluster instead. + operationId: RotateSslCerts + parameters: + - $ref: '#/components/parameters/AutonomousExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + description: The request was successfully received and the SSL cert rotation is in progress. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Rotate SSL certs for Autonomous Exadata Infrastructure. + tags: + - database + x-example: | + POST /20160918/autonomousExadataInfrastructure/<autonomousExadataInfrastructureId>/actions/rotateSslCerts + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousExadataInfrastructure' + /autonomousExadataInfrastructures/{autonomousExadataInfrastructureId}/ocpus: + get: + description: | + Gets details of the available and consumed OCPUs for the specified Autonomous Exadata Infrastructure resource. + operationId: GetExadataInfrastructureOcpus + parameters: + - $ref: '#/components/parameters/AutonomousExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: Details of the available and consumed OCPUs for the specified Autonomous Exadata Infrastructure instance. + 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/OCPUs' + application-json: + examples: + response: + value: | + { + "totalCpu": 92.0, + "consumedCpu": 45.0, + "byWorkloadType": { + "atp": 30.0, + "adw": 15.0 + } + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - database + x-example: | + GET /20160918/autonomousExadataInfrastructure/<autonomousExadataInfrastructureId>/ocpus + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/OCPUs' + /autonomousPatches/{autonomousPatchId}: + get: + description: Gets information about a specific autonomous patch. + operationId: GetAutonomousPatch + parameters: + - $ref: '#/components/parameters/AutonomousPatchIdPathParam' + responses: + '200': + description: The autonomous patch details. + 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 contact Oracle about + a particular request, then you must provide the request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousPatch' + application-json: + examples: + response: + value: | + { + "availableActions" : ["APPLY"], + "description" : "Patch PSU as released on 201611", + "id" : "ocid1.autonomousdbpatch.oc1.phx.", + "lastAction" : "APPLY", + "lifecycleDetails" : "A failure message that can be displayed to the user", + "lifecycleState" : "FAILED", + "timeReleased" : "2017-02-16T01:50:07.0001", + "type" : "BUNDLE", + "version" : "20170127" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetAutonomousPatch + tags: + - database + x-example: | + GET /20160918/autonomousPatch/<autonomousPatch> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousPatch' + /autonomousVirtualMachines: + get: + description: | + Lists the Autonomous Virtual Machines in the specified Autonomous VM Cluster and Compartment. + operationId: ListAutonomousVirtualMachines + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/AutonomousVmClusterIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ListAutonomousVirtualMachinesFilterByLifecycleStateQueryParam' + responses: + '200': + description: The list of autonomous virtual machines. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListAutonomousVirtualMachinesResponse' + application-json: + examples: + response: + value: | + [{ + "id" : "ocid1.autonomousvirtualmachine.oc1.", + "vmName" : "host559086", + "dbServerId" : "ocid1.dbserver.oc1.", + "dbServerDisplayName" : "dbServer-1", + "cpuCoreCount" : "4", + "memorySizeInGBs" : "30", + "dbNodeStorageSizeInGBs" : "60", + "lifecycleState" : "AVAILABLE", + "clientIpAddress" : "10.0.20.14", + "compartmentId" : "ocid1.tenancy.oc1..", + "autonomousVmClusterId" : "ocid1.autonomousvmcluster.oc1." + }] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Gets the list of the Autonomous Virtual Machines. + tags: + - database + x-example: | + GET /20160918/autonomousVirtualMachines?compartmentId=<compartmentId>&autonomousVmClusterId=< autonomousVmClusterId>limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousVirtualMachine' + /autonomousVirtualMachines/{autonomousVirtualMachineId}: + get: + description: | + Gets the details of specific Autonomous Virtual Machine. + operationId: GetAutonomousVirtualMachine + parameters: + - $ref: '#/components/parameters/AutonomousVirtualMachineIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: Autonomous Virtual Machine details. + 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/AutonomousVirtualMachine' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.autonomousvirtualmachine.oc1.", + "vmName" : "host559086", + "dbServerId" : "ocid1.dbserver.oc1.", + "dbServerDisplayName" : "dbServer-1", + "cpuCoreCount" : "4", + "memorySizeInGBs" : "30", + "dbNodeStorageSizeInGBs" : "60", + "lifecycleState" : "AVAILABLE", + "clientIpAddress" : "10.0.20.14", + "compartmentId" : "ocid1.tenancy.oc1..", + "cloudAutonomousVmClusterId" : "ocid1.cloudautonomousvmcluster.oc1.", + "autonomousVmClusterId" : "ocid1.autonomousvmcluster.oc1." + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Gets the details of the specified Autonomous Virtual Machine. + tags: + - database + x-example: | + GET /20160918/autonomousVirtualMachines/<autonomousVirtualMachineId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /autonomousVmClusters: + get: + description: | + Gets a list of Exadata Cloud@Customer Autonomous VM clusters in the specified compartment. To list Autonomous VM Clusters in the Oracle Cloud, see [ListCloudAutonomousVmClusters](#/en/database/latest/CloudAutonomousVmCluster/ListCloudAutonomousVmClusters). + operationId: ListAutonomousVmClusters + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/OptionalExadataInfrastructureIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/ListAutonomousVmClustersSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListAutonomousVmClustersFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The list of Autonomous VM clusters. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListAutonomousVmClustersResponse' + application-json: + examples: + response: + value: | + [ + { + "displayName" : "autonomousVmCluster", + "compartmentId" : "ocid1.tenancy.oc1.", + "lifecycleState" : "PROVISIONING", + "lifecycleDetails" : null, + "timeCreated" : "2018-11-22T19:25:42.755Z", + "licenseModel" : "LICENSE_INCLUDED", + "isLocalBackupEnabled" : "true", + "cpusEnabled" : "4", + "memorySizeInGBs" : "30", + "dbNodeStorageSizeInGBs" : "60", + "dataStorageSizeInTBs" : "84", + "timeZone" : "PST", + "id" : "ocid1.autonomousvmcluster.oc1.", + "exadataInfrastructureId" : "ocid1.exadataInfrastructure.oc1.", + "dbServers" : ["ocid1.dbserver.oc1."], + "vmClusterNetworkId" : "ocid1.vmclusternetwork.oc1." + } + ] + '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/DefaultError' + summary: ListAutonomousVmClusters + tags: + - database + x-example: | + GET /20160918/autonomousVmClusters?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousVmCluster' + post: + description: | + Creates an Autonomous VM cluster for Exadata Cloud@Customer. To create an Autonomous VM Cluster in the Oracle cloud, see [CreateCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/CreateCloudAutonomousVmCluster). + operationId: CreateAutonomousVmCluster + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAutonomousVmClusterDetails' + description: Request to create an Autonomous VM cluster. + required: true + responses: + '200': + description: The request was successfully received and the create Autonomous VM cluster operation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousVmCluster' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.autonomousvmcluster.oc1.", + "compartmentId" : "ocid1.tenancy.oc1.", + "displayName" : "autonomousVmCluster", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "lifecycleState" : "PROVISIONING", + "lifecycleDetails" : null, + "isLocalBackupEnabled" : "true", + "cpusEnabled" : "4", + "memorySizeInGBs" : "30", + "dbNodeStorageSizeInGBs" : "60", + "dataStorageSizeInTBs" : "84", + "exadataInfrastructureId" : "ocid1.exadataInfrastructure.oc1.", + "vmClusterNetworkId" : "ocid1.vmclusternetwork.oc1.", + "licenseModel" : "LICENSE_INCLUDED" + } + '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/DefaultError' + summary: CreateAutonomousVmCluster + tags: + - database + x-example: | + POST /20160918/autonomousVmClusters + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName" : "autonomousVmCluster", + "compartmentId" : "ocid1.tenancy.oc1.<unique_ID>", + "exadataInfrastructureId" : "ocid1.exadataInfrastructure.oc1.<unique_ID>", + "vmClusterNetworkId" : "ocid1.vmclusternetwork.oc1.<unique_ID>", + "licenseModel" : "LICENSE_INCLUDED" + } + /autonomousVmClusters/{autonomousVmClusterId}: + delete: + description: | + Deletes the specified Autonomous VM cluster in an Exadata Cloud@Customer system. To delete an Autonomous VM Cluster in the Oracle cloud, see [DeleteCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/DeleteCloudAutonomousVmCluster). + operationId: DeleteAutonomousVmCluster + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/AutonomousVmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '204': + description: The request to delete the Autonomous VM cluster was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Deletes the specified Autonomous VM cluster. + tags: + - database + x-related-resource: '#/definitions/AutonomousVmCluster' + get: + description: | + Gets information about the specified Autonomous VM cluster for an Exadata Cloud@Customer system. To get information about an Autonomous VM Cluster in the Oracle cloud, see [GetCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/GetCloudAutonomousVmCluster). + operationId: GetAutonomousVmCluster + parameters: + - $ref: '#/components/parameters/AutonomousVmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: Information about the Autonomous VM cluster. + 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/AutonomousVmCluster' + application-json: + examples: + response: + value: | + { + "displayName" : "autonomousVmCluster", + "compartmentId" : "ocid1.tenancy.oc1.", + "lifecycleState" : "PROVISIONING", + "lifecycleDetails" : null, + "timeCreated" : "2018-11-22T19:25:42.755Z", + "licenseModel" : "LICENSE_INCLUDED", + "isLocalBackupEnabled" : "true", + "cpusEnabled" : "4", + "memorySizeInGBs" : "30", + "dbNodeStorageSizeInGBs" : "60", + "dataStorageSizeInTBs" : "84", + "timeZone" : "PST", + "id" : "ocid1.autonomousvmcluster.oc1.", + "exadataInfrastructureId" : "ocid1.exadataInfrastructure.oc1.", + "dbServers" : ["ocid1.dbserver.oc1."], + "vmClusterNetworkId" : "ocid1.vmclusternetwork.oc1." + } + '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/DefaultError' + summary: GetAutonomousVmCluster + tags: + - database + x-example: | + GET /20160918/AutonomousVmClusters/<autonomousVmClusterId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the specified Autonomous VM cluster for the Exadata Cloud@Customer system.To update an Autonomous VM Cluster in the Oracle cloud, see [UpdateCloudAutonomousVmCluster](#/en/database/latest/CloudAutonomousVmCluster/UpdateCloudAutonomousVmCluster). + operationId: UpdateAutonomousVmCluster + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/AutonomousVmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAutonomousVmClusterDetails' + description: Request to update the attributes of an Autonomous VM cluster. + required: true + responses: + '200': + description: The request was successfully received and the Autonomous VM cluster update is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AutonomousVmCluster' + application-json: + examples: + response: + value: | + { + "displayName" : "autonomousVmCluster", + "compartmentId" : "ocid1.tenancy.oc1.", + "lifecycleState" : "UPDATING", + "lifecycleDetails" : null, + "timeCreated" : "2018-11-22T19:25:42.755Z", + "licenseModel" : "BRING_YOUR_OWN_LICENSE", + "isLocalBackupEnabled" : "true", + "cpusEnabled" : "4", + "memorySizeInGBs" : "30", + "dbNodeStorageSizeInGBs" : "60", + "dataStorageSizeInTBs" : "84", + "timeZone" : "PST", + "id" : "ocid1.autonomousvmcluster.oc1.", + "exadataInfrastructureId" : "ocid1.exadataInfrastructure.oc1.", + "vmClusterNetworkId" : "ocid1.vmclusternetwork.oc1." + } + '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/DefaultError' + summary: Updates the specified Autonomous VM cluster. + tags: + - database + x-example: | + PUT /latest/autonomousVmClusters/<autonomousVmClusterId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "licenseModel" : "BRING_YOUR_OWN_LICENSE" + } + /autonomousVmClusters/{autonomousVmClusterId}/acdResourceUsage: + get: + description: | + Gets the list of resource usage details for all the Autonomous Container Database in the specified Autonomous Exadata VM cluster. + operationId: ListAutonomousVmClusterAcdResourceUsage + parameters: + - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' + - $ref: '#/components/parameters/AutonomousVmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + responses: + '200': + description: Gets the list of resource usage details for all the Autonomous Container Database in the specified Autonomous Exadata VM cluster. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListAutonomousVmClusterAcdResourceUsageResponse' + application-json: + examples: + response: + value: | + [ + { "autonomousContainerDatabaseResourceUsage" : { + "displayName": "autonomousContainerDatabase", + "id": "ocid1.autonomousContainerDatabase.oc1.", + "provisionedCpus": 20, + "availableCpus": 100, + "reservedCpus": 0, + "reclaimableCpus": 0, + "usedCpus": 0, + "largestProvisionableAutonomousDatabaseinCpus": 50, + "autonomousContainerDatabaseVmUsage" : [ + { + "displayName" : "autonomousVirtualMachine", + "id" : "autonomousVirtualMachine", + "availableCpus" : 6, + "reclaimableCpus" : 4, + "provisionedCpus" : 4, + "reservedCpus" : 3, + "usedCpus" : 5 + }, + { + "displayName" : "autonomousVirtualMachine", + "id" : "autonomousVirtualMachine", + "availableCpus" : 4, + "reclaimableCpus" : 6, + "provisionedCpus" : 6, + "reservedCpus" : 7, + "usedCpus" : 5 + } + ] + } + } + ] + '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/DefaultError' + summary: ListAutonomousVmClusterAcdResourceUsage + tags: + - database + x-example: | + GET /20160918/AutonomousVmClusters/<autonomousVmClusterId>/acdResourceUsage + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousVmCluster' + /autonomousVmClusters/{autonomousVmClusterId}/actions/changeCompartment: + post: + description: | + Moves an Autonomous VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud@Customer only. For systems in the Oracle cloud, see [ChangeAutonomousVmClusterCompartment](#/en/database/latest/AutonomousVmCluster/ChangeAutonomousVmClusterCompartment). + operationId: ChangeAutonomousVmClusterCompartment + parameters: + - $ref: '#/components/parameters/AutonomousVmClusterIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeAutonomousVmClusterCompartmentDetails' + description: Request to move Autonomous VM cluster to a different compartment + required: true + responses: + '202': + description: The request was successfully received and the change compartment action is being performed. + 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: Unique Oracle-assigned identifier of the work 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/DefaultError' + summary: ChangeAutonomousVmClusterCompartment + tags: + - database + x-related-resource: '#/definitions/AutonomousVmCluster' + /autonomousVmClusters/{autonomousVmClusterId}/actions/restartOrds: + post: + description: | + Restarts Oracle REST Data Services (ORDS) for Autonomous Exadata VM cluster. + operationId: RestartAutonomousVmClusterOrds + parameters: + - $ref: '#/components/parameters/AutonomousVmClusterIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + description: The request was successfully received and the ORDS restart action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: RestartAutonomousVmClusterOrds + tags: + - database + x-related-resource: '#/definitions/AutonomousVmCluster' + /autonomousVmClusters/{autonomousVmClusterId}/actions/rotateOrdsCerts: + post: + description: | + Rotates the Oracle REST Data Services (ORDS) certificates for Autonomous Exadata VM cluster. + operationId: RotateAutonomousVmClusterOrdsCerts + parameters: + - $ref: '#/components/parameters/AutonomousVmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RotateAutonomousVmClusterOrdsCertsDetails' + description: Request to rotate the Oracle REST Data Services (ORDS) certificates on Autonomous Exadata VM cluster. + required: true + responses: + '202': + description: The request was successfully received and the ORDS certificate rotation action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: RotateAutonomousVmClusterOrdsCerts + tags: + - database + x-example: | + POST /20160918/AutonomousVmClusters/<autonomousVmClusterId>/action/rotateOrdsCerts + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "certificateGenerationType": "BYOC", + "certificateId" : "ocid1.certificate.oc1.", + "certificateAuthorityId" : "ocid1.certificateauthority.oc1.", + "caBundleId": "ocid1.cabundle.oc1." + } + x-obmcs-terraform: + actionType: MANAGEMENT_RESOURCE + x-related-resource: '#/definitions/AutonomousVmCluster' + /autonomousVmClusters/{autonomousVmClusterId}/actions/rotateSslCerts: + post: + description: | + Rotates the SSL certificates for Autonomous Exadata VM cluster. + operationId: RotateAutonomousVmClusterSslCerts + parameters: + - $ref: '#/components/parameters/AutonomousVmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RotateAutonomousVmClusterSslCertsDetails' + description: Request to rotate the SSL certificates on Autonomous Exadata VM cluster. + required: true + responses: + '202': + description: The request was successfully received and the SSL certificate rotation action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: RotateAutonomousVmClusterSslCerts + tags: + - database + x-example: | + POST /20160918/AutonomousVmClusters/<autonomousVmClusterId>/action/rotateSslCerts + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "certificateGenerationType": "BYOC", + "certificateId" : "ocid1.certificate.oc1.", + "certificateAuthorityId" : "ocid1.certificateauthority.oc1.", + "caBundleId": "ocid1.cabundle.oc1." + } + x-obmcs-terraform: + actionType: MANAGEMENT_RESOURCE + x-related-resource: '#/definitions/AutonomousVmCluster' + /autonomousVmClusters/{autonomousVmClusterId}/resourceUsage: + get: + description: | + Get the resource usage details for the specified Autonomous Exadata VM cluster. + operationId: GetAutonomousVmClusterResourceUsage + parameters: + - $ref: '#/components/parameters/AutonomousVmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: Get the Autonomous VM cluster resource usage details. + 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/AutonomousVmClusterResourceUsage' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.autonomousVmCluster.oc1.", + "displayName" : "autonomousVmCluster", + "autonomousDataStorageSizeInTBs" : 149, + "dbNodeStorageSizeGb" : 1800, + "memorySizeInGBs" : 1440, + "totalContainerDatabases" : 16, + "availableAutonomousDataStorageSizeInTBs" : 117.442, + "usedAutonomousDataStorageSizeInTBs" : 0.0, + "memoryPerOracleComputeUnitInGBs" : 13, + "totalCpus" : 100, + "availableCpus" : 10, + "reclaimableCpus" : 10, + "provisionedCpus" : 10, + "reservedCpus" : 10, + "provisionableCpus":[ + "1", + "2" + ], + "provisionableAutonomousContainerDatabases" : 10, + "provisionedAutonomousContainerDatabases" : 10, + "nonProvisionableAutonomousContainerDatabases" : 10, + "autonomousVmResourceUsage" : [ + { + "id": "autonomousVmCluster", + "displayName": "autonomousVmCluster", + "usedCpus": 20, + "availableCpus": 20, + "provisionedCpus": 20, + "reservedCpus": 0, + "reclaimableCpus": 0, + "autonomousContainerDatabaseUsage": [{ + "id": "ocid1.autonomousContainerDatabase.oc1.", + "displayName": "autonomousContainerDatabase", + "usedCpus": 20, + "availableCpus": 20, + "provisionedCpus": 20, + "reservedCpus": 0, + "reclaimableCpus": 0 + }] + } + ] + } + '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/DefaultError' + summary: GetAutonomousVmClusterResourceUsage + tags: + - database + x-example: | + GET /20160918/AutonomousVmClusters/<autonomousVmClusterId>/resourceUsage + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AutonomousVmCluster' + /backupDestinations: + get: + description: | + Gets a list of backup destinations in the specified compartment. + operationId: ListBackupDestination + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/FilterByDestinationTypeQueryParam' + responses: + '200': + description: | + List of backup destinations. + headers: + etag: + description: | + For optimistic concurrency control. See `if-match`. + schema: + type: string + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListBackupDestinationResponse' + application-json: + examples: + response: + value: | + { + "id":"ocid1.backupdestination.oc1.phx.", + "displayName":"Recovery Appliance1", + "compartmentId":"ocid1.tenancy.oc1..", + "type":"RECOVERY_APPLIANCE", + "lifecycleState":"ACTIVE", + "vpcusers":[ + "bkupUser1", + "bkupUser2" + ], + "timeCreated" : "2016-11-22T19:25:42.755Z", + "lifecycleDetails": null, + "associatedDatabases":[ + { + "id" : "ocid1.database.oc1.phx.", + "dbName" : "testDb" + }, + { + "id" : "ocid1.database.oc1.phx.", + "dbName" : "testDb1" + } + ] + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListBackupDestination + tags: + - database + x-example: | + GET /20160918/backupDestinations?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/BackupDestinationSummary' + post: + description: | + Creates a backup destination in an Exadata Cloud@Customer system. + operationId: CreateBackupDestination + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBackupDestinationDetails' + description: | + Request to create a new backup destination. + required: true + responses: + '200': + description: | + The request was successfully received and the backup destination is being created. + 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/BackupDestination' + application-json: + examples: + response: + value: | + { + "id":"ocid1.backupdestination.oc1.phx.", + "displayName":"Recovery Appliance1", + "compartmentId":"ocid1.tenancy.oc1..", + "type":"RECOVERY_APPLIANCE", + "lifecycleState":"ACTIVE", + "vpcusers":[ + "bkupUser1", + "bkupUser2" + ], + "timeCreated" : "2016-11-22T19:25:42.755Z", + "lifecycleDetails": null, + "associatedDatabases":[] + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateBackupDestination + tags: + - database + x-example: | + POST /20160918/backupDestinations + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName":"Recovery Appliance1", + "compartmentId":"ocid1.tenancy.oc1.<unique_ID>", + "type":"RECOVERY_APPLIANCE", + "vpcusers":[ + "bkupUser1", + "bkupUser2" + ], + } + /backupDestinations/{backupDestinationId}: + delete: + description: | + Deletes a backup destination in an Exadata Cloud@Customer system. + operationId: DeleteBackupDestination + parameters: + - $ref: '#/components/parameters/BackupDestinationIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '204': + description: | + The request to delete the backup destination was accepted. + 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteBackupDestination + tags: + - database + x-example: | + DELETE /20160918/backupDestinations/<backupDestinationId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/BackupDestination' + get: + description: | + Gets information about the specified backup destination in an Exadata Cloud@Customer system. + operationId: GetBackupDestination + parameters: + - $ref: '#/components/parameters/BackupDestinationIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: | + The backup destination. + 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/BackupDestination' + application-json: + examples: + response: + value: | + { + "id":"ocid1.backupdestination.oc1.phx.", + "displayName":"Recovery Appliance1", + "compartmentId":"ocid1.tenancy.oc1..", + "type":"RECOVERY_APPLIANCE", + "lifecycleState":"ACTIVE", + "vpcusers":[ + "bkupUser1", + "bkupUser2" + ], + "timeCreated" : "2016-11-22T19:25:42.755Z", + "lifecycleDetails": null, + "associatedDatabases":[ + { + "id" : "ocid1.database.oc1.phx.", + "dbName" : "testDb" + }, + { + "id" : "ocid1.database.oc1.phx.", + "dbName" : "testDb1" + } + ] + + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetBackupDestination + tags: + - database + x-example: | + GET /20160918/backupDestinations/<backupDestinationId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + If no database is associated with the backup destination: + - For a RECOVERY_APPLIANCE backup destination, updates the connection string and/or the list of VPC users. + - For an NFS backup destination, updates the NFS location. + operationId: UpdateBackupDestination + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/BackupDestinationIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBackupDestinationDetails' + description: | + For a RECOVERY_APPLIANCE backup destination, request to update the connection string and/or the list of VPC users. + For an NFS backup destination, request to update the NFS location. + required: true + responses: + '200': + description: | + The request was successfully received and the backup destination update is in-progress. + 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/BackupDestination' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Updates the specified backup destination. + tags: + - database + /backupDestinations/{backupDestinationId}/actions/changeCompartment: + post: + description: | + Move the backup destination and its dependent resources to the specified compartment. + For more information, see + [Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes). + operationId: ChangeBackupDestinationCompartment + parameters: + - $ref: '#/components/parameters/BackupDestinationIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeCompartmentDetails' + description: | + Request to move backup destination to a different compartment. + required: true + responses: + '202': + description: | + The request was successfully received and the change compartment action is being performed. + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier of the work 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeBackupDestinationCompartment + tags: + - database + x-example: | + POST /20160918/backupDestinations/<backupDestinationId>/actions/changeCompartment + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid.compartment.oc1..<unique_ID>" + } + x-related-resource: '#/definitions/BackupDestination' + /backups: + get: + description: | + Gets a list of backups based on the `databaseId` or `compartmentId` specified. Either one of these query parameters must be provided. + operationId: ListBackups + parameters: + - $ref: '#/components/parameters/OptionalDatabaseIdQueryParam' + - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalShapeFamilyQueryParam' + - $ref: '#/components/parameters/FilterByDatabaseVersionQueryParam' + - $ref: '#/components/parameters/FilterByBackupTypeQueryParam' + - $ref: '#/components/parameters/ListBackupsFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/TimeExpiryScheduledGreaterThanOrEqualTo' + - $ref: '#/components/parameters/TimeExpiryScheduledLessThan' + - $ref: '#/components/parameters/FilterByBackupDestinationType' + responses: + '200': + description: The list of backups was retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListBackupsResponse' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "databaseId" : "ocid1.database.oc1.phx.", + "displayName" : "Monthly Backup", + "type" : "FULL", + "id" : "ocid1.backup.oc1.phx.", + "lifecycleState" : "CREATING", + "timeStarted" : "2016-11-23T01:59:07.032Z", + "timeEnded" : null, + "retentionPeriodInDays" : 100, + "timeExpiryScheduled" : null, + "backupDestinationType" : "DBRS", + "databaseEdition" : "ENTERPRISE_EDITION", + "databaseSizeInGBs" : 256, + , + "shapeFamily" : "EXADATA" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListBackups + tags: + - database + x-example: | + GET /20160918/databases/backups?databaseId=<databaseId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Backup' + post: + description: | + Creates a new backup in the specified database based on the request parameters you provide. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work. + operationId: CreateBackup + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBackupDetails' + description: Request to create a new database backup. + required: true + responses: + '200': + description: The request was successfully received and the backup operation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Backup' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "databaseId" : "ocid1.database.oc1.phx.", + "displayName" : "Monthly Backup", + "id" : "ocid1.backup.oc1.phx.", + "lifecycleState" : "CREATING", + "timeStarted" : "2016-11-23T01:59:07.032Z", + "timeEnded" : null, + "databaseEdition" : "ENTERPRISE_EDITION", + "databaseSizeInGBs" : 256, + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateBackup + tags: + - database + x-examples: + example1: | + POST /20160918/backups + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "databaseId" : "ocid1.database.oc1.phx.<unique_ID>", + "displayName" : "Monthly Backup" + } + example2: | + POST /20160918/backups + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "databaseId" : "ocid1.database.oc1.phx.<unique_ID>", + "displayName" : "LongTermBackup1" + "retentionPeriodInDays" : 100 + } + example3: | + POST /20160918/backups + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "databaseId" : "ocid1.database.oc1.phx.<unique_ID>", + "displayName" : "LongTermBackup2" + "retentionPeriodInYears" : 5 + } + /backups/{backupId}: + delete: + description: Deletes a full backup. You cannot delete automatic backups using this API. + operationId: DeleteBackup + parameters: + - $ref: '#/components/parameters/BackupIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The request to delete the backup was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteBackup + tags: + - database + x-example: | + DELETE /20160918/backups/<backupId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Backup' + get: + description: Gets information about the specified backup. + operationId: GetBackup + parameters: + - $ref: '#/components/parameters/BackupIdPathParam' + responses: + '200': + description: The database backup information was retrieved. + 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/Backup' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "databaseId" : "ocid1.database.oc1.phx.", + "displayName" : "Monthly Backup", + "type" : "FULL", + "id" : "ocid1.backup.oc1.phx.", + "lifecycleState" : "CREATING", + "timeStarted" : "2016-11-23T01:59:07.032Z", + "timeEnded" : null, + "retentionPeriodInYears" : 5, + "timeExpiryScheduled" : null, + "backupDestinationType" : "DBRS", + "databaseEdition" : "ENTERPRISE_EDITION", + "databaseSizeInGBs" : 256 + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetBackup + tags: + - database + x-example: | + GET /20160918/backups/<backupId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: Updates database backup details. + operationId: UpdateBackup + parameters: + - $ref: '#/components/parameters/BackupIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBackupDetails' + description: Request to update the properties of a Backup. + required: true + responses: + '200': + description: Request to update database backup details is successful. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Backup' + '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/DefaultError' + summary: UpdateBackup + tags: + - database + x-example: | + Example I: + PUT /20160918/backups/<backupId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "retentionPeriodInDays" : 100 + } + x-related-resource: '#/definitions/Backup' + /cloudAutonomousVmClusters: + get: + description: | + Lists Autonomous Exadata VM clusters in the Oracle cloud. For Exadata Cloud@Customer systems, see [ListAutonomousVmClusters](#/en/database/latest/AutonomousVmCluster/ListAutonomousVmClusters). + operationId: ListCloudAutonomousVmClusters + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/OptionalCloudExadataInfrastructureIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/ListCloudAutonomousVmClustersSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListCloudAutonomousVmClustersFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByAvailabilityDomainQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: List of the Autonomous Cloud VM clusters. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListCloudAutonomousVmClustersResponse' + application-json: + examples: + response: + value: | + [ + { + "autonomousDataStoragePercentage": 100.0, + "autonomousDataStorageSizeInTBs": 118.10625, + "availabilityDomain": "OXET:PHX-AD-1", + "availableAutonomousDataStorageSizeInTBs": 0.0, + "availableContainerDatabases": 0, + "availableCpus": 100.0, + "clusterTimeZone": "Etc/UTC", + "compartmentId": "ocid1.tenancy.phx..", + "computeModel": "OCPU", + "cpuCoreCount": 100, + "cpuCoreCountPerNode": 50, + "cpuPercentage": 0.0, + "dataStorageSizeInGBs": 152576.0, + "dataStorageSizeInTBs": 149.0, + "dbNodeStorageSizeInGBs": 1526, + "dbServers": null, + "definedTags": { + "Operators": { + "Created_Time": "2020-06-29T22:59:49.299Z", + "Created_By": "" + } + }, + "description": null, + "displayName": "UIFake5", + "domain": "backupad1.abc.oraclevcn.com", + "exadataStorageInTBsLowestScaledValue": 118.10625, + "freeformTags": {}, + "hostname": "atpd-exa-flleh", + "id": "ocid1.autonomousexainfrastructure.oc1.", + "isMtlsEnabledVmCluster": false, + "licenseModel": "BRING_YOUR_OWN_LICENSE", + "lifecycleState": "AVAILABLE", + "maintenanceWindow": { + "preference": "NO_PREFERENCE" + }, + "maxAcdsLowestScaledValue": 12, + "memoryPerOracleComputeUnitInGBs": 13, + "memorySizeInGBs": 1440, + "nextMaintenanceRunId": "ocid1.dbmaintenancerun.oc1.", + "nodeCount": 2, + "nonProvisionableAutonomousContainerDatabases": 0, + "nsgIds": null, + "ocpuCount": 100.0, + "ocpusLowestScaledValue": 0, + "provisionableAutonomousContainerDatabases": 0, + "provisionedAutonomousContainerDatabases": 0, + "provisionedCpus": 0.0, + "reclaimableCpus": 0.0, + "reservedCpus": 0.0, + "scanListenerPortNonTls": 1521, + "scanListenerPortTls": 2484, + "securityAttributes": {}, + "shape": "Exadata.Quarter3.100", + "subnetId": "ocid1.subnet.oc1.", + "systemTags": {}, + "timeCreated": "2020-06-29T22:59:49.399Z", + "totalContainerDatabases": 12 + },... + ] + '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/DefaultError' + summary: ListCloudAutonomousVmClusters + tags: + - database + x-example: | + GET /20160918/cloudAutonomousVmClusters?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/CloudAutonomousVmCluster' + post: + description: | + Creates an Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see [CreateAutonomousVmCluster](#/en/database/latest/AutonomousVmCluster/CreateAutonomousVmCluster). + operationId: CreateCloudAutonomousVmCluster + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCloudAutonomousVmClusterDetails' + description: Request to create a cloud Autonomous VM cluster. + required: true + responses: + '200': + description: The request to create cloud Autonomous VM cluster was received. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/CloudAutonomousVmCluster' + application-json: + examples: + response: + value: | + { + "autonomousDataStoragePercentage" : 33.07, + "autonomousDataStorageSizeInTBs" : 2.0, + "availabilityDomain" : "OXET:PHX-AD-1", + "availableAutonomousDataStorageSizeInTBs" : 2.0, + "availableContainerDatabases" : 1, + "availableCpus" : 80.0, + "cloudExadataInfrastructureId" : "ocid1.cloudexadatainfrastructure.phx.", + "clusterTimeZone" : "UTC", + "compartmentId" : "ocid1.tenancy.phx..", + "computeModel" : "ECPU", + "cpuCoreCount" : 80, + "cpuCoreCountPerNode" : 20, + "cpuPercentage" : 0.0, + "dataStorageSizeInGBs" : 245760.0, + "dataStorageSizeInTBs" : 2.98828125, + "dbNodeStorageSizeInGBs" : 1362, + "dbServers" : [ "ocid1.dbserver.phx.", "ocid1.dbserver.phx.", "ocid1.dbserver.phx.", "ocid1.dbserver.phx." ], + "definedTags" : { }, + "displayName" : "VMCluster-dk", + "domain" : "dgtestsubnet.priganesvcn.oraclevcn.com", + "exadataStorageInTBsLowestScaledValue" : 2.0, + "freeformTags" : { }, + "hostname" : "host-dkkho", + "id" : "ocid1.cloudautonomousvmcluster.phx.", + "isMtlsEnabledVmCluster" : false, + "licenseModel" : "BRING_YOUR_OWN_LICENSE", + "lifecycleState" : "PROVISIONING", + "maintenanceWindow" : { + "preference" : "NO_PREFERENCE" + }, + "maxAcdsLowestScaledValue" : 1, + "memoryPerOracleComputeUnitInGBs" : 2, + "memorySizeInGBs" : 320, + "nodeCount" : 4, + "nonProvisionableAutonomousContainerDatabases" : 0, + "ocpuCount" : 0.0, + "ocpusLowestScaledValue" : 80, + "provisionableAutonomousContainerDatabases" : 0, + "provisionedAutonomousContainerDatabases" : 0, + "provisionedCpus" : 0.0, + "reclaimableCpus" : 0.0, + "reservedCpus" : 0.0, + "scanListenerPortNonTls" : 1521, + "scanListenerPortTls" : 2484, + "securityAttributes" : { }, + "shape" : "Exadata.X10M", + "subnetId" : "ocid1.subnet.phx.", + "systemTags" : { }, + "timeCreated" : "2024-06-27T14:09:06.900Z", + "totalContainerDatabases" : 1 + } + '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/DefaultError' + summary: CreateCloudAutonomousVmCluster + tags: + - database + x-example: | + POST /20160918/cloudAutonomousVmClusters + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + autonomousDataStorageSizeInTBs: 2, + cloudExadataInfrastructureId: "ocid1.cloudexadatainfrastructure.phx.", + clusterTimeZone: "UTC", + compartmentId: "ocid1.tenancy.phx..", + computeModel: "ECPU", + cpuCoreCountPerNode: 20, + dbServers: ["ocid1.dbserver.phx.",…], + definedTags: {}, + displayName: "VMCluster-dk", + freeformTags: {}, + isMtlsEnabledVmCluster: false, + licenseModel: "BRING_YOUR_OWN_LICENSE", + maintenanceWindowDetails: null, + memoryPerOracleComputeUnitInGBs: 2, + scanListenerPortNonTls: 1521, + scanListenerPortTls: 2484, + subnetId: "ocid1.subnet.phx.", + totalContainerDatabases: 1 + } + /cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}: + delete: + description: | + Deletes the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see [DeleteAutonomousVmCluster](#/en/database/latest/AutonomousVmCluster/DeleteAutonomousVmCluster). + operationId: DeleteCloudAutonomousVmCluster + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/CloudAutonomousVmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '204': + description: Request to delete cloud Autonomous VM cluster was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Deletes the specified cloud VM cluster. + tags: + - database + x-related-resource: '#/definitions/CloudAutonomousVmCluster' + get: + description: | + Gets information about the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Custustomer systems, see [GetAutonomousVmCluster ](#/en/database/latest/AutonomousVmCluster/GetAutonomousVmCluster). + operationId: GetCloudAutonomousVmCluster + parameters: + - $ref: '#/components/parameters/CloudAutonomousVmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: Information about the cloud VM cluster. + 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/CloudAutonomousVmCluster' + application-json: + examples: + response: + value: | + { + "autonomousDataStoragePercentage": 33.07, + "autonomousDataStorageSizeInTBs": 2.0, + "availabilityDomain": "OXET:PHX-AD-1", + "availableAutonomousDataStorageSizeInTBs": 2.0, + "availableContainerDatabases": 1, + "availableCpus": 80.0, + "cloudExadataInfrastructureId": "ocid1.cloudexadatainfrastructure.phx.", + "clusterTimeZone": "UTC", + "compartmentId": "ocid1.tenancy.phx..", + "computeModel": "ECPU", + "cpuCoreCount": 80, + "cpuCoreCountPerNode": 20, + "cpuPercentage": 0.0, + "dataStorageSizeInGBs": 245760.0, + "dataStorageSizeInTBs": 2.98828125, + "dbNodeStorageSizeInGBs": 1362, + "dbServers": [ + "ocid1.dbserver.phx.", + "ocid1.dbserver.phx.", + "ocid1.dbserver.phx.", + "ocid1.dbserver.phx." + ], + "definedTags": {}, + "description": null, + "displayName": "VMCluster-dk", + "domain": "dgtestsubnet.priganesvcn.oraclevcn.com", + "exadataStorageInTBsLowestScaledValue": 2.0, + "freeformTags": {}, + "hostname": "host-dkkho", + "id": "ocid1.cloudautonomousvmcluster.phx.", + "isMtlsEnabledVmCluster": false, + "licenseModel": "BRING_YOUR_OWN_LICENSE", + "lifecycleState": "AVAILABLE", + "maintenanceWindow": { + "preference": "NO_PREFERENCE" + }, + "maxAcdsLowestScaledValue": 1, + "memoryPerOracleComputeUnitInGBs": 2, + "memorySizeInGBs": 320, + "nodeCount": 4, + "nonProvisionableAutonomousContainerDatabases": 0, + "nsgIds": null, + "ocpuCount": 0.0, + "ocpusLowestScaledValue": 80, + "provisionableAutonomousContainerDatabases": 0, + "provisionedAutonomousContainerDatabases": 0, + "provisionedCpus": 0.0, + "reclaimableCpus": 0.0, + "reservedCpus": 0.0, + "scanListenerPortNonTls": 1521, + "scanListenerPortTls": 2484, + "securityAttributes": {}, + "shape": "Exadata.X10M", + "subnetId": "ocid1.subnet.phx.", + "systemTags": {}, + "timeCreated": "2024-06-27T14:09:06.900Z", + "totalContainerDatabases": 1 + } + '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/DefaultError' + summary: GetCloudAutonomousVmCluster + tags: + - database + x-example: | + GET /20160918/cloudAutonomousVmClusters/<cloudAutonomousVmClusterId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see [UpdateAutonomousVmCluster](#/en/database/latest/AutonomousVmCluster/UpdateAutonomousVmCluster). + operationId: UpdateCloudAutonomousVmCluster + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/CloudAutonomousVmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCloudAutonomousVmClusterDetails' + description: Request to update the attributes of a cloud VM cluster. + required: true + responses: + '200': + description: The request was successfully received and the cloud VM cluster update is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/CloudAutonomousVmCluster' + application-json: + examples: + response: + value: | + { + "displayName" : "cloudAutonomousVmCluster", + "compartmentId" : "ocid1.tenancy.oc1.", + "lifecycleState" : "UPDATING", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "nodeCount" : "4", + "licenseModel" : "LICENSE_INCLUDED", + "id" : "ocid1.autonomousvmcluster.oc1.", + "lifecycleDetails" : null, + "cloudExadataInfrastructureId" : "ocid1.cloudExadataInfrastructure.oc1." + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Updates the specified cloud Autonomous VM cluster. + tags: + - database + x-example: | + PUT /latest/cloudAutonomousVmClusters/<cloudAutonomousVmClusterId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "nodeCount" : 10, + "licenseModel" : "LICENSE_INCLUDED" + } + /cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}/acdResourceUsage: + get: + description: | + Gets the list of resource usage details for all the Cloud Autonomous Container Database + in the specified Cloud Autonomous Exadata VM cluster. + operationId: ListCloudAutonomousVmClusterAcdResourceUsage + parameters: + - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' + - $ref: '#/components/parameters/CloudAutonomousVmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + responses: + '200': + description: | + Gets the list of resource usage details for all the Autonomous Container Database + in the specified Cloud Autonomous Exadata VM cluster. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListCloudAutonomousVmClusterAcdResourceUsageResponse' + application-json: + examples: + response: + value: | + [ + { + "autonomousContainerDatabaseVmUsage": [ + { + "displayName": "VM_0", + "id": "ID_0", + "provisionedCpus": 2.0, + "reclaimableCpus": 3.0, + "reservedCpus": 4.0, + "usedCpus": 2.0 + }, + { + "displayName": "VM_1", + "id": "ID_1", + "provisionedCpus": 2.0, + "reclaimableCpus": 3.0, + "reservedCpus": 4.0, + "usedCpus": 2.0 + }, + { + "displayName": "VM_2", + "id": "ID_2", + "provisionedCpus": 2.0, + "reclaimableCpus": 3.0, + "reservedCpus": 4.0, + "usedCpus": 2.0 + }, + { + "displayName": "VM_3", + "id": "ID_3", + "provisionedCpus": 2.0, + "reclaimableCpus": 3.0, + "reservedCpus": 4.0, + "usedCpus": 2.0 + } + ], + "availableCpus": 1.0, + "definedTags": null, + "displayName": "ACD-dk-tested", + "freeformTags": null, + "id": "ocid1.autonomouscontainerdatabase.phx.", + "largestProvisionableAutonomousDatabaseInCpus": 3.0, + "provisionableCpus": [ + 1.0, + 2.0 + ], + "provisionedCpus": 5.0, + "reclaimableCpus": 4.0, + "reservedCpus": 2.0, + "usedCpus": null + } + ] + '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/DefaultError' + summary: ListCloudAutonomousVmClusterAcdResourceUsage + tags: + - database + x-example: | + GET /20160918/cloudAutonomousVmClusters/<cloudAutonomousVmClusterId>/acdResourceUsage + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/CloudAutonomousVmCluster' + /cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}/actions/changeCompartment: + post: + description: | + Moves an Autonomous Exadata VM cluster in the Oracle cloud and its dependent resources to another compartment. For Exadata Cloud@Customer systems, see [ChangeAutonomousVmClusterCompartment](#/en/database/latest/AutonomousVmCluster/ChangeAutonomousVmClusterCompartment). + operationId: ChangeCloudAutonomousVmClusterCompartment + parameters: + - $ref: '#/components/parameters/CloudAutonomousVmClusterIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeCloudAutonomousVmClusterCompartmentDetails' + description: Request to move cloud Autonomous VM cluster to a different compartment + required: true + responses: + '202': + description: The request was successfully received and the change compartment action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeCloudAutonomousVmClusterCompartment + tags: + - database + x-related-resource: '#/definitions/CloudAutonomousVmCluster' + /cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}/actions/restartOrds: + post: + description: | + Restarts Oracle REST Data Services (ORDS) for a cloud Autonomous Exadata VM cluster. + operationId: RestartCloudAutonomousVmClusterOrds + parameters: + - $ref: '#/components/parameters/CloudAutonomousVmClusterIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + description: The request was successfully received and the ORDS restart action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: RestartCloudAutonomousVmClusterOrds + tags: + - database + x-related-resource: '#/definitions/CloudAutonomousVmCluster' + /cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}/actions/rotateOrdsCerts: + post: + description: | + Rotates the Oracle REST Data Services (ORDS) certificates for a cloud Autonomous Exadata VM cluster. + operationId: RotateCloudAutonomousVmClusterOrdsCerts + parameters: + - $ref: '#/components/parameters/CloudAutonomousVmClusterIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RotateCloudAutonomousVmClusterOrdsCertsDetails' + description: Request to rotate the Oracle REST Data Services (ORDS) certificates on Cloud Autonomous Exadata VM cluster. + responses: + '202': + description: The request was successfully received and the ORDS cert rotation action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: RotateCloudAutonomousVmClusterOrdsCerts + tags: + - database + x-related-resource: '#/definitions/CloudAutonomousVmCluster' + /cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}/actions/rotateSslCerts: + post: + description: | + Rotates the SSL certficates for a cloud Autonomous Exadata VM cluster. + operationId: RotateCloudAutonomousVmClusterSslCerts + parameters: + - $ref: '#/components/parameters/CloudAutonomousVmClusterIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RotateCloudAutonomousVmClusterSslCertsDetails' + description: Request to rotate the SSL certificates on Cloud Autonomous Exadata VM cluster. + responses: + '202': + description: The request was successfully received and the SSL cert rotation action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: RotateCloudAutonomousVmClusterSslCerts + tags: + - database + x-related-resource: '#/definitions/CloudAutonomousVmCluster' + /cloudAutonomousVmClusters/{cloudAutonomousVmClusterId}/resourceUsage: + get: + description: | + Get the resource usage details for the specified Cloud Autonomous Exadata VM cluster. + operationId: GetCloudAutonomousVmClusterResourceUsage + parameters: + - $ref: '#/components/parameters/CloudAutonomousVmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: Get the Autonomous Cloud VM cluster resource usage details. + 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/CloudAutonomousVmClusterResourceUsage' + application-json: + examples: + response: + value: | + { + "autonomousDataStorageSizeInTBs": 149.0, + "autonomousVmResourceUsage": [ + { + "autonomousContainerDatabaseUsage": [], + "availableCpus": 2.0, + "displayName": "VM_0", + "id": "id_0", + "provisionedCpus": 4.0, + "reclaimableCpus": 5.0, + "reservedCpus": 6.0, + "usedCpus": 3.0 + }, + { + "autonomousContainerDatabaseUsage": [], + "availableCpus": 2.0, + "displayName": "VM_1", + "id": "id_1", + "provisionedCpus": 4.0, + "reclaimableCpus": 5.0, + "reservedCpus": 6.0, + "usedCpus": 3.0 + }, + { + "autonomousContainerDatabaseUsage": [], + "availableCpus": 2.0, + "displayName": "VM_2", + "id": "id_2", + "provisionedCpus": 4.0, + "reclaimableCpus": 5.0, + "reservedCpus": 6.0, + "usedCpus": 3.0 + }, + { + "autonomousContainerDatabaseUsage": [], + "availableCpus": 2.0, + "displayName": "VM_3", + "id": "id_3", + "provisionedCpus": 4.0, + "reclaimableCpus": 5.0, + "reservedCpus": 6.0, + "usedCpus": 3.0 + } + ], + "availableAutonomousDataStorageSizeInTBs": 88.0, + "availableCpus": 10.0, + "dbNodeStorageSizeInGBs": 677, + "displayName": "VMCluster-dk", + "exadataStorageInTBs": 125.0, + "id": "ocid1.cloudautonomousvmcluster.phx.", + "memoryPerOracleComputeUnitInGBs": 15, + "memorySizeInGBs": 560, + "nonProvisionableAutonomousContainerDatabases": 2, + "provisionableAutonomousContainerDatabases": 5, + "provisionedAutonomousContainerDatabases": 10, + "provisionedCpus": 3.0, + "reclaimableCpus": 4.0, + "reservedCpus": 5.0, + "totalContainerDatabases": 12, + "totalCpus": 92.0, + "usedAutonomousDataStorageSizeInTBs": 25.0, + "usedCpus": 45.0 + } + '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/DefaultError' + summary: GetCloudAutonomousVmClusterResourceUsage + tags: + - database + x-example: | + GET /20160918/cloudAutonomousVmClusters/<cloudAutonomousVmClusterId>/resourceUsage + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/CloudAutonomousVmCluster' + /cloudExadataInfrastructures: + get: + description: | + Gets a list of the cloud Exadata infrastructure resources in the specified compartment. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only. + operationId: ListCloudExadataInfrastructures + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ListCloudExadataInfrastructuresSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListCloudExadataInfrastructuresFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/ListCloudExadataInfrastructuresFilterByClusterPlacementGroupIdQueryParam' + responses: + '200': + description: | + A list of the cloud Exadata infrastructure resources in the specified compartment. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListCloudExadataInfrastructuresResponse' + application-json: + examples: + response: + value: | + [ + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1.", + "displayName" : "tstExaInfra", + "id" : "ocid1.cloudExadataInfrastructure.oc1.", + "lifecycleDetails" : "Resource available", + "lifecycleState" : "AVAILABLE", + "shape" : "Exadata.Full2.336", + "computeCount" : 2, + "storageCount" : 3, + "timeCreated" : "2020-03-04T01:59:07.030Z", + "databaseServerType" : "X11M", + "storageServerType": "X11M-HC-XRMEM", + "computeModel": "ECPU", + "definedFileSystemConfigurations" : [ + { + "mountPoint" : "/u01", + "minSizeGb" : 10, + "isResizable" : true, + "isBackupPartition" : true + }, + { + "mountPoint" : "/var", + "minSizeGb" : 10, + "isResizable" : false, + "isBackupPartition" : false + } + ], + "exascaleConfig" : { + "totalStorageInGBs": 200, + "availableStorageInGBs": 100 + }, + "maintenanceWindow" : null + + } + ] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListCloudExadataInfrastructures + tags: + - database + x-example: | + GET /20160918/cloudExadataInfrastructures?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/CloudExadataInfrastructure' + post: + description: | + Creates a cloud Exadata infrastructure resource. This resource is used to create either an [Exadata Cloud Service](/Content/Database/Concepts/exaoverview.htm) instance or an Autonomous AI Database on dedicated Exadata infrastructure. + operationId: CreateCloudExadataInfrastructure + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCloudExadataInfrastructureDetails' + description: | + Request to create a cloud Exadata infrastructure resource in an [Exadata Cloud Service](/Content/Database/Concepts/exaoverview.htm) instance. + required: true + responses: + '200': + description: | + The request was successfully received and the create cloud Exadata infrastructure operation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/CloudExadataInfrastructure' + application-json: + examples: + response: + value: | + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1.", + "displayName" : "tstExaInfra", + "id" : "ocid1.cloudExadataInfrastructure.oc1.", + "lifecycleDetails" : "Creating resource", + "lifecycleState" : "PROVISIONING", + "shape" : "Exadata.Full2.336", + "computeCount" : 2, + "storageCount" : 3, + "timeCreated" : "2020-03-04T01:59:07.030Z", + "databaseServerType" : "X11M", + "storageServerType": "X11M-HC-XRMEM", + "computeModel": "OCPU", + "exascaleConfig" : { + "totalStorageInGBs": 200, + "availableStorageInGBs": 100 + }, + "maintenanceWindow" : null + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateCloudExadataInfrastructure + tags: + - database + x-example: | + POST /20160918/cloudExadataInfrastructures + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.tenancy.oc1.<unique_ID>", + "displayName" : "tstExaInfra", + "shape" : "Exadata.X8M", + "availabilityDomain" : "OXET:PHX-AD-1", + "databaseServerType" : "X11M", + "storageServerType": "X11M-HC-XRMEM", + "computeCount" : 2, + "storageCount" : 3 + } + /cloudExadataInfrastructures/{cloudExadataInfrastructureId}: + delete: + description: | + Deletes the cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only. + operationId: DeleteCloudExadataInfrastructure + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/CloudExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/isDeleteVmClustersQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '204': + description: The request to delete the cloud Exadata infrastructure resource was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Deletes the specified cloud Exadata infrastructure. + tags: + - database + x-related-resource: '#/definitions/CloudExadataInfrastructure' + get: + description: | + Gets information about the specified cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only. + operationId: GetCloudExadataInfrastructure + parameters: + - $ref: '#/components/parameters/CloudExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The cloud Exadata infrastructure details. + 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/CloudExadataInfrastructure' + application-json: + examples: + response: + value: | + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1.", + "displayName" : "tstExaInfra", + "id" : "ocid1.cloudExadataInfrastructure.oc1.", + "lifecycleDetails" : "Resource available", + "lifecycleState" : "AVAILABLE", + "shape" : "Exadata.Full2.336", + "computeCount" : 2, + "storageCount" : 3, + "timeCreated" : "2020-03-04T01:59:07.030Z", + "databaseServerType" : "X11M", + "storageServerType": "X11M-HC-XRMEM", + "computeModel": "OCPU", + "definedFileSystemConfigurations" : [ + { + "mountPoint" : "/u01", + "minSizeGb" : 10, + "isResizable" : true, + "isBackupPartition" : true + }, + { + "mountPoint" : "/var", + "minSizeGb" : 10, + "isResizable" : false, + "isBackupPartition" : false + } + ], + "exascaleConfig" : { + "totalStorageInGBs": 200, + "availableStorageInGBs": 100 + }, + "maintenanceWindow" : null + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetCloudExadataInfrastructure + tags: + - database + x-example: | + GET /20160918/cloudExadataInfrastructures/<cloudExadataInfrastructureId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the Cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only. + operationId: UpdateCloudExadataInfrastructure + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/CloudExadataInfrastructureIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCloudExadataInfrastructureDetails' + description: Request to update the properties of an cloud Exadata infrastructure resource. + required: true + responses: + '200': + description: | + The request was successfully received and the cloud Exadata infrastructure update is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/CloudExadataInfrastructure' + application-json: + examples: + response: + value: | + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1.", + "displayName" : "tstExaInfra", + "id" : "ocid1.cloudExadataInfrastructure.oc1.", + "lifecycleDetails" : "Updating resource", + "lifecycleState" : "UPDATING", + "shape" : "Exadata.Full2.336", + "computeCount" : 3, + "storageCount" : 4, + "timeCreated" : "2020-03-04T01:59:07.030Z", + "exascaleConfig" : { + "totalStorageInGBs": 200, + "availableStorageInGBs": 100 + }, + "maintenanceWindow" : null + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Updates the specified cloud Exadata Infrastructure resource. + tags: + - database + x-example: | + PUT /20160918/cloudExadataInfrastructures/<cloudExadataInfrastructureId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "computeCount" : 3, + "storageCount" : 4, + "displayName" : "displayName" + } + /cloudExadataInfrastructures/{cloudExadataInfrastructureId}/actions/addStorageCapacity: + post: + description: | + Makes the storage capacity from additional storage servers available for Cloud VM Cluster consumption. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only. + operationId: AddStorageCapacityCloudExadataInfrastructure + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/CloudExadataInfrastructureIdPathParam' + responses: + '200': + description: | + The request was successfully received and the Exadata Cloud infrastructure update is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/CloudExadataInfrastructure' + application-json: + examples: + response: + value: | + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1.", + "displayName" : "testCloudExaInfra", + "id" : "ocid1.cloudExadataInfrastructure.oc1.", + "lifecycleDetails" : "Storage expansion in progress", + "lifecycleState" : "AVAILABLE", + "shape" : "Exadata.QuarterX8M.100", + "storageCount" : 4, + "additionalStorageCount" : 2, + "maxCpuCount": 200, + "memorySizeInGBs": 30, + "maxMemoryInGBs": 200, + "dbNodeStorageSizeInGBs": 60, + "maxDbNodeStorageInGBs": 200, + "dataStorageSizeInTBs": 84.0, + "maxDataStorageInTBs": 200.0, + "timeCreated": "2018-11-23T01:59:07.030Z" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Makes the storage capacity from additional storage servers available for Cloud VM Cluster consumption. Applies to Exadata Cloud instances only. + tags: + - database + x-related-resource: '#/definitions/CloudExadataInfrastructure' + /cloudExadataInfrastructures/{cloudExadataInfrastructureId}/actions/changeCompartment: + post: + description: | + Moves a cloud Exadata infrastructure resource and its dependent resources to another compartment. Applies to Exadata Cloud Service instances and Autonomous AI Database on dedicated Exadata infrastructure only.For more information about moving resources to a different compartment, see [Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes). + operationId: ChangeCloudExadataInfrastructureCompartment + parameters: + - $ref: '#/components/parameters/CloudExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeCloudExadataInfrastructureCompartmentDetails' + description: Request to move cloud Exadata infrastructure resource to a different compartment. + required: true + responses: + '202': + description: The request was successfully received and the change compartment action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeCloudExadataInfrastructureCompartment + tags: + - database + x-related-resource: '#/definitions/CloudExadataInfrastructure' + /cloudExadataInfrastructures/{cloudExadataInfrastructureId}/actions/changeSubscription: + post: + description: | + Associate a cloud Exadata infrastructure with a different subscription. + operationId: ChangeCloudExadataInfrastructureSubscription + parameters: + - $ref: '#/components/parameters/CloudExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeCloudExadataInfrastructureSubscriptionDetails' + description: Associate a cloud Exadata infrastructure with a different subscription. + required: true + responses: + '202': + description: The request was successfully received and the update subscription action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: ChangeCloudExadataInfrastructureSubscription + tags: + - database + x-related-resource: '#/definitions/CloudExadataInfrastructure' + /cloudExadataInfrastructures/{cloudExadataInfrastructureId}/actions/configureExascale: + post: + description: | + Configures Exascale on Cloud exadata infrastructure resource. Applies to Exadata Cloud Service instances only. + operationId: ConfigureExascaleCloudExadataInfrastructure + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/CloudExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigureExascaleCloudExadataInfrastructureDetails' + description: The exascale config details for the Exadata infrastructure with the total storage needed. + required: true + responses: + '200': + description: The Exadata Cloud Infrastructure. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/CloudExadataInfrastructure' + application-json: + examples: + response: + value: | + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1.", + "displayName" : "testCloudExaInfra", + "id" : "ocid1.cloudexadataInfrastructure.oc1.", + "lifecycleDetails" : "Exascale configuration in progress", + "lifecycleState" : "AVAILABLE", + "shape" : "Exadata.QuarterX8M.100", + "storageCount" : 4, + "additionalStorageCount" : 2, + "maxCpuCount": 200, + "memorySizeInGBs": 30, + "maxMemoryInGBs": 200, + "dbNodeStorageSizeInGBs": 60, + "maxDbNodeStorageInGBs": 200, + "dataStorageSizeInTBs": 84.0, + "maxDataStorageInTBs": 200.0, + "timeCreated": "2018-11-23T01:59:07.030Z", + "exascaleConfig" : { + "totalStorageInGBs": 200, + "availableStorageInGBs": 100 + } + } + '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/DefaultError' + summary: Configure exascale on Cloud ExadataInfrastructure. + tags: + - database + x-example: | + POST /20160918/cloudExadataInfrastructures/<cloudExadataInfrastructureId>/actions/configureExascale + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "totalStorageInGBs" : 300 + } + x-obmcs-terraform: + actionType: MANAGEMENT_RESOURCE + x-related-resource: '#/definitions/CloudExadataInfrastructure' + /cloudExadataInfrastructures/{cloudExadataInfrastructureId}/unAllocatedResources: + get: + description: | + Gets unallocated resources information for the specified Cloud Exadata infrastructure. + operationId: GetCloudExadataInfrastructureUnallocatedResources + parameters: + - $ref: '#/components/parameters/CloudExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/OptionalDbServersQueryParam' + responses: + '200': + description: The Cloud Exadata infrastructure unallocated resources details. + 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/CloudExadataInfrastructureUnallocatedResources' + application-json: + examples: + response: + value: | + { + "cloudExadataInfrastructureDisplayName" : "tstExaInfra", + "cloudExadataInfrastructureId" : "ocid1.cloudexadataInfrastructure.oc1.", + "localStorageInGbs": 620, + "ocpus": 20, + "memoryInGBs": 120, + "exadataStorageInTBs": 8.0 + } + '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/DefaultError' + summary: GetCloudExadataInfrastructureUnallocatedResources + tags: + - database + x-example: | + GET /20160918/cloudExadataInfrastructures/<cloudexadataInfrastructureId>/unallocatedResources + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/CloudExadataInfrastructure' + /cloudVmClusters: + get: + description: | + Gets a list of the cloud VM clusters in the specified compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only. + operationId: ListCloudVmClusters + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/OptionalCloudExadataInfrastructureIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/ListCloudVmClustersSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListCloudVmClustersFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: List of the Cloud VM clusters. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListCloudVmClustersResponse' + application-json: + examples: + response: + value: | + [ + { + "displayName" : "cloudVmCluster", + "compartmentId" : "ocid1.tenancy.oc1.", + "lifecycleState" : "PROVISIONING", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "availabilityDomain" : "Uocm:PHX-AD-1", + "subnetId" : "ocid1.subnet.oc1.phx.", + "hostname" : "apollo", + "domain" : "example.com", + "cpuCoreCount" : 4, + "licenseModel" : "LICENSE_INCLUDED", + "isSparseDiskgroupEnabled" : false, + "isLocalBackupEnabled" : true, + "timeZone" : "PST", + "shape" : "Exadata.Full2.336", + "id" : "ocid1.cloudVmCluster.oc1.", + "lifecycleDetails" : "Cloud VM cluster provisioning in progress.", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "cloudExadataInfrastructureId" : "ocid1.cloudExadataInfrastructure.oc1.", + "computeModel": "ECPU", + "fileSystemConfigurationDetails" : [ + { + "mountPoint" : "/u01", + "fileSystemSizeGb" : 10 + }, + { + "mountPoint" : "/var", + "fileSystemSizeGb" : 10 + } + ], + "exascaleDbStorageVaultId": "ocid1.exascaledbstoragevault.oc1.", + "storageManagementType": "EXASCALE", + "giVersion" : "19.0.0.0" + } + ] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListCloudVmClusters + tags: + - database + x-example: | + GET /20160918/cloudVmClusters?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/CloudVmCluster' + post: + description: | + Creates a cloud VM cluster. + operationId: CreateCloudVmCluster + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCloudVmClusterDetails' + description: | + Request to create a cloud VM cluster. Applies to Exadata Cloud Service instances only. See [The New Exadata Cloud Service Resource Model](/iaas/Content/Database/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) for information on this resource type. + required: true + responses: + '200': + description: The request was successfully received and the create cloud VM cluster operation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/CloudVmCluster' + application-json: + examples: + response: + value: | + { + "displayName" : "cloudVmCluster", + "compartmentId" : "ocid1.tenancy.oc1.", + "lifecycleState" : "PROVISIONING", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "availabilityDomain" : "Uocm:PHX-AD-1", + "subnetId" : "ocid1.subnet.oc1.phx.", + "hostname" : "apollo", + "domain" : "example.com", + "cpuCoreCount" : 4, + "licenseModel" : "LICENSE_INCLUDED", + "isSparseDiskgroupEnabled" : false, + "isLocalBackupEnabled" : true, + "timeZone" : "PST", + "shape" : "Exadata.Full2.336", + "id" : "ocid1.cloudVmcluster.oc1.", + "lifecycleDetails" : "Cloud VM cluster provisioning in progress.", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "cloudExadataInfrastructureId" : "ocid1.cloudExadataInfrastructure.oc1.", + "computeModel": "OCPU", + "fileSystemConfigurationDetails" : [ + { + "mountPoint" : "/u01", + "fileSystemSizeGb" : 10 + }, + { + "mountPoint" : "/var", + "fileSystemSizeGb" : 10 + } + ], + "exascaleDbStorageVaultId": "ocid1.exascaledbstoragevault.oc1.", + "storageManagementType": "EXASCALE", + "giVersion" : "19.0.0.0" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateCloudVmCluster + tags: + - database + x-example: | + POST /20160918/cloudVmClusters + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName" : "cloudVmCluster", + "compartmentId" : "ocid1.tenancy.oc1.<unique_ID>", + "cloudExadataInfrastructureId" : "ocid1.cloudExadataInfrastructure.oc1.<unique_ID>", + "cpuCoreCount" : 4, + "sshPublicKeys" : [ "ssh-rsa <public_SSH_key> name@example.com" ], + "licenseModel" : "LICENSE_INCLUDED", + "domain" : "example.com", + "hostname" : "apollo", + "isSparseDiskgroupEnabled" : false, + "isLocalBackupEnabled" : true, + "privateZoneId" : "ocid1.dns-zone.oc1.<unique_ID>", + "exascaleDbStorageVaultId": "ocid1.exascaleDbstoragevault.oc1.", + "storageManagementType": "EXASCALE", + "timeZone" : "PST", + "subnetId" : "ocid1.subnet.oc1.phx.<unique_ID>", + "backupSubnetId" : "ocid1.subnet.oc1.phx.<backup_subnet_unique_ID>", + "giVersion" : "19.0.0.0" + } + /cloudVmClusters/{cloudVmClusterId}: + delete: + description: | + Deletes the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only. + operationId: DeleteCloudVmCluster + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/CloudVmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '204': + description: The request to delete the cloud VM cluster was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Deletes the specified cloud VM cluster. + tags: + - database + x-related-resource: '#/definitions/CloudVmCluster' + get: + description: | + Gets information about the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only. + operationId: GetCloudVmCluster + parameters: + - $ref: '#/components/parameters/CloudVmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: Information about the cloud VM cluster. + 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/CloudVmCluster' + application-json: + examples: + response: + value: | + { + "displayName" : "cloudVmCluster", + "compartmentId" : "ocid1.tenancy.oc1.", + "lifecycleState" : "AVAILABLE", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "availabilityDomain" : "Uocm:PHX-AD-1", + "subnetId" : "ocid1.subnet.oc1.phx.", + "hostname" : "apollo", + "domain" : "example.com", + "cpuCoreCount" : 4, + "lastUpdateHistoryEntryId": "ocid1.cloudvmclusterupdatehistoryentry.oc1.phx.", + "licenseModel" : "LICENSE_INCLUDED", + "isSparseDiskgroupEnabled" : false, + "isLocalBackupEnabled" : true, + "timeZone" : "PST", + "shape" : "Exadata.Full2.336", + "id" : "ocid1.cloudVmCluster.oc1.", + "lifecycleDetails" : "Cloud VM cluster is available.", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "computeModel": "OCPU", + "scanDnsName" : "cloudVmCluster.my.company.com", + "zoneId" : "ocid1.zone.oc1.", + "cloudExadataInfrastructureId" : "ocid1.cloudExadataInfrastructure.oc1.", + "giSoftwareImageId" : "ocid1.databasesoftwareimage.oc1.", + "fileSystemConfigurationDetails" : [ + { + "mountPoint" : "/u01", + "fileSystemSizeGb" : 10 + }, + { + "mountPoint" : "/var", + "fileSystemSizeGb" : 10 + } + ], + "exascaleDbStorageVaultId": "ocid1.exascaledbstoragevault.oc1.", + "storageManagementType": "EXASCALE", + "giVersion" : "19.0.0.0" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetCloudVmCluster + tags: + - database + x-example: | + GET /20160918/cloudVmClusters/<cloudVmClusterId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only. + operationId: UpdateCloudVmCluster + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/CloudVmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCloudVmClusterDetails' + description: Request to update the attributes of a cloud VM cluster. + required: true + responses: + '200': + description: The request was successfully received and the cloud VM cluster update is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/CloudVmCluster' + application-json: + examples: + response: + value: | + { + "displayName" : "cloudVmCluster", + "compartmentId" : "ocid1.tenancy.oc1.", + "lifecycleState" : "UPDATING", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "availabilityDomain" : "Uocm:PHX-AD-1", + "subnetId" : "ocid1.subnet.oc1.phx.", + "hostname" : "apollo", + "domain" : "example.com", + "shape" : "Exadata.Full2.336", + "cpuCoreCount" : 4, + "licenseModel" : "LICENSE_INCLUDED", + "isSparseDiskgroupEnabled" : false, + "isLocalBackupEnabled" : true, + "timeZone" : "PST", + "id" : "ocid1.cloudVmCluster.oc1.", + "lifecycleDetails" : "Cloud VM cluster update in progress.", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "cloudExadataInfrastructureId" : "ocid1.cloudExadataInfrastructure.oc1.", + "fileSystemConfigurationDetails" : [ + { + "mountPoint" : "/u01", + "fileSystemSizeGb" : 10 + }, + { + "mountPoint" : "/var", + "fileSystemSizeGb" : 10 + } + ], + "exascaleDbStorageVaultId" : "ocid1.exascaledbstoragevault.oc1.", + "storageManagementType" : "EXASCALE", + "giVersion" : "19.0.0.0" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Updates the specified cloud VM cluster. + tags: + - database + x-example: | + PUT /20160918/cloudVmClusters/<cloudVmClusterId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "cpuCoreCount" : 10, + "licenseModel" : "LICENSE_INCLUDED" + } + /cloudVmClusters/{cloudVmClusterId}/CloudVmClusterIormConfig: + get: + description: | + Gets the IORM configuration for the specified cloud VM cluster in an Exadata Cloud Service instance. + If you have not specified an IORM configuration, the default configuration is returned. + operationId: GetCloudVmClusterIormConfig + parameters: + - $ref: '#/components/parameters/CloudVmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: An object containing the list of databases in the specified cloud VM cluster and their IORM settings. + 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/ExadataIormConfig' + application-json: + examples: + response: + value: | + { + "lifecycleState": "ENABLED", + "lifecycleDetails": "Successful", + "objective": "AUTO", + "dbPlans": [ + { + "dbName": "default", + "share": 4, + "flashCacheLimit": "1490G" + }, + { + "dbName": "db1", + "share": 5, + "flashCacheLimit": "2048G" + }, + { + "dbName": "db2", + "share": 4, + "flashCacheLimit": "1490G" + }, + { + "dbName": "db3", + "share": 0, + "flashCacheLimit": "0G" + }, + { + "dbName": "db4", + "share": 0, + "flashCacheLimit": "0G" + } + ] + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - database + x-example: | + GET /20160918/cloudVmClusters/<cloudVmClusterId>/CloudVmClusterIormConfig + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/CloudVmCluster' + put: + description: | + Updates the IORM settings for the specified cloud VM cluster in an Exadata Cloud Service instance. + operationId: UpdateCloudVmClusterIormConfig + parameters: + - $ref: '#/components/parameters/CloudVmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + $ref: '#/components/requestBodies/ExadataIormConfigUpdateDetails' + responses: + '200': + description: An object containing the list of databases and their IORM settings. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExadataIormConfig' + application-json: + examples: + response: + value: | + { + "lifecycleState": "ENABLED", + "lifecycleDetails": "Successful", + "objective": "AUTO", + "dbPlans": + [ + { + "dbName": "default", + "share": 4, + "flashCacheLimit": "1490G" + }, + { + "dbName": "db1", + "share": 5, + "flashCacheLimit": "2048G" + }, + { + "dbName": "db2", + "share": 4, + "flashCacheLimit": "1490G" + }, + { + "dbName": "db3", + "share": 0, + "flashCacheLimit": "0G" + }, + { + "dbName": "db4", + "share": 0, + "flashCacheLimit": "0G" + } + ] + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - database + x-example: | + PUT /20160918/cloudVmClusters/<cloudVmClusterId>/CloudVmClusterIormConfig + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/CloudVmCluster' + /cloudVmClusters/{cloudVmClusterId}/actions/addVirtualMachine: + post: + description: | + Add Virtual Machines to the Cloud VM cluster. Applies to Exadata Cloud instances only. + operationId: AddVirtualMachineToCloudVmCluster + parameters: + - $ref: '#/components/parameters/CloudVmClusterIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddVirtualMachineToCloudVmClusterDetails' + description: Request to add Virtual Machines to the Cloud VM cluster. + required: true + responses: + '200': + description: The request was successfully received and the adding Virtual Machines action is being performed. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/CloudVmCluster' + application-json: + examples: + response: + value: | + { + "displayName" : "CloudVmCluster", + "compartmentId" : "ocid1.tenancy.oc1.", + "lifecycleState" : "UPDATING", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "availabilityDomain" : "Uocm:PHX-AD-1", + "subnetId" : "ocid1.subnet.oc1.phx.", + "hostname" : "apollo", + "domain" : "example.com", + "cpuCoreCount" : 10, + "licenseModel" : "LICENSE_INCLUDED", + "timeZone" : "PST", + "shape" : "Exadata.Full2.336", + "id" : "ocid1.cloudvmcluster.oc1.", + "lifecycleDetails" : "Cloud VM cluster update in progress.", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "cloudExadataInfrastructureId" : "ocid1.tenancy.oc1." + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: AddVirtualMachineToCloudVmCluster + tags: + - database + x-example: | + POST /20160918/cloudVmClusters/<cloudVmClusterId>/actions/addVirtualMachine + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "dbServers" : [ + { + "dbServerId" : "ocid1.dbserver.oc1." + }, + { + "dbServerId" : "ocid1.dbserver.oc1." + } + ] + } + x-related-resource: '#/definitions/CloudVmCluster' + /cloudVmClusters/{cloudVmClusterId}/actions/changeCompartment: + post: + description: | + Moves a cloud VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only. + operationId: ChangeCloudVmClusterCompartment + parameters: + - $ref: '#/components/parameters/CloudVmClusterIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeCloudVmClusterCompartmentDetails' + description: Request to move cloud VM cluster to a different compartment + required: true + responses: + '202': + description: The request was successfully received and the change compartment action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeCloudVmClusterCompartment + tags: + - database + x-related-resource: '#/definitions/CloudVmCluster' + /cloudVmClusters/{cloudVmClusterId}/actions/changeSubscription: + post: + description: | + Associate a cloud VM cluster with a different subscription. + operationId: ChangeCloudVmClusterSubscription + parameters: + - $ref: '#/components/parameters/CloudVmClusterIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeCloudVmClusterSubscriptionDetails' + description: Associate a cloud VM cluster with a different subscription. + required: true + responses: + '202': + description: The request was successfully received and the update subscription action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: ChangeCloudVmClusterSubscription + tags: + - database + x-related-resource: '#/definitions/CloudVmCluster' + /cloudVmClusters/{cloudVmClusterId}/actions/registerPkcs: + post: + description: | + Install the PKCS11 driver for given keystore type + operationId: RegisterCloudVmClusterPkcs + parameters: + - $ref: '#/components/parameters/CloudVmClusterIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegisterCloudVmClusterPkcsDetails' + description: Details of registering PKCS11 driver. + required: true + responses: + '202': + description: The request was successfully received and registering pkcs rpm action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: RegisterCloudVmClusterPkcs + tags: + - database + x-example: | + POST /20160918/cloudVmClusters/<cloudVmClusterId>/actions/registerPkcs + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "tdeKeyStoreType" : "AZURE" + } + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/CloudVmCluster' + /cloudVmClusters/{cloudVmClusterId}/actions/removeVirtualMachine: + post: + description: | + Remove Virtual Machines from the Cloud VM cluster. Applies to Exadata Cloud instances only. + operationId: RemoveVirtualMachineFromCloudVmCluster + parameters: + - $ref: '#/components/parameters/CloudVmClusterIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveVirtualMachineFromCloudVmClusterDetails' + description: Request to remove Virtual Machines from the Cloud VM cluster. + required: true + responses: + '200': + description: The request was successfully received and the removing Virtual Machines action is being performed. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/CloudVmCluster' + application-json: + examples: + response: + value: | + { + "displayName" : "vmCluster", + "compartmentId" : "ocid1.tenancy.oc1.", + "lifecycleState" : "UPDATING", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "availabilityDomain" : "Uocm:PHX-AD-1", + "subnetId" : "ocid1.subnet.oc1.phx.", + "hostname" : "apollo", + "domain" : "example.com", + "cpuCoreCount" : 10, + "licenseModel" : "LICENSE_INCLUDED", + "timeZone" : "PST", + "shape" : "Exadata.Full2.336", + "id" : "ocid1.cloudvmcluster.oc1.", + "lifecycleDetails" : "Cloud VM cluster update in progress.", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "cloudExadataInfrastructureId" : "ocid1.tenancy.oc1." + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: RemoveVirtualMachineFromCloudVmCluster + tags: + - database + x-example: | + POST /20160918/cloudVmClusters/<cloudVmClusterId>/actions/removeVirtualMachine + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "dbServers" : [ + { + "dbServerId" : "ocid1.dbserver.oc1." + }, + { + "dbServerId" : "ocid1.dbserver.oc1." + } + ] + } + x-related-resource: '#/definitions/CloudVmCluster' + /cloudVmClusters/{cloudVmClusterId}/actions/unregisterPkcs: + post: + description: | + Uninstall the PKCS11 driver for given keystore type + operationId: UnregisterCloudVmClusterPkcs + parameters: + - $ref: '#/components/parameters/CloudVmClusterIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnregisterCloudVmClusterPkcsDetails' + description: Details of registering PKCS11 driver. + required: true + responses: + '202': + description: The request was successfully received and unregistering pkcs rpm action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: UnregisterCloudVmClusterPkcs + tags: + - database + x-example: | + POST /20160918/cloudVmClusters/<cloudVmClusterId>/actions/unregisterPkcs + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "tdeKeyStoreType" : "AZURE" + } + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/CloudVmCluster' + /cloudVmClusters/{cloudVmClusterId}/updateHistoryEntries: + get: + description: | + Gets the history of the maintenance update actions performed on the specified cloud VM cluster. Applies to Exadata Cloud Service instances only. + operationId: ListCloudVmClusterUpdateHistoryEntries + parameters: + - $ref: '#/components/parameters/CloudVmClusterIdPathParam' + - $ref: '#/components/parameters/FilterByCloudVmClusterUpdateTypeQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The maintenance update history for the specified cloud VM cluster. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListCloudVmClusterUpdateHistoryEntriesResponse' + application-json: + examples: + response: + value: | + [ + { + "updateAction" : "ROLLING_APPLY", + "updateId" : "ocid1.dbpatch.oc1.phx.", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "updateType" : "GI_PATCH", + "lifecycleState" : "IN_PROGRESS", + "lifecycleDetails" : "Update is in progress.", + "timeStarted" : "2017-01-01T07:07:07.007Z", + "timeCompleted" : "2017-01-01T08:07:07.007Z" + }, { + "updateAction" : "ROLLING_APPLY", + "updateId" : "ocid1.dbpatch.oc1.phx.", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "updateType" : "GI_PATCH", + "lifecycleState" : "SUCCEEDED", + "lifecycleDetails" : "Completed successfully.", + "timeStarted" : "2016-12-21T01:59:07.032Z", + "timeCompleted" : "2016-12-21T02:21:07.032Z" + }, { + "updateAction" : "ROLLING_APPLY", + "updateId" : "ocid1.dbpatch.oc1.phx.", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "updateType" : "GI_PATCH", + "lifecycleState" : "FAILED", + "lifecycleDetails" : "Something failed that needs attention.", + "timeStarted" : "2016-11-20T01:23:45.6789Z", + "timeCompleted" : "2016-11-20T01:23:45.6789Z" + } + ] + '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/DefaultError' + summary: ListCloudVmClusterUpdateHistoryEntries + tags: + - database + x-example: | + GET /20160918/cloudVmClusters/<cloudVmClusterId>/updateHistoryEntries?limit=100 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/UpdateHistoryEntry' + /cloudVmClusters/{cloudVmClusterId}/updateHistoryEntries/{updateHistoryEntryId}: + get: + description: | + Gets the maintenance update history details for the specified update history entry. Applies to Exadata Cloud Service instances only. + operationId: GetCloudVmClusterUpdateHistoryEntry + parameters: + - $ref: '#/components/parameters/CloudVmClusterIdPathParam' + - $ref: '#/components/parameters/UpdateHistoryEntryIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The maintenance update history details for the specified update history entry. + 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/UpdateHistoryEntry' + application-json: + examples: + response: + value: | + { + "updateAction" : "ROLLING_APPLY", + "updateId" : "ocid1.dbpatch.oc1.phx.", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "updateType" : "GI_PATCH", + "lifecycleState" : "FAILED", + "lifecycleDetails" : "Something failed that needs attention.", + "timeStarted" : "2016-11-20T01:23:45.6789Z", + "timeCompleted" : "2016-11-20T01:23:45.6789Z" + } + '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/DefaultError' + summary: GetCloudVmClusterUpdateHistoryEntry + tags: + - database + x-example: | + GET /20160918/cloudVmClusters/<cloudVmClusterId>/updateHistoryEntries/<updateHistoryEntryId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/UpdateHistoryEntry' + /cloudVmClusters/{cloudVmClusterId}/updates: + get: + description: | + Lists the maintenance updates that can be applied to the specified cloud VM cluster. Applies to Exadata Cloud Service instances only. + operationId: ListCloudVmClusterUpdates + parameters: + - $ref: '#/components/parameters/CloudVmClusterIdPathParam' + - $ref: '#/components/parameters/FilterByCloudVmClusterUpdateTypeQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: A list of the maintenance update packages. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListCloudVmClusterUpdatesResponse' + application-json: + examples: + response: + value: | + [ + { + "availableActions" : ["ROLLING_APPLY"], + "description" : "Update PSU as released on 201611", + "id" : "ocid1.dbpatch.oc1.phx.", + "lastAction" : "ROLLING_APPLY", + "lifecycleDetails" : "A failure message that can be displayed to the user", + "lifecycleState" : "FAILED", + "timeReleased" : "2017-02-16T01:50:07.0001", + "updateType" : "GI_PATCH", + "version" : "20170127" + }, + { + "availableActions" : ["ROLLING_APPLY"], + "description" : "Update PSU as released on 20170127", + "id" : "ocid1.dbpatch.oc1.phx.", + "lastAction" : "PRECHECK", + "lifecycleDetails" : "Update package is available.", + "lifecycleState" : "AVAILABLE", + "timeReleased" : "2017-02-17T09:20:01.0007", + "updateType" : "GI_PATCH", + "version" : "20170127" + } + ] + '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/DefaultError' + summary: ListCloudVmClusterUpdates + tags: + - database + x-example: | + GET /20160918/cloudVmClusters/<cloudVmClusterId>/updates?limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Update' + /cloudVmClusters/{cloudVmClusterId}/updates/{updateId}: + get: + description: | + Gets information about a specified maintenance update package for a cloud VM cluster. Applies to Exadata Cloud Service instances only. + operationId: GetCloudVmClusterUpdate + parameters: + - $ref: '#/components/parameters/CloudVmClusterIdPathParam' + - $ref: '#/components/parameters/UpdateIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The maintenance update package. + 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/Update' + application-json: + examples: + response: + value: | + { + "description" : "Update PSU as released on 20170127", + "id" : "ocid1.dbpatch.oc1.phx.", + "timeReleased" : "2017-01-16T01:50:07.0001Z", + "updateType" : "GI_PATCH", + "version" : "20170127" + } + '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/DefaultError' + summary: GetCloudVmClusterUpdate + tags: + - database + x-example: | + GET /20160918/cloudVmClusters/<cloudVmClusterId>/updates/<updateId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Update' + /databaseSoftwareImages: + get: + description: | + Gets a list of the database software images in the specified compartment. + operationId: ListDatabaseSoftwareImages + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/ListDatabaseSoftwareImagesSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListDatabaseSoftwareImagesFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/ListDatabaseSoftwareImagesFilterByImageTypeQueryParam' + - $ref: '#/components/parameters/ListDatabaseSoftwareImagesFilterByImageShapeFamilyQueryParam' + - $ref: '#/components/parameters/PatchSetGreaterThanOrEqualToQueryParam' + - $ref: '#/components/parameters/OptionalDatabaseUpgradeSupportedQueryParam' + responses: + '200': + description: Retrieved the list of all the Database software images. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListDatabaseSoftwareImagesResponse' + application-json: + examples: + response: + value: | + [ + { + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "iamge1", + "id" : "ocid1.databasesoftwareimage.oc1.phx.", + "imageShapeFamily" : "VM_BM_SHAPE", + "imageType" : "DATABASE_IMAGE", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails": null, + "timeCreated" : "2016-11-22T19:25:42.755Z" + } + ] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDatabaseSoftwareImages + tags: + - database + x-example: | + Example I: + GET /20160918/databaseSoftwareImages?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DatabaseSoftwareImage' + post: + description: | + create database software image in the specified compartment. + operationId: CreateDatabaseSoftwareImage + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateDatabaseSoftwareImageDetails' + description: Request to create database software image. + required: true + responses: + '200': + description: The request was successfully received and the database software image creation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DatabaseSoftwareImage' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "image1", + "id" : "ocid1.databasesoftwareimage.oc1.phx.", + "imageShapeFamily" : "VM_BM_SHAPE", + "imageType" : "DATABASE_IMAGE", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails": null, + "timeCreated" : "2016-11-22T19:25:42.755Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateDatabaseSoftwareImage + tags: + - database + x-example: | + Example I: + POST /20160918/databaseSoftwareImages + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.tenancy.oc1..<unique_ID>", + "databaseVersion" : "19c", + "displayName" : "image1" + "patchSet" : "19.6.0.0.0" + "databaseSoftwareImageOneoffPatches": "123456, 987654, 246802" + } + /databaseSoftwareImages/{databaseSoftwareImageId}: + delete: + description: Delete a database software image + operationId: DeleteDatabaseSoftwareImage + parameters: + - $ref: '#/components/parameters/DatabaseSoftwareImageIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The request to delete database software image was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteDatabaseSoftwareImage + tags: + - database + x-example: | + DELETE /20160918/databaseSoftwareImages/<databaseSoftwareImageId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DatabaseSoftwareImage' + get: + description: Gets information about the specified database software image. + operationId: GetDatabaseSoftwareImage + parameters: + - $ref: '#/components/parameters/DatabaseSoftwareImageIdPathParam' + responses: + '200': + description: The Database Software Image. + 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/DatabaseSoftwareImage' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "image1", + "id" : "ocid1.databasesoftwareimage.oc1.phx.", + "imageShapeFamily" : "VM_BM_SHAPE", + "imageType" : "DATABASE_IMAGE", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails": null, + "timeCreated" : "2016-11-22T19:25:42.755Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetDatabaseSoftwareImage + tags: + - database + x-example: | + GET /20160918/dbSystems/<databaseSoftwareImageId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: Updates the properties of a Database Software Image, like Display Nmae + operationId: UpdateDatabaseSoftwareImage + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/DatabaseSoftwareImageIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateDatabaseSoftwareImageDetails' + description: Request to update the properties of a DB system. + required: true + responses: + '200': + description: The Database Software Image. + 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/DatabaseSoftwareImage' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "image1", + "id" : "ocid1.databasesoftwareimage.oc1.phx.", + "imageShapeFamily" : "VM_BM_SHAPE", + "imageType" : "DATABASE_IMAGE", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails": null, + "timeCreated" : "2016-11-22T19:25:42.755Z" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateDatabaseSoftwareImage + tags: + - database + x-example: | + Example I: + PUT /latest/databaseSoftwareImages/<databaseSoftwareImageId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName" : "image2" + } + /databaseSoftwareImages/{databaseSoftwareImageId}/actions/changeCompartment: + post: + description: | + Move the Database Software Image and its dependent resources to the specified compartment. + For more information about moving Databse Software Images, see + [Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes). + operationId: ChangeDatabaseSoftwareImageCompartment + parameters: + - $ref: '#/components/parameters/DatabaseSoftwareImageIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeCompartmentDetails' + description: Request to move Database Software Image to a different compartment + required: true + responses: + '202': + description: The request was successfully received and the change compartment action is being performed. + 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 + opc-work-request-id: + description: Unique Oracle-assigned identifier of the work 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeDatabaseSoftwareImageCompartment + tags: + - database + x-example: | + POST /20160918/databaseSoftwareImages/<dbSystemId>/actions/changeCompartment + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid.compartment.oc1..<unique_ID>" + } + x-related-resource: '#/definitions/DatabaseSoftwareImage' + /databases: + get: + description: | + Gets a list of the databases in the specified Database Home. + operationId: ListDatabases + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/DbHomeIdQueryParam' + - $ref: '#/components/parameters/SystemIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/ListDatabasesSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListDatabasesFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDbNameQueryParam' + responses: + '200': + description: The list of the databases was retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListDatabasesResponse' + application-json: + examples: + response: + value: | + [ + { + "compartmentId" : "ocid1.tenancy.oc1..", + "dbHomeId" : "ocid1.dbhome.oc1.oc1.", + "dbSystemId" : "ocid1.dbsystem.oc1.oc1.", + "vmClusterId" : "ocid1.vmcluster.oc1.oc1.", + "dbName" : "myTestDb", + "dbUniqueName" : "myTestDb_oc11cs", + "characterSet" : "AL32UTF8", + "ncharacterSet" : "AL16UTF16", + "id" : "ocid1.database.oc1.oc1.", + "kmsKeyId" : "ocid1.key.oc1.phx.", + "lifecycleState" : "PROVISIONING", + "timeCreated" : "2016-11-23T01:59:07.032Z", + "dbBackupConfig" : { + "recoveryWindowInDays" : 30, + "autoBackupEnabled" : true + }, + } + ] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDatabases + tags: + - database + x-example: | + GET /20160918/databases?compartmentId=<compartmentId>&systemId=<systemId>&dbHomeId=<dbHomeId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Database' + post: + description: | + Creates a new database in the specified Database Home. If the database version is provided, it must match the version of the Database Home. Applies to Exadata and Exadata Cloud@Customer systems. + operationId: CreateDatabase + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateDatabaseBase' + description: Request to create a new database. + required: true + responses: + '200': + description: The request was successfully received and the database create is in-progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Database' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "dbHomeId" : "ocid1.dbhome.oc1.phx.", + "dbName" : "myTestDb", + "dbUniqueName" : "myTestDb_phx1cs", + "characterSet" : "AL32UTF8", + "ncharacterSet" : "AL16UTF16", + "id" : "ocid1.database.oc1.phx.", + "kmsKeyId" : "ocid1.key.oc1.phx.", + "lifecycleState" : "PROVISIONING", + "timeCreated" : "2016-11-23T01:59:07.032Z", + "dbBackupConfig" : { + "recoveryWindowInDays" : 30, + "autoBackupEnabled" : true + } + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateDatabase + tags: + - database + x-example: | + Example I: + POST /20160918/databases + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "dbHomeId" : "ocid1.dbhome.oc1.phx.<unique_ID>", + "source": "NONE", + "database" : { + "adminPassword" : "<password>", + "dbName" : "myTestDb", + "dbBackupConfig" : { + "recoveryWindowInDays" : 30, + "autoBackupEnabled" : true + } + } + , + "kmsKeyId" : "ocid1.key.oc1..<unique_ID>", + "kmsKeyVersionId" : "ocid1.keyversion.oc1..<unique_ID>" + } + Example II: + POST /20160918/databases + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "dbHomeId" : "ocid1.dbhome.oc1.phx.<unique_ID>", + "source": "DB_BACKUP", + "database" : { + "backupId" : "ocid1.backup.oc1.phx.<unique_ID>", + "backupTDEPassword" : "<password>", + "adminPassword" : "<password>" + } + } + Example III: + POST /20160918/databases + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "dbHomeId" : "ocid1.dbhome.oc1.phx.<unique_ID>", + "source": "DATAGUARD", + "database" : { + "databaseAdminPassword": "<password>", + "dbUniqueName": "testUniqueName", + "protectionMode": "MAXIMUM_PERFORMANCE", + "sourceTdeWalletPassword": "<password>", + "isActiveDataGuardEnabled": "TRUE", + "sidPrefix": "testSidPrefix", + "sourceDatabaseId": "ocid1.database.oc1.phx.<unique_ID>", + "transportType": "ASYNC" + } + } + /databases/{databaseId}: + delete: + description: | + Deletes the specified database. Applies only to Exadata systems. + + The data in this database is local to the Exadata system and will be lost when the database is deleted. Oracle recommends that you back up any data in the Exadata system prior to deleting it. You can use the `performFinalBackup` parameter to have the Exadata system database backed up before it is deleted. + operationId: DeleteDatabase + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/PerformFinalBackupParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '204': + description: The request to delete the database was received. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteDatabase + tags: + - database + x-example: | + DELETE /20160918/databases/<databaseId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Database' + get: + description: Gets information about the specified database. + operationId: GetDatabase + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + responses: + '200': + description: The database information was retrieved. + 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/Database' + application-json: + examples: + response: + value: | + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1..", + "dbHomeId" : "ocid1.dbhome.oc1.oc1.", + "dbSystemId" : "ocid1.dbsystem.oc1.oc1.", + "vmClusterId" : "ocid1.vmcluster.oc1.oc1.", + "dbName": "myTestDb", + "characterSet": "AL32UTF8", + "ncharacterSet": "AL16UTF16", + "dbUniqueName": "myTestDb_phx1cs", + "id": "ocid1.database.oc1.oc1.", + "kmsKeyId" : "ocid1.key.oc1.phx.", + "lifecycleState": "PROVISIONING", + "timeCreated": "2016-11-23T01:59:07.032Z", + "dbBackupConfig": { + "recoveryWindowInDays": 30, + "autoBackupEnabled": true + } + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetDatabase + tags: + - database + x-example: | + GET /20160918/databases/<databaseId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Update the specified database based on the request parameters provided. + operationId: UpdateDatabase + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateDatabaseDetails' + description: Request to perform database update. + required: true + responses: + '200': + description: The request was successfully received and the database update is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Database' + application-json: + examples: + response: + value: | + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1..", + "dbHomeId" : "ocid1.dbhome.oc1.phx.", + "dbName" : "myTestDb", + "dbUniqueName" : "myTestDb", + "id" : "ocid1.database.oc1.phx.", + "lifecycleState" : "UPDATING", + "timeCreated" : "2016-11-23T01:59:07.032Z", + "dbBackupConfig": { + "recoveryWindowInDays": 30, + "autoBackupEnabled": true + } + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateDatabase + tags: + - database + x-example: | + PUT /latest/databases/<databaseId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "dbBackupConfig" : + { + "recoveryWindowInDays" : 30, + "autoBackupEnabled" : true + } + } + /databases/{databaseId}/actions/changeEncryptionKeyLocation: + post: + description: Update the encryption key management location for the database + operationId: ChangeEncryptionKeyLocation + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EncryptionKeyLocationDetails' + description: Request to change the source of the encryption key for the database. + required: true + responses: + '202': + description: | + The request was successfully received and the migrate key action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Change encryption key location + tags: + - database + x-example: | + POST /20160918/databases/<databaseId>/actions/changeEncryptionKeyLocation + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "hsmPassword" : "<hsm password>" + } + x-obmcs-terraform: + actionType: UPDATE_FIELD + x-related-resource: '#/definitions/Database' + /databases/{databaseId}/actions/convertToPdb: + post: + description: | + Converts a non-container database to a pluggable database. + operationId: ConvertToPdb + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConvertToPdbDetails' + description: | + Request to convert a non-container database to a pluggable database. + required: true + responses: + '200': + description: The request was successfully received and the action is being performed. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Database' + '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/DefaultError' + summary: ConvertToPdb + tags: + - database + x-example: | + POST /20160918/databases/<databaseId>/actions/convertToPdb + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "convertToPdbTargetDetails" : { + "source" : "NEW_DATABASE", + "cdbName" : "myTestDb", + "cdbAdminPassword" : "<password>", + "nonCdbTdeWalletPassword" : "<password>" + }, + "action" : "PRECHECK" + } + x-related-resource: '#/definitions/Database' + /databases/{databaseId}/actions/disableDatabaseManagement: + post: + description: | + Disables the Database Management service for the database. + operationId: DisableDatabaseManagement + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + description: The request was successfully received and Database Management service is being disabled. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Database' + '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/DefaultError' + summary: Disables the Database Management service for the database. + tags: + - database + x-example: | + POST /20160918/databases/<databaseId>/actions/disableDatabaseManagement + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Database' + /databases/{databaseId}/actions/enableDatabaseManagement: + post: + description: Enables the Database Management service for an Oracle Database located in Oracle Cloud Infrastructure. This service allows the database to access tools including Metrics and Performance hub. Database Management is enabled at the container database (CDB) level. + operationId: EnableDatabaseManagement + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnableDatabaseManagementDetails' + description: Request to enable the Database Management service for an Oracle Database located in Oracle Cloud Infrastructure. + required: true + responses: + '202': + description: The request was successfully received and Database Management is being enabled. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Database' + '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/DefaultError' + summary: Enables the Database Management service for an Oracle Database located in Oracle Cloud Infrastructure. + tags: + - database + x-example: | + Example I - Enable Database Management with TCP protocol: + POST /20160918/databases/<databaseId>/actions/enableDatabaseManagement + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "credentialDetails" : + { + "userName" : "dbUser_1", + "passwordSecretId" : "ocid1.vaultsecret.oc1.phx.amaaaaaaqn2gl2iahl4b5q4u6ux3nhvnznyvjkuu6p7vlgpxt2bnmmmmmmmm" + }, + "privateEndPointId" : "ocid1.dbmanagementprivateendpoint.oc1.phx.amaaaaaaet6wzjya46nhydueyc3p3vtvqg4ubsrpfd4q26wvrjsicqunnnnn", + "managementType" : "BASIC", + "serviceName" : "DB0510_phx23p.sub04302048065.abcd123.oraclevcn.com" + } + x-related-resource: '#/definitions/Database' + /databases/{databaseId}/actions/migrateKey: + post: + description: Changes encryption key management from customer-managed, using the [Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm), to Oracle-managed. + operationId: MigrateVaultKey + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MigrateVaultKeyDetails' + description: Request to change the source of the encryption key for the database. + required: true + responses: + '202': + description: | + The request was successfully received and the migrate key action is being performed. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Database' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Migrate Key + tags: + - database + x-example: | + POST /20160918/databases/<databaseId>/actions/migrateKey + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "primaryKey" : "ocid1.key.oc1.phx.<unique_ID>", + } + x-related-resource: '#/definitions/Database' + /databases/{databaseId}/actions/modifyDatabaseManagement: + post: + description: Updates one or more attributes of the Database Management service for the database. + operationId: ModifyDatabaseManagement + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModifyDatabaseManagementDetails' + description: The data to update one or more attributes of the Database Management Service for the database. + required: true + responses: + '202': + description: The request was successfully received and Database Management configuration is being updated. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Database' + '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/DefaultError' + summary: Updates one or more attributes of the Database Management service for the database. + tags: + - database + x-example: | + POST /20160918/databases/<databaseId>/actions/updateDatabaseManagement + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "credentialDetails" : + { + "userName" : "dbUser_2", + "passwordSecretId" : "ocid1.vaultsecret.oc1.phx.amaaaaaaqn2gl2iahl4b5q4u6ux3nhvnznyvjkuu6p7vlgpxt2bnmmmmmmmm" + }, + "privateEndPointId" : "ocid1.dbmanagementprivateendpoint.oc1.phx.amaaaaaaet6wzjya46nhydueyc3p3vtvqg4ubsrpfd4q26wvrjsicqunnnnn", + "managementType" : "ADVANCED", + "serviceName" : "DB0630_phx23p.sub04302048065.abcd123.oraclevcn.com" + } + x-related-resource: '#/definitions/Database' + /databases/{databaseId}/actions/rescheduleManagedDbSoftwareUpdate: + post: + description: | + Reschedule the Managed Database Software Update + operationId: RescheduleManagedDbSoftwareUpdate + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '202': + description: The request was successfully received and the managed database software update reschedule operation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Database' + application-json: + examples: + response: + value: | + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1..", + "dbHomeId" : "ocid1.dbhome.oc1.phx.", + "dbName" : "myTestDb", + "dbUniqueName" : "myTestDb", + "id" : "ocid1.database.oc1.phx.", + "lifecycleState" : "UPDATING", + "timeCreated" : "2016-11-23T01:59:07.032Z", + "lastRemoteBackupTimestamp" : "2019-02-09T01:59:07.032Z", + "dbBackupConfig": { + "recoveryWindowInDays": 30, + "autoBackupEnabled": true, + "remoteBackupEnabled": true, + "remoteRegion": "FRA" + }, + "managedSoftwareUpdateDetails": { + "isEnrolled": true, + "preferenceDetails": { + "dayOfWeek": ["WEDNESDAY"], + "hourOfDay": 10, + "updateMode": "ROLLING", + "source": "VERSION_SERIES", + "versionSchemeDetails": { + "majorVersion": 23.0.0.0, + "versionPreference": "LATEST" + } + }, + "maintenanceDetails": { + "timeScheduled" : "2025-02-19T10:00:00.000Z", + "state": "SCHEDULED", + "version": "19.26.0.0.0", + "timeOfLastReadinessCheck": null + } + } + } + '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/DefaultError' + summary: RescheduleManagedDbSoftwareUpdate + tags: + - database + x-example: | + POST /20160918/databases/<databaseId>/actions/reschedule + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-terraform: + actionType: MANAGEMENT_RESOURCE + x-related-resource: '#/definitions/Database' + /databases/{databaseId}/actions/restore: + post: + description: | + Restore a Database based on the request parameters you provide. + operationId: RestoreDatabase + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RestoreDatabaseDetails' + description: Request to perform database restore. + required: true + responses: + '200': + description: The request was successfully received and the Database restore is in-progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Database' + application-json: + examples: + response: + value: | + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1..", + "dbHomeId" : "ocid1.dbhome.oc1.phx.", + "dbName" : "myTestDb", + "dbUniqueName" : "myTestDb", + "id" : "ocid1.database.oc1.phx.", + "lifecycleState" : "UPDATING", + "timeCreated" : "2016-11-23T01:59:07.032Z", + "dbBackupConfig" : { + "recoveryWindowInDays" : 30, + "autoBackupEnabled" : true + } + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: RestoreDatabase + tags: + - database + x-example: | + POST /20160918/databases/<databaseId>/actions/restore + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "restoreDetails" : + { + "databaseSCN" : null, + "timestamp" : null, + "latest" : true + } + } + x-related-resource: '#/definitions/Database' + /databases/{databaseId}/actions/rotateKey: + post: + description: Creates a new version of an existing [Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) key. + operationId: RotateVaultKey + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '202': + description: | + The request was successfully received and the key is being rotated. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Database' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Rotate Key + tags: + - database + x-example: | + POST /20160918/databases/<databaseId>/actions/rotateKey + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Database' + /databases/{databaseId}/actions/upgrade: + post: + description: | + Upgrades the specified Oracle Database instance. + operationId: UpgradeDatabase + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpgradeDatabaseDetails' + description: Request to perform a database upgrade. + required: true + responses: + '200': + description: The request was successfully received and the action is being performed. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Database' + '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/DefaultError' + summary: UpgradeDatabase + tags: + - database + x-example: | + POST /20160918/databases/<databaseId>/actions/upgrade + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "databaseUpgradeSourceDetails" : { + "dbVersion" : "19.7.0.0", + "source" : "DB_VERSION" + }, + "action" : "PRECHECK" + } + x-related-resource: '#/definitions/Database' + /databases/{databaseId}/dataGuard/actions/convertToStandalone: + post: + description: | + Disassociate the standby database identified by the `databaseId` parameter from existing Data Guard group. + + Convert the standby to a standalone database. + + This operation should be performed on respective standby database. + operationId: ConvertToStandalone + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConvertToStandaloneDetails' + description: A request to update an existing Data Guard member. + required: true + responses: + '202': + description: The request was accepted for processing. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Database' + application-json: + examples: + response: + value: | + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1..", + "dbHomeId" : "ocid1.dbhome.oc1.phx.", + "dbName" : "myTestDb", + "dbUniqueName" : "myTestDb", + "id" : "ocid1.database.oc1.phx.", + "lifecycleState" : "UPDATING", + "timeCreated" : "2016-11-23T01:59:07.032Z", + "lastRemoteBackupTimestamp" : "2019-02-09T01:59:07.032Z", + "dbBackupConfig" : { + "recoveryWindowInDays" : 30, + "autoBackupEnabled" : true, + "remoteBackupEnabled" : true, + "remoteRegion" : "FRA" + } + } + '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/DefaultError' + summary: Convert a standby database to a standalone database. + tags: + - database + x-example: | + POST /20160918/databases/<databaseId>/dataGuard/actions/convertToStandalone + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "databaseAdminPassword" : "<password>" + } + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/Database' + /databases/{databaseId}/dataGuard/actions/failover: + post: + description: | + Performs a failover to transition the standby database identified by the `databaseId` path parameter into the + primary role after the existing primary database fails or becomes unreachable. + + A failover might result in data loss depending on the protection mode in effect at the time of the primary + database failure. + + This operation should be performed on respective standby database. + operationId: FailoverDataGuard + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FailoverDataGuardDetails' + description: A request to update an existing Data Guard member. + required: true + responses: + '202': + description: The request was accepted for processing. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Database' + application-json: + examples: + response: + value: | + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1..", + "dbHomeId" : "ocid1.dbhome.oc1.phx.", + "dbName" : "myTestDb", + "dbUniqueName" : "myTestDb", + "id" : "ocid1.database.oc1.phx.", + "lifecycleState" : "UPDATING", + "timeCreated" : "2016-11-23T01:59:07.032Z", + "lastRemoteBackupTimestamp" : "2019-02-09T01:59:07.032Z", + "dbBackupConfig" : { + "recoveryWindowInDays" : 30, + "autoBackupEnabled" : true, + "remoteBackupEnabled" : true, + "remoteRegion" : "FRA" + }, + "dataGuardGroup" : { + "protectionMode": "MAXIMUM_PERFORMANCE", + "members": [ + { + "dbSystemId": "ocid1.dbsystem.oc1.phx.<unique_ID>", + "dbHomeId": "ocid1.dbhome.oc1.phx.<unique_ID>", + "databaseId": "ocid1.dbsystem.oc1.phx.<unique_ID>", + "role": "PRIMARY" + }, + { + "dbSystemId": "ocid1.dbsystem.oc1.phx.<unique_ID>", + "dbHomeId": "ocid1.dbhome.oc1.phx.<unique_ID>", + "databaseId": "ocid1.dbsystem.oc1.phx.<unique_ID>", + "role": "STANDBY", + "applyLag": "0 seconds", + "transportLag": "0 seconds", + "applyRate": "180 Mb per second", + "transportLagRefresh": "2024-01-01 06:24:34 +00:00", + "transportType": "ASYNC", + "isActiveDataguardEnabled": true + } + ] + } + } + '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/DefaultError' + summary: Performs a failover to transition a standby database into the primary database role. + tags: + - database + x-example: | + POST /20160918/databases/<databaseId>/dataGuard/actions/failover + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "databaseAdminPassword" : "<password>" + } + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/Database' + /databases/{databaseId}/dataGuard/actions/reinstate: + post: + description: | + Reinstates the database identified by the `databaseId` parameter into the standby role in a Data Guard association. + + This operation should be performed on disabled standby database. + operationId: ReinstateDataGuard + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ReinstateDataGuardDetails' + description: A request to update an existing Data Guard member. + required: true + responses: + '202': + description: The request was accepted for processing. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Database' + application-json: + examples: + response: + value: | + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1..", + "dbHomeId" : "ocid1.dbhome.oc1.phx.", + "dbName" : "myTestDb", + "dbUniqueName" : "myTestDb", + "id" : "ocid1.database.oc1.phx.", + "lifecycleState" : "UPDATING", + "timeCreated" : "2016-11-23T01:59:07.032Z", + "lastRemoteBackupTimestamp" : "2019-02-09T01:59:07.032Z", + "dbBackupConfig" : { + "recoveryWindowInDays" : 30, + "autoBackupEnabled" : true, + "remoteBackupEnabled" : true, + "remoteRegion" : "FRA" + }, + "dataGuardGroup" : { + "protectionMode": "MAXIMUM_PERFORMANCE", + "members": [ + { + "dbSystemId": "ocid1.dbsystem.oc1.phx.<unique_ID>", + "dbHomeId": "ocid1.dbhome.oc1.phx.<unique_ID>", + "databaseId": "ocid1.dbsystem.oc1.phx.<unique_ID>", + "role": "PRIMARY" + }, + { + "dbSystemId": "ocid1.dbsystem.oc1.phx.<unique_ID>", + "dbHomeId": "ocid1.dbhome.oc1.phx.<unique_ID>", + "databaseId": "ocid1.dbsystem.oc1.phx.<unique_ID>", + "role": "STANDBY", + "applyLag": "0 seconds", + "transportLag": "0 seconds", + "applyRate": "180 Mb per second", + "transportLagRefresh": "2024-01-01 06:24:34 +00:00", + "transportType": "ASYNC", + "isActiveDataguardEnabled": true + } + ] + } + } + '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/DefaultError' + summary: Reinstates a database to a Data Guard association standby role. + tags: + - database + x-example: | + POST /20160918/databases/<databaseId>/dataGuard/actions/reinstate + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "databaseAdminPassword" : "<password>", + "sourceDatabaseId" : "ocid1.dbsystem.oc1.phx.<unique_ID>" + } + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/Database' + /databases/{databaseId}/dataGuard/actions/switchover: + post: + description: | + Performs a switchover to transition primary database of this Data Guard association into a standby role. The + standby database associated with the `dataGuardAssociationId` assumes the primary database role. + + A switchover guarantees no data loss. + + This operation should be performed on respective standby database. + operationId: SwitchOverDataGuard + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SwitchOverDataGuardDetails' + description: A request to update an existing Data Guard member. + required: true + responses: + '202': + description: The request was accepted for processing. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Database' + application-json: + examples: + response: + value: | + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1..", + "dbHomeId" : "ocid1.dbhome.oc1.phx.", + "dbName" : "myTestDb", + "dbUniqueName" : "myTestDb", + "id" : "ocid1.database.oc1.phx.", + "lifecycleState" : "UPDATING", + "timeCreated" : "2016-11-23T01:59:07.032Z", + "lastRemoteBackupTimestamp" : "2019-02-09T01:59:07.032Z", + "dbBackupConfig" : { + "recoveryWindowInDays" : 30, + "autoBackupEnabled" : true, + "remoteBackupEnabled" : true, + "remoteRegion" : "FRA" + }, + "dataGuardGroup" : { + "protectionMode": "MAXIMUM_PERFORMANCE", + "members": [ + { + "dbSystemId": "ocid1.dbsystem.oc1.phx.<unique_ID>", + "dbHomeId": "ocid1.dbhome.oc1.phx.<unique_ID>", + "databaseId": "ocid1.dbsystem.oc1.phx.<unique_ID>", + "role": "PRIMARY" + }, + { + "dbSystemId": "ocid1.dbsystem.oc1.phx.<unique_ID>", + "dbHomeId": "ocid1.dbhome.oc1.phx.<unique_ID>", + "databaseId": "ocid1.dbsystem.oc1.phx.<unique_ID>", + "role": "STANDBY", + "applyLag": "0 seconds", + "transportLag": "0 seconds", + "applyRate": "180 Mb per second", + "transportLagRefresh": "2024-01-01 06:24:34 +00:00", + "transportType": "ASYNC", + "isActiveDataguardEnabled": true + } + ] + } + } + '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/DefaultError' + summary: Performs a switchover to transition the primary database of a Data Guard association into a standby role. + tags: + - database + x-example: | + POST /20160918/databases/<databaseId>/dataGuard/actions/switchover + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "databaseAdminPassword" : "<password>" + } + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/Database' + /databases/{databaseId}/dataGuard/actions/updateDataGuard: + post: + description: | + Update an existing Data Guard member. A Data Guard member represents the replication relationship between the + specified database and a standby database. For more information, see [Using Oracle Data Guard](/Content/Database/Tasks/usingdataguard.htm). + operationId: UpdateDataGuard + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateDataGuardDetails' + description: A request to update an existing Data Guard member. + required: true + responses: + '202': + description: The request was accepted for processing. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Database' + application-json: + examples: + response: + value: | + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1..", + "dbHomeId" : "ocid1.dbhome.oc1.phx.", + "dbName" : "myTestDb", + "dbUniqueName" : "myTestDb", + "id" : "ocid1.database.oc1.phx.", + "lifecycleState" : "UPDATING", + "timeCreated" : "2016-11-23T01:59:07.032Z", + "lastRemoteBackupTimestamp" : "2019-02-09T01:59:07.032Z", + "dbBackupConfig" : { + "recoveryWindowInDays" : 30, + "autoBackupEnabled" : true, + "remoteBackupEnabled" : true, + "remoteRegion" : "FRA" + }, + "dataGuardGroup" : { + "protectionMode": "MAXIMUM_PERFORMANCE", + "members": [ + { + "dbSystemId": "ocid1.dbsystem.oc1.phx.<unique_ID>", + "dbHomeId": "ocid1.dbhome.oc1.phx.<unique_ID>", + "databaseId": "ocid1.dbsystem.oc1.phx.<unique_ID>", + "role": "PRIMARY" + }, + { + "dbSystemId": "ocid1.dbsystem.oc1.phx.<unique_ID>", + "dbHomeId": "ocid1.dbhome.oc1.phx.<unique_ID>", + "databaseId": "ocid1.dbsystem.oc1.phx.<unique_ID>", + "role": "STANDBY", + "applyLag": "0 seconds", + "transportLag": "0 seconds", + "applyRate": "180 Mb per second", + "transportLagRefresh": "2024-01-01 06:24:34 +00:00", + "transportType": "ASYNC", + "isActiveDataguardEnabled": true + } + ] + } + } + '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/DefaultError' + summary: Updates an existing Data Guard member. + tags: + - database + x-example: | + POST /20160918/databases/<databaseId>/dataGuard/actions/updateDataGuard + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "databaseAdminPassword" : "<password>", + "isActiveDataGuardEnabled" : true, + "protectionMode" : "MAXIMUM_PERFORMANCE", + "transportType" : "ASYNC" + } + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/Database' + /databases/{databaseId}/dataGuardAssociations: + get: + description: | + Lists all Data Guard associations for the specified database. + operationId: ListDataGuardAssociations + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + responses: + '200': + description: The list is being retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListDataGuardAssociationsResponse' + application-json: + examples: + response: + value: | + Example I (Primary) + [ + { + "id" : "ocid1.dataguardassociation.oc1.phx.", + "lifecycleState" : "AVAILABLE", + "databaseId" : "ocid1.database.oc1.phx.", + "role" : "primary", + "peerDbSystemId" : "ocid1.dbsystem.oc1.phx.", + "peerDatabaseId" : "ocid1.database.oc1.phx.", + "peerRole" : "standby" + "applyLag" : null, + "applyRate" : null, + "protectionMode" : "MAXIMUM_PERFORMANCE" + }, + { + "id" : "ocid1.dataguardassociation.oc1.phx.", + "lifecycleState" : "AVAILABLE", + "databaseId" : "ocid1.database.oc1.phx.", + "role" : "primary", + "peerDbSystemId" : "ocid1.dbsystem.oc1.phx.", + "peerDatabaseId" : "ocid1.database.oc1.phx.", + "peerRole" : "standby" + "applyLag" : null, + "applyRate" : null, + "protectionMode" : "MAXIMUM_PERFORMANCE" + } + ] + + Example II (Standby) + [ + { + "id" : "ocid1.dataguardassociation.oc1.phx.", + "lifecycleState" : "AVAILABLE", + "databaseId" : "ocid1.database.oc1.phx.", + "role" : "standby", + "peerDbSystemId" : "ocid1.dbsystem.oc1.phx.", + "peerDatabaseId" : "ocid1.database.oc1.phx.", + "peerRole" : "primary" + "applyLag" : "0 seconds", + "applyRate" : "180 Mb per second", + "protectionMode" : "MAXIMUM_PERFORMANCE" + } + ] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Lists all Data Guard associations for the specified database. + tags: + - database + x-example: | + GET /20160918/databases/<databaseId>/dataguardassociations?limit=100 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DataGuardAssociation' + post: + description: | + Creates a new Data Guard association. A Data Guard association represents the replication relationship between the + specified database and a peer database. For more information, see [Using Oracle Data Guard](/Content/Database/Tasks/usingdataguard.htm). + + All Oracle Cloud Infrastructure resources, including Data Guard associations, get an Oracle-assigned, unique ID + called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. + You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the + resource in the Console. For more information, see + [Resource Identifiers](/Content/General/Concepts/identifiers.htm). + operationId: CreateDataGuardAssociation + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateDataGuardAssociationDetails' + description: A request to create a Data Guard association. + required: true + responses: + '200': + description: The request was accepted for processing. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DataGuardAssociation' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.dataguardassociation.oc1.phx.", + "lifecycleState" : "IN_PROGRESS", + "databaseId" : "ocid1.database.oc1.phx.", + "role" : "primary", + "peerDbSystemId" : "ocid1.dbsystem.oc1.phx.", + "peerDatabaseId" : "ocid1.database.oc1.phx.", + "peerRole" : "standby", + "applyLag" : null, + "applyRate" : null, + "protectionMode" : "MAXIMUM_PERFORMANCE", + "transportType" : "ASYNC", + "timeCreated" : "2016-11-22T19:25:42.755Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Creates a Data Guard association. + tags: + - database + x-example: | + POST /20160918/databases/<databaseId>/dataguardassociations + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "databaseAdminPassword" : "<password>" + "protectionMode" : "MAXIMUM_PERFORMANCE" + "creationType" : "ExistingDbSystem" + "transportType" : "ASYNC", + "peerDbSystemId" : "ocid1.dbsystem.oc1.phx.<unique_ID>" + } + /databases/{databaseId}/dataGuardAssociations/{dataGuardAssociationId}: + get: + description: | + Gets the specified Data Guard association's configuration information. + operationId: GetDataGuardAssociation + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/DataGuardAssociationIdPathParam' + responses: + '200': + description: The configuration information is being retrieved. + 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/DataGuardAssociation' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.dataguardassociation.oc1.phx.", + "lifecycleState" : "IN_PROGRESS", + "databaseId" : "ocid1.database.oc1.phx.", + "role" : "primary", + "peerDbSystemId" : "ocid1.dbsystem.oc1.phx.", + "peerDatabaseId" : "ocid1.database.oc1.phx.", + "peerRole" : "standby", + "applyLag" : null, + "applyRate" : null, + "protectionMode" : "MAXIMUM_PERFORMANCE", + "transportType" : "ASYNC", + "timeCreated" : "2016-11-22T19:25:42.755Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Gets configuration information for the specified database and Data Guard association. + tags: + - database + x-example: | + GET /20160918/databases/<databaseId>/dataguardassociations/<dataguardAssociationId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the Data Guard association the specified database. This API can be used to change the `protectionMode` and `transportType` of the Data Guard association. + operationId: UpdateDataGuardAssociation + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/DataGuardAssociationIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateDataGuardAssociationDetails' + description: A request to update Data Guard association of a database. + required: true + responses: + '200': + description: The request was accepted for processing. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DataGuardAssociation' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.dataguardassociation.oc1.phx.", + "lifecycleState" : "IN_PROGRESS", + "databaseId" : "ocid1.database.oc1.phx.", + "role" : "standby", + "peerDbSystemId" : "ocid1.dbsystem.oc1.phx.", + "peerDatabaseId" : "ocid1.database.oc1.phx.", + "peerRole" : "primary", + "applyLag" : "0 seconds", + "applyRate" : "180 Mb per second", + "protectionMode" : "MAXIMUM_PERFORMANCE" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Update Data Guard association of a database. + tags: + - database + x-example: | + PUT /20160918/databases/<databaseId>/update + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DataGuardAssociation' + /databases/{databaseId}/dataGuardAssociations/{dataGuardAssociationId}/actions/failover: + post: + description: | + Performs a failover to transition the standby database identified by the `databaseId` parameter into the + specified Data Guard association's primary role after the existing primary database fails or becomes unreachable. + + A failover might result in data loss depending on the protection mode in effect at the time of the primary + database failure. + operationId: FailoverDataGuardAssociation + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/DataGuardAssociationIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FailoverDataGuardAssociationDetails' + description: A request to perform a failover, transitioning a standby database into a primary database. + required: true + responses: + '200': + description: The request was accepted for processing. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DataGuardAssociation' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.dataguardassociation.oc1.phx.", + "lifecycleState" : "IN_PROGRESS", + "databaseId" : "ocid1.database.oc1.phx.", + "role" : "standby", + "peerDbSystemId" : "ocid1.dbsystem.oc1.phx.", + "peerDatabaseId" : "ocid1.database.oc1.phx.", + "peerRole" : "primary", + "applyLag" : "0 seconds", + "applyRate" : "180 Mb per second", + "protectionMode" : "MAXIMUM_PERFORMANCE" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Performs a failover to transition a standby database into the primary database role. + tags: + - database + x-example: | + POST /20160918/databases/<databaseId>/actions/failover + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DataGuardAssociation' + /databases/{databaseId}/dataGuardAssociations/{dataGuardAssociationId}/actions/migrate: + post: + description: | + Migrates the existing Data Guard association to new Data Guard model to support multiple standby databases functionality. + + This operation should always be performed on primary. + operationId: MigrateDataGuardAssociationToMultiDataGuards + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/DataGuardAssociationIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + description: The request was accepted for processing. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Database' + application-json: + examples: + response: + value: | + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1..", + "dbHomeId" : "ocid1.dbhome.oc1.phx.", + "dbName" : "myTestDb", + "dbUniqueName" : "myTestDb", + "id" : "ocid1.database.oc1.phx.", + "lifecycleState" : "UPDATING", + "timeCreated" : "2016-11-23T01:59:07.032Z", + "lastRemoteBackupTimestamp" : "2019-02-09T01:59:07.032Z", + "dbBackupConfig" : { + "recoveryWindowInDays" : 30, + "autoBackupEnabled" : true, + "remoteBackupEnabled" : true, + "remoteRegion" : "FRA" + }, + "dataGuardGroup" : { + "protectionMode": "MAXIMUM_PERFORMANCE", + "members": [ + { + "dbSystemId": "ocid1.dbsystem.oc1.phx.<unique_ID>", + "dbHomeId": "ocid1.dbhome.oc1.phx.<unique_ID>", + "databaseId": "ocid1.dbsystem.oc1.phx.<unique_ID>", + "role": "PRIMARY" + }, + { + "dbSystemId": "ocid1.dbsystem.oc1.phx.<unique_ID>", + "dbHomeId": "ocid1.dbhome.oc1.phx.<unique_ID>", + "databaseId": "ocid1.dbsystem.oc1.phx.<unique_ID>", + "role": "STANDBY", + "applyLag": "0 seconds", + "transportLag": "0 seconds", + "applyRate": "180 Mb per second", + "transportLagRefresh": "2024-01-01 06:24:34 +00:00", + "transportType": "ASYNC", + "isActiveDataguardEnabled": true + } + ] + } + } + '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/DefaultError' + summary: Enables existing Data Guard to support multiple standby databases. + tags: + - database + x-example: | + POST /20160918/databases/<databaseId>/dataGuardAssociations/<dataGuardAssociationId>/actions/migrate + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/DataGuardAssociation' + /databases/{databaseId}/dataGuardAssociations/{dataGuardAssociationId}/actions/reinstate: + post: + description: | + Reinstates the database identified by the `databaseId` parameter into the standby role in a Data Guard association. + operationId: ReinstateDataGuardAssociation + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/DataGuardAssociationIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ReinstateDataGuardAssociationDetails' + description: A request to reinstate a database in a standby role. + required: true + responses: + '200': + description: The request was accepted for processing. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DataGuardAssociation' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.dataguardassociation.oc1.phx.", + "lifecycleState" : "IN_PROGRESS", + "databaseId" : "ocid1.database.oc1.phx.", + "role" : "standby", + "peerDbSystemId" : "ocid1.dbsystem.oc1.phx.", + "peerDatabaseId" : "ocid1.database.oc1.phx.", + "peerRole" : "primary", + "applyLag" : "0 seconds", + "applyRate" : "180 Mb per second", + "protectionMode" : "MAXIMUM_PERFORMANCE" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Reinstates a database to a Data Guard association standby role. + tags: + - database + x-example: | + POST /20160918/databases/<databaseId>/actions/reinstate + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DataGuardAssociation' + /databases/{databaseId}/dataGuardAssociations/{dataGuardAssociationId}/actions/switchover: + post: + description: | + Performs a switchover to transition the primary database of a Data Guard association into a standby role. The + standby database associated with the `dataGuardAssociationId` assumes the primary database role. + + A switchover guarantees no data loss. + operationId: SwitchoverDataGuardAssociation + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/DataGuardAssociationIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SwitchoverDataGuardAssociationDetails' + description: Request to swtichover a primary to a standby. + required: true + responses: + '200': + description: The request was accepted for processing. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DataGuardAssociation' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.dataguardassociation.oc1.phx.", + "lifecycleState" : "IN_PROGRESS", + "databaseId" : "ocid1.database.oc1.phx.", + "role" : "standby", + "peerDbSystemId" : "ocid1.dbsystem.oc1.phx.", + "peerDatabaseId" : "ocid1.database.oc1.phx.", + "peerRole" : "primary", + "applyLag" : "0 seconds", + "applyRate" : "180 Mb per second", + "protectionMode" : "MAXIMUM_PERFORMANCE" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Performs a switchover to transition the primary database of a Data Guard association into a standby role. + tags: + - database + x-example: | + POST /20160918/databases/<databaseId>/actions/switchover + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DataGuardAssociation' + /databases/{databaseId}/pdbConversionHistoryEntries: + get: + description: | + Gets the pluggable database conversion history for a specified database in a bare metal or virtual machine DB system. + operationId: ListPdbConversionHistoryEntries + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/FilterByPdbConversionActionQueryParam' + - $ref: '#/components/parameters/FilterByPdbConversionLifecycleStateQueryParam' + - $ref: '#/components/parameters/ListPdbConversionHistoryEntriesSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + responses: + '200': + description: The conversion history entries for the specified pluggable database. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListPdbConversionHistoryEntriesResponse' + application-json: + examples: + response: + value: | + [{ + "id" : "ocid1.dbconversionhistory.oc1.phx.abzwkljr7jdmapjf2pcdltavwgsxdct2my5ohnz5ta7sn3zehvmmgrxkk3sq", + "cdbName" : "testDb", + "action" : "PRECHECK", + "lifecycleState" : "SUCCEEDED", + "lifecycleDetails" : null, + "sourceDatabaseId" : "ocid1.database.oc1.phx.", + "targetDatabaseId" : "ocid1.database.oc1.phx.", + "additionalCdbParams" : null, + "timeStarted": "21-04-11T01:59:07.032Z", + "timeEnded": "21-04-11T02:45:07.032Z" + }] + '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/DefaultError' + summary: ListPdbConversionHistoryEntries + tags: + - database + x-example: | + GET /20160918/databases/<databaseId>/pdbConversionHistoryEntries + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Database' + /databases/{databaseId}/pdbConversionHistoryEntries/{pdbConversionHistoryEntryId}: + get: + description: | + Gets the details of operations performed to convert the specified database from non-container (non-CDB) to pluggable (PDB). + operationId: GetPdbConversionHistoryEntry + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/PdbConversionHistoryEntryIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The pluggable database conversion history. + 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/PdbConversionHistoryEntry' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.dbconversionhistory.oc1.phx.abzwkljr7jdmapjf2pcdltavwgsxdct2my5ohnz5ta7sn3zehvmmgrxkk3sq", + "cdbName" : "testDb", + "action" : "PRECHECK", + "lifecycleState" : "SUCCEEDED", + "lifecycleDetails" : null, + "sourceDatabaseId" : "ocid1.database.oc1.phx.", + "targetDatabaseId" : "ocid1.database.oc1.phx.", + "additionalCdbParams" : null, + "timeStarted": "21-04-11T01:59:07.032Z", + "timeEnded": "21-04-11T02:45:07.032Z" + } + '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/DefaultError' + summary: GetPdbConversionHistoryEntry + tags: + - database + x-example: | + GET /20160918/databases/<databaseId>/pdbConversionHistoryEntries/<pdbConversionHistoryEntryId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/PdbConversionHistoryEntry' + /databases/{databaseId}/upgradeHistoryEntries: + get: + description: | + Gets the upgrade history for a specified database in a bare metal or virtual machine DB system. + operationId: ListDatabaseUpgradeHistoryEntries + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/FilterByUpgradeActionQueryParam' + - $ref: '#/components/parameters/FilterByUpgradeLifecycleStateQueryParam' + - $ref: '#/components/parameters/ListUpgradeHistoryEntriesSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + responses: + '200': + description: The upgrade history for the specified Database. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListDatabaseUpgradeHistoryEntriesResponse' + application-json: + examples: + response: + value: | + [{ + "id" : "ocid1.dbupgradehistory.oc1.phx.abzwkljr7jdmapjf2pcdltavwgsxdct2my5ohnz5ta7sn3zehvmmgrxkk3sq", + "action" : "UPGRADE", + "lifecycleState" : "SUCCEEDED", + "lifecycleDetails" : null, + "targetDBVersion": "19.6.0.0", + "targetDatabaseSoftwareImageId": null, + "targetDbHomeId": null, + "sourceDbHomeId": null, + "startTime": "20-04-11T01:59:07.032Z", + "endTime": null + }] + '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/DefaultError' + summary: ListDatabaseUpgradeHistoryEntries + tags: + - database + x-example: | + GET /20160918/databases/<databaseId>/upgradeHistory + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Database' + /databases/{databaseId}/upgradeHistoryEntries/{upgradeHistoryEntryId}: + get: + description: | + gets the upgrade history for a specified database. + operationId: GetDatabaseUpgradeHistoryEntry + parameters: + - $ref: '#/components/parameters/DatabaseIdPathParam' + - $ref: '#/components/parameters/UpgradeHistoryEntryIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The database upgrade history. + 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/DatabaseUpgradeHistoryEntry' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.dbupgradehistory.oc1.phx.abzwkljr7jdmapjf2pcdltavwgsxdct2my5ohnz5ta7sn3zehvmmgrxkk3sq", + "action" : "PRECHECK", + "lifecycleState" : "SUCCEEDED", + "lifecycleDetails" : null, + "targetDBVersion": "19.7.0.0", + "targetDatabaseSoftwareImageId": null, + "targetDbHomeId": null, + "sourceDbHomeId": null, + "startTime": "20-04-11T01:59:07.032Z", + "endTime": null + } + '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/DefaultError' + summary: GetDatabaseUpgradeHistoryEntry + tags: + - database + x-example: | + GET /20160918/databases/<databaseId>/upgradeHistory/<upgradeHistoryId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DatabaseUpgradeHistoryEntry' + /dbConnectionBundles: + get: + description: | + Lists all database connection bundles that match the query parameters. + operationId: ListDbConnectionBundles + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListDbConnectionBundlesSortByQueryParam' + - $ref: '#/components/parameters/ListDbConnectionBundlesFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/ListDbConnectionBundlesFilterByTypeQueryParam' + - $ref: '#/components/parameters/OptionalAssociatedResourceIdQueryParam' + responses: + '200': + description: Retrieved the list of all the database connection bundles. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListDbConnectionBundlesResponse' + '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/DefaultError' + summary: Gets a list of Database Connection Bundles in the specified compartment + tags: + - database + x-example: | + GET /20160918/dbConnectionBundles?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DbConnectionBundle' + /dbConnectionBundles/{dbConnectionBundleId}: + get: + description: Gets information about the specified database connection bundle. + operationId: GetDbConnectionBundle + parameters: + - $ref: '#/components/parameters/DbConnectionBundleIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The specified database connection bundle 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/DbConnectionBundle' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "db-connection-bundle-1", + "id" : "ocid1.dbconnectionbundle.oc1.phx.", + "lifecycleState" : "AVAILABLE", + "timeCreated" : "2016-11-22T19:25:42.755Z" + } + '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/DefaultError' + summary: Gets a database connection bundle. + tags: + - database + x-example: | + GET /20160918/dbConnectionBundles/<dbConnectionBundleId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /dbConnectionBundles/{dbConnectionBundleId}/actions/download: + post: + description: | + Downloads the specified database connection bundle content. + The bundle is returned as a binary file containing the connection details. + operationId: DownloadDbConnectionBundle + parameters: + - $ref: '#/components/parameters/DbConnectionBundleIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DownloadDbConnectionBundleDetails' + description: Request to download a database connection bundle. + required: true + responses: + '200': + description: The database connection bundle content. + headers: + content-disposition: + description: Specifies presentational information for the file attachment. + schema: + type: string + content-length: + description: Size of the content, in bytes. + schema: + type: integer + format: int64 + content-type: + description: The content type of the body. + schema: + type: string + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + last-modified: + description: The date and time the bundle was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. + schema: + type: string + format: date-time + 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/octet-stream: + schema: + format: binary + 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/DefaultError' + summary: Downloads a database connection bundle. + tags: + - database + x-example: | + POST /20160918/dbConnectionBundles/<dbConnectionBundleId>/download + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/DbConnectionBundle' + /dbHomes: + get: + description: | + Lists the Database Homes in the specified DB system and compartment. A Database Home is a directory where Oracle Database software is installed. + operationId: ListDbHomes + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/OptionalDbSystemIdQueryParam' + - $ref: '#/components/parameters/OptionalVmClusterIdQueryParam' + - $ref: '#/components/parameters/BackupIdQueryParam' + - $ref: '#/components/parameters/DbVersionQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/ListDbHomesSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListDbHomesFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + responses: + '200': + description: The list of Database Homes was retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListDbHomesResponse' + application-json: + examples: + response: + value: | + [ + { + "compartmentId" : "ocid1.tenancy.oc1..", + "dbSystemId" : "ocid1.dbsystem.oc1.phx.", + "dbVersion" : "12.1.0.2", + "displayName" : "dbhome20161123015907", + "id" : "ocid1.dbhome.oc1.phx.", + "lastPatchHistoryEntryId" : null, + "lifecycleState" : "PROVISIONING", + "timeCreated" : "2016-11-23T01:59:07.032Z" + } + ] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDbHomes + tags: + - database + x-example: | + GET /20160918/dbHomes?compartmentId=<compartmentId>&dbSystemId=<dbSystemId>&backupId=<backupId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DbHome' + post: + description: | + Creates a new Database Home in the specified database system based on the request parameters you provide. Applies to bare metal DB systems, Exadata systems, and Exadata Cloud@Customer systems. + operationId: CreateDbHome + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateDbHomeBase' + description: Request to create a new Database Home. + required: true + responses: + '200': + description: The request was successfully received and the Database Home creation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DbHome' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "dbSystemId" : "ocid1.dbsystem.oc1.phx.", + "dbVersion" : "12.1.0.2", + "displayName" : "dbhome20161123015907", + "id" : "ocid1.dbhome.oc1.phx.", + "kmsKeyId" : "ocid1.key.oc1.phx.annnb3f4aacuu.", + "lastPatchHistoryEntryId" : null, + "lifecycleState" : "PROVISIONING", + "timeCreated" : "2016-11-23T01:59:07.032Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateDbHome + tags: + - database + x-example: | + Example I: (Database Home with database details) + POST /20160918/dbHomes + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "dbSystemId" : "ocid1.dbsystem.oc1.phx.<unique_ID>", + "displayName" : "createdDbHome", + "source": "NONE", + "dbVersion" : "12.1.0.2", + "database" : { + "adminPassword" : "<password>", + "dbName" : "myTestDb", + "dbUniqueName" : "myTestDb_phx1cs", + "kmsKeyId" : "ocid1.key.oc1..<unique_ID>", + "kmsKeyVersionId" : "ocid1.keyversion.oc1..<unique_ID>", + "vaultId" : "ocid1.vault.oc1.phx.", + "dbBackupConfig" : { + "recoveryWindowInDays" : 30, + "autoBackupEnabled" : true + } + } + } + Example II: (With database details when the source is a backup) + POST /20160918/dbHomes + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "dbSystemId" : "ocid1.dbsystem.oc1.phx.<unique_ID>", + "displayName" : "restoredDbHome", + "source": "DB_BACKUP", + "kmsKeyId": "ocid1.key.oc1..<unique_ID>", + "kmsKeyVersionId": "ocid1.keyversion.oc1..<unique_ID>" + "database" : { + "backupId" : "ocid1.backup.oc1.phx.<unique_ID>", + "backupTDEPassword" : "<password>", + "adminPassword" : "<password>" + } + } + Example III (Without database details. Creates an empty Database Home.): + POST /20160918/dbHomes + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "dbSystemId" : "ocid1.dbsystem.oc1.phx.<unique_ID>", + "displayName" : "createdDbHome", + "source": "NONE", + "dbVersion" : "12.1.0.2", + } + /dbHomes/{dbHomeId}: + delete: + description: | + Deletes a Database Home. Applies to bare metal DB systems, Exadata Cloud Service, and Exadata Cloud@Customer systems. + + Oracle recommends that you use the `performFinalBackup` parameter to back up any data on a bare metal DB system before you delete a Database Home. On an Exadata Cloud@Customer system or an Exadata Cloud Service system, you can delete a Database Home only when there are no databases in it and therefore you cannot use the `performFinalBackup` parameter to back up data. + operationId: DeleteDbHome + parameters: + - $ref: '#/components/parameters/DbHomeIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/PerformFinalBackupParam' + responses: + '204': + description: The request to delete the Database Home was received. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteDbHome + tags: + - database + x-example: | + DELETE /20160918/dbHomes/<dbHomeId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DbHome' + get: + description: Gets information about the specified Database Home. + operationId: GetDbHome + parameters: + - $ref: '#/components/parameters/DbHomeIdPathParam' + responses: + '200': + description: The Database Home. + 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/DbHome' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "dbSystemId" : "ocid1.dbsystem.oc1.phx.", + "dbVersion" : "12.1.0.2", + "displayName" : "dbhome20161123015907", + "id" : "ocid1.dbhome.oc1.phx.", + "lastPatchHistoryEntryId" : null, + "lifecycleState" : "PROVISIONING", + "timeCreated" : "2016-11-23T01:59:07.032Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetDbHome + tags: + - database + x-example: | + GET /20160918/dbHomes/<dbHomeId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: Patches the specified Database Home. + operationId: UpdateDbHome + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/DbHomeIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateDbHomeDetails' + description: Request to update the properties of a Database Home. + required: true + responses: + '200': + description: The request was successfully received and the Database Home update is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DbHome' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..", + "dbSystemId" : "ocid1.dbsystem.oc1.phx.", + "dbVersion" : "12.1.0.2", + "displayName" : "dbhome20161123015907", + "id" : "ocid1.dbhome.oc1.phx.", + "lastPatchHistoryEntryId" : "ocid1.dbpatchhistory.oc1.phx.", + "lifecycleState" : "UPDATING", + "timeCreated" : "2016-11-23T01:59:07.032Z" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateDbHome + tags: + - database + x-example: | + Example I: + PUT /latest/dbHomes/<dbHomeId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "dbVersion" : { + "patchId" : "ocid1.dbpatch.oc1.phx.<unique_ID>", + "action" : "APPLY" + } + } + Example II: + PUT /latest/dbHomes/<dbHomeId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "dbVersion" : { + "databaseSoftwareImageId" : "ocid1.databasesoftwareimage.oc1.phx.<unique_ID>", + "action" : "APPLY" + } + } + /dbHomes/{dbHomeId}/patchHistoryEntries: + get: + description: | + Lists the history of patch operations on the specified Database Home. + operationId: ListDbHomePatchHistoryEntries + parameters: + - $ref: '#/components/parameters/DbHomeIdPathParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + responses: + '200': + description: The patch history for the specified Database Home was retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListDbHomePatchHistoryEntriesResponse' + application-json: + examples: + response: + value: | + [ + { + "action" : "APPLY", + "patchId" : "ocid1.dbpatch.oc1.phx.", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "lifecycleState" : "IN_PROGRESS", + "lifecycleDetails" : "", + "timeStarted" : "2017-01-01T07:07:07.007Z", + "timeEnded" : null + }, { + "action" : "APPLY", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "patchId" : "ocid1.dbpatch.oc1.phx.", + "lifecycleState" : "SUCCESS", + "lifecycleDetails" : "", + "timeStarted" : "2016-12-21T01:59:07.032Z", + "timeEnded" : "2016-12-21T02:21:07.032Z" + }, { + "action" : "APPLY", + "patchId" : "ocid1.dbpatch.oc1.phx.", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "lifecycleState" : "SUCCESS", + "lifecycleDetails" : "", + "timeStarted" : "2016-12-20T01:23:45.6789Z", + "timeEnded" : "2016-12-20T01:23:45.6789Z" + }, { + "action" : "APPLY", + "patchId" : "ocid1.dbpatch.oc1.phx.", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "lifecycleState" : "FAILED", + "lifecycleDetails" : "", + "timeStarted" : "2016-11-20T01:23:45.6789Z", + "timeEnded" : "2016-11-20T01:23:45.6789Z" + } + ] + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDbHomePatchHistoryEntries + tags: + - database + x-example: | + GET /20160918/dbHomes/<dbHomeId>/patchHistoryEntries?limit=100 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/PatchHistoryEntry' + /dbHomes/{dbHomeId}/patchHistoryEntries/{patchHistoryEntryId}: + get: + description: | + Gets the patch history details for the specified patchHistoryEntryId + operationId: GetDbHomePatchHistoryEntry + parameters: + - $ref: '#/components/parameters/DbHomeIdPathParam' + - $ref: '#/components/parameters/PatchHistoryEntryIdPathParam' + responses: + '200': + description: The patch history details for the specified patchHistoryEntryId. + 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/PatchHistoryEntry' + application-json: + examples: + response: + value: | + { + "action" : "APPLY", + "patchId" : "ocid1.dbpatch.oc1.phx.", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "lifecycleState" : "FAILED", + "lifecycleDetails" : "", + "timeStarted" : "2016-11-20T01:23:45.6789Z", + "timeEnded" : "2016-11-20T01:23:45.6789Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetDbHomePatchHistoryEntry + tags: + - database + x-example: | + GET /20160918/patchHistoryEntries/<patchHistoryEntryId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/PatchHistoryEntry' + /dbHomes/{dbHomeId}/patches: + get: + description: | + Lists patches applicable to the requested Database Home. + operationId: ListDbHomePatches + parameters: + - $ref: '#/components/parameters/DbHomeIdPathParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + responses: + '200': + description: A list of the patch packages. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListDbHomePatchesResponse' + application-json: + examples: + response: + value: | + [ + { + "availableActions" : ["APPLY"], + "description" : "Jan DB patch for 12.0.2.3.1", + "id" : "ocid1.dbpatch.oc1.phx.", + "lastAction": "APPLY", + "lifecycleDetails" : "", + "lifecycleState" : "FAILED", + "name" : "db.12.0.2.3.1", + "timeReleased" : "2017-01-16T01:50:07.0001", + "type" : "BUNDLE", + "version" : "12.0.2.3.1" + } + ] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDbHomePatches + tags: + - database + x-example: | + GET /20160918/dbHomes/<dbHomeId>/patches?limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Patch' + /dbHomes/{dbHomeId}/patches/{patchId}: + get: + description: | + Gets information about a specified patch package. + operationId: GetDbHomePatch + parameters: + - $ref: '#/components/parameters/DbHomeIdPathParam' + - $ref: '#/components/parameters/PatchIdPathParam' + responses: + '200': + description: The patch package. + 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/Patch' + application-json: + examples: + response: + value: | + { + "availableActions" : ["APPLY"], + "description" : "Jan DB patch for 12.0.2.3.1", + "id" : "ocid1.dbpatch.oc1.phx.", + "lastAction": "APPLY", + "lifecycleDetails" : "A failure message that can be displayed to the user", + "lifecycleState" : "FAILED", + "name" : "db.12.0.2.3.1", + "timeReleased" : "2017-01-16T01:50:07.0001", + "type" : "BUNDLE", + "version" : "12.0.2.3.1" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetDbHomePatch + tags: + - database + x-example: | + GET /20160918/dbHomes/<dbHomeId>/patches/<patchId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Patch' + /dbNodes: + get: + description: | + Lists the database nodes in the specified DB system and compartment. In addition to the other required parameters, either '--db-system-id' or '--vm-cluster-id' also must be provided, depending on the service being accessed. + operationId: ListDbNodes + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/OptionalDbSystemIdQueryParam' + - $ref: '#/components/parameters/OptionalVmClusterIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/ListDbNodesSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListDbNodesFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/OptionalDbServerIdQueryParam' + responses: + '200': + description: The list of database nodes is retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListDbNodesResponse' + application-json: + examples: + response: + value: | + [{ + "dbSystemId" : "ocid1.dbsystem.oc1.phx.", + "hostname" : "host559086", + "id" : "ocid1.dbnode.oc1.phx.", + "lifecycleState" : "PROVISIONING", + "timeCreated" : "2016-11-23T01:59:07.031Z", + "vnicId" : null, + "cpuCoreCount": "4", + "memorySizeInGBs": "30", + "dbNodeStorageSizeInGBs": "60", + + "dbServerId": "ocid1.dbserver.oc1." + }] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDbNodes + tags: + - database + x-example: | + GET /20160918/dbNodes?compartmentId=<compartmentId>&dbSystemId=<dbSystemId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DbNode' + /dbNodes/{dbNodeId}: + get: + description: Gets information about the specified database node. + operationId: GetDbNode + parameters: + - $ref: '#/components/parameters/DbNodeIdPathParam' + responses: + '200': + description: The database node information is retrieved. + 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/DbNode' + application-json: + examples: + response: + value: | + { + "dbSystemId" : "ocid1.dbsystem.oc1.phx.", + "hostname" : "host559086", + "id" : "ocid1.dbnode.oc1.phx.", + "lifecycleState" : "PROVISIONING", + "timeCreated" : "2016-11-23T01:59:07.031Z", + "vnicId" : null, + "cpuCoreCount": "4", + "memorySizeInGBs": "30", + "dbNodeStorageSizeInGBs": "60" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetDbNode + tags: + - database + x-example: | + GET /20160918/dbNodes/<dbNodeId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + post: + description: | + Performs one of the following power actions on the specified DB node: + - start - power on + - stop - power off gracefully + - forcestop - power off forcefully + - forcereset - ACPI shutdown and power on forcefully + - softreset - ACPI shutdown and power on + - reset - power off and power on + + **Note:** Stopping a node affects billing differently, depending on the type of DB system: + *Bare metal and Exadata systems* - The _stop_ state has no effect on the resources you consume. + Billing continues for DB nodes that you stop, and related resources continue + to apply against any relevant quotas. You must terminate the DB system + ([TerminateDbSystem](#/en/database/latest/DbSystem/TerminateDbSystem)) + to remove its resources from billing and quotas. + *Virtual machine DB systems* - Stopping a node stops billing for all OCPUs associated with that node, and billing resumes when you restart the node. + operationId: DbNodeAction + parameters: + - $ref: '#/components/parameters/DbNodeIdPathParam' + - $ref: '#/components/parameters/DbNodeActionQueryParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '200': + description: The request was successfully received and the action is being performed. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DbNode' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DbNodeAction + tags: + - database + x-example: | + POST /20160918/dbNodes/<dbNodeId>?action=stop + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DbNode' + /dbNodes/{dbNodeId}/consoleConnections: + get: + description: | + Lists the console connections for the specified database node. + operationId: ListConsoleConnections + parameters: + - $ref: '#/components/parameters/DbNodeIdPathParam' + responses: + '200': + description: The list of console connections was retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListConsoleConnectionsResponse' + application-json: + examples: + response: + value: | + [ + { + "id": "ocid1.instanceconsoleconnection.oc1.iad.", + "compartmentId": "ocid1.compartment.oc1..", + "dbNodeId": "ocid1.dbnode.oc1.iad.", + "connectionString": "ssh -o ProxyCommand='ssh -W %h:%p -p 443 ocid1.ConsoleConnectionSummary.oc1.iad.@instance-console.us-ashburn-1.oraclecloud.com' ocid1.instance.oc1.iad.", + "fingerprint": "4a:46:c1:72:14:de:9f:a8:fe:89:a9:6c:6c:63:77:83", + "lifecycleState": "ACTIVE" + }, + { + "id": "ocid1.instanceconsoleconnection.oc1.iad.", + "compartmentId": "ocid1.compartment.oc1..", + "dbNodeId": "ocid1.dbnode.oc1.iad.", + "connectionString": "ssh -o ProxyCommand='ssh -W %h:%p -p 443 ocid1.ConsoleConnectionSummary.oc1.iad.@instance-console.us-ashburn-1.oraclecloud.com' ocid1.instance.oc1.iad.", + "fingerprint": "4a:46:c1:72:14:de:9f:a8:fe:89:a9:6c:6c:63:77:83", + "lifecycleState": "ACTIVE" + } + ] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListConsoleConnections + tags: + - database + x-example: | + GET /20160918/dbNodes/<dbNodeId>/consoleConnections + x-related-resource: '#/definitions/ConsoleConnection' + post: + description: | + Creates a new console connection to the specified database node. + After the console connection has been created and is available, + you connect to the console using SSH. + operationId: CreateConsoleConnection + parameters: + - $ref: '#/components/parameters/DbNodeIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateConsoleConnectionDetails' + description: Request object for creating an CreateConsoleConnection + required: true + responses: + '200': + description: The instance console connection is being configured. + 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/ConsoleConnection' + application-json: + examples: + response: + value: | + { + "id": "ocid1.instanceconsoleconnection.oc1.iad.", + "compartmentId": "ocid1.compartment.oc1..", + "dbNodeId": "ocid1.dbnode.oc1.iad.", + "connectionString": "ssh -o ProxyCommand='ssh -W %h:%p -p 443 ocid1.ConsoleConnectionSummary.oc1.iad.@instance-console.us-ashburn-1.oraclecloud.com' ocid1.instance.oc1.iad.", + "fingerprint": "4a:46:c1:72:14:de:9f:a8:fe:89:a9:6c:6c:63:77:83", + "lifecycleState": "ACTIVE" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateConsoleConnection + tags: + - database + x-example: | + POST /20160918/dbNodes/<dbNodeId>/consoleConnections + { + "publicKey":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCZ06fccNTQfq+xubFlJ5ZR3kt+uzspdH9tXL+lAejSM1NXM+CFZev7MIxfEjas06y80ZBZ7DUTQO0GsampleVorF8M4xuLwrmzRtkoZzU16umt4y1W0Q4ifdp3IiiU0U8/WxczSXcUVZOLqkz5dc6oMHdMVpkimietWzGZ4LBBsH/LjEVY7E0V+a0sNchlVDIZcm7ErReBLcdTGDq0uLBiuChyl6RUkX1PNhusquTGwK7zc8OBXkRuubn5UKXhI3Ul9Nyk4XESkVWIGNKmw8mSpoJSjR8P9ZjRmcZVo8S+x4KVPMZKQEor== name@example.com 8GnoV/6Ox6TNoh9BiifqGKC9VGYuC89RvUajRBTZSK2TK4DPfaT+2R+slPsFrwiT/oPEhhEK1S5Q== rsa-key-20160227" + } + x-related-resource: '#/definitions/ConsoleConnection' + /dbNodes/{dbNodeId}/consoleConnections/{consoleConnectionId}: + delete: + description: Deletes the specified database node console connection. + operationId: DeleteConsoleConnection + parameters: + - $ref: '#/components/parameters/DbNodeIdPathParam' + - $ref: '#/components/parameters/ConsoleConnectionIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The instance console connection is being 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 + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteConsoleConnection + tags: + - database + x-example: | + DELETE /20160918/dbNodes/<dbNodeId>/consoleConnections/<instanceConsoleConnectionId> + x-related-resource: '#/definitions/ConsoleConnection' + get: + description: Gets the specified database node console connection's information. + operationId: GetConsoleConnection + parameters: + - $ref: '#/components/parameters/DbNodeIdPathParam' + - $ref: '#/components/parameters/ConsoleConnectionIdPathParam' + responses: + '200': + description: The console connection information was retrieved. + 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/ConsoleConnection' + application-json: + examples: + response: + value: | + { + "id": "ocid1.instanceconsoleconnection.oc1.iad.", + "compartmentId": "ocid1.compartment.oc1..", + "dbNodeId": "ocid1.dbnode.oc1.iad.", + "connectionString": "ssh -o ProxyCommand='ssh -W %h:%p -p 443 ocid1.ConsoleConnectionSummary.oc1.iad.@instance-console.us-ashburn-1.oraclecloud.com' ocid1.instance.oc1.iad.", + "fingerprint": "4a:46:c1:72:14:de:9f:a8:fe:89:a9:6c:6c:63:77:83", + "lifecycleState": "ACTIVE" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetConsoleConnection + tags: + - database + x-example: | + GET /20160918/dbNodes/<dbNodeId>/consoleConnections/<instanceConsoleConnectionId> + x-related-resource: '#/definitions/ConsoleConnection' + /dbNodes/{dbNodeId}/consoleHistories: + get: + description: | + Lists the console histories for the specified database node. + operationId: ListConsoleHistories + parameters: + - $ref: '#/components/parameters/DbNodeIdPathParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ListConsoleHistoriesSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListConsoleHistoriesFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + responses: + '200': + description: The list of console histories was retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ConsoleHistoryCollection' + application-json: + examples: + response: + value: | + [ + { + "id": "ocid1.consolehistory.oc1.iad.exampleunique_ID", + "displayName" : "console-history-20221202-1943", + "compartmentId": "ocid1.compartment.oc1.iad.exampleunique_ID", + "dbNodeId": "ocid1.dbnode.oc1.iad.exampleunique_ID", + "lifecycleState": "REQUESTED", + "definedTags" : {}, + "freeformTags" : {}, + "timeCreated" : "2022-12-03T03:43:24.342Z" + } + ] + '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/DefaultError' + summary: ListConsoleHistories + tags: + - database + x-example: | + GET /20160918/dbNodes/<dbNodeId>/consoleHistories + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ConsoleHistory' + post: + description: | + Captures the most recent serial console data (up to a megabyte) for the specified database node. + operationId: CreateConsoleHistory + parameters: + - $ref: '#/components/parameters/DbNodeIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateConsoleHistoryDetails' + description: | + Request object for creating a console history. + required: true + responses: + '200': + description: The console history is being captured. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ConsoleHistory' + application-json: + examples: + response: + value: | + { + "id": "ocid1.consolehistory.oc1.iad.exampleunique_ID", + "displayName" : "console-history-20221202-1943", + "compartmentId": "ocid1.compartment.oc1.iad.exampleunique_ID", + "dbNodeId": "ocid1.dbnode.oc1.iad.exampleunique_ID", + "lifecycleState": "REQUESTED", + "definedTags" : {}, + "freeformTags" : {}, + "timeCreated" : "2022-12-03T03:43:24.342Z" + } + '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/DefaultError' + summary: CreateConsoleHistory + tags: + - database + x-example: | + POST /20160918/dbNodes/<dbNodeId>/consoleHistories + { + "displayName" : "console-history-20221202-1943", + "definedTags" : {}, + "freeformTags" : {} + } + /dbNodes/{dbNodeId}/consoleHistories/{consoleHistoryId}: + delete: + description: | + Deletes the specified database node console history. + operationId: DeleteConsoleHistory + parameters: + - $ref: '#/components/parameters/DbNodeIdPathParam' + - $ref: '#/components/parameters/ConsoleHistoryIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '204': + description: The instance console history is being 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: DeleteConsoleHistory + tags: + - database + x-related-resource: '#/definitions/ConsoleHistory' + get: + description: | + Gets information about the specified database node console history. + operationId: GetConsoleHistory + parameters: + - $ref: '#/components/parameters/DbNodeIdPathParam' + - $ref: '#/components/parameters/ConsoleHistoryIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The console history information was retrieved. + 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/ConsoleHistory' + application-json: + examples: + response: + value: | + { + "id": "ocid1.consolehistory.oc1.iad.exampleunique_ID", + "displayName" : "console-history-20221202-1943", + "compartmentId": "ocid1.compartment.oc1.iad.exampleunique_ID", + "dbNodeId": "ocid1.dbnode.oc1.iad.exampleunique_ID", + "lifecycleState": "REQUESTED", + "definedTags" : {}, + "freeformTags" : {}, + "timeCreated" : "2022-12-03T03:43:24.342Z" + } + '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/DefaultError' + summary: GetConsoleHistory + tags: + - database + x-example: | + GET /20160918/dbNodes/<dbNodeId>/consoleHistories/<consoleHistoryId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the specified database node console history. + operationId: UpdateConsoleHistory + parameters: + - $ref: '#/components/parameters/DbNodeIdPathParam' + - $ref: '#/components/parameters/ConsoleHistoryIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateConsoleHistoryDetails' + description: Request to update the specified database node console history. + required: true + responses: + '200': + description: The instance console history is being updated. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ConsoleHistory' + application-json: + examples: + response: + value: | + { + "id": "ocid1.consolehistory.oc1.iad.exampleunique_ID", + "displayName" : "console-history-20221202-1943", + "compartmentId": "ocid1.compartment.oc1.iad.exampleunique_ID", + "dbNodeId": "ocid1.dbnode.oc1.iad.exampleunique_ID", + "lifecycleState": "REQUESTED", + "definedTags" : {}, + "freeformTags" : {}, + "timeCreated" : "2022-12-03T03:43:24.342Z" + } + '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/DefaultError' + summary: UpdateConsoleHistory + tags: + - database + x-example: | + PUT /latest//consoleHistories//<consoleHistoryId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName" : "console-history-20221202-1944", + "freeformTags" : {"Department": "Finance"}, + "definedTags": {"Operations": {"CostCenter": "42"}} + } + x-related-resource: '#/definitions/ConsoleHistory' + /dbNodes/{dbNodeId}/consoleHistories/{consoleHistoryId}/content: + get: + description: | + Retrieves the specified database node console history contents upto a megabyte. + operationId: GetConsoleHistoryContent + parameters: + - $ref: '#/components/parameters/DbNodeIdPathParam' + - $ref: '#/components/parameters/ConsoleHistoryIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The console history content was retrieved. + 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/octet-stream: + schema: + format: binary + 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/DefaultError' + summary: GetConsoleHistoryContent + tags: + - database + x-example: | + GET /20160918/dbNodes/<dbNodeId>/consoleHistories/<consoleHistoryId>/content + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ConsoleHistory' + /dbServers: + get: + description: | + Lists the Exadata DB servers in the ExadataInfrastructureId and specified compartment. + operationId: ListDbServers + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/ExadataInfrastructureIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ListDbServersSortByQueryParam' + - $ref: '#/components/parameters/ListDbServersFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + responses: + '200': + description: The list of Exadata Db Servers. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListDbServersResponse' + application-json: + examples: + response: + value: | + [ + { + "id" : "ocid1.dbserver.oc1.", + "displayName" : "dbServer-1", + "compartmentId" : "ocid1.tenancy.oc1.", + "exadataInfrastructureId" : "ocid1.exadataInfrastructure.oc1.", + "cpuCoreCount" : "4", + "memorySizeInGBs" : "120", + "maxMemorySizeInGBs" : "200", + "dbNodeStorageSizeInGBs" : "240", + "maxdDbNodeStorageSizeInGBs" : "400", + "autonomousVirtualMachineIds": ["ocid1.autonomousvirtualmachine.oc1."], + "autonomousVmClusterIds": [ "ocid1.autonomousvmcluster.oc1." ], + "vmClusterIds" : ["ocid1.vmcluster.oc1."], + "dbNodeIds" : ["ocid1.dbnode.oc1."], + "computeModel": "ECPU", + "lifecycleState" : "AVAILABLE", + "timeCreated" : "2021-06-22T19:25:42.755Z" + } + ] + '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/DefaultError' + summary: ListDbServers + tags: + - database + x-example: | + GET /20160918/dbServers?compartmentId=<compartmentId>&exadataInfrastructureId=<exadataInfrastructureId>limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DbServer' + /dbServers/{dbServerId}: + get: + description: | + Gets information about the Exadata Db server. + operationId: GetDbServer + parameters: + - $ref: '#/components/parameters/ExadataInfrastructureIdQueryParam' + - $ref: '#/components/parameters/DbServerIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: Information about the Exadata Db server. + 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/DbServer' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.dbserver.oc1.", + "displayName" : "dbServer-1", + "compartmentId" : "ocid1.tenancy.oc1.", + "exadataInfrastructureId" : "ocid1.exadataInfrastructure.oc1.", + "cpuCoreCount" : "4", + "memorySizeInGBs" : "120", + "maxMemorySizeInGBs" : "200", + "dbNodeStorageSizeInGBs" : "240", + "maxdDbNodeStorageSizeInGBs" : "400", + "vmClusterIds" : ["ocid1.vmcluster.oc1."], + "dbNodeIds" : ["ocid1.dbnode.oc1."], + "computeModel": "ECPU", + "lifecycleState" : "AVAILABLE", + "timeCreated" : "2021-06-22T19:25:42.755Z" + } + '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/DefaultError' + summary: GetDbServer + tags: + - database + x-example: | + GET /20160918/dbServers/<dbServerId>&exadataInfrastructureId=<exadataInfrastructureId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /dbSystemComputePerformance: + get: + description: | + Gets a list of expected compute performance parameters for a virtual machine DB system based on system configuration. Adding compartmentId does not affect results. + operationId: ListDbSystemComputePerformances + parameters: + - $ref: '#/components/parameters/DbSystemShapeParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' + responses: + '200': + description: list of possible expected compute performance parameters of a VMDB System . + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListDbSystemComputePerformancesResponse' + application-json: + examples: + response: + value: | + [ + { + "shape": "AmdFlex.E4", + "computePerformanceList": [ + { + "cpuCoreCount": 1, + "memoryInGBs": 16, + "networkBandwidthInGbps": 1, + "networkIOPs": 480, + "networkThroughput": 1 + }, + { + "cpuCoreCount": 2, + "memoryInGBs": 32, + "networkBandwidthInGbps": 2, + "networkIOPs": 960, + "networkThroughput": 2 + } + ] + }, + { + "shape": "VMStandard2.1", + "computePerformanceList": [ + { + "cpuCoreCount": 1, + "memoryInGBs": 16, + "networkBandwidthInGbps": 1, + "networkIOPs": 480, + "networkThroughputInMbps": 1 + } + ] + } + ] + '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/DefaultError' + summary: List of DbSystemComputePerformance params + tags: + - database + x-example: | + Example: + GET /20160918/dbSystemPerformance?shapeType=<AMD>&compartmentId=<compartmentId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-authz-declarations: + authorizationRequired: false + x-related-resource: '#/definitions/DbSystem' + /dbSystemShapes: + get: + description: Gets a list of the shapes that can be used to launch a new DB system. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. + operationId: ListDbSystemShapes + parameters: + - $ref: '#/components/parameters/OptionalAvailabilityDomainQueryParam' + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/ShapeAttributeQueryParam' + responses: + '200': + description: Supported DB system shapes. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListDbSystemShapesResponse' + application-json: + examples: + response: + value: | + [ + { + "availableCoreCount" : 36, + "shape" : "BM.HighIO1.36" + }, { + "availableCoreCount" : 36, + "shape" : "BM.DenseIO1.36" + } + ] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDbSystemShapes + tags: + - database + x-example: | + GET /20160918/dbSystemShapes?availabilityDomain=<availabilityDomain>&compartmentId=<compartmentId>&limit=100 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-authz-declarations: + authorizationRequired: false + /dbSystemShapes/flexComponents: + get: + description: Gets a list of the flex components that can be used to launch a new DB system. The flex component determines resources to allocate to the DB system - Database Servers and Storage Servers. + operationId: ListFlexComponents + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/FilterByNameQueryParam' + - $ref: '#/components/parameters/FilterByShapeQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListFlexComponentsSortByQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + responses: + '200': + description: Supported DB system flex Components for a given DB System shape. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/FlexComponentCollection' + application-json: + examples: + response: + value: | + [ + { + "availableCoreCount" : 50, + "minimumCoreCount" : 0, + "name" : "Database.Server" + } + ] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListFlexComponents + tags: + - database + x-example: | + GET /20160918/dbSystemShapes/flexComponents?limit=100 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-authz-declarations: + authorizationRequired: false + /dbSystemStoragePerformance: + get: + description: | + Gets a list of possible expected storage performance parameters of a VMDB System based on Configuration. + operationId: ListDbSystemStoragePerformances + parameters: + - $ref: '#/components/parameters/StorageManagementQueryParam' + - $ref: '#/components/parameters/ShapeTypeParam' + - $ref: '#/components/parameters/DatabaseEditionQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: list of possible storage performance parameters of a VMDB System . + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListDbSystemStoragePerformancesResponse' + application-json: + examples: + response: + value: | + [ + { + "shapeType": "AMD", + "dataStoragePerformanceList": [ + { + "sizeInGb": 256, + "balancedDiskPerformance": { + "diskIOPs": 100, + "diskThroughputInMbps": 200 + }, + "highDiskPerformance": { + "diskIOPs": 200, + "diskThroughputInMbps": 400 + } + }, + { + "sizeInGb": 512, + "balancedDiskPerformance": { + "diskIOPs": 100, + "diskThroughputInMbps": 200 + }, + "highDiskPerformance": { + "diskIOPs": 200, + "diskThroughputInMbps": 400 + } + } + ], + "recoStoragePerformanceList": [ + { + "sizeInGb": 256, + "balancedDiskPerformance": { + "diskIOPs": 100, + "diskThroughputInMbps": 200 + }, + "highDiskPerformance": { + "diskIOPs": 200, + "diskThroughputInMbps": 400 + } + }, + { + "sizeInGb": 512, + "balancedDiskPerformance": { + "diskIOPs": 100, + "diskThroughputInMbps": 200 + }, + "highDiskPerformance": { + "diskIOPs": 200, + "diskThroughputInMbps": 400 + } + } + ] + }, + { + "shapeType": "INTEL", + "dataStoragePerformanceList": [ + { + "sizeInGbps": 256, + "balancedDiskPerformance": { + "diskIOPs": 100, + "diskThroughputInMbps": 200 + }, + "highDiskPerformance": { + "diskIOPs": 200, + "diskThroughputInMbps": 400 + } + }, + { + "sizeInGb": 512, + "balancedDiskPerformance": { + "diskIOPs": 100, + "diskThroughputInMbps": 200 + }, + "highDiskPerformance": { + "diskIOPs": 200, + "diskThroughputInMbps": 400 + } + } + ], + "recoStoragePerformanceList": [ + { + "sizeInGb": 512, + "balancedDiskPerformance": { + "diskIOPs": 100, + "diskThroughputInMbps": 200 + }, + "highDiskPerformance": { + "diskIOPs": 200, + "diskThroughputInMbps": 400 + } + }, + { + "sizeInGb": 512, + "balancedDiskPerformance": { + "diskIOPs": 100, + "diskThroughputInMbps": 200 + }, + "highDiskPerformance": { + "diskIOPs": 200, + "diskThroughputInMbps": 400 + } + } + ] + } + ] + '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/DefaultError' + summary: List of DbSystemStoragePerformance params + tags: + - database + x-example: | + Example: + GET /20160918/dbSystemPerformance?shapeType=<AMD> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + Example with databaseEdition: + GET /20160918/dbSystemPerformance?shapeType=<AMPERE_FLEX_A1>&databaseEdition=<ENTERPRISE_EDITION_DEVELOPER> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-authz-declarations: + authorizationRequired: false + x-related-resource: '#/definitions/DbSystem' + /dbSystems: + get: + description: | + Lists the DB systems in the specified compartment. You can specify a `backupId` to list only the DB systems that support creating a database using this backup in this compartment. + + **Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model. + operationId: ListDbSystems + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/BackupIdQueryParam' + - $ref: '#/components/parameters/ListDbSystemsSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListDbSystemsFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByAvailabilityDomainQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + responses: + '200': + description: All the DB systems. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListDbSystemsResponse' + application-json: + examples: + response: + value: | + [ + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1..", + "cpuCoreCount" : 8, + "databaseEdition" : "ENTERPRISE_EDITION", + "diskRedundancy" : "HIGH", + "displayName" : "tst1dbsys", + "domain" : "my.company.com", + "hostname" : "apollo", + "id" : "ocid1.dbsystem.oc1.phx.", + "lastPatchHistoryEntryId" : null, + "licenseModel" : "LICENSE_INCLUDED", + "lifecycleDetails" : null, + "lifecycleState" : "AVAILABLE", + "listenerPort" : 1521, + "scanIpIds": null, + "shape" : "BM.DenseIO1.36", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "subnetId" : "ocid1.subnet.oc1.phx.", + "timeCreated" : "2016-11-22T19:25:42.755Z", + "version" : "201703160308", + "vipIds": null + }, { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1..", + "cpuCoreCount" : 8, + "databaseEdition" : "ENTERPRISE_EDITION", + "diskRedundancy" : "HIGH", + "displayName" : "tst2dbsys", + "domain" : "my.company.com", + "hostname" : "artemis", + "id" : "ocid1.dbsystem.oc1.phx.", + "lastPatchHistoryEntryId" : "ocid1.dbpatchhistory.oc1.phx.", + "licenseModel" : "BRING_YOUR_OWN_LICENSE", + "lifecycleDetails" : null, + "lifecycleState" : "AVAILABLE", + "listenerPort" : 1521, + "scanIpIds": null, + "shape" : "BM.DenseIO1.36", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "subnetId" : "ocid1.subnet.oc1.phx.", + "timeCreated" : "2016-11-22T19:49:54.146Z", + "version" : "201701011007", + "vipIds": null + } + ] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDbSystems + tags: + - database + x-example: | + Example I: + GET /20160918/dbSystems?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + Example II: + GET /20160918/dbSystems?compartmentId=<compartmentId>&backupId=<backupId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DbSystem' + post: + description: | + Creates a new DB system in the specified compartment and availability domain. The Oracle + Database edition that you specify applies to all the databases on that DB system. The selected edition cannot be changed. + + An initial database is created on the DB system based on the request parameters you provide and some default + options. For detailed information about default options, see [Bare metal and virtual machine DB system default options.](/Content/Database/Tasks/creatingDBsystem.htm#Default) + + **Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model. + + Use the [CreateCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/CreateCloudExadataInfrastructure/) and [CreateCloudVmCluster](#/en/database/latest/CloudVmCluster/CreateCloudVmCluster/) APIs to provision a new Exadata Cloud Service instance. + operationId: LaunchDbSystem + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LaunchDbSystemBase' + description: | + Request to launch a DB system. + + **Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model. + required: true + responses: + '200': + description: The request was successfully received and the DB system launch is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DbSystem' + application-json: + examples: + response: + value: | + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1..", + "cpuCoreCount" : 8, + "databaseEdition" : "ENTERPRISE_EDITION", + "diskRedundancy" : "HIGH", + "displayName" : "tst3dbsys", + "domain" : "my.company.com", + "hostname" : "athena", + "id" : "ocid1.dbsystem.oc1.phx.", + "kmsKeyId" : "ocid1.key.oc1.phx.", + "lastPatchHistoryEntryId" : null, + "licenseModel" : "LICENSE_INCLUDED", + "lifecycleDetails" : null, + "lifecycleState" : "PROVISIONING", + "listenerPort" : 1521, + "scanIpIds": null, + "shape" : "BM.DenseIO1.36", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "subnetId" : "ocid1.subnet.oc1.phx.", + "timeCreated" : "2016-11-23T01:59:07.030Z", + "version" : "201609160308", + "vipIds": null + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: LaunchDbSystem + tags: + - database + x-example: | + Example I: + POST /20160918/dbSystems + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1..<unique_ID>", + "cpuCoreCount" : 8, + "databaseEdition" : "ENTERPRISE_EDITION", + "dbHome" : { + "database" : { + "adminPassword" : "<password>", + "dbName" : "myTestDb", + "kmsKeyId" : "ocid1.key.oc1..<unique_ID>", + "kmsKeyVersionId" : "ocid1.keyversion.oc1..<unique_ID>", + "vaultId" : "ocid1.vault.oc1.phx.", + "dbBackupConfig" : { + "backupDestinationDetails" : [{ + "type": "RECOVERY_APPLIANCE", + "id": "ocid1.bkupdest.oc1.phx.<unique_ID>", + "vpcUser": "vpcUser1", + "vpcPassword": "<password>" + }], + "recoveryWindowInDays" : 30, + "autoBackupEnabled" : true + } + }, + "dbVersion" : "12.1.0.2", + "displayName" : null + }, + "dbSystemOptions" : { + "storageManagement" : "LVM" + }, + "diskRedundancy" : null, + "displayName" : "tst3dbsys", + "domain" : "<example.com>", + "hostname" : "athena", + "shape" : "BM.DenseIO1.36", + "source" : "NONE", + "sshPublicKeys" : [ "ssh-rsa <public_SSH_key> name@example.com" ], + "subnetId" : "ocid1.subnet.oc1.phx.<unique_ID>" + } + Example II (Launch from Backup): + POST /20160918/dbSystems + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1..<unique_ID>", + "cpuCoreCount" : 8, + "databaseEdition" : "ENTERPRISE_EDITION", + "dbHome":{ + "database" : { + "backupId" : "ocid1.backup.oc1.phx.<unique_ID>", + "backupTDEPassword" : "<TDE_password>", + "adminPassword" : "<password>" + } + } + "diskRedundancy" : null, + "displayName" : "tst3dbsys", + "domain" : "<example.com>", + "hostname" : "athena", + "kmsKeyId" : "ocid1.key.oc1..<unique_ID>", + "kmsKeyVersionId" : "ocid1.keyversion.oc1..<unique_ID>", + "shape" : "BM.DenseIO1.36", + "source" : "DB_BACKUP", + "sshPublicKeys" : [ "ssh-rsa <public_SSH_key> name@example.com" ], + "subnetId" : "ocid1.subnet.oc1.phx.<unique_ID>" + } + Example III: + POST /20160918/dbSystems + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "availabilityDomain": "OXET:PHX-AD-1", + "compartmentId": "ocid1.tenancy.oc1..<unique_ID>", + "cpuCoreCount": 8, + "databaseEdition": "ENTERPRISE_EDITION", + "dbHome": { + "database": { + "adminPassword": "<password>", + "dbName": "myTestDb", + "kmsKeyId": "ocid1.key.oc1.phx.<unique_ID>", + "kmsKeyVersionId" : "ocid1.keyversion.oc1..<unique_ID>", + "vaultId": "ocid1.vault.oc1.phx.", + "dbBackupConfig": { + "recoveryWindowInDays": 30, + "autoBackupEnabled": true, + "autoBackupWindow": "SLOT_TWO" + + } + }, + "dbVersion": "12.1.0.2", + "displayName": null + }, + "diskRedundancy": null, + "displayName": "tst3dbsys", + "domain": "<example.com>", + "hostname": "athena", + "kmsKeyId": "ocid1.key.oc1.phx.<unique_ID>", + "shape": "BM.DenseIO1.36", + "source": "NONE", + "sshPublicKeys": [ "ssh-rsa <public_SSH_key> name@example.com" ], + "subnetId": "ocid1.subnet.oc1.phx.<unique_ID>" + } + Example IV (Launch Standby DbSystem): + POST /20160918/dbSystems + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "availabilityDomain": "OXET:PHX-AD-1", + "compartmentId": "ocid1.tenancy.oc1..<unique_ID>", + "cpuCoreCount": 8, + "databaseEdition": "ENTERPRISE_EDITION", + "dbHome": { + "database": { + "adminPassword": "<password>", + "protectionMode": "MAXIMUM_AVAILABILITY", + "transportType": "SYNC", + "databaseSoftwareImageId": "ocid1.softwareImage", + "isActiveDataGuardEnabled": true, + "dbUniqueName": "UniqueName1", + }, + "displayName": null + }, + "diskRedundancy": null, + "displayName": "tst3dbsys", + "domain": "<example.com>", + "hostname": "athena", + "kmsKeyId": "ocid1.key.oc1.phx.<unique_ID>", + "shape": "VM.Standard2.4", + "source": "DATAGUARD", + "sshPublicKeys": [ "ssh-rsa <public_SSH_key> name@example.com" ], + "subnetId": "ocid1.subnet.oc1.phx.<unique_ID>", + "primaryDbSystemId": "ocid1.dbsystem.oc1...<unique_ID>", + "licenseModel": "LICENSE_INCLUDED" + } + /dbSystems/{dbSystemId}: + delete: + description: | + Terminates a DB system and permanently deletes it and any databases running on it, and any storage volumes attached to it. The database data is local to the DB system and will be lost when the system is terminated. Oracle recommends that you back up any data in the DB system prior to terminating it. + + **Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model. + operationId: TerminateDbSystem + parameters: + - $ref: '#/components/parameters/DbSystemIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The request to terminate the DB system was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: TerminateDbSystem + tags: + - database + x-example: | + DELETE /20160918/dbSystems/<dbSystemId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DbSystem' + get: + description: | + Gets information about the specified DB system. + + **Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model. + operationId: GetDbSystem + parameters: + - $ref: '#/components/parameters/DbSystemIdPathParam' + responses: + '200': + description: The DB system information was retrieved. + 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/DbSystem' + application-json: + examples: + response: + value: | + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1..", + "cpuCoreCount" : 8, + "databaseEdition" : "ENTERPRISE_EDITION", + "diskRedundancy" : "HIGH", + "displayName" : "tst3dbsys", + "domain" : "my.company.com", + "hostname" : "athena", + "id" : "ocid1.dbsystem.oc1.phx.", + "lastPatchHistoryEntryId" : "ocid1.dbpatchhistory.oc1.phx.", + "licenseModel" : "LICENSE_INCLUDED", + "lifecycleDetails" : null, + "lifecycleState" : "PROVISIONING", + "listenerPort" : 1521, + "scanIpIds": null, + "shape" : "BM.DenseIO1.36", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "subnetId" : "ocid1.subnet.oc1.phx.", + "scanDnsName" : "tst3dbsys.my.company.com", + "zoneId" : "ocid1.zone.oc1.phx.", + "timeCreated" : "2016-11-23T01:59:07.030Z", + "version" : "201609160308", + "vipIds": null + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetDbSystem + tags: + - database + x-example: | + GET /20160918/dbSystems/<dbSystemId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the properties of the specified DB system. + + **Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model. + operationId: UpdateDbSystem + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/DbSystemIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateDbSystemDetails' + description: Request to update the properties of a DB system. + required: true + responses: + '200': + description: The request was successfully received and the DB system update is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DbSystem' + application-json: + examples: + response: + value: | + Response to Example I: + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1..", + "cpuCoreCount" : 8, + "databaseEdition" : "ENTERPRISE_EDITION", + "diskRedundancy" : "HIGH", + "displayName" : "tst3dbsys", + "domain" : "example.com", + "hostname" : "athena", + "id" : "ocid1.dbsystem.oc1.phx.", + "lastPatchHistoryEntryId" : null, + "lifecycleDetails" : null, + "lifecycleState" : "UPDATING", + "listenerPort" : 1521, + "scanIpIds": null, + "shape" : "BM.DenseIO1.36", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "subnetId" : "ocid1.subnet.oc1.phx.", + "timeCreated" : "2016-11-23T01:59:07.030Z", + "version" : "201609160308", + "vipIds": null + } + + Response to Example II: + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1..", + "cpuCoreCount" : 8, + "databaseEdition" : "ENTERPRISE_EDITION", + "diskRedundancy" : "HIGH", + "displayName" : "tst3dbsys", + "domain" : "my.company.com", + "hostname" : "athena", + "id" : "ocid1.dbsystem.oc1.phx.", + "lastPatchHistoryEntryId" : "ocid1.dbpatchhistory.oc1.phx.", + "lifecycleDetails" : "Executing APPLY with patch 'The patch display name'", + "lifecycleState" : "UPDATING", + "listenerPort" : 1521, + "scanIpIds": null, + "shape" : "BM.DenseIO1.36", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "subnetId" : "ocid1.subnet.oc1.phx.", + "timeCreated" : "2016-11-23T01:59:07.030Z", + "version" : "201609160308", + "vipIds": null + } + + Response to example III: + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1..", + "cpuCoreCount" : 8, + "databaseEdition" : "ENTERPRISE_EDITION", + "diskRedundancy" : "HIGH", + "displayName" : "tst3dbsys", + "domain" : "my.company.com", + "hostname" : "athena", + "id" : "ocid1.dbsystem.oc1.phx.", + "lastPatchHistoryEntryId" : null, + "lifecycleDetails" : null, + "lifecycleState" : "UPDATING", + "listenerPort" : 1521, + "scanIpIds": null, + "shape" : "BM.DenseIO1.36", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "subnetId" : "ocid1.subnet.oc1.phx.", + "timeCreated" : "2016-11-23T01:59:07.030Z", + "version" : "201609160308", + "vipIds": null + } + + Response to example IV: + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1..", + "cpuCoreCount" : 8, + "databaseEdition" : "ENTERPRISE_EDITION", + "diskRedundancy" : "HIGH", + "displayName" : "tst3dbsys", + "domain" : "my.company.com", + "hostname" : "athena", + "id" : "ocid1.dbsystem.oc1.phx.", + "lastPatchHistoryEntryId" : "ocid1.dbpatchhistory.oc1.phx.", + "lifecycleDetails" : "Executing APPLY with patch 'The patch display name'", + "lifecycleState" : "UPDATING", + "listenerPort" : 1521, + "scanIpIds": null, + "shape" : "BM.DenseIO1.36", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "subnetId" : "ocid1.subnet.oc1.phx.", + "timeCreated" : "2016-11-23T01:59:07.030Z", + "version" : "201609160308", + "vipIds": null + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateDbSystem + tags: + - database + x-example: | + Example I: + PUT /latest/dbSystems/<dbSystemId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "cpuCoreCount" : 10 + } + + Example II: + PUT /latest/dbSystems/<dbSystemId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "version" : { + "patchId" : "ocid1.patch.oc1.phx.<unique_ID>", + "action" : "APPLY" + } + } + + Example III: + PUT /latest/dbSystems/<dbSystemId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "sshPublicKeys" : [ "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEA...BOk70tWmJHF== rsa-key-20170408" ] + } + + Example IV: + PUT /latest/dbSystems/<dbSystemId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "cpuCoreCount" : 10, + "version" : { + "patchId" : "ocid1.patch.oc1.phx.<unique_ID>", + "action" : "APPLY" + }, + "sshPublicKeys" : [ "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEA...BOk70tWmJHF== rsa-key-20170408" ] + } + /dbSystems/{dbSystemId}/ExadataIormConfig: + get: + description: | + Gets the IORM configuration settings for the specified cloud Exadata DB system. + All Exadata service instances have default IORM settings. + + **Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model. + + The [GetCloudVmClusterIormConfig](#/en/database/latest/CloudVmCluster/GetCloudVmClusterIormConfig/) API is used for this operation with Exadata systems using the + new resource model. + operationId: GetExadataIormConfig + parameters: + - $ref: '#/components/parameters/DbSystemIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The IORM configuration was retrieved. + 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/ExadataIormConfig' + application-json: + examples: + response: + value: | + { + "lifeCycleState": "ACTIVE", + "lifeCycleDetails": "Successful", + "objective": "Auto", + "dbPlans": [ + { + "dbName": "default", + "share": "4", + "flashCacheLimit": "1490G" + }, + { + "dbName": "db1", + "share": "5", + "flashCacheLimit": "2048G" + }, + { + "dbName": "db2", + "share": "4", + "flashCacheLimit": "1490G" + }, + { + "dbName": "db3", + "share": null, + "flashCacheLimit": null + }, + { + "dbName": "db4", + "share": null, + "flashCacheLimit": null + } + ] + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - database + x-example: | + GET /20160918/dbSystems/<dbSystemId>/ExadataIormConfig + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DbSystem' + put: + description: | + Updates IORM settings for the specified Exadata DB system. + + **Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model. + + The [UpdateCloudVmClusterIormConfig](#/en/database/latest/CloudVmCluster/UpdateCloudVmClusterIormConfig/) API is used for Exadata systems using the + new resource model. + operationId: UpdateExadataIormConfig + parameters: + - $ref: '#/components/parameters/DbSystemIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + $ref: '#/components/requestBodies/ExadataIormConfigUpdateDetails' + responses: + '200': + description: The updated IORM configuration was retrieved. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExadataIormConfig' + application-json: + examples: + response: + value: | + { + "lifeCycleState": "ACTIVE", + "lifeCycleDetails": "Successful", + "objective": "Auto", + "dbPlans": [ + { + "dbName": "default", + "share": "4", + "flashCacheLimit": "1490G" + }, + { + "dbName": "db1", + "share": "5", + "flashCacheLimit": "2048G" + }, + { + "dbName": "db2", + "share": "4", + "flashCacheLimit": "1490G" + }, + { + "dbName": "db3", + "share": null, + "flashCacheLimit": null + }, + { + "dbName": "db4", + "share": null, + "flashCacheLimit": null + } + ] + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - database + x-example: | + PUT /latest/dbSystems/<dbSystemId>/ExadataIormConfig + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DbSystem' + /dbSystems/{dbSystemId}/actions/changeCompartment: + post: + description: | + Moves the DB system and its dependent resources to the specified compartment. + For more information about moving DB systems, see + [Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes). + operationId: ChangeDbSystemCompartment + parameters: + - $ref: '#/components/parameters/DbSystemIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeCompartmentDetails' + description: | + Request to move the DB system to a different compartment. + + **Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model. + required: true + responses: + '202': + description: The request was successfully received and the change compartment action is being performed. + 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 + opc-work-request-id: + description: Unique Oracle-assigned identifier of the work 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeDbSystemCompartment + tags: + - database + x-example: | + POST /20160918/dbSystems/<dbSystemId>/actions/changeCompartment + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid.compartment.oc1..<unique_ID>" + } + x-related-resource: '#/definitions/DbSystem' + /dbSystems/{dbSystemId}/actions/migration: + post: + description: | + Migrates the Exadata DB system to the new [Exadata resource model](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model). + All related resources will be migrated. + operationId: MigrateExadataDbSystemResourceModel + parameters: + - $ref: '#/components/parameters/DbSystemIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '200': + description: An object containing information about the migration to the cloud Exadata infrastructure model. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExadataDbSystemMigration' + application-json: + examples: + response: + value: | + { + "dbSystemId" : "ocid1.dbsystem.oc1.phx.<unique_ID>", + "cloudVmClusterId": "ocid1.cloudVmCluster.oc1.phx.<unique_ID>", + "cloudExadataInfrastructureId": "ocid1.cloudExadataInfrastructure.oc1.phx.<unique_ID>" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - database + x-example: | + PUT /latest/dbSystems/<dbSystemId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DbSystem' + /dbSystems/{dbSystemId}/actions/osPatch: + post: + description: | + Execute an operating system (OS) patch action on a DB system. Returns 202 and a work request. Some updates may require a reboot. + operationId: ExecuteDbSystemOsPatch + parameters: + - $ref: '#/components/parameters/DbSystemIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExecuteDbSystemOsPatchDetails' + description: Details to execute an OS patch action on a DB System. + required: true + responses: + '202': + description: The request was successfully received and the OS patching action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: ExecuteDbSystemOsPatch + tags: + - database + x-example: | + POST /20160918/dbSystems/<dbSystemId>/actions/osPatch + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "action" : "PRECHECK" + } + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/DbSystem' + /dbSystems/{dbSystemId}/actions/upgrade: + post: + description: | + Upgrades the operating system and grid infrastructure of the DB system. + operationId: UpgradeDbSystem + parameters: + - $ref: '#/components/parameters/DbSystemIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpgradeDbSystemDetails' + description: Request to perform an upgrade of the operating system and the Oracle Grid Infrastructure (GI) of the DB system. + required: true + responses: + '202': + description: The request was successfully received and the action is being performed. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DbSystem' + '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/DefaultError' + summary: UpgradeDbSystem + tags: + - database + x-example: | + POST /20160918/dbSystems/<dbSystemId>/actions/upgrade + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "newGiVersion" : "19.7.0.0", + "snapshotRetentionPeriodInDays" : 30 + "action" : "PRECHECK" + } + x-related-resource: '#/definitions/DbSystem' + /dbSystems/{dbSystemId}/dbSystemUpgrades: + get: + description: | + Lists the applicable upgrade components for a DB systems. + operationId: ListDbSystemUpgrades + parameters: + - $ref: '#/components/parameters/DbSystemIdPathParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + responses: + '200': + description: Lists the possible upgrade components available for DB systems. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListDbSystemUpgradesResponse' + Example I - Response, LVM DbSystem: + examples: + response: + value: + Example II - ASM DbSystem: + application-json: | + [ + { + "component" : "OS_GI", + "osVersion" : "Oracle Linux Server release 8.6", + "giVersion" : "19.16.0.0" + }, { + "component" : "OS_GI", + "osVersion" : "Oracle Linux Server release 8.6", + "giVersion" : "19.17.0.0" + }, { + "component" : "GI", + "osVersion" : null, + "giVersion" : "19.17.0.0" + } + ] + application-json: | + [ + { + "component" : "OS", + "osVersion" : "Oracle Linux Server release 8.6", + "giVersion" : null + } + ] + '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/DefaultError' + summary: ListDbSystemUpgrades + tags: + - database + x-example: | + GET /20160918/dbSystems/<dbSystemId>/dbSystemUpgrades + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DbSystemUpgradeSummary' + /dbSystems/{dbSystemId}/osPatchHistoryEntries: + get: + description: | + Gets the history of the OS patch actions performed on the specified DB system. + operationId: ListDbSystemOsPatchHistoryEntries + parameters: + - $ref: '#/components/parameters/DbSystemIdPathParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListDbSystemOsPatchHistoryEntriesSortByQueryParam' + - $ref: '#/components/parameters/ListDbSystemOsPatchHistoryEntriesFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/ListDbSystemOsPatchHistoryEntriesFilterByActionQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The OS patch history for the specified DB system was retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/DbSystemOsPatchHistoryEntryCollection' + application-json: + examples: + response: + value: | + { + "items": [ + { + "action": "PRECHECK", + "dbSystemId": "ocid1.dbsystem.oc1.phx.", + "id": "ocid1.dbsystemospatchhistory.oc1.phx.", + "lifecycleState": "SUCCEEDED", + "lifecycleDetails": "Completed successfully.", + "osPatchDetails": { + "items": [ + { + "dbNodeId": "ocid1.dbnode.oc1.phx.", + "rpms": ["NetworkManager.x86_64::1:1.40.16-20.0.1.el8_10", "NetworkManager-libnm.x86_64::1:1.40.16-20.0.1.el8_10"], + "isRebootRequired": true + }, + { + "dbNodeId": "ocid1.dbnode.oc1.phx.", + "rpms": ["NetworkManager.x86_64::1:1.40.16-20.0.1.el8_10", "NetworkManager-libnm.x86_64::1:1.40.16-20.0.1.el8_10"], + "isRebootRequired": true + } + ] + }, + "timeStarted": "2025-11-21T01:59:07.032Z", + "timeEnded": "2025-11-21T02:21:07.032Z" + }, + { + "action" : "APPLY", + "dbSystemId": "ocid1.dbsystem.oc1.phx.", + "id" : "ocid1.dbsystemospatchhistory.oc1.phx.", + "lifecycleState" : "IN_PROGRESS", + "lifecycleDetails" : null, + "osPatchDetails": { + "items": [ + { + "dbNodeId": "ocid1.dbnode.oc1.phx.", + "rpms": [], + "isRebootRequired": false + } + ] + }, + "timeStarted" : "2025-11-07T07:07:07.007Z", + "timeEnded" : null + } + ] + } + '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/DefaultError' + summary: ListDbSystemOsPatchHistoryEntries + tags: + - database + x-example: | + GET /20160918/dbSystems/<dbSystemId>/osPatchHistoryEntries?limit=100 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DbSystemOsPatchHistoryEntryCollection' + /dbSystems/{dbSystemId}/osPatchHistoryEntries/{osPatchHistoryEntryId}: + get: + description: | + Gets the details of the specified OS patch action for the specified DB system. + operationId: GetDbSystemOsPatchHistoryEntry + parameters: + - $ref: '#/components/parameters/DbSystemIdPathParam' + - $ref: '#/components/parameters/DbSystemOsPatchHistoryEntryIdParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The OS patch operation details were retrieved. + 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/DbSystemOsPatchHistoryEntry' + Example I - Response for a single node DB System: + examples: + response: + value: + application-json: | + { + "action": "PRECHECK", + "dbSystemId": "ocid1.dbsystem.oc1.phx.", + "id": "ocid1.dbsystemospatchhistory.oc1.phx.", + "lifecycleState": "SUCCEEDED", + "lifecycleDetails": "Completed successfully.", + "osPatchDetails": { + "items": [ + { + "dbNodeId": "ocid1.dbnode.oc1.phx.", + "rpms": ["NetworkManager.x86_64::1:1.40.16-20.0.1.el8_10", "NetworkManager-libnm.x86_64::1:1.40.16-20.0.1.el8_10"], + "isRebootRequired": true + } + ] + }, + "timeStarted": "2025-10-21T01:59:07.032Z", + "timeEnded": "2025-10-21T02:21:07.032Z" + } + Example II - Response for a 2 node DB System: + examples: + response: + value: + application-json: | + { + "action": "PRECHECK", + "dbSystemId": "ocid1.dbsystem.oc1.phx.", + "id": "ocid1.dbsystemospatchhistory.oc1.phx.", + "lifecycleState": "SUCCEEDED", + "lifecycleDetails": "Completed successfully.", + "osPatchDetails": { + "items": [ + { + "dbNodeId": "ocid1.dbnode.oc1.phx.", + "rpms": ["NetworkManager.x86_64::1:1.40.16-20.0.1.el8_10", "NetworkManager-libnm.x86_64::1:1.40.16-20.0.1.el8_10"], + "isRebootRequired": true + }, + { + "dbNodeId": "ocid1.dbnode.oc1.phx.", + "rpms": ["NetworkManager.x86_64::1:1.40.16-20.0.1.el8_10", "NetworkManager-libnm.x86_64::1:1.40.16-20.0.1.el8_10"], + "isRebootRequired": true + } + ] + }, + "timeStarted": "2025-10-21T01:59:07.032Z", + "timeEnded": "2025-10-21T02:21:07.032Z" + } + '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/DefaultError' + summary: GetDbSystemOsPatchHistoryEntry + tags: + - database + x-example: | + GET /20160918/dbSystems/<dbSystemId>/osPatchHistoryEntries/<osPatchHistoryEntryId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DbSystemOsPatchHistoryEntry' + /dbSystems/{dbSystemId}/patchHistoryEntries: + get: + description: | + Gets the history of the patch actions performed on the specified DB system. + operationId: ListDbSystemPatchHistoryEntries + parameters: + - $ref: '#/components/parameters/DbSystemIdPathParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + responses: + '200': + description: The patch history for the specified DB system was retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListDbSystemPatchHistoryEntriesResponse' + application-json: + examples: + response: + value: | + [ + { + "action" : "APPLY", + "patchId" : "ocid1.dbpatch.oc1.phx.", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "lifecycleState" : "IN_PROGRESS", + "lifecycleDetails" : null, + "timeStarted" : "2017-01-01T07:07:07.007Z", + "timeEnded" : null + }, { + "action" : "APPLY", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "patchId" : "ocid1.dbpatch.oc1.phx.", + "lifecycleState" : "SUCCESS", + "lifecycleDetails" : "Completed successfully.", + "timeStarted" : "2016-12-21T01:59:07.032Z", + "timeEnded" : "2016-12-21T02:21:07.032Z" + }, { + "action" : "APPLY", + "patchId" : "ocid1.dbpatch.oc1.phx.", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "lifecycleState" : "FAILED", + "lifecycleDetails" : "", + "timeStarted" : "2016-11-20T01:23:45.6789Z", + "timeEnded" : "2016-11-20T01:23:45.6789Z" + } + ] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDbSystemPatchHistoryEntries + tags: + - database + x-example: | + GET /20160918/dbSystems/<dbSystemId>/patchHistoryEntries?limit=100 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/PatchHistoryEntry' + /dbSystems/{dbSystemId}/patchHistoryEntries/{patchHistoryEntryId}: + get: + description: | + Gets the details of the specified patch operation on the specified DB system. + operationId: GetDbSystemPatchHistoryEntry + parameters: + - $ref: '#/components/parameters/DbSystemIdPathParam' + - $ref: '#/components/parameters/PatchHistoryEntryIdPathParam' + responses: + '200': + description: The patch operation details were retrieved. + 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/PatchHistoryEntry' + application-json: + examples: + response: + value: | + { + "action" : "APPLY", + "patchId" : "ocid1.dbpatch.oc1.phx.", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "lifecycleState" : "FAILED", + "lifecycleDetails" : "", + "timeStarted" : "2016-11-20T01:23:45.6789Z", + "timeEnded" : "2016-11-20T01:23:45.6789Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetDbSystemPatchHistoryEntry + tags: + - database + x-example: | + GET /20160918/patchHistoryEntries/<patchHistoryEntryId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/PatchHistoryEntry' + /dbSystems/{dbSystemId}/patches: + get: + description: | + Lists the patches applicable to the specified DB system. + operationId: ListDbSystemPatches + parameters: + - $ref: '#/components/parameters/DbSystemIdPathParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + responses: + '200': + description: The list of applicable patches was retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListDbSystemPatchesResponse' + application-json: + examples: + response: + value: | + [ + { + "availableActions" : ["APPLY"], + "description" : "Patch PSU as released on 201611", + "id" : "ocid1.dbpatch.oc1.phx.", + "lastAction" : "APPLY", + "lifecycleDetails" : "", + "lifecycleState" : "FAILED", + "timeReleased" : "2017-02-16T01:50:07.0001", + "type" : "BUNDLE", + "version" : "20170127" + }, + { + "availableActions" : ["APPLY"], + "description" : "Patch PSU as released on 20170127", + "id" : "ocid1.dbpatch.oc1.phx.", + "lastAction" : null, + "lifecycleDetails" : null, + "lifecycleState" : "AVAILABLE", + "timeReleased" : "2017-02-17T09:20:01.0007", + "type" : "BUNDLE", + "version" : "20170127" + } + ] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDbSystemPatches + tags: + - database + x-example: | + GET /20160918/dbSystems/<dbSystemId>/patches?limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Patch' + /dbSystems/{dbSystemId}/patches/{patchId}: + get: + description: | + Gets information the specified patch. + operationId: GetDbSystemPatch + parameters: + - $ref: '#/components/parameters/DbSystemIdPathParam' + - $ref: '#/components/parameters/PatchIdPathParam' + responses: + '200': + description: The patch information was retrieved. + 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/Patch' + application-json: + examples: + response: + value: | + { + "description" : "Patch PSU as released on 20170127", + "id" : "ocid1.dbpatch.oc1.phx.", + "name" : "DbSystem 20170127", + "timeReleased" : "2017-01-16T01:50:07.0001Z", + "type" : "BUNDLE", + "version" : "20170127" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetDbSystemPatch + tags: + - database + x-example: | + GET /20160918/dbSystems/<dbSystemId>/patches/<patchId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Patch' + /dbSystems/{dbSystemId}/upgradeHistoryEntries: + get: + description: | + Gets the history of the upgrade actions performed on the specified DB system. + operationId: ListDbSystemUpgradeHistoryEntries + parameters: + - $ref: '#/components/parameters/DbSystemIdPathParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListUpgradeHistoryEntriesSortByQueryParam' + - $ref: '#/components/parameters/FilterByDbSystemUpgradeActionQueryParam' + - $ref: '#/components/parameters/FilterByUpgradeDbSystemLifecycleStateQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The upgrade history for the specified DB system was retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListDbSystemUpgradeHistoryEntriesResponse' + application-json: + examples: + response: + value: | + [ + { + "action" : "UPGRADE", + "id" : "ocid1.dbsystemupgradehistory.oc1.phx.", + "newGiVersion" : "19.7.0.0", + "oldGiVersion" : "18.6.0.0", + "snapshotRetentionPeriodInDays" : "30", + "lifecycleState" : "IN_PROGRESS", + "lifecycleDetails" : null, + "timeStarted" : "2017-01-01T07:07:07.007Z", + "timeEnded" : null + }, { + "action" : "UPGRADE", + "id" : "ocid1.dbsystemupgradehistory.oc1.phx.", + "newGiVersion" : "19.7.0.0", + "oldGiVersion" : "18.6.0.0", + "snapshotRetentionPeriodInDays" : "20", + "lifecycleState" : "SUCCESS", + "lifecycleDetails" : "Completed successfully.", + "timeStarted" : "2016-12-21T01:59:07.032Z", + "timeEnded" : "2016-12-21T02:21:07.032Z" + }, { + "action" : "UPGRADE", + "id" : "ocid1.dbsystemupgradehistory.oc1.phx.", + "newGiVersion" : "19.7.0.0", + "oldGiVersion" : "18.6.0.0", + "snapshotRetentionPeriodInDays" : "30", + "lifecycleState" : "FAILED", + "lifecycleDetails" : "", + "timeStarted" : "2016-11-20T01:23:45.6789Z", + "timeEnded" : "2016-11-20T01:23:45.6789Z" + } + ] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDbSystemUpgradeHistoryEntries + tags: + - database + x-example: | + GET /20160918/dbSystems/<dbSystemId>/upgradeHistoryEntries?limit=100 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DbSystemUpgradeHistoryEntry' + /dbSystems/{dbSystemId}/upgradeHistoryEntries/{upgradeHistoryEntryId}: + get: + description: | + Gets the details of the specified operating system upgrade operation for the specified DB system. + operationId: GetDbSystemUpgradeHistoryEntry + parameters: + - $ref: '#/components/parameters/DbSystemIdPathParam' + - $ref: '#/components/parameters/UpgradeHistoryEntryIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The upgrade operation details were retrieved. + 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/DbSystemUpgradeHistoryEntry' + application-json: + examples: + response: + value: | + { + "action" : "UPGRADE", + "id" : "ocid1.dbsystemupgradehistory.oc1.phx.", + "lifecycleState" : "FAILED", + "lifecycleDetails" : "", + "timeStarted" : "2016-11-20T01:23:45.6789Z", + "timeEnded" : "2016-11-20T01:23:45.6789Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetDbSystemUpgradeHistoryEntry + tags: + - database + x-example: | + GET /20160918/upgradeHistoryEntries/<upgradeHistoryEntryId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DbSystemUpgradeHistoryEntry' + /dbVersions: + get: + description: Gets a list of supported Oracle Database versions. + operationId: ListDbVersions + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/DbSystemShapeParam' + - $ref: '#/components/parameters/OptionalDbSystemIdQueryParam' + - $ref: '#/components/parameters/OptionalStorageManagementQueryParam' + - $ref: '#/components/parameters/ShapeAttributeQueryParam' + - $ref: '#/components/parameters/OptionalDatabaseUpgradeSupportedQueryParam' + - $ref: '#/components/parameters/OptionalDatabaseSoftwareImageSupportedQueryParam' + responses: + '200': + description: Supported Oracle Database versions. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListDbVersionsResponse' + application-json: + examples: + response: + value: | + { + "version" : "11.2.0.4", + "supportsPdb" : "false" + }, { + "version" : "12.1.0.2", + "supportsPdb" : "true" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDbVersions + tags: + - database + x-example: | + GET /20160918/dbVersions?compartmentId=<compartmentId>&limit=100 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-authz-declarations: + authorizationRequired: false + /dbnodeSnapshots: + get: + description: | + Gets a list of the Exadata Database Node Snapshots in the specified compartment. + operationId: ListDbnodeSnapshots + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/ListDbnodeSnapshotsSortByQueryParam' + - $ref: '#/components/parameters/FilterByNameQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListDbnodeSnapshotsFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/ListDbnodeSnapshotsFilterByClusterQueryParam' + - $ref: '#/components/parameters/ListDbnodeSnapshotsFilterByDbNodeQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: List of the Exadata Database Node Snapshots + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListDbnodeSnapshotsResponse' + application-json: + examples: + response: + value: | + [ + { + "id" : "ocid1.dbnodesnapshot.oc1.", + "exadbVmClusterId" : "ocid1.exadbvmcluster.oc1.", + "compartmentId": "ocid1.compartment.oc1.", + "name" : "snapshot-1", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "lifecycleState" : "PROVISIONING", + "lifecycleDetails" : null, + "sourceDbnodeId": "ocid1.dbnode.oc1." + } + ] + '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/DefaultError' + summary: ListDbnodeSnapshots + tags: + - database + x-example: | + GET /20160918/dbnodeSnapshots?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/DbnodeSnapshot' + /dbnodeSnapshots/{dbnodeSnapshotId}: + delete: + description: | + Deletes the specified Exadata Database Node Snapshot. + operationId: DeleteDbnodeSnapshot + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/DbnodeSnapshotIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '204': + description: The request to delete the Exadata Database Node Snapshot was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Deletes the specified Exadata Database Node Snapshot. + tags: + - database + x-related-resource: '#/definitions/DbnodeSnapshot' + get: + description: | + Gets information about the specified Exadata Database Node Snapshot in the specified compartment. + operationId: GetDbnodeSnapshot + parameters: + - $ref: '#/components/parameters/DbnodeSnapshotIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: Information about the Exadata Database Node Snapshot. + 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/DbnodeSnapshot' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.dbnodesnapshot.oc1.", + "exadbVmClusterId" : "ocid1.exadbvmcluster.oc1.", + "compartmentId": "ocid1.compartment.oc1.", + "name" : "snapshot-1", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "lifecycleState" : "PROVISIONING", + "lifecycleDetails" : null, + "sourceDbnodeId": "ocid1.dbnode.oc1.", + "mountPoints": [{ + "name" : "mount-1", "dbNodeId": "ocid1.dbnode.oc1." + }], + "volumes": [ + {"name": "vol-1", "size": 100}, + {"name": "vol-2", "size": 100}, + {"name": "vol-3", "size": 100}, + ] + } + '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/DefaultError' + summary: GetDbnodeSnapshot + tags: + - database + x-example: | + GET /20160918/dbnodeSnapshots/<dbnodeSnapshotId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /dbnodeSnapshots/{dbnodeSnapshotId}/actions/mount: + post: + description: | + Mounts the snapshot for the provided dbNode. + operationId: MountDbnodeSnapshot + parameters: + - $ref: '#/components/parameters/DbnodeSnapshotIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MountDbnodeSnapshotDetails' + description: Request to mount the snapshot for the provided Exadata Database Node. + required: true + responses: + '202': + description: The request was successfully received and the mount action is being performed. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DbnodeSnapshot' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.dbnodesnapshot.oc1.", + "exadbVmClusterId" : "ocid1.exadbvmcluster.oc1.", + "compartmentId": "ocid1.compartment.oc1.", + "name" : "snapshot-1", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "lifecycleState" : "MOUNTING", + "lifecycleDetails" : null, + "sourceDbnodeId": "ocid1.dbnode.oc1.", + "mountPoints": [{ + "name" : "mount-1", "dbNodeId": "ocid1.dbnode.oc1." + }], + "volumes": [ + {"name": "vol-1", "size": 100}, + {"name": "vol-2", "size": 100}, + {"name": "vol-3", "size": 100}, + ] + } + '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/DefaultError' + summary: MountDbnodeSnapshot + tags: + - database + x-example: | + POST /20160918/dbnodeSnapshots/<dbnodeSnapshotId>/actions/mount + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "dbNodeId": "ocid1.dbnode.oc1." + } + x-obmcs-terraform: + actionType: START + x-related-resource: '#/definitions/DbnodeSnapshot' + /dbnodeSnapshots/{dbnodeSnapshotId}/actions/unmount: + post: + description: | + Unmounts the snapshot for the provided dbNode. + operationId: UnmountDbnodeSnapshot + parameters: + - $ref: '#/components/parameters/DbnodeSnapshotIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnmountDbnodeSnapshotDetails' + description: Request to unmount the snapshot for the provided Exadata Database Node. + required: true + responses: + '202': + description: The request was successfully received and the unmount action is being performed. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DbnodeSnapshot' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.dbnodesnapshot.oc1.", + "exadbVmClusterId" : "ocid1.exadbvmcluster.oc1.", + "compartmentId": "ocid1.compartment.oc1.", + "name" : "snapshot-1", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "lifecycleState" : "UNMOUNTING", + "lifecycleDetails" : null, + "sourceDbnodeId": "ocid1.dbnode.oc1.", + "mountPoints": [{ + "name" : "mount-1", "dbNodeId": "ocid1.dbnode.oc1." + }], + "volumes": [ + {"name": "vol-1", "size": 100}, + {"name": "vol-2", "size": 100}, + {"name": "vol-3", "size": 100}, + ] + } + '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/DefaultError' + summary: UnmountDbnodeSnapshot + tags: + - database + x-example: | + POST /20160918/dbnodeSnapshots/<dbnodeSnapshotId>/actions/unmount + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "dbNodeId": "ocid1.dbnode.oc1." + } + x-obmcs-terraform: + actionType: STOP + x-related-resource: '#/definitions/DbnodeSnapshot' + /exadataInfrastructures: + get: + description: | + Lists the Exadata infrastructure resources in the specified compartment. Applies to Exadata Cloud@Customer instances only. + To list the Exadata Cloud Service infrastructure resources in a compartment, use the [ListCloudExadataInfrastructures](#/en/database/latest/CloudExadataInfrastructure/ListCloudExadataInfrastructures) operation. + operationId: ListExadataInfrastructures + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ListExadataInfrastructuresSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListExadataInfrastructuresFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/OptionalExcludedFieldsQueryParam' + responses: + '200': + description: | + A list of the Exadata Cloud@Customer infrastructure resources in the specified compartment. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListExadataInfrastructuresResponse' + application-json: + examples: + response: + value: | + [ + { + "compartmentId" : "ocid1.tenancy.oc1.", + "displayName" : "tstExaInfra", + "id" : "ocid1.exadataInfrastructure.oc1.", + "lifecycleDetails" : "", + "lifecycleState" : "ACTIVE", + "shape" : "Exadata.Full2.336", + "timeZone" : "PST", + "storageCount" : 4, + "additionalStorageCount" : 2, + "isMultiRackDeployment": true, + "multiRackConfigurationFile": "ZmFrZV9leGFjY19pbmZyYXN0cnVjdHVyZV9jb25maWc=", + "activatedStorageCount" : 0, + "computeCount" : 2, + "additionalComputeCount": 1, + "additionalComputeSystemModel": "X9M", + "cpusEnabled" : 16, + "memorySizeInGBs" : 40, + "dbNodeStorageSizeInGBs" : 60, + "dataStorageSizeInTBs" : 84, + "rackSerialNumber" : "AK00436142", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "cloudControlPlaneServer1" :"192.168.19.1", + "cloudControlPlaneServer2" : "192.168.19.2", + "netmask" : "255.255.0.0", + "gateway" : "192.168.20.1", + "adminNetworkCIDR" : "192.168.19.2/16", + "infiniBandNetworkCIDR" : "10.172.19.1/24", + "corporateProxy" : "192.168.20.1", + "dnsServer" : ["192.168.10.10"], + "databaseServerType": "X11M", + "storageServerType": "X11M-HC-XRMEM", + "computeModel": "OCPU", + "ntpServer" : ["192.168.10.20"] + } + ] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListExadataInfrastructures + tags: + - database + x-example: | + GET /20160918/exadataInfrastructures?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExadataInfrastructure' + post: + description: | + Creates an Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only. + To create an Exadata Cloud Service infrastructure resource, use the [CreateCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/CreateCloudExadataInfrastructure) operation. + operationId: CreateExadataInfrastructure + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateExadataInfrastructureDetails' + description: Request to create Exadata Cloud@Customer infrastructure. + required: true + responses: + '200': + description: | + The request was successfully received and the create Exadata Cloud@Customer infrastructure operation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExadataInfrastructure' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1.", + "displayName" : "tstExaInfra", + "id" : "ocid1.exadataInfrastructure.oc1.", + "lifecycleDetails" : "", + "lifecycleState" : "CREATING", + "shape" : "Exadata.Full2.336", + "timeZone" : "PST", + "storageCount" : 4, + "additionalStorageCount" : 0, + "isMultiRackDeployment": true, + "multiRackConfigurationFile": "ZmFrZV9leGFjY19pbmZyYXN0cnVjdHVyZV9jb25maWc=", + "activatedStorageCount" : 0, + "computeCount" : 2, + "additionalComputeCount": 1, + "additionalComputeSystemModel": "X9M", + "cpusEnabled" : 4, + "memorySizeInGBs" : 8, + "dbNodeStorageSizeInGBs" : 60, + "dataStorageSizeInTBs" : 84, + "timeCreated" : "2018-11-23T01:59:07.030Z", + "cloudControlPlaneServer1" :"192.168.19.1", + "cloudControlPlaneServer2" : "192.168.19.2", + "netmask" : "255.255.0.0", + "gateway" : "192.168.20.1", + "adminNetworkCIDR" : "192.168.19.2/16", + "infiniBandNetworkCIDR" : "10.172.19.1/24", + "corporateProxy" : "192.168.20.1", + "dnsServer" : ["192.168.10.10"], + "databaseServerType": "X11M", + "storageServerType": "X11M-HC-XRMEM", + "computeModel": "OCPU", + "ntpServer" : ["192.168.10.20"] + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateExadataInfrastructure + tags: + - database + x-example: | + POST /20160918/exadataInfrastructures + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.tenancy.oc1.<unique_ID>", + "displayName" : "tstExaInfra", + "shape" : "Exadata.Full2.336", + "timeZone" : "PST", + "cloudControlPlaneServer1" :"192.168.19.1", + "cloudControlPlaneServer2" : "192.168.19.2", + "netmask" : "255.255.0.0", + "gateway" : "192.168.20.1", + "adminNetworkCIDR" : "192.168.19.2/16", + "infiniBandNetworkCIDR" : "10.172.19.1/24", + "corporateProxy" : "192.168.20.1", + "dnsServer" : ["192.168.10.10"], + "databaseServerType": "X11M", + "storageServerType": "X11M-HC-XRMEM", + "ntpServer" : ["192.168.10.20"] + } + /exadataInfrastructures/{exadataInfrastructureId}: + delete: + description: | + Deletes the Exadata Cloud@Customer infrastructure. + operationId: DeleteExadataInfrastructure + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '204': + description: The request to delete the Exadata Cloud@Customer infrastructure was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Deletes the specified Exadata infrastructure. + tags: + - database + x-related-resource: '#/definitions/ExadataInfrastructure' + get: + description: | + Gets information about the specified Exadata infrastructure. Applies to Exadata Cloud@Customer instances only. + To get information on an Exadata Cloud Service infrastructure resource, use the [GetCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/GetCloudExadataInfrastructure) operation. + operationId: GetExadataInfrastructure + parameters: + - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/OptionalExcludedFieldsQueryParam' + responses: + '200': + description: The Exadata Cloud@Customer infrastructure details. + 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/ExadataInfrastructure' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1.", + "displayName" : "tstExaInfra", + "id" : "ocid1.exadataInfrastructure.oc1.", + "lifecycleDetails" : "", + "lifecycleState" : "ACTIVE", + "shape" : "Exadata.Full2.336", + "timeZone" : "PST", + "storageCount" : 4, + "additionalStorageCount" : 2, + "isMultiRackDeployment": true, + "multiRackConfigurationFile": "ZmFrZV9leGFjY19pbmZyYXN0cnVjdHVyZV9jb25maWc=", + "activatedStorageCount" : 0, + "computeCount" : 2, + "additionalComputeCount": 1, + "additionalComputeSystemModel": "X9M", + "cpusEnabled" : 16, + "maxCpuCount" : 200, + "memorySizeInGBs" : 30, + "maxMemoryInGBs" : 200, + "dbNodeStorageSizeInGBs" : 60, + "maxDbNodeStorageInGBs" : 200, + "dataStorageSizeInTBs" : 84, + "maxDataStorageInTBs" : 200, + "rackSerialNumber" : "AK00436142", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "cloudControlPlaneServer1" :"192.168.19.1", + "cloudControlPlaneServer2" : "192.168.19.2", + "netmask" : "255.255.0.0", + "gateway" : "192.168.20.1", + "adminNetworkCIDR" : "192.168.19.2/16", + "infiniBandNetworkCIDR" : "10.172.19.1/24", + "corporateProxy" : "192.168.20.1", + "dnsServer" : ["192.168.10.10"], + "definedFileSystemConfigurations" : [{ + "mountPoint" : "/u01", + "minSizeGb" : 10, + "isResizable" : true, + "isBackupPartition" : true + }, { + "mountPoint" : "/var", + "minSizeGb" : 10, + "isResizable" : false, + "isBackupPartition" : false + }], + "databaseServerType": "X11M", + "storageServerType": "X11M-HC-XRMEM", + "computeModel": "OCPU", + "ntpServer" : ["192.168.10.20"] + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetExadataInfrastructure + tags: + - database + x-example: | + GET /20160918/exadataInfrastructures/<exadataInfrastructureId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only. + To update an Exadata Cloud Service infrastructure resource, use the [UpdateCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/UpdateCloudExadataInfrastructure) operation. + operationId: UpdateExadataInfrastructure + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateExadataInfrastructureDetails' + description: Request to update the properties of an Exadata Cloud@Customer infrastructure. + required: true + responses: + '200': + description: | + The request was successfully received and the Exadata Cloud@Customer infrastructure update is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExadataInfrastructure' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1.", + "displayName" : "tstExaInfra", + "id" : "ocid1.exadataInfrastructure.oc1.", + "lifecycleDetails" : "", + "lifecycleState" : "ACTIVE", + "shape" : "Exadata.Full2.336", + "timeZone" : "PST", + "storageCount" : 4, + "additionalStorageCount" : 2, + "isMultiRackDeployment": true, + "multiRackConfigurationFile": "ZmFrZV9leGFjY19pbmZyYXN0cnVjdHVyZV9jb25maWc=", + "activatedStorageCount" : 0, + "computeCount" : 2, + "additionalComputeCount": 1, + "additionalComputeSystemModel": "X9M", + "cpusEnabled" : 16, + "maxCpuCount" : 200, + "memorySizeInGBs" : 30, + "maxMemoryInGBs" : 200, + "dbNodeStorageSizeInGBs" : 60, + "maxDbNodeStorageInGBs" : 200, + "dataStorageSizeInTBs" : 84, + "maxDataStorageInTBs" : 200, + "timeCreated" : "2018-11-23T01:59:07.030Z", + "cloudControlPlaneServer1" :"192.168.19.1", + "cloudControlPlaneServer2" : "192.168.19.2", + "netmask" : "255.255.0.0", + "gateway" : "192.168.20.1", + "adminNetworkCIDR" : "192.168.19.2/16", + "infiniBandNetworkCIDR" : "10.172.19.2/24", + "corporateProxy" : "192.168.20.1", + "dnsServer" : ["192.168.10.10"], + "ntpServer" : ["192.168.10.20"] + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Updates the specified Exadata Cloud@Customer Infrastructure + tags: + - database + x-example: | + PUT /20160918/exadataInfrastructures/<exadataInfrastructureId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "adminNetworkCIDR" : "192.168.19.1/16", + "infiniBandNetworkCIDR" : "10.172.19.2/24" + } + /exadataInfrastructures/{exadataInfrastructureId}/actions/activate: + post: + description: | + Activates the specified Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only. + operationId: ActivateExadataInfrastructure + parameters: + - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ActivateExadataInfrastructureDetails' + description: The activation details for the Exadata infrastructure and the additional storage servers requested. + required: true + responses: + '200': + description: The Exadata Cloud@Customer Infrastructure. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExadataInfrastructure' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1.", + "displayName" : "tstExaInfra", + "id" : "ocid1.exadataInfrastructure.oc1.", + "lifecycleDetails" : "", + "lifecycleState" : "ACTIVE", + "shape" : "Exadata.Full2.336", + "timeZone" : "PST", + "storageCount" : 4, + "additionalStorageCount" : 2, + "isMultiRackDeployment": false, + "multiRackConfigurationFile": "", + "activatedStorageCount" : 0, + "computeCount" : 2, + "additionalComputeCount": 1, + "additionalComputeSystemModel": "X9M", + "cpusEnabled" : 16, + "maxCpuCount" : 200, + "memorySizeInGBs" : 30, + "maxMemoryInGBs" : 200, + "dbNodeStorageSizeInGBs" : 60, + "maxDbNodeStorageInGBs" : 200, + "dataStorageSizeInTBs" : 84, + "maxDataStorageInTBs" : 200, + "timeCreated" : "2018-11-23T01:59:07.030Z", + "cloudControlPlaneServer1" :"192.168.19.1", + "cloudControlPlaneServer2" : "192.168.19.2", + "netmask" : "255.255.0.0", + "gateway" : "192.168.20.1", + "adminNetworkCIDR" : "192.168.19.2/16", + "infiniBandNetworkCIDR" : "10.172.19.1/24", + "corporateProxy" : "192.168.20.1", + "dnsServer" : ["192.168.10.10"], + "ntpServer" : ["192.168.10.20"] + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Activate ExadataInfrastructure + tags: + - database + x-example: | + POST /20160918/exadataInfrastructures/<exadataInfrastructureId>/actions/activate + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "activationFile" : "<base64EncodedActivationFile>" + } + x-related-resource: '#/definitions/ExadataInfrastructure' + /exadataInfrastructures/{exadataInfrastructureId}/actions/addStorageCapacity: + post: + description: | + Makes the storage capacity from additional storage servers available for VM Cluster consumption. Applies to Exadata Cloud@Customer instances only. + operationId: AddStorageCapacityExadataInfrastructure + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' + responses: + '200': + description: | + The request was successfully received and the Exadata Cloud@Customer infrastructure update is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExadataInfrastructure' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1.", + "displayName" : "tstExaInfra", + "id" : "ocid1.exadataInfrastructure.oc1.", + "lifecycleDetails" : "", + "lifecycleState" : "ACTIVE", + "shape" : "ExadataCC.QuarterX8M.100", + "timeZone" : "PST", + "storageCount" : 4, + "additionalStorageCount" : 2, + "isMultiRackDeployment": false, + "multiRackConfigurationFile": "", + "activatedStorageCount" : 2, + "computeCount" : 2, + "additionalComputeCount": 1, + "additionalComputeSystemModel": "X9M", + "cpusEnabled" : 16, + "maxCpuCount" : 200, + "memorySizeInGBs" : 30, + "maxMemoryInGBs" : 200, + "dbNodeStorageSizeInGBs" : 60, + "maxDbNodeStorageInGBs" : 200, + "dataStorageSizeInTBs" : 84, + "maxDataStorageInTBs" : 200, + "timeCreated" : "2018-11-23T01:59:07.030Z", + "cloudControlPlaneServer1" :"192.168.19.1", + "cloudControlPlaneServer2" : "192.168.19.2", + "netmask" : "255.255.0.0", + "gateway" : "192.168.20.1", + "adminNetworkCIDR" : "192.168.19.2/16", + "infiniBandNetworkCIDR" : "10.172.19.2/24", + "corporateProxy" : "192.168.20.1", + "dnsServer" : ["192.168.10.10"], + "ntpServer" : ["192.168.10.20"] + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Makes the storage capacity from additional storage servers available for VM Cluster consumption. Applies to Exadata Cloud@Customer instances only. + tags: + - database + x-related-resource: '#/definitions/ExadataInfrastructure' + /exadataInfrastructures/{exadataInfrastructureId}/actions/changeCompartment: + post: + description: | + Moves an Exadata infrastructure resource and its dependent resources to another compartment. Applies to Exadata Cloud@Customer instances only. + To move an Exadata Cloud Service infrastructure resource to another compartment, use the [ChangeCloudExadataInfrastructureCompartment](#/en/database/latest/CloudExadataInfrastructure/ChangeCloudExadataInfrastructureCompartment) operation. + operationId: ChangeExadataInfrastructureCompartment + parameters: + - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeExadataInfrastructureCompartmentDetails' + description: Request to move Exadata infrastructure to a different compartment + required: true + responses: + '202': + description: The request was successfully received and the change compartment action is being performed. + 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: Unique Oracle-assigned identifier of the work 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeExadataInfrastructureCompartment + tags: + - database + x-related-resource: '#/definitions/ExadataInfrastructure' + /exadataInfrastructures/{exadataInfrastructureId}/actions/downloadConfigFile: + post: + description: | + Downloads the configuration file for the specified Exadata Cloud@Customer infrastructure. + operationId: DownloadExadataInfrastructureConfigFile + parameters: + - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '200': + description: The configuration file for the specified Exadata Cloud@Customer infrastructure is being retrieved. + headers: + content-length: + description: Size of the file. + schema: + type: integer + format: int64 + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + last-modified: + description: The date and time the configuration file was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. + schema: + type: string + format: date-time + 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/octet-stream: + schema: + format: binary + type: string + '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/DefaultError' + summary: Downloads the configuration file for the specified Exadata infrastructure. + tags: + - database + x-related-resource: '#/definitions/ExadataInfrastructure' + /exadataInfrastructures/{exadataInfrastructureId}/unAllocatedResources: + get: + description: | + Gets un allocated resources information for the specified Exadata infrastructure. Applies to Exadata Cloud@Customer instances only. + operationId: GetExadataInfrastructureUnAllocatedResources + parameters: + - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/OptionalDbServersQueryParam' + responses: + '200': + description: The Exadata Cloud@Customer infrastructure un allocated resources details. + 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/ExadataInfrastructureUnAllocatedResources' + application-json: + examples: + response: + value: | + { + "displayName" : "tstExaInfra", + "id" : "ocid1.exadataInfrastructure.oc1.", + "localStorageInGbs": 620, + "ocpus": 20, + "memoryInGBs": 120, + "exadataStorageInTBs": 8 + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetExadataInfrastructureUnAllocatedResources + tags: + - database + x-example: | + GET /20160918/exadataInfrastructures/<exadataInfrastructureId>/unAllocatedResources + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks: + get: + description: | + Gets a list of the VM cluster networks in the specified compartment. Applies to Exadata Cloud@Customer instances only. + operationId: ListVmClusterNetworks + parameters: + - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/ListVmClusterNetworksSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListVmClusterNetworksFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: A list of VM cluster networks in the specified compartment. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListVmClusterNetworksResponse' + application-json: + examples: + response: + value: | + [ + { + "displayName" : "testVmClusterNw", + "shape" : "Exadata.Full2.336", + "exadataInfrastructureId" : "ocid1.exadataInfrastructure.oc1.", + "compartmentId" : "ocid1.tenancy.oc1.", + "lifecycleState" : "PROVISIONING", + "id" : "ocid1.vmclusternetwork.oc1.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleDetails" : null, + "scans": + [ + { + "hostname": "sea2410c4-scan", + "port": 1521, + "ips": ["10.0.20.20", "10.0.20.21", "10.0.20.22"] + } + ], + "dnsServer" : ["192.168.10.10"], + "ntpServer" : ["192.168.10.20"], + "vmNetworks": + [ + { + "network_type": "client", + "domainname": "sredatart.srevcn.oraclevcn.com", + "netmask": "255.255.255.0", + "gateway": "10.0.20.1", + "prefix": "myprefix1", + "vlanId": "0-4095", + "cidr": "192.168.19.2/16", + "nodes": + [ + { + "lifecycleState" : "CREATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4n7", + "ip": "10.0.20.14", + "vipHostname": "sea2410c4n7-vip", + "vip": "10.0.20.15" + }, + { + "lifecycleState" : "CREATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4n8", + "ip": "10.0.20.16", + "vipHostname": "sea2410c4n8-vip", + "vip": "10.0.20.17" + } + ] + }, + { + "network_type": "backup", + "domainname": "srebackupsn.srevcn.oraclevcn.com", + "netmask": "255.255.255.0", + "gateway": "10.0.21.1", + "prefix": "myprefix2", + "vlanId": "0-4095", + "cidr": "192.168.19.2/16", + "nodes": + [ + { + "lifecycleState" : "CREATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4bk7", + "ip": "10.0.21.8", + "vipHostname": "sea2411c4n7-vip", + "vip": "192.168.19.3" + }, + { + "lifecycleState" : "CREATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4bk8", + "ip": "10.0.21.9", + "vipHostname": "sea2412c4n7-vip", + "vip": "192.168.19.4" + } + ] + } + ] + } + ] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListVmClusterNetworks + tags: + - database + x-example: | + GET /20160918/vmClusterNetworks?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/VmClusterNetwork' + post: + description: | + Creates the VM cluster network. Applies to Exadata Cloud@Customer instances only. + To create a cloud VM cluster in an Exadata Cloud Service instance, use the [CreateCloudVmCluster ](#/en/database/latest/CloudVmCluster/CreateCloudVmCluster) operation. + operationId: CreateVmClusterNetwork + parameters: + - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VmClusterNetworkDetails' + description: Request to create the Cloud@Customer VM cluster network. + required: true + responses: + '200': + description: | + The request was successfully received and the create operation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/VmClusterNetwork' + application-json: + examples: + response: + value: | + { + "displayName" : "testVmClusterNw", + "shape" : "Exadata.Full2.336", + "exadataInfrastructureId" : "ocid1.exadataInfrastructure.oc1.", + "compartmentId" : "ocid1.tenancy.oc1.", + "lifecycleState" : "PROVISIONING", + "id" : "ocid1.vmclusternetwork.oc1.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleDetails" : null, + "scans":[ + { + "hostname": "sea2410c4-scan", + "port": 1521, + "ips": ["10.0.20.20", "10.0.20.21", "10.0.20.22"] + } + ], + "dnsServer" : ["192.168.10.10"], + "ntpServer" : ["192.168.10.20"], + "vmNetworks": + [ + { + "network_type": "client", + "domainname": "sredatart.srevcn.oraclevcn.com", + "netmask": "255.255.255.0", + "gateway": "10.0.20.1", + "prefix": "myprefix1", + "vlanId": "0-4095", + "cidr": "192.168.19.2/16", + "nodes": + [ + { + "lifecycleState" : "CREATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4n7", + "ip": "10.0.20.14", + "vipHostname": "sea2410c4n7-vip", + "vip": "10.0.20.15" + }, + { + "lifecycleState" : "CREATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4n8", + "ip": "10.0.20.16", + "vipHostname": "sea2410c4n8-vip", + "vip": "10.0.20.17" + } + ] + }, + { + "network_type": "backup", + "domainname": "srebackupsn.srevcn.oraclevcn.com", + "netmask": "255.255.255.0", + "gateway": "10.0.21.1", + "prefix": "myprefix2", + "vlanId": "0-4095", + "cidr": "192.168.19.2/16", + "nodes": + [ + { + "lifecycleState" : "CREATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4bk7", + "ip": "10.0.21.8", + "vipHostname": "sea2411c4n7-vip", + "vip": "192.168.19.3" + }, + { + "lifecycleState" : "CREATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4bk8", + "ip": "10.0.21.9", + "vipHostname": "sea2412c4n7-vip", + "vip": "192.168.19.4" + } + ] + } + ] + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateVmClusterNetwork + tags: + - database + x-example: | + POST /20160918/exadataInfrastructures/<exadataInfrastructureId>vmClusterNetworks + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName" : "testVmClusterNw", + "compartmentId" : "ocid1.tenancy.oc1.<example_unique_ID>", + "scans": [ + { + "hostname": "sea2410c4-scan", + "port": 1521, + "ips": ["10.0.20.20", "10.0.20.21", "10.0.20.22"] + } + ], + "dnsServer" : ["192.168.10.10"], + "ntpServer" : ["192.168.10.20"], + "vmNetworks": + [ + { + "network_type": "client", + "domainname": "sredatart.srevcn.oraclevcn.com", + "netmask": "255.255.255.0", + "gateway": "10.0.20.1", + "prefix": "myprefix1", + "vlanId": "0-4095", + "cidr": "192.168.19.2/16", + "nodes": + [ + { + "lifecycleState" : "CREATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4n7", + "ip": "10.0.20.14", + "vipHostname": "sea2410c4n7-vip", + "vip": "10.0.20.15" + }, + { + "lifecycleState" : "CREATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4n8", + "ip": "10.0.20.16", + "vipHostname": "sea2410c4n8-vip", + "vip": "10.0.20.17" + } + ] + }, + { + "network_type": "backup", + "domainname": "srebackupsn.srevcn.oraclevcn.com", + "netmask": "255.255.255.0", + "gateway": "10.0.21.1", + "prefix": "myprefix2", + "vlanId": "0-4095", + "cidr": "192.168.19.2/16", + "nodes": + [ + { + "lifecycleState" : "CREATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4bk7", + "ip": "10.0.21.8", + "vipHostname": "sea2411c4n7-vip", + "vip": "192.168.19.3" + }, + { + "lifecycleState" : "CREATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4bk8", + "ip": "10.0.21.9", + "vipHostname": "sea2412c4n7-vip", + "vip": "192.168.19.4" + } + ] + } + ] + } + /exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks/actions/generateRecommendedNetwork: + post: + description: | + Generates a recommended Cloud@Customer VM cluster network configuration. + operationId: GenerateRecommendedVmClusterNetwork + parameters: + - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GenerateRecommendedNetworkDetails' + description: Request to generate a recommended Cloud@Customer VM cluster network configuration. + required: true + responses: + '200': + description: The request was successfully received. + 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/VmClusterNetworkDetails' + application-json: + examples: + response: + value: | + { + "displayName" : "testVmClusterNw", + "compartmentId" : "ocid1.tenancy.oc1.", + "scans": [ + { + "hostname": "sea2410c4-scan", + "port": 1521, + "ips": ["10.0.20.20", "10.0.20.21", "10.0.20.22"] + } + ], + "dns" : ["192.168.10.10"], + "ntp" : ["192.168.10.20"], + "vmNetworks": + [ + { + "networkType": "CLIENT", + "domainName": "sredatart.srevcn.oraclevcn.com", + "netmask": "255.255.255.0", + "gateway": "10.0.20.1", + "vlanId": "0-4095", + "nodes": + [ + { + "lifecycleState" : "CREATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4n7", + "ip": "10.0.20.14", + "vipHostname": "sea2410c4n7-vip", + "vip": "10.0.20.15" + }, + { + "lifecycleState" : "CREATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4n8", + "ip": "10.0.20.16", + "vipHostname": "sea2410c4n8-vip", + "vip": "10.0.20.17" + } + ] + }, + { + "networkType": "BACKUP", + "domainName": "srebackupsn.srevcn.oraclevcn.com", + "netmask": "255.255.255.0", + "gateway": "10.0.21.1", + "vlanId": "0-4095", + "nodes": + [ + { + "lifecycleState" : "CREATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4bk7", + "ip": "10.0.21.8", + "vipHostname": "sea2411c4n7-vip", + "vip": "192.168.19.3" + }, + { + "lifecycleState" : "CREATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4bk8", + "ip": "10.0.21.9", + "vipHostname": "sea2412c4n7-vip", + "vip": "192.168.19.4" + } + ] + } + ] + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Generates a recommended VM cluster network configuration. + tags: + - database + x-example: | + POST /20160918/exadataInfrastructures/<exadataInfrastructureId>/vmClusterNetworks/actions/generateRecommendedNetwork + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.tenancy.oc1.<unique_ID>", + "displayName" : "testVmClusterNw", + "dbServers" : ["ocid1.dbserver.oc1.", "ocid1.dbserver.oc1."], + "dns" : ["192.168.10.10"], + "ntp" : ["192.168.10.20"], + "networks" : [{ + "networkType" : "CLIENT", + "vlanId" : "0-54095", + "cidr" : "192.168.19.2/16", + "gateway" : "192.168.20.1", + "netmask" : "255.255.0.0", + "domain" : "oracle.com", + "prefix" : "myprefix1" + },{ + "networkType" : "BACKUP", + "vlanId" : "0-54095", + "cidr" : "192.168.19.1/16", + "gateway" : "192.168.20.1", + "netmask" : "255.255.0.0", + "domain" : "oracle.com", + "prefix" : "myprefix2" + }] + } + x-related-resource: '#/definitions/ExadataInfrastructure' + /exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks/{vmClusterNetworkId}: + delete: + description: | + Deletes the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. + To delete a cloud VM cluster in an Exadata Cloud Service instance, use the [DeleteCloudVmCluster ](#/en/database/latest/CloudVmCluster/DeleteCloudVmCluster) operation. + operationId: DeleteVmClusterNetwork + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/VmClusterNetworkIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '204': + description: The request to delete the VM cluster network was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Deletes the specified VM cluster network. + tags: + - database + x-related-resource: '#/definitions/VmClusterNetwork' + get: + description: | + Gets information about the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. + To get information about a cloud VM cluster in an Exadata Cloud Service instance, use the [GetCloudVmCluster ](#/en/database/latest/CloudVmCluster/GetCloudVmCluster) operation. + operationId: GetVmClusterNetwork + parameters: + - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/VmClusterNetworkIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The specified Exadata Cloud@Customer VM cluster network. + 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/VmClusterNetwork' + application-json: + examples: + response: + value: | + { + "displayName" : "testVmClusterNw", + "shape" : "Exadata.Full2.336", + "exadataInfrastructureId" : "ocid1.exadataInfrastructure.oc1.", + "compartmentId" : "ocid1.tenancy.oc1.", + "lifecycleState" : "CREATING", + "id" : "ocid1.vmclusternetwork.oc1.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleDetails" : null, + "scans": [ + { + "hostname": "sea2410c4-scan", + "port": 1521, + "ips": ["10.0.20.20", "10.0.20.21", "10.0.20.22"] + } + ], + "dnsServer" : ["192.168.10.10"], + "ntpServer" : ["192.168.10.20"], + "vmNetworks": + [ + { + "network_type": "client", + "domainname": "sredatart.srevcn.oraclevcn.com", + "netmask": "255.255.255.0", + "gateway": "10.0.20.1", + "prefix": "myprefix1", + "vlanId": "0-4095", + "cidr": "192.168.19.2/16", + "nodes": + [ + { + "lifecycleState" : "CREATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4n7", + "ip": "10.0.20.14", + "vipHostname": "sea2410c4n7-vip", + "vip": "10.0.20.15" + }, + { + "lifecycleState" : "CREATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4n8", + "ip": "10.0.20.16", + "vipHostname": "sea2410c4n8-vip", + "vip": "10.0.20.17" + } + ] + }, + { + "network_type": "backup", + "domainname": "srebackupsn.srevcn.oraclevcn.com", + "netmask": "255.255.255.0", + "gateway": "10.0.21.1", + "prefix": "myprefix2", + "vlanId": "0-4095", + "cidr": "192.168.19.2/16", + "nodes": + [ + { + "lifecycleState" : "CREATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4bk7", + "ip": "10.0.21.8", + "vipHostname": "sea2411c4n7-vip", + "vip": "192.168.19.3" + }, + { + "lifecycleState" : "CREATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4bk8", + "ip": "10.0.21.9", + "vipHostname": "sea2412c4n7-vip", + "vip": "192.168.19.4" + } + ] + } + ] + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetVmClusterNetwork + tags: + - database + x-example: | + GET /20160918/exadataInfrastructures/<exadataInfrastructureId>/vmClusterNetworks/<vmClusterNetworkId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. + To update a cloud VM cluster in an Exadata Cloud Service instance, use the [UpdateCloudVmCluster ](#/en/database/latest/CloudVmCluster/UpdateCloudVmCluster) operation. + operationId: UpdateVmClusterNetwork + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/VmClusterNetworkIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateVmClusterNetworkDetails' + description: Request to update the properties of a VM cluster network. + required: true + responses: + '200': + description: The request was successfully received and the Exadata Cloud@Customer VM cluster network update is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/VmClusterNetwork' + application-json: + examples: + response: + value: | + { + "displayName" : "testVmClusterNw", + "shape" : "Exadata.Full2.336", + "exadataInfrastructureId" : "ocid1.exadataInfrastructure.oc1.", + "compartmentId" : "ocid1.tenancy.oc1.", + "lifecycleState" : "UPDATING", + "id" : "ocid1.vmclusternetwork.oc1.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleDetails" : null, + "scans": [ + { + "hostname": "sea2410c4-scan", + "port": 1521, + "ips": ["10.0.20.20", "10.0.20.21", "10.0.20.22"] + } + ], + "dnsServer" : ["192.168.10.10", "192.168.10.30"], + "ntpServer" : ["192.168.10.20", "192.168.10.40"], + "vmNetworks": + [ + { + "network_type": "client", + "domainname": "sredatart.srevcn.oraclevcn.com", + "netmask": "255.255.255.0", + "gateway": "10.0.20.1", + "prefix": "myprefix1", + "vlanId": "0-4095", + "cidr": "192.168.19.2/16", + "nodes": + [ + { + "lifecycleState" : "UPDATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4n7", + "ip": "10.0.20.14", + "vipHostname": "sea2410c4n7-vip", + "vip": "10.0.20.15" + }, + { + "lifecycleState" : "UPDATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4n8", + "ip": "10.0.20.16", + "vipHostname": "sea2410c4n8-vip", + "vip": "10.0.20.17" + } + ] + }, + { + "network_type": "backup", + "domainname": "srebackupsn.srevcn.oraclevcn.com", + "netmask": "255.255.255.0", + "gateway": "10.0.21.1", + "prefix": "myprefix2", + "vlanId": "0-4095", + "cidr": "192.168.19.2/16", + "nodes": + [ + { + "lifecycleState" : "UPDATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4bk7", + "ip": "10.0.21.8", + "vipHostname": "sea2411c4n7-vip", + "vip": "192.168.19.3" + }, + { + "lifecycleState" : "UPDATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4bk8", + "ip": "10.0.21.9", + "vipHostname": "sea2412c4n7-vip", + "vip": "192.168.19.4" + } + ] + } + ] + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Updates the specified VM cluster network. + tags: + - database + x-example: | + PUT /latest/exadataInfrastructures/<exadataInfrastructureId>/vmClusterNetworks/<vmClusterNetworkId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "dnsServer" : ["192.168.10.30"], + "ntpServer" : ["192.168.10.40"] + } + /exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks/{vmClusterNetworkId}/actions/downloadConfigFile: + post: + description: | + Downloads the configuration file for the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. + operationId: DownloadVmClusterNetworkConfigFile + parameters: + - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/VmClusterNetworkIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '200': + description: The configuration file for the specified VM cluster network is being retrieved. + headers: + content-length: + description: Size of the file. + schema: + type: integer + format: int64 + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + last-modified: + description: The date and time the configuration file was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. + schema: + type: string + format: date-time + 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/octet-stream: + schema: + format: binary + type: string + '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/DefaultError' + summary: Downloads the configuration file for the specified VM Cluster Network. + tags: + - database + x-related-resource: '#/definitions/VmClusterNetwork' + /exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks/{vmClusterNetworkId}/actions/resize: + post: + description: | + Adds or removes Db server network nodes to extend or shrink the existing VM cluster network. Applies to Exadata + Cloud@Customer instances only. + operationId: ResizeVmClusterNetwork + parameters: + - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/VmClusterNetworkIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResizeVmClusterNetworkDetails' + description: Request to add or remove Db server network nodes in the VM cluster network. + required: true + responses: + '200': + description: The request was successfully received and the Exadata Cloud@Customer operation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/VmClusterNetwork' + application-json: + examples: + response: + value: | + { + "displayName" : "testVmClusterNw", + "shape" : "Exadata.Full2.336", + "exadataInfrastructureId" : "ocid1.exadataInfrastructure.oc1.", + "compartmentId" : "ocid1.tenancy.oc1.", + "lifecycleState" : "UPDATING", + "id" : "ocid1.vmclusternetwork.oc1.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleDetails" : null, + "scans": [ + { + "hostname": "sea2410c4-scan", + "port": 1521, + "ips": ["10.0.20.20", "10.0.20.21", "10.0.20.22"] + } + ], + "dnsServer" : ["192.168.10.10", "192.168.10.30"], + "ntpServer" : ["192.168.10.20", "192.168.10.40"], + "vmNetworks": + [ + { + "network_type": "client", + "domainname": "sredatart.srevcn.oraclevcn.com", + "netmask": "255.255.255.0", + "gateway": "10.0.20.1", + "prefix": "myprefix1", + "vlanId": "0-4095", + "cidr": "192.168.19.2/16", + "nodes": + [ + { + "lifecycleState": "ALLOCATED", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4n7", + "ip": "10.0.20.14", + "vipHostname": "sea2410c4n7-vip", + "vip": "10.0.20.15" + }, + { + "lifecycleState": "ALLOCATED", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4n8", + "ip": "10.0.20.16", + "vipHostname": "sea2410c4n8-vip", + "vip": "10.0.20.17" + }, + { + "lifecycleState": "UPDATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4n9", + "ip": "10.0.20.17", + "vipHostname": "sea2410c4n9-vip", + "vip": "10.0.20.18" + } + ] + }, + { + "network_type": "backup", + "domainname": "srebackupsn.srevcn.oraclevcn.com", + "netmask": "255.255.255.0", + "gateway": "10.0.21.1", + "prefix": "myprefix2", + "vlanId": "0-4095", + "cidr": "192.168.19.2/16", + "nodes": + [ + { + "lifecycleState": "ALLOCATED", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4bk7", + "ip": "10.0.21.8", + "vipHostname": "sea2411c4n7-vip", + "vip": "192.168.19.3" + }, + { + "lifecycleState": "ALLOCATED", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4bk8", + "ip": "10.0.21.9", + "vipHostname": "sea2412c4n7-vip", + "vip": "192.168.19.4" + }, + { + "lifecycleState": "UPDATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4bk9", + "ip": "10.0.21.10", + "vipHostname": "sea2412c4n8-vip", + "vip": "192.168.19.5" + } + ] + } + ] + } + '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/DefaultError' + summary: Adds or removes Db server network nodes in the VM cluster network. + tags: + - database + x-example: | + POST /20160918/vmClusterNetworks/<vmClusterNetworkId>/actions/resize + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/VmClusterNetwork' + /exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks/{vmClusterNetworkId}/actions/validate: + post: + description: | + Validates the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. + operationId: ValidateVmClusterNetwork + parameters: + - $ref: '#/components/parameters/ExadataInfrastructureIdPathParam' + - $ref: '#/components/parameters/VmClusterNetworkIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '200': + description: The specified VM cluster network. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/VmClusterNetwork' + application-json: + examples: + response: + value: | + { + "displayName" : "testVmClusterNw", + "shape" : "Exadata.Full2.336", + "exadataInfrastructureId" : "ocid1.exadataInfrastructure.oc1.", + "compartmentId" : "ocid1.tenancy.oc1.", + "lifecycleState" : "VALIDATING", + "id" : "ocid1.vmclusternetwork.oc1.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleDetails" : null, + "scans": [ + { + "hostname": "sea2410c4-scan", + "port": 1521, + "ips": ["10.0.20.20", "10.0.20.21", "10.0.20.22"] + } + ], + "dnsServer" : ["192.168.10.10", + "192.168.10.30"], + "ntpServer" : ["192.168.10.20", + "192.168.10.40"], + "vmNetworks": + [ + { + "network_type": "client", + "domainname": "sredatart.srevcn.oraclevcn.com", + "netmask": "255.255.255.0", + "gateway": "10.0.20.1", + "prefix": "myprefix1", + "vlanId": "0-4095", + "cidr": "192.168.19.2/16", + "nodes": + [ + { + "lifecycleState" : "VALIDATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4n7", + "ip": "10.0.20.14", + "vipHostname": "sea2410c4n7-vip", + "vip": "10.0.20.15" + }, + { + "lifecycleState" : "VALIDATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4n8", + "ip": "10.0.20.16", + "vipHostname": "sea2410c4n8-vip", + "vip": "10.0.20.17" + } + ] + }, + { + "network_type": "backup", + "domainname": "srebackupsn.srevcn.oraclevcn.com", + "netmask": "255.255.255.0", + "gateway": "10.0.21.1", + "prefix": "myprefix2", + "vlanId": "0-4095", + "cidr": "192.168.19.2/16", + "nodes": + [ + { + "lifecycleState" : "VALIDATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4bk7", + "ip": "10.0.21.8", + "vipHostname": "sea2411c4n7-vip", + "vip": "192.168.19.3" + }, + { + "lifecycleState" : "VALIDATING", + "dbServerId": "ocid1.dbserver.oc1.", + "hostname": "sea2410c4bk8", + "ip": "10.0.21.9", + "vipHostname": "sea2412c4n7-vip", + "vip": "192.168.19.4" + } + ] + } + ] + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Validates the specified VM cluster network. + tags: + - database + x-example: | + POST /20160918/vmClusterNetworks/<vmClusterNetworkId>/actions/validate + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/VmClusterNetwork' + /exadbVmClusters: + get: + description: | + Gets a list of the Exadata VM clusters on Exascale Infrastructure in the specified compartment. Applies to Exadata Database Service on Exascale Infrastructure only. + operationId: ListExadbVmClusters + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/ListExadbVmClustersSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListExadbVmClustersFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/ListExadbVmClustersFilterByExascaleDbStorageVaultIdQueryParam' + - $ref: '#/components/parameters/ListExadbVmClustersFilterByClusterPlacementGroupIdQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: List of the Exadata VM clusters on Exascale Infrastructure. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListExadbVmClustersResponse' + application-json: + examples: + response: + value: | + [ + { + "displayName" : "exadbVmCluster", + "compartmentId" : "ocid1.tenancy.oc1.", + "availabilityDomain" : "OXET:PHX-AD-1", + "lifecycleState" : "PROVISIONING", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "licenseModel" : "LICENSE_INCLUDED", + "timeZone" : "PST", + "id" : "ocid1.exadbvmcluster.oc1.", + "lifecycleDetails" : "Exadata VM cluster provisioning in progress.", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "hostname" : "apollo", + "domain" : "example.com", + "subnetId" : "ocid1.subnet.oc1.phx.", + "backupSubnetId" : "ocid1.subnet.oc1.phx.", + "shape" : "ExaDB-XS-2", + "scanListenerPortTcp": 1521, + "scanListenerPortTcpSsl": 2484, + "privateZoneId": "ocid1.dns-zone.oc1.", + "giVersion": "19.0.0.0", + "totalECpuCount" : 10, + "enabledECpuCount" : 4, + "vmFileSystemStorage": { + "totalSizeInGbs": 1000 + }, + "exascaleDbStorageVaultId": "ocid1.exascaledbstoragevault.oc1.<unique_ID>", + "nodeCount": 2 + } + ] + '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/DefaultError' + summary: ListExadbVmClusters + tags: + - database + x-example: | + GET /20160918/exadbVmClusters?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExadbVmCluster' + post: + description: | + Creates an Exadata VM cluster on Exascale Infrastructure + operationId: CreateExadbVmCluster + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateExadbVmClusterDetails' + description: | + Request to create a Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only. See [The New Exadata Cloud Service Resource Model](/iaas/Content/Database/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) for information on this resource type. + required: true + responses: + '200': + description: The request was successfully received and the create Exadata VM cluster on Exascale Infrastructure operation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExadbVmCluster' + application-json: + examples: + response: + value: | + { + "displayName" : "exadbVmCluster", + "compartmentId" : "ocid1.tenancy.oc1.", + "availabilityDomain" : "OXET:PHX-AD-1", + "lifecycleState" : "PROVISIONING", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "licenseModel" : "LICENSE_INCLUDED", + "timeZone" : "PST", + "id" : "ocid1.exadbvmcluster.oc1.", + "lifecycleDetails" : "Exadata VM cluster provisioning in progress.", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "hostname" : "apollo", + "domain" : "example.com", + "subnetId" : "ocid1.subnet.oc1.phx.", + "backupSubnetId" : "ocid1.subnet.oc1.phx.", + "shape" : "ExaDB-XS-2", + "giVersion" : "19.0.0.0", + "totalECpuCount" : 10, + "enabledECpuCount" : 4, + "vmFileSystemStorage": { + "totalSizeInGbs": 1000 + }, + "exascaleDbStorageVaultId": "ocid1.exascaledbstoragevault.oc1.<unique_ID>", + "nodeCount": 2, + "dbCertificateId" : "ocid1.dbcertificate.oc1." + } + '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/DefaultError' + summary: CreateExadbVmCluster + tags: + - database + x-example: | + POST /20160918/exadbVmClusters + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName" : "exadbVmCluster", + "compartmentId" : "ocid1.tenancy.oc1.<unique_ID>", + "sshPublicKeys" : [ "ssh-rsa <public_SSH_key> name@example.com" ], + "availabilityDomain" : "OXET:PHX-AD-1", + "licenseModel" : "LICENSE_INCLUDED", + "domain" : "example.com", + "hostname" : "apollo", + "scanListenerPortTcp" : 1521, + "scanListenerPortTcpSsl" : 2484, + "privateZoneId" : "ocid1.dns-zone.oc1.<unique_ID>", + "timeZone" : "PST", + "subnetId" : "ocid1.subnet.oc1.phx.<unique_ID>", + "backupSubnetId" : "ocid1.subnet.oc1.phx.<unique_ID>", + "shape" : "ExaDB-XS-2", + "gridImageId" : "ocid1.gridimage.oc1.<unique_ID>", + "totalECpuCount" : 10, + "enabledECpuCount": 2, + "vmFileSystemStorage": { + "totalSizeInGbs": 1000 + }, + "exascaleDbStorageVaultId": "ocid1.exascaledbstoragevault.oc1.<unique_ID>", + "nodeCount": 2 + } + /exadbVmClusters/{exadbVmClusterId}: + delete: + description: | + Deletes the specified Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only. + operationId: DeleteExadbVmCluster + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/ExadbVmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '204': + description: The request to delete the Exadata VM cluster on Exascale Infrastructure was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application-json: + examples: + response: + value: | + {} + '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/DefaultError' + summary: Deletes the specified Exadata VM cluster on Exascale Infrastructure. + tags: + - database + x-example: | + DELETE /20160918/exadbVmClusters/<exadbVmClusterId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + } + x-related-resource: '#/definitions/ExadbVmCluster' + get: + description: | + Gets information about the specified Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only. + operationId: GetExadbVmCluster + parameters: + - $ref: '#/components/parameters/ExadbVmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: Information about the Exadata VM cluster on Exascale Infrastructure + 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/ExadbVmCluster' + application-json: + examples: + response: + value: | + { + "displayName" : "exadbVmCluster", + "compartmentId" : "ocid1.tenancy.oc1.", + "availabilityDomain" : "OXET:PHX-AD-1", + "lifecycleState" : "AVAILABLE", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "lastUpdateHistoryEntryId": "ocid1.dbpatchhistory.oc1.", + "licenseModel" : "LICENSE_INCLUDED", + "timeZone" : "PST", + "id" : "ocid1.exadbvmcluster.oc1.", + "lifecycleDetails" : "Exadata VM cluster is available.", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "hostname" : "apollo", + "domain" : "example.com", + "subnetId" : "ocid1.subnet.oc1.phx.", + "backupSubnetId" : "ocid1.subnet.oc1.phx.", + "shape" : "ExaDB-XS-2", + "scanDnsName": "cloudVmCluster.my.company.com", + "zoneId": "ocid1.zone.oc1.", + "giVersion": "19.0.0.0", + "totalECpuCount" : 10, + "enabledECpuCount" : 4, + "vmFileSystemStorage": { + "totalSizeInGbs": 1000 + }, + "exascaleDbStorageVaultId": "ocid1.exascaledbstoragevault.oc1.<unique_ID>", + "nodeCount": 2, + "dbCertificateId" : "ocid1.dbcertificate.oc1." + } + '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/DefaultError' + summary: GetExadbVmCluster + tags: + - database + x-example: | + GET /20160918/exadbVmClusters/<exadbVmClusterId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the specified Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only. + operationId: UpdateExadbVmCluster + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/ExadbVmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateExadbVmClusterDetails' + description: Request to update the attributes of a Exadata VM cluster on Exascale Infrastructure. + required: true + responses: + '200': + description: The request was successfully received and the Exadata VM cluster on Exascale Infrastructure update operation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExadbVmCluster' + application-json: + examples: + response: + value: | + { + "displayName" : "exadbVmCluster", + "compartmentId" : "ocid1.tenancy.oc1.", + "availabilityDomain" : "OXET:PHX-AD-1", + "lifecycleState" : "UPDATING", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "licenseModel" : "LICENSE_INCLUDED", + "timeZone" : "PST", + "id" : "ocid1.exadbvmcluster.oc1.", + "lifecycleDetails" : "Exadata VM cluster update in progress.", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "hostname" : "apollo", + "domain" : "example.com", + "subnetId" : "ocid1.subnet.oc1.phx.", + "backupSubnetId" : "ocid1.subnet.oc1.phx.", + "shape" : "ExaDB-XS-2", + "giVersion" : "19.0.0.0", + "totalECpuCount" : 10, + "enabledECpuCount" : 10, + "vmFileSystemStorage": { + "totalSizeInGbs": 1000 + }, + "exascaleDbStorageVaultId": "ocid1.exascaledbstoragevault.oc1.<unique_ID>", + "nodeCount": 2, + "dbCertificateId" : "ocid1.dbcertificate.oc1." + } + '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/DefaultError' + summary: Updates the specified Exadata VM cluster on Exascale Infrastructure. + tags: + - database + x-example: | + PUT /20160918/exadbVmClusters/<exadbVmClusterId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "enabledECpuCount" : 10, + "licenseModel" : "LICENSE_INCLUDED", + "dbCertificateId" : "ocid1.dbcertificate.oc1." + } + /exadbVmClusters/{exadbVmClusterId}/actions/addDbNodeSnapshots: + post: + description: | + Add a database node snapshots to the Exadb VM cluster.. + operationId: AddDbnodeSnapshotsForExadbVmCluster + parameters: + - $ref: '#/components/parameters/ExadbVmClusterIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddDbnodeSnapshotsForExadbVmClusterDetails' + description: | + Request to add a database node snapshots to the Exadb VM cluster.. + required: true + responses: + '202': + description: The request was successfully received to create DB Node Snapshots. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DbnodeSnapshots' + application-json: + examples: + response: + value: | + { + "name": "snapshot-1", + "snapshots": [{ + "id" : "ocid1.dbnodesnapshot.oc1.", + "clusterId" : "ocid1.exadbvmcluster.oc1.", + "compartmentId": "ocid1.compartment.oc1.", + "name" : "snapshot-1", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "lifecycleState" : "CREATING", + "lifecycleDetails" : "Snapshot creation in progress.", + "sourceDbnodeId": "ocid1.dbnode.oc1.", + "mountPoints": [], + "volumes": [] + },{ + "id" : "ocid1.dbnodesnapshot.oc1.", + "clusterId" : "ocid1.exadbvmcluster.oc1.", + "compartmentId": "ocid1.compartment.oc1.", + "name" : "snapshot-1", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "lifecycleState" : "CREATING", + "lifecycleDetails" : "Snapshot creation in progress.", + "sourceDbnodeId": "ocid1.dbnode.oc1.", + "mountPoints": [], + "volumes": [] + } + ] + } + '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/DefaultError' + summary: AddDbnodeSnapshotsForExadbVmCluster + tags: + - database + x-example: | + POST /20160918/exadbVmClusters/<exadbVmClusterId>/actions/addDbNodeSnapshot + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "name" : "snapshot-1", + "sourceDbnodeIds": [ + "ocid1.dbnode.oc1.", + "ocid1.dbnode.oc1.", + "ocid1.dbnode.oc1." + ] + } + x-obmcs-terraform: + actionType: MANAGEMENT_RESOURCE + x-related-resource: '#/definitions/ExadbVmCluster' + /exadbVmClusters/{exadbVmClusterId}/actions/changeCompartment: + post: + description: | + Moves a Exadata VM cluster on Exascale Infrastructure and its dependent resources to another compartment. Applies to Exadata Database Service on Exascale Infrastructure only. + operationId: ChangeExadbVmClusterCompartment + parameters: + - $ref: '#/components/parameters/ExadbVmClusterIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeExadbVmClusterCompartmentDetails' + description: Request to move Exadata VM cluster on Exascale Infrastructure to a different compartment + required: true + responses: + '202': + description: The request was successfully received and the change compartment action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: ChangeExadbVmClusterCompartment + tags: + - database + x-example: | + POST /20160918/exadbVmClusters/<exadbVmClusterId>/actions/changeCompartment + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.compartment.oc1.<unique_ID>" + } + x-related-resource: '#/definitions/ExadbVmCluster' + /exadbVmClusters/{exadbVmClusterId}/actions/changeSubscription: + post: + description: | + Associate a Exadata VM cluster on Exascale Infrastructure with a different subscription. + operationId: ChangeExadbVmClusterSubscription + parameters: + - $ref: '#/components/parameters/ExadbVmClusterIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeExadbVmClusterSubscriptionDetails' + description: Associate a Exadata VM cluster on Exascale Infrastructure with a different subscription. + required: true + responses: + '202': + description: The request was successfully received and the update subscription action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: ChangeExadbVmClusterSubscription + tags: + - database + x-example: | + POST /20160918/exadbVmClusters/<exadbVmClusterId>/actions/changeSubscription + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "subscriptionId" : "ocid1.subscription.oc1.<unique_ID>", + "isDefault" : false + } + x-related-resource: '#/definitions/ExadbVmCluster' + /exadbVmClusters/{exadbVmClusterId}/actions/removeVirtualMachine: + post: + description: | + Remove Virtual Machines from the Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Cloud instances only. + operationId: RemoveVirtualMachineFromExadbVmCluster + parameters: + - $ref: '#/components/parameters/ExadbVmClusterIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveVirtualMachineFromExadbVmClusterDetails' + description: Request to remove Virtual Machines from the Exadata VM cluster on Exascale Infrastructure. + required: true + responses: + '200': + description: The request was successfully received and the removing Virtual Machines action is being performed. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExadbVmCluster' + application-json: + examples: + response: + value: | + { + "displayName" : "exadbVmCluster", + "compartmentId" : "ocid1.tenancy.oc1.", + "availabilityDomain" : "OXET:PHX-AD-1", + "lifecycleState" : "UPDATING", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "licenseModel" : "LICENSE_INCLUDED", + "timeZone" : "PST", + "id" : "ocid1.exadbvmcluster.oc1.", + "lifecycleDetails" : "Exadata VM cluster is being updated after removing virtual machines.", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "hostname" : "apollo", + "domain" : "example.com", + "subnetId" : "ocid1.subnet.oc1.phx.", + "backupSubnetId" : "ocid1.subnet.oc1.phx.", + "shape" : "ExaDB-XS-2", + "giVersion" : "19.0.0.0", + "totalECpuCount" : 10, + "enabledECpuCount" : 10, + "memorySizeInGBs" : 50, + "vmFileSystemStorage": { + "totalSizeInGbs": 1000 + }, + "exascaleDbStorageVaultId": "ocid1.exascaledbstoragevault.oc1.<unique_ID>", + "nodeCount": 2 + } + '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/DefaultError' + summary: RemoveVirtualMachineFromExadbVmCluster + tags: + - database + x-example: | + POST /20160918/exadbVmClusters/<exadbVmClusterId>/actions/removeVirtualMachine + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "dbNodes" : [ + { + "dbNodeId" : "ocid1.dbnode.oc1." + }, + { + "dbNodeId" : "ocid1.dbnode.oc1." + } + ] + } + x-related-resource: '#/definitions/ExadbVmCluster' + /exadbVmClusters/{exadbVmClusterId}/updateHistoryEntries: + get: + description: | + Gets the history of the maintenance update actions performed on the specified Exadata VM cluster on Exascale Infrastructure. + operationId: ListExadbVmClusterUpdateHistoryEntries + parameters: + - $ref: '#/components/parameters/ExadbVmClusterIdPathParam' + - $ref: '#/components/parameters/FilterByExadbVmClusterUpdateTypeQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The maintenance update history for the specified Exadata VM cluster on Exascale Infrastructure. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListExadbVmClusterUpdateHistoryEntriesResponse' + application-json: + examples: + response: + value: | + [ + { + "updateAction" : "ROLLING_APPLY", + "updateId" : "ocid1.dbpatch.oc1.phx.", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "updateType" : "GI_PATCH", + "lifecycleState" : "IN_PROGRESS", + "lifecycleDetails" : "Update action in progress.", + "timeStarted" : "2017-01-01T07:07:07.007Z", + "timeCompleted" : "2017-01-01T07:17:07.007Z" + }, { + "updateAction" : "ROLLING_APPLY", + "updateId" : "ocid1.dbpatch.oc1.phx.", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "updateType" : "GI_PATCH", + "lifecycleState" : "SUCCEEDED", + "lifecycleDetails" : "Completed successfully.", + "timeStarted" : "2016-12-21T01:59:07.032Z", + "timeCompleted" : "2016-12-21T02:21:07.032Z" + }, { + "updateAction" : "ROLLING_APPLY", + "updateId" : "ocid1.dbpatch.oc1.phx.", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "updateType" : "GI_PATCH", + "lifecycleState" : "FAILED", + "lifecycleDetails" : "Something failed that needs attention.", + "timeStarted" : "2016-11-20T01:23:45.6789Z", + "timeCompleted" : "2016-11-20T01:23:45.6789Z" + } + ] + '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/DefaultError' + summary: ListExadbVmClusterUpdateHistoryEntries + tags: + - database + x-example: | + GET /20160918/exadbVmClusters/<exadbVmClusterId>/updateHistoryEntries?limit=100 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExadbVmClusterUpdateHistoryEntry' + /exadbVmClusters/{exadbVmClusterId}/updateHistoryEntries/{updateHistoryEntryId}: + get: + description: | + Gets the maintenance update history details for the specified update history entry. + operationId: GetExadbVmClusterUpdateHistoryEntry + parameters: + - $ref: '#/components/parameters/ExadbVmClusterIdPathParam' + - $ref: '#/components/parameters/UpdateHistoryEntryIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The maintenance update history details for the specified update history entry. + 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/ExadbVmClusterUpdateHistoryEntry' + application-json: + examples: + response: + value: | + { + "updateAction" : "ROLLING_APPLY", + "updateId" : "ocid1.dbpatch.oc1.phx.", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "updateType" : "GI_PATCH", + "lifecycleState" : "FAILED", + "lifecycleDetails" : "Something failed that needs attention.", + "timeStarted" : "2016-11-20T01:23:45.6789Z", + "timeCompleted" : "2016-11-20T01:23:45.6789Z" + } + '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/DefaultError' + summary: GetExadbVmClusterUpdateHistoryEntry + tags: + - database + x-example: | + GET /20160918/exadbVmClusters/<exadbVmClusterId>/updateHistoryEntries/<updateHistoryEntryId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExadbVmClusterUpdateHistoryEntry' + /exadbVmClusters/{exadbVmClusterId}/updates: + get: + description: | + Lists the maintenance updates that can be applied to the specified Exadata VM cluster on Exascale Infrastructure. + operationId: ListExadbVmClusterUpdates + parameters: + - $ref: '#/components/parameters/ExadbVmClusterIdPathParam' + - $ref: '#/components/parameters/FilterByExadbVmClusterUpdateTypeQueryParam' + - $ref: '#/components/parameters/FilterByUpdateTypeVersionQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: A list of the maintenance update packages. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListExadbVmClusterUpdatesResponse' + application-json: + examples: + response: + value: | + [ + { + "availableActions" : ["ROLLING_APPLY"], + "description" : "Update PSU as released on 201611", + "id" : "ocid1.dbpatch.oc1.phx.", + "lastAction" : "ROLLING_APPLY", + "lifecycleDetails" : "A failure message that can be displayed to the user", + "lifecycleState" : "FAILED", + "timeReleased" : "2017-02-16T01:50:07.001Z", + "updateType" : "GI_PATCH", + "version" : "20170127" + }, + { + "availableActions" : ["ROLLING_APPLY"], + "description" : "Update PSU as released on 20170127", + "id" : "ocid1.dbpatch.oc1.phx.", + "lastAction" : "ROLLING_APPLY", + "lifecycleDetails" : "Update package available.", + "lifecycleState" : "AVAILABLE", + "timeReleased" : "2017-02-17T09:20:01.007Z", + "updateType" : "GI_PATCH", + "version" : "20170127" + } + ] + '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/DefaultError' + summary: ListExadbVmClusterUpdates + tags: + - database + x-example: | + GET /20160918/exadbVmClusters/<exadbVmClusterId>/updates?limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExadbVmClusterUpdate' + /exadbVmClusters/{exadbVmClusterId}/updates/{updateId}: + get: + description: | + Gets information about a specified maintenance update package for a Exadata VM cluster on Exascale Infrastructure. + operationId: GetExadbVmClusterUpdate + parameters: + - $ref: '#/components/parameters/ExadbVmClusterIdPathParam' + - $ref: '#/components/parameters/UpdateIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The maintenance update package. + 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/ExadbVmClusterUpdate' + application-json: + examples: + response: + value: | + { + "description" : "Update PSU as released on 20170127", + "id" : "ocid1.dbpatch.oc1.phx.", + "timeReleased" : "2017-01-16T01:50:07.0001Z", + "updateType" : "GI_PATCH", + "lastAction" : "ROLLING_APPLY", + "version" : "20170127" + } + '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/DefaultError' + summary: GetExadbVmClusterUpdate + tags: + - database + x-example: | + GET /20160918/exadbVmClusters/<exadbVmClusterId>/updates/<updateId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExadbVmClusterUpdate' + /exascaleDbStorageVaults: + get: + description: | + Gets a list of the Exadata Database Storage Vaults in the specified compartment. + operationId: ListExascaleDbStorageVaults + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/ListExascaleDbStorageVaultsSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListExascaleDbStorageVaultsFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/ListExascaleDbStorageVaultsFilterByClusterPlacementGroupIdQueryParam' + - $ref: '#/components/parameters/AttachedShapeAttributesNotEqualToQueryParam' + - $ref: '#/components/parameters/AttachedShapeAttributesQueryParam' + - $ref: '#/components/parameters/VmClusterCountLessThanOrEqualToQueryParam' + - $ref: '#/components/parameters/VmClusterCountGreaterThanOrEqualToQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ListExascaleDbStorageVaultsFilterByExadataInfrastructureIdQueryParam' + responses: + '200': + description: List of the Exadata Database Storage Vaults + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListExascaleDbStorageVaultsResponse' + application-json: + examples: + response: + value: | + [ + { + "displayName" : "exascaleDbStorageVault", + "compartmentId" : "ocid1.tenancy.oc1.<unique_ID>", + "availabilityDomain" : "OXET:PHX-AD-1", + "lifecycleState" : "PROVISIONING", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "id" : "ocid1.exascaleDbstoragevault.oc1.", + "lifecycleDetails" : "Exascale DB storage vault is being provisioned.", + "highCapacityDatabaseStorage": { + "totalSizeInGbs": 256 + }, + "additionalFlashCacheInPercent": 20, + "vmClusterCount": 0 + }, + { + "displayName": "exascaleDbStorageVault", + "compartmentId": "ocid1.tenancy.oc1.<unique_ID>", + "availabilityDomain": "OXET:PHX-AD-1", + "lifecycleState": "PROVISIONING", + "timeCreated": "2018-11-22T19:25:42.755Z", + "id": "ocid1.exascaleDbstoragevault.oc1.", + "lifecycleDetails": "Exascale DB storage vault is being provisioned.", + "highCapacityDatabaseStorage": { + "totalSizeInGbs": 256 + }, + "additionalFlashCacheInPercent": 20, + "exadataInfrastructureId": "ocid1.cloudexadataInfrastructure.oc1.", + "vmClusterCount": 0 + } + ] + '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/DefaultError' + summary: ListExascaleDbStorageVaults + tags: + - database + x-example: | + GET /20160918/exascaleDbStorageVaults?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExascaleDbStorageVault' + post: + description: | + Creates an Exadata Database Storage Vault + operationId: CreateExascaleDbStorageVault + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateExascaleDbStorageVaultDetails' + description: | + Request to create a Exadata Database Storage Vault. + required: true + responses: + '200': + description: The request was successfully received and the create Exadata Database Storage Vault. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExascaleDbStorageVault' + application-json: + examples: + response: + value: | + { + "displayName" : "exascaleDbStorageVault", + "compartmentId" : "ocid1.tenancy.oc1.<unique_ID>", + "availabilityDomain" : "OXET:PHX-AD-1", + "lifecycleState" : "PROVISIONING", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "id" : "ocid1.exascaleDbstoragevault.oc1.", + "lifecycleDetails" : "Exascale DB storage vault is being provisioned.", + "highCapacityDatabaseStorage": { + "totalSizeInGbs": 256 + }, + "additionalFlashCacheInPercent": 20, + "exadataInfrastructureId": "ocid1.exadatainfrastructure.oc1.", + "vmClusterIds": [] + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateExascaleDbStorageVault + tags: + - database + x-example: | + POST /20160918/exascaleDbStorageVaults + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName" : "exascaleDbStorageVault", + "compartmentId" : "ocid1.tenancy.oc1.<unique_ID>", + "availabilityDomain" : "OXET:PHX-AD-1", + "highCapacityDatabaseStorage": { + "totalSizeInGbs": 256 + }, + "additionalFlashCacheInPercent": 20 + } + /exascaleDbStorageVaults/{exascaleDbStorageVaultId}: + delete: + description: | + Deletes the specified Exadata Database Storage Vault. + operationId: DeleteExascaleDbStorageVault + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/ExascaleDbStorageVaultIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '204': + description: The request to delete the Exadata Database Storage Vault was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Deletes the specified Exadata Database Storage Vault. + tags: + - database + x-example: | + DELETE /20160918/exascaleDbStorageVaults/<storageVaultId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExascaleDbStorageVault' + get: + description: | + Gets information about the specified Exadata Database Storage Vaults in the specified compartment. + operationId: GetExascaleDbStorageVault + parameters: + - $ref: '#/components/parameters/ExascaleDbStorageVaultIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: Information about the Exadata Database Storage Vault. + 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/ExascaleDbStorageVault' + application-json: + examples: + response: + value: | + { + "displayName" : "exascaleDbStorageVault", + "compartmentId" : "ocid1.tenancy.oc1.<unique_ID>", + "availabilityDomain" : "OXET:PHX-AD-1", + "lifecycleState" : "PROVISIONING", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "id" : "ocid1.exascaleDbstoragevault.oc1.", + "lifecycleDetails" : "Exascale DB storage vault is being provisioned.", + "highCapacityDatabaseStorage": { + "totalSizeInGbs": 256 + }, + "additionalFlashCacheInPercent": 20, + "exadataInfrastructureId": "ocid1.exadatainfrastructure.oc1.", + "vmClusterIds": [] + } + '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/DefaultError' + summary: GetExascaleDbStorageVault + tags: + - database + x-example: | + GET /20160918/exascaleDbStorageVaults/<storageVaultId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the specified Exadata Database Storage Vault. + operationId: UpdateExascaleDbStorageVault + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/ExascaleDbStorageVaultIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateExascaleDbStorageVaultDetails' + description: Request to update the attributes of a Exadata Database Storage Vault. + required: true + responses: + '200': + description: The request was successfully received and the Exadata Database Storage Vault update operation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExascaleDbStorageVault' + application-json: + examples: + response: + value: | + { + "displayName" : "exascaleDbStorageVault", + "compartmentId" : "ocid1.tenancy.oc1.<unique_ID>", + "availabilityDomain" : "OXET:PHX-AD-1", + "lifecycleState" : "UPDATING", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "id" : "ocid1.exascaleDbstoragevault.oc1.", + "lifecycleDetails" : "Exascale DB storage vault update is in progress.", + "highCapacityDatabaseStorage": { + "totalSizeInGbs": 256 + }, + "additionalFlashCacheInPercent": 20, + "exadataInfrastructureId": "ocid1.exadatainfrastructure.oc1.", + "vmClusterIds": [] + } + '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/DefaultError' + summary: Updates the specified Exadata Database Storage Vault. + tags: + - database + x-example: | + PUT /20160918/exascaleDbStorageVaults/<storageVaultId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "highCapacityDatabaseStorage": { + "totalSizeInGbs": 256 + }, + "additionalFlashCacheInPercent": 20, + "displayName": "exascaleVaultName" + } + /exascaleDbStorageVaults/{exascaleDbStorageVaultId}/actions/changeCompartment: + post: + description: | + Moves a Exadata Database Storage Vault to another compartment. + operationId: ChangeExascaleDbStorageVaultCompartment + parameters: + - $ref: '#/components/parameters/ExascaleDbStorageVaultIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeExascaleDbStorageVaultCompartmentDetails' + description: Request to move Exadata Database Storage Vault to a different compartment + required: true + responses: + '202': + description: The request was successfully received and the change compartment action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: ChangeExascaleDbStorageVaultCompartment + tags: + - database + x-example: | + POST /20160918/exascaleDbStorageVaults/<storageVaultId>/actions/changeCompartment + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>" + } + x-related-resource: '#/definitions/ExascaleDbStorageVault' + /exascaleDbStorageVaults/{exascaleDbStorageVaultId}/actions/changeSubscription: + post: + description: | + Associate a Exadata Database Storage Vault with a different subscription. + operationId: ChangeExascaleDbStorageVaultSubscription + parameters: + - $ref: '#/components/parameters/ExascaleDbStorageVaultIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeExascaleDbStorageVaultSubscriptionDetails' + description: Associate a Exadata Database Storage Vault with a different subscription. + required: true + responses: + '202': + description: The request was successfully received and the update subscription action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: ChangeExascaleDbStorageVaultSubscription + tags: + - database + x-example: | + POST /20160918/exascaleDbStorageVaults/<storageVaultId>/actions/changeSubscription + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "subscriptionId": "ocid1.subscription.oc1..<unique_ID>" + } + x-related-resource: '#/definitions/ExascaleDbStorageVault' + /executionActions: + get: + description: | + Lists the execution action resources in the specified compartment. + operationId: ListExecutionActions + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ListExecutionActionsSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListExecutionActionsFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/ListExecutionActionsFilterByExecutionWindowIdQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + responses: + '200': + description: | + A list of the execution action resources in the specified compartment. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListExecutionActionsResponse' + application-json: + examples: + response: + value: | + [{ + "id" : "ocid1.executionaction.oc1.phx.", + "displayName" : "tstExecutionAction", + "compartmentId" : "ocid1.tenancy.oc1.", + "executionWindowId" : "ocid1.executionWindow.oc1.phx.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "UPDATING", + "lifecycleDetails" : null, + "executionActionOrder" : 1, + "executionActionType" : "DB_SERVER_FULL_SOFTWARE_UPDATE", + "executionActionParams" : [ + {"patchingMode": "Rolling"}, + {"enableCustomtActionTimeout": "true"}, + {"customtActionTimeout": "30"} + ], + "actionMembers": [{ + "memberOrder": "1", + "memberId": "ocid1.dbServer.oc1.phx.", + "status": "SCHEDULED", + "estimatedTimeInMins": "90" + }, + { + "memberOrder": "2", + "memberId": "ocid1.dbServer.oc1.phx.", + "status": "SCHEDULED", + "estimatedTimeInMins": "90" + }] + }, + { + "id" : "ocid1.executionaction.oc1.phx.", + "displayName" : "tstExecutionAction2", + "compartmentId" : "ocid1.tenancy.oc1.", + "executionWindowId" : "ocid1.executionWindow.oc1.phx.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "UPDATING", + "lifecycleDetails" : null, + "executionActionOrder" : 2, + "executionActionType" : "STORAGE_SERVER_FULL_SOFTWARE_UPDATE", + "executionActionParams" : [ + {"patchingMode": "Rolling"}, + {"enableCustomtActionTimeout": "false"}, + {"count": "3"} + ], + "actionMembers": [] + }] + '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/DefaultError' + summary: ListExecutionActions + tags: + - database + x-example: | + GET /20160918/executionActions?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExecutionAction' + post: + description: | + Creates an execution action resource. + operationId: CreateExecutionAction + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateExecutionActionDetails' + description: Request to create execution action. + required: true + responses: + '200': + description: | + The request was successfully received and the create execution action operation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExecutionAction' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.executionaction.oc1.phx.", + "displayName" : "tstExecutionAction", + "compartmentId" : "ocid1.tenancy.oc1.", + "executionWindowId" : "ocid1.executionWindow.oc1.phx.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "SCHEDULED", + "lifecycleDetails" : null, + "executionActionOrder" : 2, + "executionActionType" : "DB_SERVER_FULL_SOFTWARE_UPDATE", + "executionActionParams" : [ + {"patchingMode": "Rolling"}, + {"enableCustomtActionTimeout": "true"}, + {"customtActionTimeout": "30"} + ], + "actionMembers": [{ + "memberOrder": "1", + "memberId": "ocid1.dbServer.oc1.phx.", + "status": "SCHEDULED", + "estimatedTimeInMins": "90" + }, + { + "memberOrder": "2", + "memberId": "ocid1.dbServer.oc1.phx.", + "status": "SCHEDULED", + "estimatedTimeInMins": "90" + }] + } + '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/DefaultError' + summary: CreateExecutionAction + tags: + - database + x-example: | + POST /20160918/executionActions + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.tenancy.oc1.<unique_ID>", + "executionWindowId" : "ocid1.executionWindow.oc1.phx.", + "executionActionType" : "DB_SERVER_FULL_SOFTWARE_UPDATE", + "executionActionParams" : [ + {"patchingMode": "Rolling"}, + {"enableCustomtActionTimeout": "true"}, + {"customtActionTimeout": "30"} + ], + "actionMembers": [{ + "memberOrder": "1", + "memberId": "ocid1.dbServer.oc1.phx." + }, + { + "memberOrder": "2", + "memberId": "ocid1.dbServer.oc1.phx." + }] + } + /executionActions/{executionActionId}: + delete: + description: | + Deletes the execution action. + operationId: DeleteExecutionAction + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ExecutionActionIdPathParam' + responses: + '204': + description: The request to delete the execution action was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Delete an execution action. + tags: + - database + x-related-resource: '#/definitions/ExecutionAction' + get: + description: | + Gets information about the specified execution action. + operationId: GetExecutionAction + parameters: + - $ref: '#/components/parameters/ExecutionActionIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The execution action details. + 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/ExecutionAction' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.executionaction.oc1.phx.", + "displayName" : "tstExecutionAction", + "compartmentId" : "ocid1.tenancy.oc1.", + "executionWindowId" : "ocid1.executionWindow.oc1.phx.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "UPDATING", + "lifecycleDetails" : null, + "executionActionOrder" : 2, + "executionActionType" : "DB_SERVER_FULL_SOFTWARE_UPDATE", + "executionActionParams" : [ + {"patchingMode": "Rolling"}, + {"enableCustomtActionTimeout": "true"}, + {"customtActionTimeout": "30"} + ], + "actionMembers": [{ + "memberOrder": "1", + "memberId": "ocid1.dbServer.oc1.phx.", + "status": "SCHEDULED", + "estimatedTimeInMins": "90" + }, + { + "memberOrder": "2", + "memberId": "ocid1.dbServer.oc1.phx.", + "status": "SCHEDULED", + "estimatedTimeInMins": "90" + }] + } + '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/DefaultError' + summary: Get ExecutionAction + tags: + - database + x-example: | + GET /20160918/executionActions/<executionActionId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the execution action resource. + operationId: UpdateExecutionAction + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ExecutionActionIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateExecutionActionDetails' + description: Request to update the properties of a execution action. + required: true + responses: + '200': + description: | + The request was successfully received and the execution action update is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExecutionAction' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.executionaction.oc1.phx.", + "displayName" : "tstExecutionAction", + "compartmentId" : "ocid1.tenancy.oc1.", + "executionWindowId" : "ocid1.executionWindow.oc1.phx.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "UPDATING", + "lifecycleDetails" : null, + "executionActionOrder" : 2, + "executionActionType" : "DB_SERVER_FULL_SOFTWARE_UPDATE", + "executionActionParams" : [ + {"patchingMode": "Rolling"}, + {"enableCustomtActionTimeout": "false"} + ], + "actionMembers": [{ + "memberOrder": "1", + "memberId": "ocid1.dbServer.oc1.phx.", + "status": "SCHEDULED", + "estimatedTimeInMins": "90" + }, + { + "memberOrder": "2", + "memberId": "ocid1.dbServer.oc1.phx.", + "status": "SCHEDULED", + "estimatedTimeInMins": "90" + }] + } + '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/DefaultError' + summary: Updates the specified execution action + tags: + - database + x-example: | + PUT /latest/executionActions/<executionActionId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "schedulingPolicyId" : "ocid1.schedulingpolicy.oc1.phx.", + "executionActionParams" : [ + {"patchingMode": "Rolling"}, + {"enableCustomtActionTimeout": "false"} + ], + "actionMembers": [{ + "memberOrder": "1", + "memberId": "ocid1.dbServer.oc1.phx.", + }, + { + "memberOrder": "2", + "memberId": "ocid1.dbServer.oc1.phx.", + }] + } + /executionActions/{executionActionId}/actions/moveActionMember: + post: + description: | + Moves an execution action member to this execution action resource from another. + operationId: MoveExecutionActionMember + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ExecutionActionIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MoveExecutionActionMemberDetails' + description: Request to move an execution action member to this execution action resource from another. + required: true + responses: + '200': + description: | + The request was successfully received and the add component operation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExecutionAction' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.executionaction.oc1.phx.", + "displayName" : "tstExecutionAction", + "compartmentId" : "ocid1.tenancy.oc1.", + "executionWindowId" : "ocid1.executionWindow.oc1.phx.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "UPDATING", + "lifecycleDetails" : null, + "executionActionOrder" : 2, + "executionActionType" : "DB_SERVER_FULL_SOFTWARE_UPDATE", + "executionActionParams" : [ + {"patchingMode": "Rolling"}, + {"enableCustomtActionTimeout": "true"}, + {"customtActionTimeout": "30"} + ], + "actionMembers": [{ + "memberOrder": "1", + "memberId": "ocid1.dbServer.oc1.phx.", + "status": "SCHEDULED", + "estimatedTimeInMins": "90" + }, + { + "memberOrder": "2", + "memberId": "ocid1.dbServer.oc1.phx.", + "status": "SCHEDULED", + "estimatedTimeInMins": "90" + }] + } + '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/DefaultError' + summary: Moves an execution action member to this execution action resource from another. + tags: + - database + x-example: | + POST /latest/executionActions/<executionActionId>/actions/moveActionMember + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "sourceExecutionActionId" : "ocid1.executionAction.oc1.phx.", + "executionActionMemberId" : "ocid1.dbServer.oc1.phx.", + "executionActionMemberCount" : null + } + x-related-resource: '#/definitions/ExecutionAction' + /executionWindows: + get: + description: | + Lists the execution window resources in the specified compartment. + operationId: ListExecutionWindows + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ListExecutionWindowsSortByQueryParam' + - $ref: '#/components/parameters/ListExecutionWindowsByResourceIdQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListExecutionWindowsFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + responses: + '200': + description: | + A list of execution window resources in the specified compartment. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListExecutionWindowsResponse' + application-json: + examples: + response: + value: | + [{ + "id" : "ocid1.executionWindow.oc1.phx.", + "displayName" : "2018-12-23T01:59:07.030Z", + "compartmentId" : "ocid1.tenancy.oc1.", + "executionResourceId" : "ocid1.maintenanceRun.oc1.phx.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "SCHEDULED", + "lifecycleDetails" : null, + "timeScheduled" : "2018-12-23T01:59:07.030Z", + "windowDurationInMins" : 360, + "isEnforcedDuration" : false, + "windowType" : "PLANNED" + }, + { + "id" : "ocid1.executionWindow.oc1.phx.", + "displayName" : "2018-12-27T01:59:07.030Z", + "compartmentId" : "ocid1.tenancy.oc1.", + "executionResourceId" : "ocid1.maintenanceRun.oc1.phx.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "SCHEDULED", + "lifecycleDetails" : null, + "timeScheduled" : "2018-12-27T01:59:07.030Z", + "windowDurationInMins" : 360, + "isEnforcedDuration" : true, + "windowType" : "PLANNED" + }] + '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/DefaultError' + summary: ListExecutionWindows + tags: + - database + x-example: | + GET /20160918/executionWindows?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExecutionWindow' + post: + description: | + Creates an execution window resource. + operationId: CreateExecutionWindow + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateExecutionWindowDetails' + description: Request to create execution window. + required: true + responses: + '200': + description: | + The request was successfully received and the create execution window operation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExecutionWindow' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.executionWindow.oc1.phx.", + "displayName" : "2018-12-23T01:59:07.030Z", + "compartmentId" : "ocid1.tenancy.oc1.", + "executionResourceId" : "ocid1.maintenanceRun.oc1.phx.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "CREATED", + "lifecycleDetails" : null, + "timeScheduled" : "2018-12-23T01:59:07.030Z", + "windowDurationInMins" : 360, + "isEnforcedDuration" : false, + "windowType" : "PLANNED" + } + '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/DefaultError' + summary: CreateExecutionWindow + tags: + - database + x-example: | + POST /20160918/executionWindows + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.tenancy.oc1.", + "executionResourceId" : "ocid1.maintenanceRun.oc1.phx.", + "timeScheduled" : "2018-12-23T01:59:07.030Z", + "windowDurationInMins" : 360, + "isEnforcedDuration" : false + } + /executionWindows/{executionWindowId}: + delete: + description: | + Deletes the execution window. + operationId: DeleteExecutionWindow + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ExecutionWindowIdPathParam' + responses: + '204': + description: The request to delete the execution window was accepted. + 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 + '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/DefaultError' + summary: Delete an execution window. + tags: + - database + x-related-resource: '#/definitions/ExecutionWindow' + get: + description: | + Gets information about the specified execution window. + operationId: GetExecutionWindow + parameters: + - $ref: '#/components/parameters/ExecutionWindowIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The execution window details. + 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/ExecutionWindow' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.executionWindow.oc1.phx.", + "displayName" : "2018-12-23T01:59:07.030Z", + "compartmentId" : "ocid1.tenancy.oc1.", + "executionResourceId" : "ocid1.maintenanceRun.oc1.phx.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "SCHEDULED", + "lifecycleDetails" : null, + "timeScheduled" : "2018-12-23T01:59:07.030Z", + "windowDurationInMins" : 360, + "isEnforcedDuration" : false, + "windowType" : "PLANNED" + } + '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/DefaultError' + summary: GetExecutionWindow + tags: + - database + x-example: | + GET /20160918/executionWindows/<executionWindowId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the execution window resource. + operationId: UpdateExecutionWindow + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ExecutionWindowIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateExecutionWindowDetails' + description: Request to update the properties of a execution window. + required: true + responses: + '200': + description: | + The request was successfully received and the execution window update is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExecutionWindow' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.executionWindow.oc1.phx.", + "displayName" : "2018-12-23T01:59:07.030Z", + "compartmentId" : "ocid1.tenancy.oc1.", + "executionResourceId" : "ocid1.maintenanceRun.oc1.phx.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "UPDATING", + "lifecycleDetails" : null, + "timeScheduled" : "2018-12-23T01:59:07.030Z", + "windowDurationInMins" : 360, + "isEnforcedDuration" : false, + "windowType" : "PLANNED" + } + '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/DefaultError' + summary: Updates the specified execution window + tags: + - database + x-example: | + PUT /latest/executionWindows/<executionWindowId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "timeScheduled" : "2018-12-23T01:59:07.030Z", + "windowDurationInMins" : 360, + "isEnforcedDuration" : false, + } + /executionWindows/{executionWindowId}/actions/reorder: + post: + description: | + Reorders the execution actions under this execution window resource. + operationId: ReorderExecutionActions + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/ExecutionWindowIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ReorderExecutionActionDetails' + description: Request to reorder the execution actions under this execution window resource. + required: true + responses: + '200': + description: | + The request was successfully received and the execution action reordering is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExecutionWindow' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.executionWindow.oc1.phx.", + "displayName" : "2018-12-23T01:59:07.030Z", + "compartmentId" : "ocid1.tenancy.oc1.", + "executionResourceId" : "ocid1.maintenanceRun.oc1.phx.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "SCHEDULED", + "lifecycleDetails" : null, + "timeScheduled" : "2018-12-23T01:59:07.030Z", + "windowDurationInMins" : 360, + "isEnforcedDuration" : false, + "windowType" : "PLANNED" + } + '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/DefaultError' + summary: Reorders the execution actions under this execution window resource. + tags: + - database + x-example: | + POST /latest/executionWindows/<executionWindowId>/actions/reorder + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "executionActionOrderList" : [ + { + "actionOrder": "1", + "actionResourceId": "ocid1.executionAction.oc1.phx." + }, + { + "actionOrder": "2", + "actionResourceId": "ocid1.executionAction.oc1.phx." + } + ] + } + x-related-resource: '#/definitions/ExecutionWindow' + /externalBackupJobs: + post: + description: | + Creates a new backup resource and returns the information the caller needs to back up an on-premises Oracle Database to Oracle Cloud Infrastructure. + + **Note:** This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See [Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud](/Content/Database/Tasks/mig-onprembackup.htm) for more information. + operationId: CreateExternalBackupJob + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateExternalBackupJobDetails' + description: Request to create a cloud backup resource for a database running outside the cloud. + required: true + responses: + '200': + description: The request was successfully received and the backup resource is being provisioned. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalBackupJob' + application-json: + examples: + response: + value: | + { + "backupId" : "ocid1.backup.oc1.phx.", + "tag" : "", + "swiftPath" : "", + "bucketName" : "", + "userName" : "", + "swiftPassword" : "" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateExternalBackupJob + tags: + - database + x-example: | + POST /20160918/externalBackupJobs + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "availabilityDomain" : "OXET:PHX-AD-1", + "compartmentId" : "ocid1.tenancy.oc1..<unique_ID>", + "dbVersion" : "12.1.0.2", + "dbName" : "<example_db>" + "externalDatabaseIdentifier" : "3942196782", + "displayName" : "<example_display_name>" + "characterSet" : "AL32UTF8", + "ncharacterSet" : "AL16UTF16" + "shape" : "BM.DensioIO1.36" + } + /externalBackupJobs/{backupId}: + get: + description: | + Gets information about the specified external backup job. + + **Note:** This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See [Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud](/Content/Database/Tasks/mig-onprembackup.htm) for more information. + operationId: GetExternalBackupJob + parameters: + - $ref: '#/components/parameters/BackupIdPathParam' + responses: + '200': + description: The backup of an external database. + 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/ExternalBackupJob' + application-json: + examples: + response: + value: | + { + "backupId" : "ocid1.backup.oc1.phx.", + "tag" : "DBTFull5643984379xwe", + "swiftPath" : "https://swiftobjectstorage.us-phoenix-1.oraclecloud.com/v1/example_tenant", + "bucketName" : "example_bucket_name", + "userName" : "example_user_name", + "swiftPassword" : "example_password" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetExternalBackupJob + tags: + - database + x-example: | + GET /20160918/externalBackupJobs/<backupId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /externalBackupJobs/{backupId}/actions/complete: + post: + description: | + Changes the status of the standalone backup resource to `ACTIVE` after the backup is created from the on-premises database and placed in Oracle Cloud Infrastructure Object Storage. + + **Note:** This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See [Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud](/Content/Database/Tasks/mig-onprembackup.htm) for more information. + operationId: CompleteExternalBackupJob + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/BackupIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CompleteExternalBackupJobDetails' + description: Updates the status of the backup resource. + required: true + responses: + '200': + description: The request was successfully received and the update of the backup resource is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalBackupJob' + application-json: + examples: + response: + value: | + { + "backupId" : "ocid1.backup.oc1.phx.", + "tag" : "DBTFull5643984379xwe", + "swiftPath" : "https://swiftobjectstorage.us-phoenix-1.oraclecloud.com/v1/example_tenant", + "bucketName" : "example_bucket_name", + "userName" : "", + "swiftPassword" : "" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CompleteExternalBackupJob + tags: + - database + x-example: | + POST /20160918/externalBackupJobs/<backupId>/actions/complete + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "cfBackupHandle" : "nlongterm_example_db_3829144951_16s6pt5b_1_1_20170614_946664619" + "spfBackuphandle" : "nlongterm_example_db_36495879761_185h5yuu_1_2_20170614_946665678" + } + x-related-resource: '#/definitions/ExternalBackupJob' + /externalcontainerdatabases: + get: + description: | + Gets a list of the external container databases in the specified compartment. + operationId: ListExternalContainerDatabases + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/ListExternalContainerDatabasesSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListExternalContainerDatabasesFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + responses: + '200': + description: The list of external container databases in the specified compartment. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListExternalContainerDatabasesResponse' + application-json: + examples: + response: + value: | + [ + { + "compartmentId" : "ocid1.compartment.oc1..unique_ID", + "displayName" : "myTestDb", + "id": "ocid1.externalcontainerdatabase.oc1.", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails": null, + "dbId": "3315642767", + "dbVersion": "19c", + "dbUniqueName" : "myTestDb_phx1cs", + "dbEdition" : "ENTERPRISE_EDITION", + "characterSet" : "AL32UTF8", + "ncharacterSet" : "AL16UTF16", + "timeCreated" : "2016-11-23T01:59:07.032Z" + }, + { + "compartmentId" : "ocid1.compartment.oc1..unique_ID", + "displayName" : "myRealDb", + "id": "ocid1.externalcontainerdatabase.oc1.", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails": null, + "dbId": "3315642768", + "dbVersion": "19c", + "dbUniqueName" : "myRealDb_phx1cs", + "dbEdition" : "ENTERPRISE_EDITION", + "characterSet" : "AL32UTF8", + "ncharacterSet" : "AL16UTF16", + "timeCreated" : "2016-11-25T02:59:09.028Z" + } + ] + '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/DefaultError' + summary: ListExternalContainerDatabases + tags: + - database + x-example: | + Example: + GET /20160918/externalcontainerdatabases?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExternalContainerDatabase' + post: + description: Creates a new external container database resource. + operationId: CreateExternalContainerDatabase + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateExternalContainerDatabaseDetails' + description: Request to create a new external container database resource. + required: true + responses: + '200': + description: The request was successfully received and is in-progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalContainerDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..unique_ID", + "displayName" : "myTestDb", + "id": "ocid1.externalcontainerdatabase.oc1.", + "lifecycleState" : "NOT_CONNTECTED", + "lifecycleDetails": null, + "dbId": "3315642767", + "dbVersion": "19c", + "dbUniqueName" : "myTestDb_phx1cs", + "dbEdition" : "ENTERPRISE_EDITION", + "characterSet" : "AL32UTF8", + "ncharacterSet" : "AL16UTF16", + "timeCreated" : "2016-11-23T01:59:07.032Z" + } + '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/DefaultError' + summary: CreateExternalContainerDatabase + tags: + - database + x-example: | + Example I: + POST /20160918/externalcontainerdatabases + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.[tenancy|compartment].oc1.<unique_ID>", + "displayName": "myTestExternalCdb" + } + /externalcontainerdatabases/{externalContainerDatabaseId}: + delete: + description: | + Deletes the [external container database](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) + resource. Any external pluggable databases registered under this container database must be deleted in + your Oracle Cloud Infrastructure tenancy prior to this operation. + operationId: DeleteExternalContainerDatabase + parameters: + - $ref: '#/components/parameters/ExternalContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: | + The request to delete the + [external container database](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) resource + was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Delete the ExternalContainerDatabase + tags: + - database + x-example: | + DELETE /20160918/externalcontainerdatabases/<externalContainerDatabaseId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExternalContainerDatabase' + get: + description: Gets information about the specified external container database. + operationId: GetExternalContainerDatabase + parameters: + - $ref: '#/components/parameters/ExternalContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The external container database. + 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/ExternalContainerDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..unique_ID", + "displayName" : "myTestDb", + "id": "ocid1.externalcontainerdatabase.oc1.", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails": null, + "dbId": "3315642767", + "dbVersion": "19c", + "dbUniqueName" : "myTestDb_phx1cs", + "dbEdition" : "ENTERPRISE_EDITION", + "characterSet" : "AL32UTF8", + "ncharacterSet" : "AL16UTF16", + "timeCreated" : "2016-11-23T01:59:07.032Z" + } + '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/DefaultError' + summary: GetExternalContainerDatabase + tags: + - database + x-example: | + GET /20160918/externalcontainerdatabases/<externalContainerDatabaseId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the properties of + an [ExternalContainerDatabase](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) resource, + such as the display name. + operationId: UpdateExternalContainerDatabase + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ExternalContainerDatabaseIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateExternalContainerDatabaseDetails' + description: | + Request to update the properties of an + [external container database](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) resource. + required: true + responses: + '200': + description: | + The request was successfully received and the + [external container database](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) update + is in-progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalContainerDatabase' + application-json: + examples: + response: + value: | + Response to example: + { + "compartmentId" : "ocid1.tenancy.oc1..unique_ID", + "displayName" : "myTestDb2", + "id": "ocid1.externalcontainerdatabase.oc1.", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails": null, + "dbId": "3315642767", + "dbVersion": "19c", + "dbUniqueName" : "myTestDb_phx1cs", + "dbEdition" : "ENTERPRISE_EDITION", + "characterSet" : "AL32UTF8", + "ncharacterSet" : "AL16UTF16", + "timeCreated" : "2016-11-23T01:59:07.032Z" + } + '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/DefaultError' + summary: UpdateExternalContainerDatabase + tags: + - database + x-example: | + Example: + PUT /20160918/externalcontainerdatabases/<externalContainerDatabaseId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName": "myTestDb2" + } + /externalcontainerdatabases/{externalContainerDatabaseId}/actions/changeCompartment: + post: + description: | + Move the [external container database](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) + and its dependent resources to the specified compartment. + For more information about moving external container databases, see + [Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes). + operationId: ChangeExternalContainerDatabaseCompartment + parameters: + - $ref: '#/components/parameters/ExternalContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeCompartmentDetails' + description: Request to move the external container database to a different compartment. + required: true + responses: + '202': + description: The request was successfully received and the change compartment action is being performed. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: ChangeExternalContainerDatabaseCompartment + tags: + - database + x-example: | + POST /20160918/externalcontainerdatabases/<externalContainerDatabaseId>/actions/changeCompartment + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid.compartment.oc1..<unique_ID>" + } + x-related-resource: '#/definitions/ExternalContainerDatabase' + /externalcontainerdatabases/{externalContainerDatabaseId}/actions/disableDatabaseManagement: + post: + description: | + Disable Database Management service for the external container database. + operationId: DisableExternalContainerDatabaseDatabaseManagement + parameters: + - $ref: '#/components/parameters/ExternalContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + description: The request was successfully received and Database Management Service is being disabled. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Disable Database Management Service for the external container database. + tags: + - database + x-example: | + POST /20160918/externalcontainerdatabases/<externalContainerDatabaseId>/actions + /disableDatabaseManagement + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExternalContainerDatabase' + /externalcontainerdatabases/{externalContainerDatabaseId}/actions/disableStackMonitoring: + post: + description: | + Disable Stack Monitoring for the external container database. + operationId: DisableExternalContainerDatabaseStackMonitoring + parameters: + - $ref: '#/components/parameters/ExternalContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + description: The request was successfully received and this External Container Database will disable Stack Monitoring. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Disable Stack Monitoring Service for the external container database. + tags: + - database + x-example: | + POST /20160918/externalcontainerdatabases/<externalContainerDatabaseId>/actions + /disableStackMonitoring + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/ExternalContainerDatabase' + /externalcontainerdatabases/{externalContainerDatabaseId}/actions/enableDatabaseManagement: + post: + description: | + Enables Database Management Service for the external container database. + For more information about the Database Management Service, see + [Database Management Service](/Content/ExternalDatabase/Concepts/databasemanagementservice.htm). + operationId: EnableExternalContainerDatabaseDatabaseManagement + parameters: + - $ref: '#/components/parameters/ExternalContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnableExternalContainerDatabaseDatabaseManagementDetails' + description: Request to enable the Database Management Service for an external container database. + required: true + responses: + '202': + description: The request was successfully received and Database Management Service is being enabled. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Enable Database Management Service for the external container database. + tags: + - database + x-example: | + POST /20160918/externalcontainerdatabases/<externalContainerDatabaseId>/actions + /enableDatabaseManagement + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "externalDatabaseConnectorId": "ocid1.externaldatabaseconnector..unique_ID", + "licenseModel": "BRING_YOUR_OWN_LICENSE" + } + x-related-resource: '#/definitions/ExternalContainerDatabase' + /externalcontainerdatabases/{externalContainerDatabaseId}/actions/enableStackMonitoring: + post: + description: | + Enable Stack Monitoring for the external container database. + operationId: EnableExternalContainerDatabaseStackMonitoring + parameters: + - $ref: '#/components/parameters/ExternalContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnableExternalContainerDatabaseStackMonitoringDetails' + description: | + Details to enable Stack Monitoring on the external container database. + required: true + responses: + '202': + description: The request was successfully received and this External Container Database will enable Stack Monitoring. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Enable Stack Monitoring Service for the external container database. + tags: + - database + x-example: | + POST /20160918/externalcontainerdatabases/<externalContainerDatabaseId>/actions + /enableStackMonitoring + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "externalDatabaseConnectorId": "ocid1.externaldatabaseconnector..unique_ID" + } + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/ExternalContainerDatabase' + /externalcontainerdatabases/{externalContainerDatabaseId}/actions/scanPluggableDatabases: + post: + description: | + Scans for pluggable databases in the specified external container database. + This operation will return un-registered pluggable databases in the [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) operation. + operationId: ScanExternalContainerDatabasePluggableDatabases + parameters: + - $ref: '#/components/parameters/ExternalContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/ExternalDatabaseConnectorIdQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '202': + description: | + The request was successfully received and the scan pluggable databases action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application-json: + examples: + response: + value: | + Example GetWorkRequest response: + { + "operationType": "SCAN_EXTERNAL_CONTAINER_DATABASE_PLUGGABLE_DATABASES", + "status": "SUCCEEDED", + "id": "", + "compartmentId": "" + "resources" : [ + { + "actionType": "RELATED", + "entityType": "externalpluggabledatabases", + "identifier": "{'cdb':'','pdb':'Name1_PDB'}", + "metadata": { + "pdbUniqueName": "Name1_PDB" + } + }, + { + "actionType": "RELATED", + "entityType": "externalpluggabledatabases", + "identifier": "{'cdb':'','pdb':'Name2_PDB'}", + "metadata": { + "pdbUniqueName": "Name2_PDB" + } + }, + { + "actionType": "RELATED", + "entityType": "externalpluggabledatabases", + "identifier": "{'cdb':'','pdb':'Name3_PDB'}", + "metadata": { + "pdbUniqueName": "Name3_PDB" + } + } + ], + "percentComplete": 100, + "timeAccepted": "2016-11-23T01:59:07.032Z", + "timeStarted": "2016-11-23T02:00:00.000Z", + "timeFinished": "2016-11-23T02:05:00.000Z" + } + '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/DefaultError' + summary: Scan for un-registered pluggable databases in this external container database. + tags: + - database + x-examples: | + POST /20160918/externalcontainerdatabases/<externalContainerDatabaseId>/actions/scanPluggableDatabases + ?externalDatabaseConnectorId=<externalDatabaseConnectorId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExternalContainerDatabase' + /externaldatabaseconnectors: + get: + description: | + Gets a list of the external database connectors in the specified compartment. + operationId: ListExternalDatabaseConnectors + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/ListExternalDatabaseConnectorsExternalDatabaseIdQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/ListExternalDatabaseConnectorsSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListExternalDatabaseConnectorsFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + responses: + '200': + description: All the external database connectors. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListExternalDatabaseConnectorsResponse' + application-json: + examples: + response: + value: | + [ + { + "compartmentId": "ocid1.tenancy.oc1..unique_ID", + "id": "ocid1.externaldatabaseconnector..unique_ID", + "displayName": "myTestConn", + "connectionString": { + "hostname": "myHost.test", + "port": 1521, + "service": "testService", + "protocol": "TCP" + }, + "connectionCredentials": { + "credentialType": "NAME_REFERENCE", + "credentialName": "myCred" + }, + "connectorType": "MACS", + "connectorAgentId": "macsAgentIdentifier", + "externalDatabaseId": "ocid1.externalcontainerdatabases..unique_ID", + "timeCreated": "2016-11-23T02:59:07.032Z", + "connectionStatus": "SUCCESS", + "timeConnectionStatusLastUpdated": "2016-11-23T02:59:07.032Z" + }, + { + "compartmentId": "ocid1.tenancy.oc1..unique_ID", + "id": "ocid1.externaldatabaseconnector..unique_ID", + "displayName": "myTestConn2", + "connectionString": { + "hostname": "myHost.test", + "port": 1521, + "service": "testService", + "protocol": "TCP" + }, + "connectionCredentials": { + "credentialType": "NAME_REFERENCE", + "credentialName": "myCred2" + }, + "connectorType": "MACS", + "connectorAgentId": "macsAgentIdentifier", + "externalDatabaseId": "ocid1.externalcontainerdatabases..unique_ID", + "timeCreated": "2016-11-23T02:59:07.032Z", + "connectionStatus": "SUCCESS", + "timeConnectionStatusLastUpdated": "2016-11-23T02:59:07.032Z" + } + ] + '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/DefaultError' + summary: ListExternalDatabaseConnectors + tags: + - database + x-example: | + Example: + GET /20160918/externaldatabaseconnectors?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExternalDatabaseConnector' + post: + description: Creates a new external database connector. + operationId: CreateExternalDatabaseConnector + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateExternalDatabaseConnectorDetails' + description: Request to create a connector to an external database. + required: true + responses: + '200': + description: The request was successfully received and is in-progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalDatabaseConnector' + application-json: + examples: + response: + value: | + { + "compartmentId": "ocid1.tenancy.oc1..unique_ID", + "id": "ocid1.externaldatabaseconnector..unique_ID", + "displayName": "myTestConn", + "connectionString": { + "hostname": "myHost.test", + "port": 1521, + "service": "testService", + "protocol": "TCP" + }, + "connectionCredentials": { + "credentialType": "NAME_REFERENCE", + "credentialName": "myCred" + }, + "connectorType": "MACS", + "connectorAgentId": "macsAgentIdentifier", + "externalDatabaseId": "ocid1.externalcontainerdatabases..unique_ID", + "timeCreated": "2016-11-23T02:59:07.032Z", + "connectionStatus": "SUCCESS", + "timeConnectionStatusLastUpdated": "2016-11-23T02:59:07.032Z" + } + '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/DefaultError' + summary: Creates an ExternalDatabaseConnector + tags: + - database + x-example: | + Example: + POST /20160918/externaldatabaseconnectors + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName": "myTestConn", + "connectionString": { + "hostname": "myHost.test", + "port": 1521, + "service": "testService", + "protocol": "TCP" + }, + "connectionCredentials": { + "username": "testUser", + "password": "greatPassword", + "role": "SYSDBA" + }, + "connectorType": "MACS", + "connectorAgentId": "ocid", + "externalDatabaseId": "ocid" + } + /externaldatabaseconnectors/{externalDatabaseConnectorId}: + delete: + description: | + Deletes an external database connector. + Any services enabled using the external database connector must be + deleted prior to this operation. + operationId: DeleteExternalDatabaseConnector + parameters: + - $ref: '#/components/parameters/ExternalDatabaseConnectorIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '204': + description: The request to delete the ExternalDatabaseConnector was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: DeleteExternalDatabaseConnector + tags: + - database + x-example: | + DELETE /20160918/externaldatabaseconnectors/<externalDatabaseConnectorId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExternalDatabaseConnector' + get: + description: Gets information about the specified external database connector. + operationId: GetExternalDatabaseConnector + parameters: + - $ref: '#/components/parameters/ExternalDatabaseConnectorIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The ExternalDatabaseConnector 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/ExternalDatabaseConnector' + application-json: + examples: + response: + value: | + { + "compartmentId": "ocid1.tenancy.oc1..unique_ID", + "id": "ocid1.externaldatabaseconnector..unique_ID", + "displayName": "myTestConn", + "connectionString": { + "hostname": "myHost.test", + "port": 1521, + "service": "testService", + "protocol": "TCP" + }, + "connectionCredentials": { + "credentialType": "NAME_REFERENCE", + "credentialName": "myCred" + }, + "connectorType": "MACS", + "connectorAgentId": "macsAgentIdentifier", + "externalDatabaseId": "ocid1.externalcontainerdatabases..unique_ID", + "timeCreated": "2016-11-23T02:59:07.032Z", + "connectionStatus": "SUCCESS", + "timeConnectionStatusLastUpdated": "2016-11-23T02:59:07.032Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetExternalDatabaseConnector + tags: + - database + x-example: | + GET /20160918/externaldatabaseconnectors/<externalDatabaseConnectorId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: Updates the properties of an external database connector, such as the display name. + operationId: UpdateExternalDatabaseConnector + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/ExternalDatabaseConnectorIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateExternalDatabaseConnectorDetails' + description: Request to update the properties of an external database connector. + required: true + responses: + '200': + description: The request was successfully received and the external database connector update is in-progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalDatabaseConnector' + application-json: + examples: + response: + value: | + { + "compartmentId": "ocid1.tenancy.oc1..unique_ID", + "id": "ocid1.externaldatabaseconnector..unique_ID", + "displayName": "myTestConn", + "connectionString": { + "hostname": "myHost.test", + "port": 1521, + "service": "testService", + "protocol": "TCP" + }, + "connectionCredentials": { + "credentialType": "DETAILS", + "username": "testUser", + "password": "greatPassword2", + "role": "SYSDBA" + }, + "connectorType": "MACS", + "connectorAgentId": "macsAgentIdentifier", + "externalDatabaseId": "ocid1.externalcontainerdatabases..unique_ID", + "timeCreated": "2016-11-23T02:59:07.032Z", + "connectionStatus": "SUCCESS", + "timeConnectionStatusLastUpdated": "2016-11-23T02:59:07.032Z" + } + '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/DefaultError' + summary: UpdateExternalDatabaseConnector + tags: + - database + x-example: | + Example: + PUT /20160918/externaldatabaseconnectors/<externalDatabaseConnectorId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "connectionCredentials": { + "username": "testUser", + "password": "greatPassword2", + "role": "SYSDBA" + } + } + /externaldatabaseconnectors/{externalDatabaseConnectorId}/actions/checkConnectionStatus: + post: + description: | + Check the status of the external database connection specified in this connector. + This operation will refresh the connectionStatus and timeConnectionStatusLastUpdated fields. + operationId: CheckExternalDatabaseConnectorConnectionStatus + parameters: + - $ref: '#/components/parameters/ExternalDatabaseConnectorIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + description: The request was successfully received and the status of the external database connection is being checked. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Check the status of the external database connection specified in this connector. + tags: + - database + x-example: | + POST /20160918/externaldatabaseconnectors/<externalDatabaseConnectorId>/actions/checkConnectionStatus + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExternalDatabaseConnector' + /externalnoncontainerdatabases: + get: + description: | + Gets a list of the ExternalNonContainerDatabases in the specified compartment. + operationId: ListExternalNonContainerDatabases + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/ListExternalNonContainerDatabasesSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListExternalNonContainerDatabasesFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + responses: + '200': + description: The list of external non-container databases in the specified compartment. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListExternalNonContainerDatabasesResponse' + application-json: + examples: + response: + value: | + [ + { + "compartmentId" : "ocid1.[tenancy|compartment].oc1.<unique_ID>", + "displayName" : "myExternalNonCdb0", + "id": "ocid1.externalnoncontainerdatabase.oc1.", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails": null, + "dbId": "3315642749", + "dbVersion": "19c", + "dbUniqueName" : "myGoodDb_phx1cs", + "dbEdition" : "ENTERPRISE_EDITION", + "characterSet" : "AL32UTF8", + "ncharacterSet" : "AL16UTF16", + "timeCreated" : "2016-11-23T02:49:07.032Z" + }, + { + "compartmentId" : "ocid1.[tenancy|compartment].oc1.<unique_ID>", + "displayName" : "myExternalNonCdb", + "id": "ocid1.externalnoncontainerdatabase.oc1.", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails": null, + "dbId": "3315642767", + "dbVersion": "19c", + "dbUniqueName" : "myTestDb_phx1cs", + "dbEdition" : "ENTERPRISE_EDITION", + "characterSet" : "AL32UTF8", + "ncharacterSet" : "AL16UTF16", + "timeCreated" : "2016-11-23T02:49:07.032Z" + } + ] + '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/DefaultError' + summary: List the ExternalNonContainerDatabases in the compartment. + tags: + - database + x-example: | + Example: + GET /20160918/externalnoncontainerdatabases?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExternalNonContainerDatabase' + post: + description: | + Creates a new ExternalNonContainerDatabase resource + operationId: CreateExternalNonContainerDatabase + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateExternalNonContainerDatabaseDetails' + description: Request to create a new external non-container database. + required: true + responses: + '200': + description: The request was successfully received and the database create is in-progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalNonContainerDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.tenancy.oc1..unique_ID", + "dbHomeId" : "ocid1.dbhome.oc1.phx.unique_ID", + "displayName" : "myExternalNonCdb", + "dbUniqueName" : "myTestDb_phx1cs", + "characterSet" : "AL32UTF8", + "ncharacterSet" : "AL16UTF16", + "id" : "ocid1.database.oc1.phx.unique_ID", + "lifecycleState" : "NOT_CONNECTED", + "timeCreated" : "2016-11-23T01:59:07.032Z" + } + '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/DefaultError' + summary: CreateExternalNonContainerDatabase + tags: + - database + x-example: | + Example: + POST /20160918/externalnoncontainerdatabases + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.[tenancy|compartment].oc1.<unique_ID>", + "displayName": "myExternalNonCdb" + } + /externalnoncontainerdatabases/{externalNonContainerDatabaseId}: + delete: + description: | + Deletes the Oracle Cloud Infrastructure resource representing an external non-container database. + operationId: DeleteExternalNonContainerDatabase + parameters: + - $ref: '#/components/parameters/ExternalNonContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '204': + description: | + The request to delete the + [ExternalNonContainerDatabase](#/en/database/latest/datatypes/CreateExternalNonContainerDatabaseDetails) + resource was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Delete the ExternalNonContainerDatabase + tags: + - database + x-example: | + DELETE /20160918/externalnoncontainerdatabases/<externalNonConatinerDatabaseId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExternalNonContainerDatabase' + get: + description: Gets information about a specific external non-container database. + operationId: GetExternalNonContainerDatabase + parameters: + - $ref: '#/components/parameters/ExternalNonContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The external non-container database. + 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/ExternalNonContainerDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.[tenancy|compartment].oc1.<unique_ID>", + "displayName" : "myExternalNonCdb", + "id": "ocid1.externalnoncontainerdatabase.oc1.", + "externalContainerDatabaseId": "ocid1.externalcontainerdatabase.oc1.", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails": null, + "dbId": "3315642767", + "dbVersion": "19c", + "dbUniqueName" : "myTestDb_phx1cs", + "dbEdition" : "ENTERPRISE_EDITION", + "characterSet" : "AL32UTF8", + "ncharacterSet" : "AL16UTF16", + "timeCreated" : "2016-11-23T02:49:07.032Z" + } + '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/DefaultError' + summary: GetExternalNonContainerDatabase + tags: + - database + x-example: | + GET /20160918/externalnoncontainerdatabases/<externalNonContainerDatabaseId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: Updates the properties of an external non-container database, such as the display name. + operationId: UpdateExternalNonContainerDatabase + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ExternalNonContainerDatabaseIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateExternalNonContainerDatabaseDetails' + description: Request to update the properties of an external non-container database. + required: true + responses: + '200': + description: | + The request was successfully received and the + [ExternalNonContainerDatabase](#/en/database/latest/datatypes/CreateExternalNonContainerDatabaseDetails) update + is in-progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalNonContainerDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.[tenancy|compartment].oc1.<unique_ID>", + "displayName" : "myOPNonCdb", + "id": "ocid1.externalnoncontainerdatabase.oc1.", + "externalContainerDatabaseId": "ocid1.externalcontainerdatabase.oc1.", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails": null, + "dbId": "3315642767", + "dbVersion": "19c", + "dbUniqueName" : "myTestDb_phx1cs", + "dbEdition" : "ENTERPRISE_EDITION", + "characterSet" : "AL32UTF8", + "ncharacterSet" : "AL16UTF16", + "timeCreated" : "2016-11-23T02:49:07.032Z" + } + '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/DefaultError' + summary: UpdateExternalNonContainerDatabase + tags: + - database + x-example: | + Example: + PUT /20160918/externalnoncontainerdatabases/<externalNonContainerDatabaseId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName": "myOPNonCdb" + } + /externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/changeCompartment: + post: + description: | + Move the external non-container database and its dependent resources to the specified compartment. + For more information about moving external non-container databases, see + [Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes). + operationId: ChangeExternalNonContainerDatabaseCompartment + parameters: + - $ref: '#/components/parameters/ExternalNonContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeCompartmentDetails' + description: Request to move the external non-container database to a different compartment. + required: true + responses: + '202': + description: The request was successfully received and the change compartment action is being performed. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: ChangeExternalNonContainerDatabaseCompartment + tags: + - database + x-example: | + POST /20160918/externalnoncontainerdatabases/<externalNonConatinerDatabaseId>/actions/changeCompartment + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid.compartment.oc1..<unique_ID>" + } + x-related-resource: '#/definitions/ExternalNonContainerDatabase' + /externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/disableDatabaseManagement: + post: + description: | + Disable Database Management Service for the external non-container database. + For more information about the Database Management Service, see + [Database Management Service](/Content/ExternalDatabase/Concepts/databasemanagementservice.htm). + operationId: DisableExternalNonContainerDatabaseDatabaseManagement + parameters: + - $ref: '#/components/parameters/ExternalNonContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + description: The request was successfully received and Database Management Service is being disabled. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Disable Database Management Service for the external container database. + tags: + - database + x-example: | + POST /20160918/externalnoncontainerdatabases/<externalNonContainerDatabaseId>/actions + /disableDatabaseManagement + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExternalNonContainerDatabase' + /externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/disableOperationsInsights: + post: + description: | + Disable Operations Insights for the external non-container database. + operationId: DisableExternalNonContainerDatabaseOperationsInsights + parameters: + - $ref: '#/components/parameters/ExternalNonContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + description: The request was successfully received and this External Non-container Database will disable Operations Insights. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Disable Operations Insights Service for the external non-container database. + tags: + - database + x-example: | + POST /20160918/externalnoncontainerdatabases/<externalNonContainerDatabaseId>/actions + /disableOperationsInsights + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExternalNonContainerDatabase' + /externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/disableStackMonitoring: + post: + description: | + Disable Stack Monitoring for the external non-container database. + operationId: DisableExternalNonContainerDatabaseStackMonitoring + parameters: + - $ref: '#/components/parameters/ExternalNonContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + description: The request was successfully received and this External Non-container Database will disable Stack Monitoring. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Disable Stack Monitoring Service for the external non-container database. + tags: + - database + x-example: | + POST /20160918/externalnoncontainerdatabases/<externalNonContainerDatabaseId>/actions + /disableStackMonitoring + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/ExternalNonContainerDatabase' + /externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/enableDatabaseManagement: + post: + description: | + Enable Database Management Service for the external non-container database. + For more information about the Database Management Service, see + [Database Management Service](/Content/ExternalDatabase/Concepts/databasemanagementservice.htm). + operationId: EnableExternalNonContainerDatabaseDatabaseManagement + parameters: + - $ref: '#/components/parameters/ExternalNonContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnableExternalNonContainerDatabaseDatabaseManagementDetails' + description: Request to enable the Database Management Service for an external non-container database. + required: true + responses: + '202': + description: The request was successfully received and Database Management Service is being enabled. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Enable Database Management Service for the external container database. + tags: + - database + x-example: | + POST /20160918/externalnoncontainerdatabases/<externalNonContainerDatabaseId>/actions + /enableDatabaseManagement + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "externalDatabaseConnectorId": "ocid1.externaldatabaseconnector..unique_ID", + "licenseModel": "BRING_YOUR_OWN_LICENSE" + } + x-related-resource: '#/definitions/ExternalNonContainerDatabase' + /externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/enableOperationsInsights: + post: + description: | + Enable Operations Insights for the external non-container database. + operationId: EnableExternalNonContainerDatabaseOperationsInsights + parameters: + - $ref: '#/components/parameters/ExternalNonContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnableExternalNonContainerDatabaseOperationsInsightsDetails' + description: | + Details to enable Operations Insights on the external non-container database + required: true + responses: + '202': + description: The request was successfully received and this External Non-container Database will enable Operations Insights. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Enable Operations Insights Service for the external non-container database. + tags: + - database + x-example: | + POST /20160918/externalnoncontainerdatabases/<externalNonContainerDatabaseId>/actions + /enableOperationsInsights + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "externalDatabaseConnectorId": "ocid1.externaldatabaseconnector..unique_ID" + } + x-related-resource: '#/definitions/ExternalNonContainerDatabase' + /externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/enableStackMonitoring: + post: + description: | + Enable Stack Monitoring for the external non-container database. + operationId: EnableExternalNonContainerDatabaseStackMonitoring + parameters: + - $ref: '#/components/parameters/ExternalNonContainerDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnableExternalNonContainerDatabaseStackMonitoringDetails' + description: | + Details to enable Stack Monitoring on the external non-container database. + required: true + responses: + '202': + description: The request was successfully received and this External Non-container Database will enable Stack Monitoring. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Enable Stack Monitoring Service for the external non-container database. + tags: + - database + x-example: | + POST /20160918/externalnoncontainerdatabases/<externalNonContainerDatabaseId>/actions + /enableStackMonitoring + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "externalDatabaseConnectorId": "ocid1.externaldatabaseconnector..unique_ID" + } + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/ExternalNonContainerDatabase' + /externalpluggabledatabases: + get: + description: | + Gets a list of the [ExternalPluggableDatabase](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) + resources in the specified compartment. + operationId: ListExternalPluggableDatabases + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ExternalContainerDatabaseIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/ListExternalPluggableDatabasesSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListExternalPluggableDatabasesFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + responses: + '200': + description: | + The list of [ExternalPluggableDatabase](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) + resources in the specified compartment. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListExternalPluggableDatabasesResponse' + application-json: + examples: + response: + value: | + [ + { + "compartmentId" : "ocid1.[tenancy|compartment].oc1.<unique_ID>", + "displayName" : "myTestExternalPdb0", + "id": "ocid1.externalpluggabledatabase.oc1.", + "externalContainerDatabaseId": "ocid1.externalcontainerdatabase.oc1.", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails": null, + "dbId": "3315642749", + "dbVersion": "19c", + "dbUniqueName" : "myGoodDb_phx1cs", + "dbEdition" : "ENTERPRISE_EDITION", + "characterSet" : "AL32UTF8", + "ncharacterSet" : "AL16UTF16", + "timeCreated" : "2016-11-23T02:49:07.032Z" + }, + { + "compartmentId" : "ocid1.[tenancy|compartment].oc1.<unique_ID>", + "displayName" : "myTestExternalPdb", + "id": "ocid1.externalpluggabledatabase.oc1.", + "externalContainerDatabaseId": "ocid1.externalcontainerdatabase.oc1.", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails": null, + "dbId": "3315642767", + "dbVersion": "19c", + "dbUniqueName" : "myTestDb_phx1cs", + "dbEdition" : "ENTERPRISE_EDITION", + "characterSet" : "AL32UTF8", + "ncharacterSet" : "AL16UTF16", + "timeCreated" : "2016-11-23T02:49:07.032Z" + } + ] + '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/DefaultError' + summary: List ExternalPluggableDatabases in the specified compartment. + tags: + - database + x-example: | + Example: + GET /20160918/externalpluggabledatabases?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExternalPluggableDatabase' + post: + description: | + Registers a new [ExternalPluggableDatabase](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) + resource. + operationId: CreateExternalPluggableDatabase + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateExternalPluggableDatabaseDetails' + description: Request to create a new external pluggable database. + required: true + responses: + '200': + description: | + The request was successfully received and the ExternalPluggableDatabase create operation is in-progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalPluggableDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.[tenancy|compartment].oc1.<unique_ID>", + "displayName" : "myTestExternalPdb", + "id": "ocid1.externalpluggabledatabase.oc1.", + "externalContainerDatabaseId": "ocid1.externalcontainerdatabase.oc1.", + "lifecycleState" : "NOT_CONNECTED", + "lifecycleDetails": null, + "dbId": "3315642767", + "dbVersion": "19c", + "dbUniqueName" : "myTestDb_phx1cs", + "dbEdition" : "ENTERPRISE_EDITION", + "characterSet" : "AL32UTF8", + "ncharacterSet" : "AL16UTF16", + "timeCreated" : "2016-11-23T02:59:07.032Z" + } + '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/DefaultError' + summary: Creates an ExternalPluggableDatabase + tags: + - database + x-example: | + POST /20160918/externalpluggabledatabases + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.[tenancy|compartment].oc1.<unique_ID>", + "displayName": "myTestExternalCdb", + "externalContainerDatabaseId": "ocid1.externalcontainerdatabase.oc1." + } + /externalpluggabledatabases/{externalPluggableDatabaseId}: + delete: + description: | + Deletes the [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails). + resource. + operationId: DeleteExternalPluggableDatabase + parameters: + - $ref: '#/components/parameters/ExternalPluggableDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: | + The request to delete the + [ExternalPluggableDatabase](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource + was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Deletes an ExternalPluggableDatabase + tags: + - database + x-example: | + DELETE /20160918/externalpluggabledatabases/<externalPluggableDatabaseId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExternalPluggableDatabase' + get: + description: | + Gets information about a specific + [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource. + operationId: GetExternalPluggableDatabase + parameters: + - $ref: '#/components/parameters/ExternalPluggableDatabaseIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: | + The [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails). + resource. + 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/ExternalPluggableDatabase' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.[tenancy|compartment].oc1.<unique_ID>", + "displayName" : "myTestExternalPdb", + "id": "ocid1.externalpluggabledatabase.oc1.", + "externalContainerDatabaseId": "ocid1.externalcontainerdatabase.oc1.", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails": null, + "dbId": "3315642767", + "dbVersion": "19c", + "dbUniqueName" : "myTestDb_phx1cs", + "dbEdition" : "ENTERPRISE_EDITION", + "characterSet" : "AL32UTF8", + "ncharacterSet" : "AL16UTF16", + "timeCreated" : "2016-11-23T02:59:07.032Z" + } + '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/DefaultError' + summary: GetExternalPluggableDatabase + tags: + - database + x-example: | + GET /20160918/externalpluggabledatabases/<externalPluggableDatabaseId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the properties of an + [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource, + such as the display name. + operationId: UpdateExternalPluggableDatabase + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ExternalPluggableDatabaseIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateExternalPluggableDatabaseDetails' + description: Request to update the properties of an external pluggable database resource. + required: true + responses: + '200': + description: | + The request was successfully received and the + [ExternalPluggableDatabase](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) update + is in-progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalPluggableDatabase' + application-json: + examples: + response: + value: | + Response to example: + { + "compartmentId" : "ocid1.[tenancy|compartment].oc1.<unique_ID>", + "displayName" : "myExternalPdb", + "id": "ocid1.externalpluggabledatabase.oc1.", + "externalContainerDatabaseId": "ocid1.externalcontainerdatabase.oc1.", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails": null, + "dbId": "3315642767", + "dbVersion": "19c", + "dbUniqueName" : "myTestDb_phx1cs", + "dbEdition" : "ENTERPRISE_EDITION", + "characterSet" : "AL32UTF8", + "ncharacterSet" : "AL16UTF16", + "timeCreated" : "2016-11-23T02:59:07.032Z" + } + '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/DefaultError' + summary: UpdateExternalPluggableDatabase + tags: + - database + x-example: | + Example: + PUT /20160918/externalpluggabledatabases/<externalPluggableDatabaseId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName": "myExternalPdb" + } + /externalpluggabledatabases/{externalPluggableDatabaseId}/actions/changeCompartment: + post: + description: | + Move the [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) and + its dependent resources to the specified compartment. + For more information about moving external pluggable databases, see + [Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes). + operationId: ChangeExternalPluggableDatabaseCompartment + parameters: + - $ref: '#/components/parameters/ExternalPluggableDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeCompartmentDetails' + description: | + Request to move the + [ExternalPluggableDatabase](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource + to a different compartment. + required: true + responses: + '202': + description: The request was successfully received and the change compartment action is being performed. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: ChangeExternalPluggableDatabaseCompartment + tags: + - database + x-example: | + POST /20160918/externalpluggabledatabases/<externalPluggableDatabaseId>/actions/changeCompartment + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid.compartment.oc1..<unique_ID>" + } + x-related-resource: '#/definitions/ExternalPluggableDatabase' + /externalpluggabledatabases/{externalPluggableDatabaseId}/actions/disableDatabaseManagement: + post: + description: | + Disable Database Management Service for the external pluggable database. + For more information about the Database Management Service, see + [Database Management Service](/Content/ExternalDatabase/Concepts/databasemanagementservice.htm). + operationId: DisableExternalPluggableDatabaseDatabaseManagement + parameters: + - $ref: '#/components/parameters/ExternalPluggableDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + description: The request was successfully received and Database Management Service is being disabled. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Disable Database Management Service for the external pluggable database. + tags: + - database + x-example: | + POST /20160918/externalpluggabledatabases/<externalPluggableDatabaseId>/actions + /disableDatabaseManagement + Host: database.us-phoenix-1.oraclecloud.com + x-related-resource: '#/definitions/ExternalPluggableDatabase' + /externalpluggabledatabases/{externalPluggableDatabaseId}/actions/disableOperationsInsights: + post: + description: | + Disable Operations Insights for the external pluggable database. + operationId: DisableExternalPluggableDatabaseOperationsInsights + parameters: + - $ref: '#/components/parameters/ExternalPluggableDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + description: The request was successfully received and this External Pluggable Database will disable Operations Insights. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Disable Operations Insights Service for the external pluggable database. + tags: + - database + x-example: | + POST /20160918/externalpluggabledatabases/<externalPluggableDatabaseId>/actions + /disableOperationsInsights + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ExternalPluggableDatabase' + /externalpluggabledatabases/{externalPluggableDatabaseId}/actions/disableStackMonitoring: + post: + description: | + Disable Stack Monitoring for the external pluggable database. + operationId: DisableExternalPluggableDatabaseStackMonitoring + parameters: + - $ref: '#/components/parameters/ExternalPluggableDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + description: The request was successfully received and this External Pluggable Database will disable Stack Monitoring. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Disable Stack Monitoring Service for the external pluggable database. + tags: + - database + x-example: | + POST /20160918/externalpluggabledatabases/<externalPluggableDatabaseId>/actions + /disableStackMonitoring + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/ExternalPluggableDatabase' + /externalpluggabledatabases/{externalPluggableDatabaseId}/actions/enableDatabaseManagement: + post: + description: | + Enable Database Management Service for the external pluggable database. + For more information about the Database Management Service, see + [Database Management Service](/Content/ExternalDatabase/Concepts/databasemanagementservice.htm). + operationId: EnableExternalPluggableDatabaseDatabaseManagement + parameters: + - $ref: '#/components/parameters/ExternalPluggableDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnableExternalPluggableDatabaseDatabaseManagementDetails' + description: Request to enable the Database Management Service for an external database. + required: true + responses: + '202': + description: The request was successfully received and Database Management Service is being enabled. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Enable Database Management Service for the external pluggable database. + tags: + - database + x-example: | + POST /20160918/externalpluggabledatabases/<externalPluggableDatabaseId>/actions + /enableDatabaseManagement + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "externalDatabaseConnectorId": "ocid1.externaldatabaseconnector..unique_ID" + } + x-related-resource: '#/definitions/ExternalPluggableDatabase' + /externalpluggabledatabases/{externalPluggableDatabaseId}/actions/enableOperationsInsights: + post: + description: | + Enable Operations Insights for the external pluggable database. + operationId: EnableExternalPluggableDatabaseOperationsInsights + parameters: + - $ref: '#/components/parameters/ExternalPluggableDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnableExternalPluggableDatabaseOperationsInsightsDetails' + description: | + Details to enable Operations Insights on the external pluggable database + required: true + responses: + '202': + description: The request was successfully received and this External Pluggable Database will enable Operations Insights. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Enable Operations Insights Service for the external pluggable database. + tags: + - database + x-example: | + POST /20160918/externalpluggabledatabases/<externalPluggableDatabaseId>/actions + /enableOperationsInsights + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "externalDatabaseConnectorId": "ocid1.externaldatabaseconnector..unique_ID" + } + x-related-resource: '#/definitions/ExternalPluggableDatabase' + /externalpluggabledatabases/{externalPluggableDatabaseId}/actions/enableStackMonitoring: + post: + description: | + Enable Stack Monitoring for the external pluggable database. + operationId: EnableExternalPluggableDatabaseStackMonitoring + parameters: + - $ref: '#/components/parameters/ExternalPluggableDatabaseIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnableExternalPluggableDatabaseStackMonitoringDetails' + description: | + Details to enable Stack Monitoring on the external pluggable database. + required: true + responses: + '202': + description: The request was successfully received and this External Pluggable Database will enable Stack Monitoring. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Enable Stack Monitoring Service for the external pluggable database. + tags: + - database + x-example: | + POST /20160918/externalpluggabledatabases/<externalPluggableDatabaseId>/actions + /enableStackMonitoring + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "externalDatabaseConnectorId": "ocid1.externaldatabaseconnector..unique_ID" + } + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/ExternalPluggableDatabase' + /giVersions: + get: + description: Gets a list of supported GI versions. + operationId: ListGiVersions + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/OptionalShapeQueryParam' + - $ref: '#/components/parameters/ExadbxsAvailabilityDomainParam' + - $ref: '#/components/parameters/ShapeAttributeQueryParam' + responses: + '200': + description: The list of supported Grid Infrastructure versions. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListGiVersionsResponse' + application-json: + examples: + response: + value: | + { + "version" : "18.1.0.4" + }, { + "version" : "19.1.0.2" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListGiVersions + tags: + - database + x-example: | + GET /20160918/giVersions?compartmentId=<compartmentId>&limit=100 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-authz-declarations: + authorizationRequired: false + /giVersions/{version}/minorVersions: + get: + description: Gets a list of supported Oracle Grid Infrastructure minor versions for the given major version and shape family. + operationId: ListGiVersionMinorVersions + parameters: + - $ref: '#/components/parameters/GiMajorVersionPathParam' + - $ref: '#/components/parameters/ExadbxsAvailabilityDomainParam' + - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/OptionalShapeFamilyQueryParam' + - $ref: '#/components/parameters/IsGiVersionForProvisioningQueryParam' + - $ref: '#/components/parameters/OptionalShapeQueryParam' + - $ref: '#/components/parameters/ListGiMinorVersionsSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + responses: + '200': + description: Gets a list of supported Oracle Grid Infrastructure minor versions for the given major version and shape family. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListGiVersionMinorVersionsResponse' + application-json: + examples: + response: + value: | + { + "version" : "19.19.0.0.0" + }, { + "version" : "19.18.0.0.0" + }, { + "version" : "19.17.0.0.0" + }, { + "version" : "19.16.0.0.0" + } + '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/DefaultError' + summary: ListGiMinorVersions + tags: + - database + x-example: | + GET /20160918/giVersions/<version>/minorVersions?shapeFamily=EXADATA + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/GiMinorVersionSummary' + /keyStores: + get: + description: | + Gets a list of key stores in the specified compartment. + operationId: ListKeyStores + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: | + List of key stores. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListKeyStoresResponse' + application-json: + examples: + response: + value: | + [{ + "id":"ocid1.dbkeystore.oc1.", + "displayName":"Key Store1", + "compartmentId":"ocid1.tenancy.oc1.", + "typeDetails": { + "type":"ORACLE_KEY_VAULT", + "connectionIps":[ + "198.12.34.56", + "198.12.34.57" + ], + "adminUsername":"username1", + "vaultId":"ocid1.vault.oc1.", + "secretId":"ocid1.key.oc1." + }, + "lifecycleState":"ACTIVE", + "timeCreated" : "2020-07-22T19:25:42.755Z", + "lifecycleDetails": null, + "associatedDatabases":[] + }] + '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/DefaultError' + summary: ListKeyStores + tags: + - database + x-example: | + GET /20160918/keyStores?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/KeyStoreSummary' + post: + description: | + Creates a Key Store. + operationId: CreateKeyStore + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateKeyStoreDetails' + description: | + Request to create a new key store. + required: true + responses: + '200': + description: | + The request was successfully received and the key store is created. + 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/KeyStore' + application-json: + examples: + response: + value: | + { + "id":"ocid1.dbkeystore.oc1.", + "displayName":"Key Store1", + "compartmentId":"ocid1.tenancy.oc1.", + "typeDetails": { + "type":"ORACLE_KEY_VAULT", + "connectionIps":[ + "198.12.34.56", + "198.12.34.57" + ], + "adminUsername":"username1", + "vaultId":"ocid1.vault.oc1.", + "secretId":"ocid1.key.oc1." + }, + "lifecycleState":"ACTIVE", + "timeCreated" : "2020-07-22T19:25:42.755Z", + "lifecycleDetails": null, + "associatedDatabases":[] + } + '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/DefaultError' + summary: CreateKeyStore + tags: + - database + x-example: | + POST /20160918/keyStores + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName":"Key Store1", + "compartmentId":"ocid1.tenancy.oc1.<unique_ID>", + "typeDetails": { + "type":"ORACLE_KEY_VAULT", + "connectionIps":[ + "198.12.34.56", + "198.12.34.57" + ], + "adminUsername":"username1", + "vaultId":"ocid1.vault.oc1.<unique_ID>", + "secretId":"ocid1.key.oc1.<unique_ID>" + } + } + /keyStores/{keyStoreId}: + delete: + description: | + Deletes a key store. + operationId: DeleteKeyStore + parameters: + - $ref: '#/components/parameters/KeyStoreIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '204': + description: | + The key store has been 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 + '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/DefaultError' + summary: DeleteKeyStore + tags: + - database + x-example: | + DELETE /20160918/keyStores/<keyStoreId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/KeyStore' + get: + description: | + Gets information about the specified key store. + operationId: GetKeyStore + parameters: + - $ref: '#/components/parameters/KeyStoreIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: | + The key store. + 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/KeyStore' + application-json: + examples: + response: + value: | + { + "id":"ocid1.dbkeystore.oc1.", + "displayName":"Key Store1", + "compartmentId":"ocid1.tenancy.oc1.", + "typeDetails": { + "type":"ORACLE_KEY_VAULT", + "connectionIps":[ + "198.12.34.56", + "198.12.34.57" + ], + "adminUsername":"username1", + "vaultId":"ocid1.vault.oc1.", + "secretId":"ocid1.key.oc1." + }, + "lifecycleState":"ACTIVE", + "timeCreated" : "2020-07-22T19:25:42.755Z", + "lifecycleDetails": null, + "associatedDatabases":[] + } + '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/DefaultError' + summary: GetKeyStore + tags: + - database + x-example: | + GET /20160918/keyStores/<keyStoreId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Edit the key store. + operationId: UpdateKeyStore + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/KeyStoreIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateKeyStoreDetails' + description: | + Request to update the attributes of a key store. + required: true + responses: + '200': + description: | + The update was successful. + 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/KeyStore' + '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/DefaultError' + summary: Updates the specified key store. + tags: + - database + /keyStores/{keyStoreId}/actions/changeCompartment: + post: + description: | + Move the key store resource to the specified compartment. + For more information about moving key stores, see + [Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes). + operationId: ChangeKeyStoreCompartment + parameters: + - $ref: '#/components/parameters/KeyStoreIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeKeyStoreCompartmentDetails' + description: | + Request to move key store to a different compartment + required: true + responses: + '202': + description: | + The request was successfully received and the change compartment action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: ChangeKeyStoreCompartment + tags: + - database + x-example: | + POST /20160918/keyStores/<keyStoreId>/actions/changeKeyStoreCompartment + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid.compartment.oc1..<unique_ID>" + } + x-related-resource: '#/definitions/KeyStore' + /maintenanceRunHistory: + get: + description: | + Gets a list of the maintenance run histories in the specified compartment. + operationId: ListMaintenanceRunHistory + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/optionalTargetResourceIdQueryParam' + - $ref: '#/components/parameters/optionalTargetResourceTypeQueryParam' + - $ref: '#/components/parameters/optionalMaintenanceTypeQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/listMaintenanceRunsSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/listMaintenanceRunHistoryFilterByStateQueryParam' + - $ref: '#/components/parameters/FilterByAvailabilityDomainQueryParam' + - $ref: '#/components/parameters/OptionalMaintenanceSubtypeQueryParam' + responses: + '200': + description: The list of maintenance run histories. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListMaintenanceRunHistoryResponse' + application-json: + examples: + response: + value: | + [{ + "id" : "ocid1.maintenancerunhistory.oc1.phx." + }, { + "id" : "ocid1.maintenancerunhistory.oc1.phx." + }] + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: List maintenance run histories. + tags: + - database + x-example: | + GET /20160918/maintenanceRunHistory?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/MaintenanceRunHistory' + /maintenanceRunHistory/{maintenanceRunHistoryId}: + get: + description: Gets information about the specified maintenance run history. + operationId: GetMaintenanceRunHistory + parameters: + - $ref: '#/components/parameters/maintenanceRunHistoryIdPathParam' + responses: + '200': + description: Information about the specified maintenance run history. + 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/MaintenanceRunHistory' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.maintenancerunhistory.oc1.phx." + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Gets maintenance run history. + tags: + - database + x-example: | + GET /20160918/maintenanceRunHistory/<maintenanceRunHistoryId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /maintenanceRuns: + get: + description: | + Gets a list of the maintenance runs in the specified compartment. + operationId: ListMaintenanceRuns + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/optionalTargetResourceIdQueryParam' + - $ref: '#/components/parameters/optionalTargetResourceTypeQueryParam' + - $ref: '#/components/parameters/optionalMaintenanceTypeQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/listMaintenanceRunsFilterByLocalAdgQueryParam' + - $ref: '#/components/parameters/listMaintenanceRunsSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/listMaintenanceRunsFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByAvailabilityDomainQueryParam' + - $ref: '#/components/parameters/OptionalMaintenanceSubtypeQueryParam' + responses: + '200': + description: The list of maintenance runs. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListMaintenanceRunsResponse' + application-json: + examples: + response: + value: | + [{ + "id" : "ocid1.maintenancerun.oc1.phx.", + "compartmentId" : "ocid1.tenancy.oc1..", + "lifecycleState" : "SCHEDULED", + "timeScheduled" : "2018-04-22T19:00:00.000Z" + }, { + "id" : "ocid1.maintenancerun.oc1.phx.", + "compartmentId" : "ocid1.tenancy.oc1..", + "lifecycleState" : "SUCCEEDED", + "timeScheduled" : "2018-01-22T19:00:00.000Z" + }] + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListMaintenanceRuns + tags: + - database + x-example: | + GET /20160918/maintenanceRuns?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/MaintenanceRun' + post: + description: | + Creates a maintenance run with one of the following: + 1. The latest available release update patch (RUP) for the Autonomous Container Database. + 2. The latest available RUP and DST time-zone (TZ) file updates for the Autonomous Container Database. + 3. The DST TZ file updates for the Autonomous Container Database. + operationId: CreateMaintenanceRun + parameters: + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateMaintenanceRunDetails' + description: Request to create a Maintenance Run for the resource. + required: true + responses: + '200': + description: The request was successfully received and the Maintenance Run for the requested resource is created. + 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/MaintenanceRun' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.maintenancerun.oc1.phx.", + "compartmentId" : "ocid1.tenancy.oc1..", + "lifecycleState" : "IN_PROGRESS", + "timeScheduled" : "2018-04-22T19:00:00.000Z" + } + '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/DefaultError' + summary: CreateMaintenanceRun + tags: + - database + /maintenanceRuns/{maintenanceRunId}: + get: + description: Gets information about the specified maintenance run. + operationId: GetMaintenanceRun + parameters: + - $ref: '#/components/parameters/maintenanceRunIdPathParam' + responses: + '200': + description: Information about the specified maintenance run. + 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/MaintenanceRun' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.maintenancerun.oc1.phx.", + "compartmentId" : "ocid1.tenancy.oc1..", + "lifecycleState" : "IN_PROGRESS", + "timeScheduled" : "2018-04-22T19:00:00.000Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetMaintenanceRun + tags: + - database + x-example: | + GET /20160918/maintenanceRuns/<maintenanceRunId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: Updates the properties of a maintenance run, such as the state of a maintenance run. + operationId: UpdateMaintenanceRun + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/maintenanceRunIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMaintenanceRunDetails' + description: Request to update the properties of a maintenance run. + required: true + responses: + '200': + description: The request was successfully received and the maintenance run is updated. + 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/MaintenanceRun' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.maintenancerun.oc1.phx.", + "compartmentId" : "ocid1.tenancy.oc1..", + "lifecycleState" : "SKIPPED", + "timeScheduled" : "2018-04-22T19:00:00.000Z" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateMaintenanceRun + tags: + - database + x-example: | + PUT /latest/maintenanceRuns/<maintenanceRunId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "isEnabled" : false + } + /oneoffPatches: + get: + description: | + Lists one-off patches in the specified compartment. + operationId: ListOneoffPatches + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/ListOneoffPatchesSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListOneoffPatchesFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: All the one-off patches requested. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListOneoffPatchesResponse' + application-json: + examples: + response: + value: | + [ + { + "id" : "ocid1.dboneoffpatch.oc1.phx.", + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "19.15_RU", + "dbVersion" : "19.0.0.0", + "releaseUpdate" : "19.15.0.0", + "lifecycleState" : "AVAILABLE", + "timeCreated" : "2022-09-26T19:25:42.755Z", + "freeformTags" : {"Department": "Finance"} + } + ] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Lists one-off patches in the specified compartment. + tags: + - database + x-example: | + Example I: + GET /20160918/oneoffPatches?<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/OneoffPatch' + post: + description: | + Creates one-off patch for specified database version to download. + operationId: CreateOneoffPatch + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateOneoffPatchDetails' + description: | + Request to create a one-off patch to download. + required: true + responses: + '200': + description: The request was successfully received and one-off patch creation is initiated. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/OneoffPatch' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.dboneoffpatch.oc1.phx.", + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "19.15_RU", + "dbVersion" : "19.0.0.0", + "releaseUpdate" : "19.15.0.0", + "lifecycleState" : "CREATING", + "timeCreated" : "2022-09-26T19:25:42.755Z", + "freeformTags" : {"Department": "Finance"} + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Create one-off patch + tags: + - database + x-example: | + Example I: + POST /20160918/oneoffPatches + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.tenancy.oc1..<unique_ID>", + "dbVersion" : "19.0.0.0", + "displayName" : "19.15_RU", + "releaseUpdate" : "19.15.0.0", + "oneOffPatches": "123456" + } + x-related-resource: '#/definitions/OneoffPatch' + /oneoffPatches/{oneoffPatchId}: + delete: + description: | + Deletes a one-off patch. + operationId: DeleteOneoffPatch + parameters: + - $ref: '#/components/parameters/OneoffPatchIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The request to delete the one-off patch was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Delete one-off patch + tags: + - database + x-example: | + DELETE /20160918/oneoffPatches/<oneoffPatchId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/OneoffPatch' + get: + description: | + Gets information about the specified one-off patch. + operationId: GetOneoffPatch + parameters: + - $ref: '#/components/parameters/OneoffPatchIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: One-off patch information was retrieved. + 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/OneoffPatch' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.dboneoffpatch.oc1.phx.", + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "19.15_RU", + "dbVersion" : "19.0.0.0", + "releaseUpdate" : "19.15.0.0", + "lifecycleState" : "AVAILABLE", + "timeCreated" : "2022-09-26T19:25:42.755Z", + "freeformTags" : {"Department": "Finance"} + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Get one-off patch + tags: + - database + x-example: | + GET /20160918/oneoffPatches/<oneoffPatchId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the properties of the specified one-off patch. + operationId: UpdateOneoffPatch + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/OneoffPatchIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateOneoffPatchDetails' + description: Request to update the properties of a one-off patch. + required: true + responses: + '200': + description: The request was successfully received and the one-off patch update is in progress. + 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/OneoffPatch' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.dboneoffpatch.oc1.phx.", + "compartmentId" : "ocid1.tenancy.oc1..", + "displayName" : "19.15_RU", + "dbVersion" : "19.0.0.0", + "releaseUpdate" : "19.15.0.0", + "lifecycleState" : "AVAILABLE", + "timeCreated" : "2022-09-26T19:25:42.755Z", + "freeformTags" : {"Department": "Executive"} + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Updates the properties of the specified one-off patch. + tags: + - database + x-example: | + Example I: + PUT /20160918/oneoffPatches/<oneoffPatchId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "freeformTags" : {"Department": "Management"} + } + /oneoffPatches/{oneoffPatchId}/actions/changeCompartment: + post: + description: | + Move the one-off patch to the specified compartment. + operationId: ChangeOneoffPatchCompartment + parameters: + - $ref: '#/components/parameters/OneoffPatchIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeCompartmentDetails' + description: Request to move one-off patch to a different compartment + required: true + responses: + '202': + description: The request was successfully received and the change compartment action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Change one-off patch compartment + tags: + - database + x-example: | + POST /20160918/oneoffPatches/<oneoffPatchId>/actions/changeCompartment + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid.compartment.oc1..<unique_ID>" + } + x-obmcs-terraform: + actionType: UPDATE_FIELD + x-related-resource: '#/definitions/OneoffPatch' + /oneoffPatches/{oneoffPatchId}/actions/downloadOneoffPatch: + post: + description: | + Download one-off patch. + operationId: DownloadOneoffPatch + parameters: + - $ref: '#/components/parameters/OneoffPatchIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '200': + description: One-off patch is being retrieved. + 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/DownloadOneoffPatch' + '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/DefaultError' + summary: Download one-off patch. + tags: + - database + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/OneoffPatch' + /pluggableDatabaseSnapshots: + get: + description: | + Gets a list of the Exadata Pluggable Database Snapshots in the specified compartment. + operationId: ListPluggableDatabaseSnapshots + parameters: + - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/ListPluggableDatabaseSnapshotsSortByQueryParam' + - $ref: '#/components/parameters/FilterByNameQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListPluggableDatabaseSnapshotsFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/ListPluggableDatabaseSnapshotsFilterByClusterQueryParam' + - $ref: '#/components/parameters/ListPluggableDatabaseSnapshotsFilterByDatabaseQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: List of the Exadata Pluggable Database Snapshots + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListPluggableDatabaseSnapshotsResponse' + application-json: + examples: + response: + value: | + [ + { + "id" : "ocid1.pluggabledatabasesnapshot.oc1.", + "exadbVmClusterId" : "ocid1.exadbvmcluster.oc1.", + "compartmentId": "ocid1.compartment.oc1.", + "name" : "snapshot-1", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "lifecycleState" : "CREATING", + "lifecycleDetails" : null, + "pluggableDatabaseId": "ocid1.pluggabledatabase.oc1." + } + ] + '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/DefaultError' + summary: ListPluggableDatabaseSnapshots + tags: + - database + x-example: | + GET /20160918/pluggableDatabaseSnapshots?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/PluggableDatabaseSnapshot' + post: + description: | + Creates a Pluggable Database Snapshot + operationId: CreatePluggableDatabaseSnapshot + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePluggableDatabaseSnapshotDetails' + description: | + Request to create a pluggable database snapshot. + required: true + responses: + '201': + description: The request was successfully received and the create pluggable database Snapshot. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PluggableDatabaseSnapshot' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.pluggabledatabasesnapshot.oc1.", + "exadbVmClusterId" : "ocid1.exadbvmcluster.oc1.", + "compartmentId": "ocid1.compartment.oc1.", + "name" : "snapshot-1", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "lifecycleState" : "CREATING", + "lifecycleDetails" : null, + "pluggableDatabaseId": "ocid1.pluggabledatabase.oc1." + } + '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/DefaultError' + summary: CreatePluggableDatabaseSnapshot + tags: + - database + x-example: | + POST /20160918/pluggableDatabaseSnapshots + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "name" : "snapshot-1", + "pluggableDatabaseId": "ocid1.pluggabledatabase.oc1." + } + /pluggableDatabaseSnapshots/{pluggableDatabaseSnapshotId}: + delete: + description: | + Deletes the specified Exadata Pluggable Database Snapshot. + operationId: DeletePluggableDatabaseSnapshot + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/PluggableDatabaseSnapshotIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '204': + description: The request to delete the Exadata Pluggable Database Snapshot was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Deletes the specified Exadata Pluggable Database Snapshot. + tags: + - database + x-related-resource: '#/definitions/PluggableDatabaseSnapshot' + get: + description: | + Gets information about the specified Exadata Pluggable Database Snapshot in the specified compartment. + operationId: GetPluggableDatabaseSnapshot + parameters: + - $ref: '#/components/parameters/PluggableDatabaseSnapshotIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: Information about the Exadata Pluggable Database Snapshot. + 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/PluggableDatabaseSnapshot' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.pluggabledatabasesnapshot.oc1.", + "exadbVmClusterId" : "ocid1.exadbvmcluster.oc1.", + "compartmentId": "ocid1.compartment.oc1.", + "name" : "snapshot-1", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "lifecycleState" : "CREATING", + "lifecycleDetails" : null, + "pluggableDatabaseId": "ocid1.pluggabledatabase.oc1." + } + '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/DefaultError' + summary: GetPluggableDatabaseSnapshot + tags: + - database + x-example: | + GET /20160918/pluggableDatabaseSnapshots/<pluggableDatabaseSnapshotId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /pluggableDatabases: + get: + description: | + Gets a list of the pluggable databases in a database or compartment. You must provide either a `databaseId` or `compartmentId` value. + operationId: ListPluggableDatabases + parameters: + - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' + - $ref: '#/components/parameters/OptionalDatabaseIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/ListPluggableDatabasesSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListPluggableDatabasesFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/ListPluggableDatabasesFilterByPdbNameQueryParam' + responses: + '200': + description: All the pluggable databases in the specified compartment or database (CDB). + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListPluggableDatabasesResponse' + application-json: + examples: + response: + value: | + [ + { + "containerDatabaseId" : "ocid1.database.oc1..aaaaaaaah2sauv373xyfrpcnaed2ptfy67fnspzyda2hacgdbrkijhffugaa", + "pdbName" : "SalesPdb", + "id" : "ocid1.pluggabledatabase.oc1.phx.abuxgljrbgyconplgryuyakyicvbqlveceapi53jhfiqtipmxymythslrmza", + "openMode" : "READ_WRITE", + "isRestricted" : "false", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails": null, + "timeCreated" : "2016-11-22T19:25:42.755Z", + } + ] + '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/DefaultError' + summary: ListPluggableDatabases + tags: + - database + x-example: | + Example I: + GET /20160918/pluggableDatabases?databaseId=<databaseId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + Example II: + GET /20160918/pluggableDatabases?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/PluggableDatabase' + post: + description: | + Creates and starts a pluggable database in the specified container database. + Pluggable Database can be created using different operations (e.g. LocalClone, RemoteClone, Relocate ) with this API. + Use the [StartPluggableDatabase](#/en/database/latest/PluggableDatabase/StartPluggableDatabase) and [StopPluggableDatabase](#/en/database/latest/PluggableDatabase/StopPluggableDatabase) APIs to start and stop the pluggable database. + operationId: CreatePluggableDatabase + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePluggableDatabaseDetails' + description: Request to create pluggable database. + required: true + responses: + '200': + description: The request was successfully received and the create pluggable database operation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PluggableDatabase' + application-json: + examples: + response: + value: | + { + "containerDatabaseId" : "ocid1.database.oc1..aaaaaaaah2sauv373xyfrpcnaed2ptfy67fnspzyda2hacgdbrkijhffugaa", + "pdbName" : "SalesPdb", + "id" : "ocid1.pluggabledatabase.oc1.phx.abuxgljrbgyconplgryuyakyicvbqlveceapi53jhfiqtipmxymythslrmza", + "openMode" : "READ_WRITE", + "isRestricted" : "false", + "lifecycleState" : "PROVISIONING", + "lifecycleDetails": null, + "timeCreated" : "2016-11-22T19:25:42.755Z" + } + '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/DefaultError' + summary: CreatePluggableDatabase + tags: + - database + x-example: | + Example I: + POST /20160918/pluggableDatabases + + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "pdbName" : "SalesPdb", + "tdeWalletPassword" : "<TDE_password>" + "containerDatabaseId" : "ocid1.database.oc1..aaaaaaaah2sauv373xyfrpcnaed2ptfy67fnspzyda2hacgdbrkijhffugaa", + "pdbAdminPassword" : "<password>" + } + + Example II: + POST /20160918/pluggableDatabases + + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "pdbName" : "SalesPdb", + "tdeWalletPassword" : "<TDE_password>", + "containerDatabaseId" : "ocid1.database.oc1.<password>", + "shouldCreatePdbBackup" : "true", + "pdbCreationTypeDetails" : { + "creationType" : "LOCAL_CLONE_PDB", + "sourcePluggableDatabaseId" : "ocid1.pluggabledatabase.oc1." + } + + Example III: + POST /20160918/pluggableDatabases + + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "pdbName" : "SalesPdb", + "tdeWalletPassword" : "<TDE_password>", + "containerDatabaseId" : "ocid1.database.oc1.<password>", + "shouldCreatePdbBackup" : "true", + "pdbCreationTypeDetails" : { + "creationType" : "REMOTE_CLONE_PDB", + "sourcePluggableDatabaseId" : "ocid1.pluggabledatabase.oc1.", + "sourceContainerDatabaseAdminPassword" : "<password>" + } + } + + Example IV: + POST /20160918/pluggableDatabases + + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "pdbName" : "SalesPdb", + "tdeWalletPassword" : "<TDE_password>", + "containerDatabaseId" : "ocid1.database.oc1.<password>", + "shouldCreatePdbBackup" : "true", + "pdbCreationTypeDetails" : { + "creationType" : "RELOCATE_PDB", + "sourcePluggableDatabaseId" : "ocid1.pluggabledatabase.oc1.", + "sourceContainerDatabaseAdminPassword" : "<password>" + } + } + + Example V: + POST /20160918/pluggableDatabases + + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "pdbName": "SalesPdb", + "tdeWalletPassword": "<TDE_password>", + "containerDatabaseId": "ocid1.database.oc1.<password>", + "pdbCreationTypeDetails": { + "creationType": "REMOTE_CLONE_PDB", + "dblinkUsername": "C##DBLINKUSER", + "dblinkUserPassword": "<password>", + "refreshableCloneDetails" : { "isRefreshableClone" : "true" }, + "sourcePluggableDatabaseId": "ocid1.pluggabledatabase.oc1.", + "sourceContainerDatabaseAdminPassword": "<password>" + } + } + Example VI: + POST /20160918/pluggableDatabases + + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "pdbName": "SalesPdb", + "tdeWalletPassword": "<TDE_password>", + "containerDatabaseId": "ocid1.database.oc1.<password>", + "pdbCreationTypeDetails": { + "creationType": "LOCAL_CLONE_PDB", + "sourcePluggableDatabaseId": "ocid1.pluggabledatabase.oc1.", + "sourcePluggableDatabaseSnapshotId": "ocid1.pluggabledatabasesnapshot.oc1.", + "isThinClone": "true" + } + } + Example VI: + POST /20160918/pluggableDatabases + + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "pdbName": "SalesPdb", + "tdeWalletPassword": "<TDE_password>", + "containerDatabaseId": "ocid1.database.oc1.<password>", + "pdbCreationTypeDetails": { + "creationType": "REMOTE_CLONE_PDB", + "dblinkUsername": "C##DBLINKUSER", + "dblinkUserPassword": "<password>", + "sourcePluggableDatabaseId": "ocid1.pluggabledatabase.oc1.", + "sourceContainerDatabaseAdminPassword": "<password>", + "sourcePluggableDatabaseSnapshotId": "ocid1.pluggabledatabasesnapshot.oc1.", + "isThinClone": "true" + } + } + /pluggableDatabases/{pluggableDatabaseId}: + delete: + description: Deletes the specified pluggable database. + operationId: DeletePluggableDatabase + parameters: + - $ref: '#/components/parameters/PluggableDatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '204': + description: The request to delete pluggable database was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: DeletePluggableDatabase + tags: + - database + x-example: | + DELETE /20160918/pluggableDatabases/<pluggableDatabaseId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/PluggableDatabase' + get: + description: Gets information about the specified pluggable database. + operationId: GetPluggableDatabase + parameters: + - $ref: '#/components/parameters/PluggableDatabaseIdPathParam' + responses: + '200': + description: The pluggable database. + 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/PluggableDatabase' + application-json: + examples: + response: + value: | + { + "containerDatabaseId" : "ocid1.database.oc1..aaaaaaaah2sauv373xyfrpcnaed2ptfy67fnspzyda2hacgdbrkijhffugaa", + "pdbName" : "SalesPdb", + "id" : "ocid1.pluggabledatabase.oc1.phx.abuxgljrbgyconplgryuyakyicvbqlveceapi53jhfiqtipmxymythslrmza", + "openMode" : "READ_WRITE", + "isRestricted" : "false", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails": null, + "timeCreated" : "2016-11-22T19:25:42.755Z", + "pdbNodeLevelDetails": [ + { + "nodeName" : "node1", + "openMode" : "READ_WRITE" + },{ + "nodeName": "node2", + "openMode": "READ_ONLY" + } + ] + } + '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/DefaultError' + summary: GetPluggableDatabase + tags: + - database + x-example: | + GET /20160918/pluggableDatabases/<pluggableDatabaseId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/PluggableDatabase' + put: + description: Updates the specified pluggable database. + operationId: UpdatePluggableDatabase + parameters: + - $ref: '#/components/parameters/PluggableDatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePluggableDatabaseDetails' + description: Request to perform pluggable database update. + required: true + responses: + '200': + description: The request was successfully received and the pluggable database update is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PluggableDatabase' + application-json: + examples: + response: + value: | + { + "containerDatabaseId" : "ocid1.database.oc1..aaaaaaaah2sauv373xyfrpcnaed2ptfy67fnspzyda2hacgdbrkijhffugaa", + "pdbName" : "SalesPdb", + "id" : "ocid1.pluggabledatabase.oc1.phx.abuxgljrbgyconplgryuyakyicvbqlveceapi53jhfiqtipmxymythslrmza", + "openMode" : "READ_WRITE", + "isRestricted" : "false", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails": null, + "timeCreated" : "2016-11-22T19:25:42.755Z", + "freeformTags" : {"Department": "Finance"} + } + '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/DefaultError' + summary: UpdatePluggableDatabase + tags: + - database + x-example: | + PUT /20160918/pluggableDatabases/<pluggableDatabaseId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "freeformTags" : {"Department": "Finance"} + } + x-related-resource: '#/definitions/PluggableDatabase' + /pluggableDatabases/{pluggableDatabaseId}/actions/convertToRegular: + post: + description: | + Converts a Refreshable clone to Regular pluggable database (PDB). + Pluggable Database will be in `READ_WRITE` openmode after conversion. + operationId: ConvertToRegularPluggableDatabase + parameters: + - $ref: '#/components/parameters/PluggableDatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConvertToRegularPluggableDatabaseDetails' + description: Request to convert a Refreshable clone pluggable database (PDB) to a Regular pluggable database. + required: true + responses: + '202': + description: The request was successfully received and the Refreshable Clone pluggable database will be converted to Regular Pluggable Database. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PluggableDatabase' + application-json: + examples: + response: + value: | + { + "containerDatabaseId" : "ocid1.database.oc1.", + "pdbName" : "NewSalesPdb", + "id" : "ocid1.pluggabledatabase.oc1.phx.", + "openMode" : "READ_WRITE", + "refreshableCloneConfig" : { "isRefreshableClone" : "true" }, + "isRestricted" : "false", + "lifecycleState" : "UPDATING", + "lifecycleDetails": null, + "timeCreated" : "2017-11-22T19:25:42.755Z" + } + '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/DefaultError' + summary: Converts a Refreshable clone to Regular pluggable database. + tags: + - database + x-example: | + POST /20160918/pluggableDatabases/<pluggableDatabaseId>/actions/convertToRegular + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "shouldCreatePdbBackup" : "true" + } + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/PluggableDatabase' + /pluggableDatabases/{pluggableDatabaseId}/actions/localClone: + post: + deprecated: true + description: | + **Deprecated.** Use [CreatePluggableDatabase](#/en/database/latest/PluggableDatabase/CreatePluggableDatabase) for Pluggable Database LocalClone Operation. + Clones and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in the `READ_WRITE` openMode to perform the clone operation. + operationId: LocalClonePluggableDatabase + parameters: + - $ref: '#/components/parameters/PluggableDatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LocalClonePluggableDatabaseDetails' + description: Request to clone a pluggable database locally. + required: true + responses: + '200': + description: The request was successfully received and the pluggable database will be cloned. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PluggableDatabase' + application-json: + examples: + response: + value: | + { + "containerDatabaseId" : "ocid1.database.oc1..aaaaaaaah2sauv373xyfrpcnaed2ptfy67fnspzyda2hacgdbrkijhffugaa", + "pdbName" : "NewSalesPdb", + "id" : "ocid1.pluggabledatabase.oc1.phx.abuxgljrbgyconplgryuyakyicvbqlveceapi53jhfiqtipmxymythslrmje", + "openMode" : "READ_WRITE", + "isRestricted" : "false", + "lifecycleState" : "PROVISIONING", + "lifecycleDetails": null, + "timeCreated" : "2017-11-22T19:25:42.755Z" + } + '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/DefaultError' + summary: LocalClonePluggableDatabase + tags: + - database + x-example: | + POST /20160918/pluggableDatabases/<pluggableDatabaseId>/actions/localClone + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "clonedPdbName" : "NewSalesPdb", + "targetTdeWalletPassword" : "<TDE_password>", + "pdbAdminPassword" : "<password>" + } + x-related-resource: '#/definitions/PluggableDatabase' + /pluggableDatabases/{pluggableDatabaseId}/actions/refresh: + post: + description: | + Refreshes a pluggable database (PDB) Refreshable clone. + operationId: RefreshPluggableDatabase + parameters: + - $ref: '#/components/parameters/PluggableDatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '202': + description: The request was successfully received and the Refreshable Clone pluggable database will be refreshed. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PluggableDatabase' + application-json: + examples: + response: + value: | + { + "containerDatabaseId" : "ocid1.database.oc1.", + "pdbName" : "NewSalesPdb", + "id" : "ocid1.pluggabledatabase.oc1.phx.", + "openMode" : "READ_WRITE", + "refreshableCloneConfig" : { "isRefreshableClone" : "true" }, + "isRestricted" : "false", + "lifecycleState" : "REFRESHING", + "lifecycleDetails": null, + "timeCreated" : "2017-11-22T19:25:42.755Z" + } + '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/DefaultError' + summary: Refreshes a pluggable database Refreshable clone. + tags: + - database + x-example: | + POST /20160918/pluggableDatabases/<pluggableDatabaseId>/actions/refresh + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/PluggableDatabase' + /pluggableDatabases/{pluggableDatabaseId}/actions/remoteClone: + post: + deprecated: true + description: | + **Deprecated.** Use [CreatePluggableDatabase](#/en/database/latest/PluggableDatabase/CreatePluggableDatabase) for Pluggable Database RemoteClone Operation. + Clones a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in the `READ_WRITE` openMode when performing the clone. + For Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructure as the target container database (CDB) to create a remote clone. + operationId: RemoteClonePluggableDatabase + parameters: + - $ref: '#/components/parameters/PluggableDatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoteClonePluggableDatabaseDetails' + description: Request to clone a pluggable database (PDB) to a different database (CDB) from the source PDB. + required: true + responses: + '200': + description: The request was successfully received and the pluggable database will be cloned. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PluggableDatabase' + application-json: + examples: + response: + value: | + { + "containerDatabaseId" : "ocid1.database.oc1..aaaaaaaah2sauv373xyfrpcnaed2ptfy67fnspzyda2hacgdbrkijhffugaa", + "pdbName" : "NewSalesPdb", + "id" : "ocid1.pluggabledatabase.oc1.phx.abuxgljrbgyconplgryuyakyicvbqlveceapi53jhfiqtipmxymythslrmje", + "openMode" : "READ_WRITE", + "isRestricted" : "false", + "lifecycleState" : "PROVISIONING", + "lifecycleDetails": null, + "timeCreated" : "2017-11-22T19:25:42.755Z" + } + '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/DefaultError' + summary: RemoteClonePluggableDatabase + tags: + - database + x-example: | + POST /20160918/pluggableDatabases/<pluggableDatabaseId>/actions/remoteClone + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "clonedPdbName" : "NewSalesPdb", + "targetContainerDatabaseId" : "ocid1.database.oc1..aaaaaaaah2sauv373xyfrpcnaed2ptfy67fnspzyda2hacgdbrkijhffugaa", + "sourceContainerDbAdminPassword" : "<password>", + "targetTdeWalletPassword" : "<TDE_password>", + "pdbAdminPassword" : "<password>" + } + x-related-resource: '#/definitions/PluggableDatabase' + /pluggableDatabases/{pluggableDatabaseId}/actions/start: + post: + description: Starts a stopped pluggable database. The `openMode` value of the pluggable database will be `READ_WRITE` upon completion. + operationId: StartPluggableDatabase + parameters: + - $ref: '#/components/parameters/PluggableDatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '200': + description: The request was successfully received and the pluggable database will be started. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PluggableDatabase' + application-json: + examples: + response: + value: | + { + "containerDatabaseId" : "ocid1.database.oc1..aaaaaaaah2sauv373xyfrpcnaed2ptfy67fnspzyda2hacgdbrkijhffugaa", + "pdbName" : "SalesPdb", + "id" : "ocid1.pluggabledatabase.oc1.phx.abuxgljrbgyconplgryuyakyicvbqlveceapi53jhfiqtipmxymythslrmza", + "openMode" : "MOUNTED", + "isRestricted" : "false", + "lifecycleState" : "UPDATING", + "lifecycleDetails": null, + "timeCreated" : "2016-11-22T19:25:42.755Z" + } + '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/DefaultError' + summary: StartPluggableDatabase + tags: + - database + x-example: | + POST /20160918/pluggableDatabases/<pluggableDatabaseId>/actions/start + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/PluggableDatabase' + /pluggableDatabases/{pluggableDatabaseId}/actions/stop: + post: + description: Stops a pluggable database. The `openMode` value of the pluggable database will be `MOUNTED` upon completion. + operationId: StopPluggableDatabase + parameters: + - $ref: '#/components/parameters/PluggableDatabaseIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '200': + description: The request was successfully received and the pluggable database will be stopped. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PluggableDatabase' + application-json: + examples: + response: + value: | + { + "containerDatabaseId" : "ocid1.database.oc1..aaaaaaaah2sauv373xyfrpcnaed2ptfy67fnspzyda2hacgdbrkijhffugaa", + "pdbName" : "SalesPdb", + "id" : "ocid1.pluggabledatabase.oc1.phx.abuxgljrbgyconplgryuyakyicvbqlveceapi53jhfiqtipmxymythslrmza", + "openMode" : "READ_WRITE", + "isRestricted" : "false", + "lifecycleState" : "UPDATING", + "lifecycleDetails": null, + "timeCreated" : "2016-11-22T19:25:42.755Z" + } + '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/DefaultError' + summary: StopPluggableDatabase + tags: + - database + x-example: | + POST /20160918/pluggableDatabases/<pluggableDatabaseId>/actions/stop + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/PluggableDatabase' + /resourcePrincipalToken/{instanceId}: + get: + description: | + Gets a resource principal intermediate token that contains mapping information between the instance prinicpal and resource. + operationId: GetResourcePrincipalToken + parameters: + - $ref: '#/components/parameters/InstanceIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The RPT that has all the mapping information between instance principal and resource information. + 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/PrincipalTokenDetails' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetResourcePrincipalToken + tags: + - database + x-example: | + Example: + GET /20160918/ResourcePrincipalToken/ + Host: database.us-phoenix-1.oraclecloud.com + x-related-resource: '#/definitions/PrincipalTokenDetails' + /scheduledActionParams: + get: + description: | + List all the action params and their possible values for a given action type + operationId: ListParamsForActionType + parameters: + - $ref: '#/components/parameters/ListParamsActionTypeQueryParam' + - $ref: '#/components/parameters/ListParamsPlanIntentQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The Action parameters and their possible values. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ActionParamValuesCollection' + application-json: + examples: + response: + value: | + { + "items": [ + { + "parameterName" : "enableCustomActionTimeout", + "parameterType" : "boolean", + "parameterValues" : ["true", "false"], + "defaultValue" : "false", + "isRequired" : "true" + }, { + "parameterName" : "count", + "parameterType" : "integer", + "parameterValues" : ["0", "128"], + "defaultValue" : "0", + "isRequired" : "true" + }, { + "parameterName" : "customActionTimeout", + "parameterType" : "integer", + "parameterValues" : ["0", "120"], + "defaultValue" : "0", + "isRequired" : "false" + }, { + "parameterName" : "patchingMode", + "parameterType" : "string", + "parameterValues" : ["ROLLING", "NONROLLING"], + "defaultValue" : "ROLLING", + "isRequired" : "true" + } + ] + } + '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/DefaultError' + summary: ListParamsForActionType + tags: + - database + x-example: | + GET /20160918/scheduledActionParams?type=<type>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-authz-declarations: + authorizationRequired: false + x-related-resource: '#/definitions/ActionParamValuesSummary' + /scheduledActions: + get: + description: | + Lists the Scheduled Action resources in the specified compartment. + operationId: ListScheduledActions + parameters: + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListScheduledActionsFilterByServiceTypeQueryParam' + - $ref: '#/components/parameters/ListScheduledActionsFilterBySchedulingPlanIdQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/ListScheduledActionsSortByQueryParam' + - $ref: '#/components/parameters/ScheduledActionIdQueryParam' + - $ref: '#/components/parameters/ListScheduledActionsFilterByLifecycleStateQueryParam' + responses: + '200': + description: | + A list of the Scheduled Action resources in the specified compartment. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ScheduledActionCollection' + application-json: + examples: + response: + value: | + [ + { + "id" : "ocid1.scheduledaction.oc1.phx.", + "compartmentId" : "ocid1.tenancy.oc1.", + "actionType" : "DB_Server_Exadata_full_software_update", + "schedulePolicyId" : "ocid1.schedulingpolicy.oc1.<unique_ID>", + "schedulePlanId" : "ocid1.schedulingplan.oc1.<unique_ID>", + "actionOrder" : 1, + "actionParams" : null, + "lifecycleState" : "AVAILABLE", + "actionMembers": [ + { + "memberOrder": 1, + "component": + }, + { + "memberOrder": 2, + "component": + }, + { + "memberOrder": 3, + "component": + }, + { + "memberOrder": 4, + "component": + } + ] + }, + { + "id" : "ocid1.scheduledaction.oc1.phx.", + "compartmentId" : "ocid1.tenancy.oc1.", + "actionType" : "Storage_Server_Exadata_full_software_update", + "schedulePolicyId" : "ocid1.schedulingpolicy.oc1.<unique_ID>", + "schedulePlanId" : "ocid1.schedulingplan.oc1.<unique_ID>", + "actionOrder" : 2, + "actionParams" : [ + { + "memberCount" : 3 + } + ] + } + ] + '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/DefaultError' + summary: ListScheduledActions + tags: + - database + x-example: | + GET /20160918/scheduledActions?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ScheduledAction' + post: + description: | + Creates a Scheduled Action resource. + operationId: CreateScheduledAction + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateScheduledActionDetails' + description: Request to create Scheduled Action. + required: true + responses: + '201': + description: | + The request was successfully received and the create Scheduled Action operation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ScheduledAction' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.scheduledaction.oc1.phx.", + "compartmentId" : "ocid1.tenancy.oc1.", + "actionType" : "DB_Server_Exadata_full_software_update", + "schedulePolicyId" : "ocid1.schedulingpolicy.oc1.<unique_ID>", + "schedulePlanId" : "ocid1.schedulingplan.oc1.<unique_ID>", + "actionOrder" : 1, + "actionParams" : null, + "actionMembers": [ + { + "memberOrder": 1, + "component": + }, + { + "memberOrder": 2, + "component": + }, + { + "memberOrder": 3, + "component": + }, + { + "memberOrder": 4, + "component": + } + ] + } + '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/DefaultError' + summary: CreateScheduledAction + tags: + - database + x-example: | + POST /20160918/scheduledAction + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.tenancy.oc1.", + "lifecycleState" : "CREATING", + "schedulePolicyId" : "ocid1.schedulingpolicy.oc1.<unique_ID>", + "schedulePlanId" : "ocid1.schedulingplan.oc1.<unique_ID>", + "actionOrder" : 1 + } + /scheduledActions/{scheduledActionId}: + delete: + description: | + Deletes the scheduled action. + operationId: DeleteScheduledAction + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/ScheduledActionIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '202': + description: The request to delete the scheduled action was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Delete a scheduled action. + tags: + - database + x-related-resource: '#/definitions/ScheduledAction' + get: + description: | + Gets information about the specified Scheduled Action. + operationId: GetScheduledAction + parameters: + - $ref: '#/components/parameters/ScheduledActionIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The Scheduled Action details. + 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/ScheduledAction' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.scheduledaction.oc1.phx.", + "compartmentId" : "ocid1.tenancy.oc1.", + "actionType" : "DB_Server_Exadata_full_software_update", + "schedulePolicyId" : "ocid1.schedulingpolicy.oc1.<unique_ID>", + "schedulePlanId" : "ocid1.schedulingplan.oc1.<unique_ID>", + "actionOrder" : 1, + "actionParams" : null, + "actionMembers": [ + { + "memberOrder": 1, + "component": + }, + { + "memberOrder": 2, + "component": + }, + { + "memberOrder": 3, + "component": + }, + { + "memberOrder": 4, + "component": + } + ] + } + '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/DefaultError' + summary: Get ScheduledAction + tags: + - database + x-example: | + GET /20160918/scheduledactions/<scheduledActionId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the Scheduled Action resource. + operationId: UpdateScheduledAction + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ScheduledActionIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateScheduledActionDetails' + description: Request to update the properties of a Scheduled Action. + required: true + responses: + '202': + description: | + The request was successfully received and the Scheduled Action update is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ScheduledAction' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.scheduledaction.oc1.phx.", + "priority" : 1, + "compartmentId" : "ocid1.tenancy.oc1.", + "lifecycleState" : "UPDATING", + "actionMembers": [ + { + "memberOrder": 1, + "component": + }, + { + "memberOrder": 2, + "component": + }, + { + "memberOrder": 3, + "component": + }, + { + "memberOrder": 4, + "component": + } + ] + } + '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/DefaultError' + summary: Updates the specified Scheduled Action + tags: + - database + x-example: | + PUT /latest/scheduledactions/<scheduledActionId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "priority" : 1, + "actionMembers": [ + { + "memberOrder": 1, + "component": + }, + { + "memberOrder": 2, + "component": + }, + { + "memberOrder": 3, + "component": + }, + { + "memberOrder": 4, + "component": + } + ] + } + /schedulingPlans: + get: + description: | + Lists the Scheduling Plan resources in the specified compartment. + operationId: ListSchedulingPlans + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ListSchedulingPlansSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListSchedulingPlansFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/ListSchedulingPlanByResourceIdQueryParam' + - $ref: '#/components/parameters/SchedulingPlanIdQueryParam' + - $ref: '#/components/parameters/ListSchedulingPlansFilterByPlanIntentQueryParam' + responses: + '200': + description: | + A list of the Scheduling Plan resources in the specified compartment. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/SchedulingPlanCollection' + application-json: + examples: + response: + value: | + [{ + "id" : "ocid1.schedulingplan.oc1.phx.", + "resourceId" : "ocid1.exadatainfrastructure.oc1.phx.", + "schedulePolicyId" : "ocid1.schedulingpolicy.oc1.phx.", + "displayName" : "test_displayName", + "compartmentId" : "ocid1.tenancy.oc1.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails" : null, + "freeformTags" : null, + "definedTags" : null, + "estimatedTimeInMins" : 360, + "isUsingRecommendedScheduledActions" : true + }] + '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/DefaultError' + summary: ListSchedulingPlans + tags: + - database + x-example: | + GET /20160918/schedulingPlans?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/SchedulingPlan' + post: + description: | + Creates a Scheduling Plan resource. + operationId: CreateSchedulingPlan + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateSchedulingPlanDetails' + description: Request to create Scheduling Plan. + required: true + responses: + '201': + description: | + The request was successfully received and the create Scheduling Plan operation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SchedulingPlan' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.schedulingplan.oc1.phx.", + "resourceId" : "ocid1.exadatainfrastructure.oc1.phx.", + "schedulePolicyId" : "ocid1.schedulingpolicy.oc1.phx.", + "displayName" : "test_displayName", + "compartmentId" : "ocid1.tenancy.oc1.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails" : null, + "freeformTags" : null, + "definedTags" : null, + "estimatedTimeInMins" : 360, + "isUsingRecommendedScheduledActions" : true + } + '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/DefaultError' + summary: CreateSchedulingPlan + tags: + - database + x-example: | + POST /20160918/schedulingPlans + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "resourceId" : "ocid1.exadatainfrastructure.oc1.phx.", + "schedulePolicyId" : "ocid1.schedulingpolicy.oc1.phx.", + "isUsingRecommendedScheduledActions" : true, + "compartmentId" : "ocid1.tenancy.oc1." + } + /schedulingPlans/{schedulingPlanId}: + delete: + description: | + Deletes the scheduling plan. + operationId: DeleteSchedulingPlan + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/SchedulingPlanIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '202': + description: The request to delete the scheduling plan was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: Delete a scheduling plan. + tags: + - database + x-related-resource: '#/definitions/SchedulingPlan' + get: + description: | + Gets information about the specified Scheduling Plan. + operationId: GetSchedulingPlan + parameters: + - $ref: '#/components/parameters/SchedulingPlanIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The Scheduling Plan details. + 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/SchedulingPlan' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.schedulingplan.oc1.phx.", + "resourceId" : "ocid1.exadatainfrastructure.oc1.phx.", + "schedulePolicyId" : "ocid1.schedulingpolicy.oc1.phx.", + "displayName" : "test_displayName", + "compartmentId" : "ocid1.tenancy.oc1.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails" : null, + "freeformTags" : null, + "definedTags" : null, + "estimatedTimeInMins" : 360, + "isUsingRecommendedScheduledActions" : true + } + '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/DefaultError' + summary: Get SchedulingPlan + tags: + - database + x-example: | + GET /20160918/schedulingplans/<schedulingPlanId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /schedulingPlans/{schedulingPlanId}/actions/changeCompartment: + post: + description: | + Moves an scheduling plan resource to another compartment. + operationId: ChangeSchedulingPlanCompartment + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/SchedulingPlanIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeSchedulingPlanCompartmentDetails' + description: Request to move scheduling plan to a different compartment + required: true + responses: + '202': + description: The request was successfully received and the change compartment action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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/DefaultError' + summary: ChangeSchedulingPlanCompartment + tags: + - database + x-related-resource: '#/definitions/SchedulingPlan' + /schedulingPlans/{schedulingPlanId}/actions/reorder: + post: + description: | + Re-order the scheduled actions under this scheduling plan resource. + operationId: ReorderScheduledActions + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/SchedulingPlanIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ReorderScheduledActionsDetails' + description: Request to re-order Scheduled Action resources. + required: true + responses: + '202': + description: | + The request was successfully received and the scheduled action reordering is in progress. + headers: + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SchedulingPlan' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.schedulingplan.oc1.phx.", + "resourceId" : "ocid1.exadatainfrastructure.oc1.phx.", + "schedulePolicyId" : "ocid1.schedulingpolicy.oc1.phx.", + "displayName" : "test_displayName", + "compartmentId" : "ocid1.tenancy.oc1.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "AVAILABLE", + "lifecycleDetails" : null, + "freeformTags" : null, + "definedTags" : null, + "estimatedTimeInMins" : 360, + "isUsingRecommendedScheduledActions" : true + } + '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/DefaultError' + summary: Re-order the scheduled actions under this scheduling plan resource + tags: + - database + x-example: | + POST /20160918/reorderScheduledActions + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "scheduledActionIdOrders": [ + { + "actionOrder": "1", + "actionResourceId": "ocid1.scheduledaction.oc1.phx." + }, + { + "actionOrder": "2", + "actionResourceId": "ocid1.scheduledaction.oc1.phx." + } + ] + } + x-related-resource: '#/definitions/SchedulingPlan' + /schedulingPolicies: + get: + description: | + Lists the Scheduling Policy resources in the specified compartment. + operationId: ListSchedulingPolicies + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ListSchedulingPoliciesSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListSchedulingPoliciesFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/ListSchedulingPoliciesFilterByCadenceQueryParam' + responses: + '200': + description: | + A list of the Scheduling Policy resources in the specified compartment. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListSchedulingPoliciesResponse' + application-json: + examples: + response: + value: | + [{ + "id" : "ocid1.schedulingpolicy.oc1.phx.", + "cadence" : QUARTERLY, + "cadenceStartMonth" : "FEBRUARY", + "displayName" : "tstSchedulingPolicy", + "compartmentId" : "ocid1.tenancy.oc1.", + "timeNextWindowStarts" : "2018-12-23T05:59:07.030Z", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "CREATING", + "lifecycleDetails" : null + }] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListSchedulingPolicies + tags: + - database + x-example: | + GET /20160918/schedulingPolicies?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/SchedulingPolicy' + post: + description: | + Creates a Scheduling Policy resource. + operationId: CreateSchedulingPolicy + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateSchedulingPolicyDetails' + description: Request to create Scheduling Policy. + required: true + responses: + '200': + description: | + The request was successfully received and the create Scheduling Policy operation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SchedulingPolicy' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.schedulingpolicy.oc1.phx.", + "cadence" : QUARTERLY, + "cadenceStartMonth" : "FEBRUARY", + "displayName" : "tstSchedulingPolicy", + "compartmentId" : "ocid1.tenancy.oc1.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "CREATING", + "lifecycleDetails" : null + } + '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/DefaultError' + summary: CreateSchedulingPolicy + tags: + - database + x-example: | + POST /20160918/schedulingPolicy + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.tenancy.oc1.<unique_ID>", + "displayName" : "tstSchedulingPolicy", + "cadence" : QUARTERLY, + "cadenceStartMonth" : "FEBRUARY" + } + /schedulingPolicies/{schedulingPolicyId}: + delete: + description: | + Deletes the scheduling policy. + operationId: DeleteSchedulingPolicy + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/SchedulingPolicyIdPathParam' + responses: + '204': + description: The request to delete the scheduling policy was accepted. + 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 + '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/DefaultError' + summary: Delete a scheduling policy. + tags: + - database + x-related-resource: '#/definitions/SchedulingPolicy' + get: + description: | + Gets information about the specified Scheduling Policy. + operationId: GetSchedulingPolicy + parameters: + - $ref: '#/components/parameters/SchedulingPolicyIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The Scheduling Policy details. + 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/SchedulingPolicy' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.schedulingpolicy.oc1.phx.", + "cadence" : QUARTERLY, + "cadenceStartMonth" : "FEBRUARY", + "displayName" : "tstSchedulingPolicy", + "compartmentId" : "ocid1.tenancy.oc1.", + "timeNextWindowStarts" : "2018-12-23T05:59:07.030Z", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "CREATING", + "lifecycleDetails" : null + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Get SchedulingPolicy + tags: + - database + x-example: | + GET /20160918/schedulingpolicies/<schedulingPolicyId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the Scheduling Policy resource. + operationId: UpdateSchedulingPolicy + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/SchedulingPolicyIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSchedulingPolicyDetails' + description: Request to update the properties of a Scheduling Policy. + required: true + responses: + '200': + description: | + The request was successfully received and the Scheduling Policy update is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SchedulingPolicy' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.schedulingpolicy.oc1.phx.", + "cadence" : QUARTERLY, + "cadenceStartMonth" : "FEBRUARY", + "displayName" : "updatedSchedulingPolicy", + "compartmentId" : "ocid1.tenancy.oc1.", + "timeNextWindowStarts" : "2018-12-23T05:59:07.030Z", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "UPDATING", + "lifecycleDetails" : null + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Updates the specified Scheduling Policy + tags: + - database + x-example: | + PUT /latest/schedulingPolicies/<schedulingPolicyId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName" : "updatedSchedulingPolicy" + "cadence" : QUARTERLY, + "cadenceStartMonth" : "FEBRUARY" + } + /schedulingPolicies/{schedulingPolicyId}/actions/changeCompartment: + post: + description: | + Moves an scheduling policy resource to another compartment. + operationId: ChangeSchedulingPolicyCompartment + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/SchedulingPolicyIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeSchedulingPolicyCompartmentDetails' + description: Request to move scheduling policy to a different compartment + required: true + responses: + '202': + description: The request was successfully received and the change compartment action is being performed. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeSchedulingPolicyCompartment + tags: + - database + x-related-resource: '#/definitions/SchedulingPolicy' + /schedulingPolicies/{schedulingPolicyId}/recommendedScheduledActions: + get: + description: | + Returns a recommended Scheduled Actions configuration for a given resource, plan intent and scheduling policy. + operationId: ListRecommendedScheduledActions + parameters: + - $ref: '#/components/parameters/SchedulingPolicyIdPathParam' + - $ref: '#/components/parameters/SchedulingPolicyTargetResourceIdQueryParam' + - $ref: '#/components/parameters/PlanIntentQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The Scheduling Actions configuration. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/RecommendedScheduledActionsCollection' + application-json: + examples: + response: + value: | + { + "items": [ + { + "actionOrder" : "1", + "actionType" : "STORAGE_SERVER_FULL_SOFTWARE_UPDATE", + "displayName" : "Apply full update to 3 Storage servers.", + "schedulingWindowId" : "ocid1.schedulingwindow.oc1.phx.", + "estimatedTimeInMins" : "180", + "actionMembers" : [], + "actionParams" : + { + "count" : "3", + "enableCustomActionTimeout" : "false", + "patchingMode" : "ROLLING" + } + }, { + "actionOrder" : "2", + "actionType" : "NETWORK_SWITCH_FULL_SOFTWARE_UPDATE", + "displayName" : "Apply full update to 2 Network switches.", + "schedulingWindowId" : "ocid1.schedulingwindow.oc1.phx.", + "estimatedTimeInMins" : "60", + "actionMembers" : [], + "actionParams" : + { + "count" : "2" + } + }, { + "actionOrder" : "1", + "actionType" : "DB_SERVER_FULL_SOFTWARE_UPDATE", + "displayName" : "Apply full update to DB Servers 1,2.", + "schedulingWindowId" : "ocid1.schedulingwindow.oc1.phx.", + "estimatedTimeInMins" : "180", + "actionMembers" : + [ + {"memberOrder" : "1", "memberId" : "ocid1.dbserver.oc1."}, + {"memberOrder" : "2", "memberId" : "ocid1.dbserver.oc1."} + + ], + "actionParams" : + { + "enableCustomActionTimeout" : "false", + "patchingMode" : "ROLLING" + } + } + ] + } + '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/DefaultError' + summary: ListRecommendedScheduledActions + tags: + - database + x-example: | + GET /20160918/schedulingPolicies/<schedulingPolicyId>/recommendedScheduledActions?schedulingPolicyTargetResourceId=<schedulingPolicyTargetResourceId>&planIntent=<planIntent> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/RecommendedScheduledActionSummary' + /schedulingPolicies/{schedulingPolicyId}/schedulingWindows: + get: + description: | + Lists the Scheduling Window resources in the specified compartment. + operationId: ListSchedulingWindows + parameters: + - $ref: '#/components/parameters/SchedulingPolicyIdPathParam' + - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ListSchedulingWindowsSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListSchedulingWindowsFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + responses: + '200': + description: | + A list of the Scheduling Window resources in the specified compartment. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListSchedulingWindowsResponse' + application-json: + examples: + response: + value: | + [{ + "id" : "ocid1.schedulingwindow.oc1.phx.", + "displayName" : "1st SAT, 10:00 AM UTC, Every FEB", + "timeNextSchedulingWindowStarts" : "2024-02-03T10:00:00.000Z", + "compartmentId" : "ocid1.tenancy.oc1.", + "schedulingPolicyId" : "ocid1.schedulingpolicy.oc1.phx.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "CREATING", + "lifecycleDetails" : null, + "windowPreference" : { + "months" : ["FEBRUARY"], + "weeksOfMonth" : [1], + "daysOfWeek" : [SATURDAY], + "startTime" : "10:00", + "duration" : 12, + "isEnforcedDuration" : false + } + }] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListSchedulingWindows + tags: + - database + x-example: | + GET /20160918/schedulingPolicies/<schedulingPolicyId>/schedulingWindows?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/SchedulingWindow' + post: + description: | + Creates a Scheduling Window resource. + operationId: CreateSchedulingWindow + parameters: + - $ref: '#/components/parameters/SchedulingPolicyIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateSchedulingWindowDetails' + description: Request to create Scheduling Window. + required: true + responses: + '200': + description: | + The request was successfully received and the create Scheduling Window operation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SchedulingWindow' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.schedulingwindow.oc1.phx.", + "compartmentId" : "ocid1.tenancy.oc1.", + "schedulingPolicyId" : "ocid1.schedulingwindow1.oc1.phx.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "CREATING", + "lifecycleDetails" : null, + "windowPreference" : { + "months" : ["FEBRUARY"], + "weeksOfMonth" : [1], + "daysOfWeek" : [SATURDAY], + "startTime" : "10:00", + "duration" : 12, + "isEnforcedDuration" : false + } + } + '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/DefaultError' + summary: CreateSchedulingWindow + tags: + - database + x-example: | + POST /20160918/schedulingPolicies/<schedulingPolicyId>/schedulingWindows + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "schedulingPolicyId" : "ocid1.schedulingpolicy.oc1.phx.", + "windowPreference" : { + "months" : ["FEBRUARY"], + "weeksOfMonth" : [1], + "daysOfWeek" : [SATURDAY], + "startTime" : "10:00", + "duration" : 12, + "isEnforcedDuration" : false + } + } + /schedulingPolicies/{schedulingPolicyId}/schedulingWindows/{schedulingWindowId}: + delete: + description: | + Deletes the scheduling window. + operationId: DeleteSchedulingWindow + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/SchedulingPolicyIdPathParam' + - $ref: '#/components/parameters/SchedulingWindowIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '204': + description: The request to delete the scheduling window was accepted. + 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 + '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/DefaultError' + summary: Delete a scheduling window. + tags: + - database + x-related-resource: '#/definitions/SchedulingWindow' + get: + description: | + Gets information about the specified Scheduling Window. + operationId: GetSchedulingWindow + parameters: + - $ref: '#/components/parameters/SchedulingPolicyIdPathParam' + - $ref: '#/components/parameters/SchedulingWindowIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The Scheduling Window details. + 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/SchedulingWindow' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.schedulingwindow.oc1.phx.", + "displayName" : "1st SAT, 10:00 AM UTC, Every FEB", + "timeNextSchedulingWindowStarts" : "2024-02-03T10:00:00.000Z", + "compartmentId" : "ocid1.tenancy.oc1.", + "schedulingPolicyId" : "ocid1.schedulingpolicy.oc1.phx.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "CREATING", + "lifecycleDetails" : null, + "windowPreference" : { + "months" : ["FEBRUARY"], + "weeksOfMonth" : [1], + "daysOfWeek" : [SATURDAY], + "startTime" : "10:00", + "duration" : 12, + "isEnforcedDuration" : false + } + } + '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/DefaultError' + summary: Get SchedulingWindow + tags: + - database + x-example: | + GET /20160918/schedulingPolicies/<schedulingPolicyId>/schedulingWindows/<schedulingWindowId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the Scheduling Window resource. + operationId: UpdateSchedulingWindow + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/SchedulingPolicyIdPathParam' + - $ref: '#/components/parameters/SchedulingWindowIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSchedulingWindowDetails' + description: Request to update the properties of a Scheduling Window. + required: true + responses: + '200': + description: | + The request was successfully received and the Scheduling Window update is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SchedulingWindow' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.schedulingwindow.oc1.phx.", + "displayName" : "1st SAT, 10:00 AM UTC, Every FEB", + "timeNextSchedulingWindowStarts" : "2024-02-03T10:00:00.000Z", + "compartmentId" : "ocid1.tenancy.oc1.", + "schedulingPolicyId" : "ocid1.schedulingpolicy.oc1.phx.", + "timeCreated" : "2018-11-23T01:59:07.030Z", + "lifecycleState" : "UPDATING", + "lifecycleDetails" : null, + "windowPreference" : { + "months" : ["FEBRUARY"], + "weeksOfMonth" : [1], + "daysOfWeek" : [SATURDAY], + "startTime" : "10:00", + "duration" : 12, + "isEnforcedDuration" : false + } + } + '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/DefaultError' + summary: Updates the specified Scheduling Window + tags: + - database + x-example: | + PUT /latest/schedulingPolicies/<schedulingPolicyId>/schedulingWindows/<schedulingWindowId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "schedulingPolicyId" : "ocid1.schedulingpolicy.oc1.phx.", + "windowPreference" : { + "months" : ["FEBRUARY"], + "weeksOfMonth" : [1], + "daysOfWeek" : [SATURDAY], + "startTime" : "10:00", + "duration" : 12, + "isEnforcedDuration" : false + } + } + /systemVersions: + get: + description: Gets a list of supported Exadata system versions for a given shape and GI version. + operationId: ListSystemVersions + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/ShapeQueryParam' + - $ref: '#/components/parameters/GridInfrastructureVersionQueryParam' + responses: + '200': + description: The list of supported Exadata system versions for a given shape and GI version. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/SystemVersionCollection' + application-json: + examples: + response: + value: | + { + "shape" : "Exadata.Full2.368", + "giVersion" : "19.0.0.0", + "systemVersions" : ["21.1.2.0.0.230523, 22.1.2.0.0.230225"] + } + '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/DefaultError' + summary: ListSystemVersions + tags: + - database + x-example: | + GET /20160918/systemVersions?compartmentId=<compartmentId>&shape=<shape>&giVersion=<giVersion>&limit=100 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /vmClusters: + get: + description: | + Lists the VM clusters in the specified compartment. Applies to Exadata Cloud@Customer instances only. + To list the cloud VM clusters in an Exadata Cloud Service instance, use the [ListCloudVmClusters ](#/en/database/latest/CloudVmCluster/ListCloudVmClusters) operation. + operationId: ListVmClusters + parameters: + - $ref: '#/components/parameters/CompartmentId' + - $ref: '#/components/parameters/OptionalExadataInfrastructureIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/ListVmClustersSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ListVmClustersFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The list of Exadata Cloud@Customer VM clusters. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListVmClustersResponse' + application-json: + examples: + response: + value: | + [ + { + "displayName" : "vmCluster", + "compartmentId" : "ocid1.tenancy.oc1.", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "cpusEnabled" : 4, + "memorySizeInGBs" : 30, + "dbNodeStorageSizeInGBs" : 60, + "dataStorageSizeInTBs" : 84, + "lastPatchHistoryEntryId": "ocid1.dbpatchhistory.oc1.phx.", + "licenseModel" : "LICENSE_INCLUDED", + "isSparseDiskgroupEnabled" : false, + "isLocalBackupEnabled" : true, + "timeZone" : "PST", + "shape" : "Exadata.Full2.336", + "lifecycleState" : "AVAILABLE", + "id" : "ocid1.vmcluster.oc1.", + "lifecycleDetails" : "No additional details.", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "exadataInfrastructureId" : "ocid1.tenancy.oc1.", + "vmClusterNetworkId" : "ocid1.vmclusternetwork.oc1.", + "giVersion" : "19.0.0.1", + "fileSystemConfigurationDetails" : [{ + "mountPoint" : "/u01", + "fileSystemSizeGb" : 10 + }, { + "mountPoint" : "/var", + "fileSystemSizeGb" : 10 + }], + "computeModel": "ECPU", + "dbServers" : ["ocid1.dbserver.oc1.", "ocid1.dbserver.oc1."] + + } + ] + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListVmClusters + tags: + - database + x-example: | + GET /20160918/vmClusters?compartmentId=<compartmentId>&limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/VmCluster' + post: + description: | + Creates an Exadata Cloud@Customer VM cluster. + operationId: CreateVmCluster + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateVmClusterDetails' + description: | + Request to create a VM cluster. Applies to Exadata Cloud@Customer instances only. + See [CreateCloudVmClusterDetails Reference](#/en/database/latest/datatypes/CreateCloudVmClusterDetails) for details on creating a cloud VM cluster in an Exadata Cloud Service instance. + required: true + responses: + '200': + description: The request was successfully received and the create VM cluster operation is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/VmCluster' + application-json: + examples: + response: + value: | + { + "displayName" : "vmCluster", + "compartmentId" : "ocid1.tenancy.oc1.", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "cpusEnabled" : 4, + "memorySizeInGBs" : 30, + "dbNodeStorageSizeInGBs" : 60, + "dataStorageSizeInTBs" : 84, + "lastPatchHistoryEntryId": "ocid1.dbpatchhistory.oc1.phx.", + "licenseModel" : "LICENSE_INCLUDED", + "isSparseDiskgroupEnabled" : false, + "isLocalBackupEnabled" : true, + "timeZone" : "PST", + "shape" : "Exadata.Full2.336", + "lifecycleState" : "AVAILABLE", + "id" : "ocid1.vmcluster.oc1.", + "lifecycleDetails" : "No additional details.", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "exadataInfrastructureId" : "ocid1.tenancy.oc1.", + "vmClusterNetworkId" : "ocid1.vmclusternetwork.oc1.", + "giVersion" : "19.0.0.1", + "fileSystemConfigurationDetails" : [{ + "mountPoint" : "/u01", + "fileSystemSizeGb" : 10 + }, { + "mountPoint" : "/var", + "fileSystemSizeGb" : 10 + }], + "dbServers" : ["ocid1.dbserver.oc1.", "ocid1.dbserver.oc1."] + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateVmCluster + tags: + - database + x-example: | + POST /20160918/vmClusters + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName" : "vmCluster", + "compartmentId" : "ocid1.tenancy.oc1.<unique_ID>", + "exadataInfrastructureId" : "ocid1.tenancy.oc1.oc1.<unique_ID>", + "vmClusterNetworkId" : "ocid1.vmclusternetwork.oc1.<unique_ID>", + "cpuCoreCount" : 4, + "memorySizeInGBs" : 30, + "dbNodeStorageSizeInGBs" : 60, + "dataStorageSizeInTBs" : 84, + "sshPublicKeys" : [ "ssh-rsa <public_SSH_key> name@example.com" ], + "licenseModel" : "LICENSE_INCLUDED", + "isSparseDiskgroupEnabled" : false, + "isLocalBackupEnabled" : true, + "timeZone" : "PST", + "giVersion" : "19.1.0.0", + "fileSystemConfigurationDetails" : [{ + "mountPoint" : "/u01", + "fileSystemSizeGb" : 10 + }, { + "mountPoint" : "/var", + "fileSystemSizeGb" : 10 + }], + "dbServers" : ["ocid1.dbserver.oc1.", "ocid1.dbserver.oc1."] + } + /vmClusters/{vmClusterId}: + delete: + description: | + Deletes the specified VM cluster. Applies to Exadata Cloud@Customer instances only. + operationId: DeleteVmCluster + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/VmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '204': + description: The request to delete the VM cluster was accepted. + 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](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Deletes the specified VM cluster. + tags: + - database + x-related-resource: '#/definitions/VmCluster' + get: + description: | + Gets information about the VM cluster. Applies to Exadata Cloud@Customer instances only. + operationId: GetVmCluster + parameters: + - $ref: '#/components/parameters/VmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: Information about the Exadata Cloud@Customer VM cluster. + 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/VmCluster' + application-json: + examples: + response: + value: | + { + "displayName" : "vmCluster", + "compartmentId" : "ocid1.tenancy.oc1.", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "cpusEnabled" : 4, + "memorySizeInGBs" : 30, + "dbNodeStorageSizeInGBs" : 60, + "dataStorageSizeInTBs" : 84, + "lastPatchHistoryEntryId": "ocid1.dbpatchhistory.oc1.phx.", + "licenseModel" : "LICENSE_INCLUDED", + "isSparseDiskgroupEnabled" : false, + "isLocalBackupEnabled" : true, + "timeZone" : "PST", + "shape" : "Exadata.Full2.336", + "lifecycleState" : "AVAILABLE", + "id" : "ocid1.vmcluster.oc1.", + "lifecycleDetails" : "No additional details.", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "exadataInfrastructureId" : "ocid1.tenancy.oc1.", + "vmClusterNetworkId" : "ocid1.vmclusternetwork.oc1.", + "giVersion" : "19.0.0.1", + "giSoftwareImageId" : "ocid1.databasesoftwareimage.oc1.", + "fileSystemConfigurationDetails" : [{ + "mountPoint" : "/u01", + "fileSystemSizeGb" : 10 + }, { + "mountPoint" : "/var", + "fileSystemSizeGb" : 10 + }], + "computeModel": "ECPU", + "dbServers": [ "ocid1.dbserver.oc1.", "ocid1.dbserver.oc1." ] + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetVmCluster + tags: + - database + x-example: | + GET /20160918/vmClusters/<vmClusterId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the specified VM cluster. Applies to Exadata Cloud@Customer instances only. + operationId: UpdateVmCluster + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/VmClusterIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateVmClusterDetails' + description: Request to update the attributes of a VM cluster. + required: true + responses: + '200': + description: The request was successfully received and the VM cluster update is in progress. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/VmCluster' + application-json: + examples: + response: + value: | + { + "displayName" : "vmCluster", + "compartmentId" : "ocid1.tenancy.oc1.", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "cpusEnabled" : 10, + "memorySizeInGBs" : 50, + "dbNodeStorageSizeInGBs" : 60, + "dataStorageSizeInTBs" : 84, + "fileSystemConfigurationDetails" : [{ + "mountPoint" : "/u01", + "fileSystemSizeGb" : 10 + }, { + "mountPoint" : "/var", + "fileSystemSizeGb" : 10 + }], + "lastPatchHistoryEntryId": "ocid1.dbpatchhistory.oc1.phx.", + "licenseModel" : "LICENSE_INCLUDED", + "isSparseDiskgroupEnabled" : false, + "isLocalBackupEnabled" : true, + "timeZone" : "PST", + "shape" : "Exadata.Full2.336", + "lifecycleState" : "AVAILABLE", + "id" : "ocid1.vmcluster.oc1.", + "lifecycleDetails" : "No additional details.", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "exadataInfrastructureId" : "ocid1.tenancy.oc1.", + "vmClusterNetworkId" : "ocid1.vmclusternetwork.oc1.", + "giVersion" : "19.0.0.1" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Updates the specified VM cluster. + tags: + - database + x-example: | + PUT /20160918/vmClusters/<vmClusterId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "cpuCoreCount" : 10 + } + /vmClusters/{vmClusterId}/actions/addVirtualMachine: + post: + description: | + Add Virtual Machines to the VM cluster. Applies to Exadata Cloud@Customer instances only. + operationId: AddVirtualMachineToVmCluster + parameters: + - $ref: '#/components/parameters/VmClusterIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddVirtualMachineToVmClusterDetails' + description: Request to add Virtual Machines to the VM cluster. + required: true + responses: + '200': + description: The request was successfully received and the adding Virtual Machines action is being performed. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/VmCluster' + application-json: + examples: + response: + value: | + { + "displayName" : "vmCluster", + "compartmentId" : "ocid1.tenancy.oc1.", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "cpusEnabled" : 10, + "memorySizeInGBs" : 50, + "dbNodeStorageSizeInGBs" : 60, + "dataStorageSizeInTBs" : 84, + "lastPatchHistoryEntryId": "ocid1.dbpatchhistory.oc1.phx.", + "licenseModel" : "LICENSE_INCLUDED", + "isSparseDiskgroupEnabled" : false, + "isLocalBackupEnabled" : true, + "timeZone" : "PST", + "shape" : "Exadata.Full2.336", + "lifecycleState" : "AVAILABLE", + "id" : "ocid1.vmcluster.oc1.", + "lifecycleDetails" : "No additional details.", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "exadataInfrastructureId" : "ocid1.tenancy.oc1.", + "vmClusterNetworkId" : "ocid1.vmclusternetwork.oc1.", + "giVersion" : "19.0.0.1" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: AddVirtualMachineToVmCluster + tags: + - database + x-example: | + POST /20160918/vmClusters/<vmClusterId>/actions/addVirtualMachine + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "dbServers" : [ + { + "dbServerId" : "ocid1.dbserver.oc1." + }, + { + "dbServerId" : "ocid1.dbserver.oc1." + } + ] + } + x-related-resource: '#/definitions/VmCluster' + /vmClusters/{vmClusterId}/actions/changeCompartment: + post: + description: | + Moves a VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud@Customer instances only. + To move a cloud VM cluster in an Exadata Cloud Service instance to another compartment, use the [ChangeCloudVmClusterCompartment ](#/en/database/latest/CloudVmCluster/ChangeCloudVmClusterCompartment) operation. + operationId: ChangeVmClusterCompartment + parameters: + - $ref: '#/components/parameters/VmClusterIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeVmClusterCompartmentDetails' + description: Request to move the Exadata Cloud@Customer VM cluster to a different compartment. + required: true + responses: + '202': + description: The request was successfully received and the change compartment action is being performed. + 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: Unique Oracle-assigned identifier of the work 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeVmClusterCompartment + tags: + - database + x-related-resource: '#/definitions/VmCluster' + /vmClusters/{vmClusterId}/actions/removeVirtualMachine: + post: + description: | + Remove Virtual Machines from the VM cluster. Applies to Exadata Cloud@Customer instances only. + operationId: RemoveVirtualMachineFromVmCluster + parameters: + - $ref: '#/components/parameters/VmClusterIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OptionalRequestId' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveVirtualMachineFromVmClusterDetails' + description: Request to remove Virtual Machines from the VM cluster. + required: true + responses: + '200': + description: The request was successfully received and the removing Virtual Machines action is being performed. + 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 + opc-work-request-id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Multiple OCID values are returned in a comma-separated list. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with a work request OCID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/VmCluster' + application-json: + examples: + response: + value: | + { + "displayName" : "vmCluster", + "compartmentId" : "ocid1.tenancy.oc1.", + "timeCreated" : "2018-11-22T19:25:42.755Z", + "cpusEnabled" : 10, + "memorySizeInGBs" : 50, + "dbNodeStorageSizeInGBs" : 60, + "dataStorageSizeInTBs" : 84, + "lastPatchHistoryEntryId": "ocid1.dbpatchhistory.oc1.phx.", + "licenseModel" : "LICENSE_INCLUDED", + "isSparseDiskgroupEnabled" : false, + "isLocalBackupEnabled" : true, + "timeZone" : "PST", + "shape" : "Exadata.Full2.336", + "lifecycleState" : "AVAILABLE", + "id" : "ocid1.vmcluster.oc1.", + "lifecycleDetails" : "No additional details.", + "sshPublicKeys" : [ "ssh-rsa name@example.com" ], + "exadataInfrastructureId" : "ocid1.tenancy.oc1.", + "vmClusterNetworkId" : "ocid1.vmclusternetwork.oc1.", + "giVersion" : "19.0.0.1" + } + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: RemoveVirtualMachineFromVmCluster + tags: + - database + x-example: | + POST /20160918/vmClusters/<vmClusterId>/actions/removeVirtualMachine + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "dbServers" : [ + { + "dbServerId" : "ocid1.dbserver.oc1." + }, + { + "dbServerId" : "ocid1.dbserver.oc1." + } + ] + } + x-related-resource: '#/definitions/VmCluster' + /vmClusters/{vmClusterId}/patchHistoryEntries: + get: + description: | + Gets the history of the patch actions performed on the specified VM cluster in an Exadata Cloud@Customer system. + operationId: ListVmClusterPatchHistoryEntries + parameters: + - $ref: '#/components/parameters/VmClusterIdPathParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + responses: + '200': + description: The patch history for the specified VM cluster. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListVmClusterPatchHistoryEntriesResponse' + application-json: + examples: + response: + value: | + [ + { + "action" : "APPLY", + "patchId" : "ocid1.dbpatch.oc1.phx.", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "lifecycleState" : "IN_PROGRESS", + "lifecycleDetails" : null, + "timeStarted" : "2017-01-01T07:07:07.007Z", + "timeEnded" : null + }, { + "action" : "APPLY", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "patchId" : "ocid1.dbpatch.oc1.phx.", + "lifecycleState" : "SUCCESS", + "lifecycleDetails" : "Completed successfully.", + "timeStarted" : "2016-12-21T01:59:07.032Z", + "timeEnded" : "2016-12-21T02:21:07.032Z" + }, { + "action" : "APPLY", + "patchId" : "ocid1.dbpatch.oc1.phx.", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "lifecycleState" : "FAILED", + "lifecycleDetails" : "Something failed that needs attention.", + "timeStarted" : "2016-11-20T01:23:45.6789Z", + "timeEnded" : "2016-11-20T01:23:45.6789Z" + } + ] + '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/DefaultError' + summary: ListVmClusterPatchHistoryEntries + tags: + - database + x-example: | + GET /20160918/vmClusters/<vmClusterId>/patchHistoryEntries?limit=100 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/PatchHistoryEntry' + /vmClusters/{vmClusterId}/patchHistoryEntries/{patchHistoryEntryId}: + get: + description: | + Gets the patch history details for the specified patch history entry. + operationId: GetVmClusterPatchHistoryEntry + parameters: + - $ref: '#/components/parameters/VmClusterIdPathParam' + - $ref: '#/components/parameters/PatchHistoryEntryIdPathParam' + responses: + '200': + description: The patch history details for the specified patch history entry. + 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/PatchHistoryEntry' + application-json: + examples: + response: + value: | + { + "action" : "APPLY", + "patchId" : "ocid1.dbpatch.oc1.phx.", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "lifecycleState" : "FAILED", + "lifecycleDetails" : "Something failed that needs attention.", + "timeStarted" : "2016-11-20T01:23:45.6789Z", + "timeEnded" : "2016-11-20T01:23:45.6789Z" + } + '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/DefaultError' + summary: GetVmClusterPatchHistoryEntry + tags: + - database + x-example: | + GET /20160918/patchHistoryEntries/<patchHistoryEntryId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/PatchHistoryEntry' + /vmClusters/{vmClusterId}/patches: + get: + description: | + Lists the patches applicable to the specified VM cluster in an Exadata Cloud@Customer system. + operationId: ListVmClusterPatches + parameters: + - $ref: '#/components/parameters/VmClusterIdPathParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + responses: + '200': + description: The list of the patches was retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListVmClusterPatchesResponse' + application-json: + examples: + response: + value: | + [ + { + "availableActions" : ["APPLY"], + "description" : "Patch PSU as released on 201611", + "id" : "ocid1.dbpatch.oc1.phx.", + "lastAction" : "APPLY", + "lifecycleDetails" : "A failure message that can be displayed to the user", + "lifecycleState" : "FAILED", + "timeReleased" : "2017-02-16T01:50:07.0001", + "type" : "BUNDLE", + "version" : "20170127" + }, + { + "availableActions" : ["APPLY"], + "description" : "Patch PSU as released on 20170127", + "id" : "ocid1.dbpatch.oc1.phx.", + "lastAction" : null, + "lifecycleDetails" : null, + "lifecycleState" : "AVAILABLE", + "timeReleased" : "2017-02-17T09:20:01.0007", + "type" : "BUNDLE", + "version" : "20170127" + } + ] + '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/DefaultError' + summary: ListVmClusterPatches + tags: + - database + x-example: | + GET /20160918/vmclusters/<vmClusterId>/patches?limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Patch' + /vmClusters/{vmClusterId}/patches/{patchId}: + get: + description: | + Gets information about a specified patch package. + operationId: GetVmClusterPatch + parameters: + - $ref: '#/components/parameters/VmClusterIdPathParam' + - $ref: '#/components/parameters/PatchIdPathParam' + responses: + '200': + description: The patch package. + 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/Patch' + application-json: + examples: + response: + value: | + { + "description" : "Patch PSU as released on 20170127", + "id" : "ocid1.dbpatch.oc1.phx.", + "name" : "DbSystem 20170127", + "timeReleased" : "2017-01-16T01:50:07.0001Z", + "type" : "BUNDLE", + "version" : "20170127" + } + '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/DefaultError' + summary: GetVmClusterPatch + tags: + - database + x-example: | + GET /20160918/vmClusters/<vmClusterId>/patches/<patchId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Patch' + /vmClusters/{vmClusterId}/updateHistoryEntries: + get: + description: | + Gets the history of the maintenance update actions performed on the specified VM cluster. Applies to Exadata Cloud@Customer instances only. + operationId: ListVmClusterUpdateHistoryEntries + parameters: + - $ref: '#/components/parameters/VmClusterIdPathParam' + - $ref: '#/components/parameters/FilterByVmClusterUpdateTypeQueryParam' + - $ref: '#/components/parameters/ListVmClusterUpdateHistoryEntriesFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The maintenance update history for the specified VM cluster. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListVmClusterUpdateHistoryEntriesResponse' + application-json: + examples: + response: + value: | + [ + { + "updateAction" : "ROLLING_APPLY", + "updateId" : "ocid1.dbpatch.oc1.phx.", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "lifecycleState" : "IN_PROGRESS", + "lifecycleDetails" : null, + "timeStarted" : "2017-01-01T07:07:07.007Z", + "timeCompleted" : null + }, { + "updateAction" : "ROLLING_APPLY", + "updateId" : "ocid1.dbpatch.oc1.phx.", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "lifecycleState" : "SUCCESS", + "lifecycleDetails" : "Completed successfully.", + "timeStarted" : "2016-12-21T01:59:07.032Z", + "timeCompleted" : "2016-12-21T02:21:07.032Z" + }, { + "updateAction" : "ROLLING_APPLY", + "updateId" : "ocid1.dbpatch.oc1.phx.", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "lifecycleState" : "FAILED", + "lifecycleDetails" : "Something failed that needs attention.", + "timeStarted" : "2016-11-20T01:23:45.6789Z", + "timeCompleted" : "2016-11-20T01:23:45.6789Z" + } + ] + '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/DefaultError' + summary: ListVmClusterUpdateHistoryEntries + tags: + - database + x-example: | + GET /20160918/vmClusters/<vmClusterId>/updateHistoryEntries?limit=100 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/VmClusterUpdateHistoryEntry' + /vmClusters/{vmClusterId}/updateHistoryEntries/{updateHistoryEntryId}: + get: + description: | + Gets the maintenance update history details for the specified update history entry. Applies to Exadata Cloud@Customer instances only. + operationId: GetVmClusterUpdateHistoryEntry + parameters: + - $ref: '#/components/parameters/VmClusterIdPathParam' + - $ref: '#/components/parameters/UpdateHistoryEntryIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The maintenance update history details for the specified update history entry. + 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/VmClusterUpdateHistoryEntry' + application-json: + examples: + response: + value: | + { + "updateAction" : "ROLLING_APPLY", + "updateId" : "ocid1.dbpatch.oc1.phx.", + "id" : "ocid1.dbpatchhistory.oc1.phx.", + "lifecycleState" : "FAILED", + "lifecycleDetails" : "Something failed that needs attention.", + "timeStarted" : "2016-11-20T01:23:45.6789Z", + "timeCompleted" : "2016-11-20T01:23:45.6789Z" + } + '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/DefaultError' + summary: GetVmClusterUpdateHistoryEntry + tags: + - database + x-example: | + GET /20160918/vmClusters/<vmClusterId>/updateHistoryEntries/<updateHistoryEntryId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/VmClusterUpdateHistoryEntry' + /vmClusters/{vmClusterId}/updates: + get: + description: | + Lists the maintenance updates that can be applied to the specified VM cluster. Applies to Exadata Cloud@Customer instances only. + operationId: ListVmClusterUpdates + parameters: + - $ref: '#/components/parameters/VmClusterIdPathParam' + - $ref: '#/components/parameters/FilterByVmClusterUpdateTypeQueryParam' + - $ref: '#/components/parameters/ListVmClusterUpdatesFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/PaginationLimitParam' + - $ref: '#/components/parameters/PaginationToken' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: A list of the maintenance update packages. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListVmClusterUpdatesResponse' + application-json: + examples: + response: + value: | + [ + { + "availableActions" : ["ROLLING_APPLY"], + "description" : "Update PSU as released on 201611", + "id" : "ocid1.dbpatch.oc1.phx.", + "lastAction" : "ROLLING_APPLY", + "lifecycleDetails" : "A failure message that can be displayed to the user", + "lifecycleState" : "FAILED", + "timeReleased" : "2017-02-16T01:50:07.0001", + "type" : "GI_PATCH", + "version" : "20170127" + }, + { + "availableActions" : ["ROLLING_APPLY"], + "description" : "GI binaries for upgrade as released on 20170127", + "id" : "ocid1.dbupdate.oc1.phx.", + "lastAction" : null, + "lifecycleDetails" : null, + "lifecycleState" : "AVAILABLE", + "timeReleased" : "2017-02-17T09:20:01.0007", + "type" : "GI_UPGRADE", + "version" : "20170127" + } + ] + '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/DefaultError' + summary: ListVmClusterUpdates + tags: + - database + x-example: | + GET /20160918/vmclusters/<vmClusterId>/updates?limit=10 + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/VmClusterUpdate' + /vmClusters/{vmClusterId}/updates/{updateId}: + get: + description: | + Gets information about a specified maintenance update package for a VM cluster. Applies to Exadata Cloud@Customer instances only. + operationId: GetVmClusterUpdate + parameters: + - $ref: '#/components/parameters/VmClusterIdPathParam' + - $ref: '#/components/parameters/UpdateIdPathParam' + - $ref: '#/components/parameters/OptionalRequestId' + responses: + '200': + description: The maintenance update package. + 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/VmClusterUpdate' + application-json: + examples: + response: + value: | + { + "description" : "Update PSU as released on 20170127", + "id" : "ocid1.dbpatch.oc1.phx.", + "name" : "Name20170127", + "timeReleased" : "2017-01-16T01:50:07.0001Z", + "type" : "GI_PATCH", + "version" : "20170127" + } + '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/DefaultError' + summary: GetVmClusterUpdate + tags: + - database + x-example: | + GET /20160918/vmClusters/<vmClusterId>/updates/<updateId> + Host: database.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/VmClusterUpdate' +components: + schemas: + ApplicationVipSummary: + description: | + Details of an application virtual IP (VIP) address. + properties: + cloudVmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud VM cluster associated with the application virtual IP (VIP) address. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + hostnameLabel: + description: The hostname of the application virtual IP (VIP) address. + maxLength: 63 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the application virtual IP (VIP) address. + maxLength: 255 + minLength: 1 + type: string + ipAddress: + description: The application virtual IP (VIP) address. + maxLength: 32 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state of the application virtual IP (VIP) address. + type: string + lifecycleState: + description: The current lifecycle state of the application virtual IP (VIP) address. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + - FAILED + type: string + subnetId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet associated with the application virtual IP (VIP) address. + maxLength: 255 + minLength: 1 + type: string + timeAssigned: + description: The date and time when the create operation for the application virtual IP (VIP) address completed. + format: date-time + type: string + required: + - id + - cloudVmClusterId + - hostnameLabel + - lifecycleState + - timeAssigned + type: object + CreateApplicationVipDetails: + description: | + Details to create an application virtual IP (VIP) address on a cloud VM cluster. + properties: + cloudVmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud VM cluster associated with the application virtual IP (VIP) address. + maxLength: 255 + minLength: 1 + type: string + dbNodeId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB node associated with the application virtual IP (VIP) address. + maxLength: 255 + minLength: 1 + type: string + hostnameLabel: + description: The hostname of the application virtual IP (VIP) address. + maxLength: 63 + minLength: 1 + type: string + ipAddress: + description: The application virtual IP (VIP) address. + maxLength: 32 + minLength: 1 + type: string + subnetId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet associated with the application virtual IP (VIP) address. + maxLength: 255 + minLength: 1 + type: string + required: + - hostnameLabel + - cloudVmClusterId + type: object + ApplicationVip: + description: Details of an application virtual IP (VIP) address. + properties: + cloudVmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud VM cluster associated with the application virtual IP (VIP) address. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + hostnameLabel: + description: The hostname of the application virtual IP (VIP) address. + maxLength: 63 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the application virtual IP (VIP) address. + maxLength: 255 + minLength: 1 + type: string + ipAddress: + description: The application virtual IP (VIP) address. + maxLength: 32 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state of the application virtual IP (VIP) address. + type: string + lifecycleState: + description: The current lifecycle state of the application virtual IP (VIP) address. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + - FAILED + type: string + subnetId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet associated with the application virtual IP (VIP) address. + maxLength: 255 + minLength: 1 + type: string + timeAssigned: + description: The date and time when the create operation for the application virtual IP (VIP) address completed. + format: date-time + type: string + required: + - id + - cloudVmClusterId + - hostnameLabel + - lifecycleState + - timeAssigned + type: object + AutonomousContainerDatabaseBackupCollection: + description: A list of all of the Autonomous Container Database Backups in the specified compartment. + properties: + items: + description: List of Autonomous container database backups. + items: + $ref: '#/components/schemas/AutonomousContainerDatabaseBackupSummary' + type: array + required: + - items + type: object + AutonomousContainerDatabaseVersionSummary: + description: | + The supported Autonomous AI Database version. + properties: + details: + description: A URL that points to a detailed description of the Autonomous Container Database version. + type: string + supportedApps: + description: The list of applications supported for the given version. + items: + $ref: '#/components/schemas/AppVersionSummary' + type: array + version: + description: A valid Oracle AI Database version for provisioning an Autonomous Container Database. + maxLength: 32 + minLength: 1 + type: string + required: + - version + - supportedApps + x-example: | + { + "version" : "19.19.1.0.1", + "supportedApps" : + [ + { + "releaseDate": "2022-09-23 06:24:34 +00:00", + "endOfSupport": "2023-09-23 06:24:34 +00:00", + "supportedAppName" : "ADBD_EBS", + "isCertified": true + }, + { + "releaseDate": "2022-08-02 06:24:34 +00:00", + "endOfSupport": "2023-08-02 06:24:34 +00:00", + "supportedAppName" : "ADBD_GENERIC", + "isCertified": true + } + ] + } + type: object + AutonomousContainerDatabaseSummary: + description: | + An Autonomous Container Database is a container database service that enables the customer to host one or more databases within the container database. A basic container database runs on a single Autonomous Exadata Infrastructure from an availability domain without the Extreme Availability features enabled. + properties: + associatedBackupConfigurationDetails: + description: A backup config object holds information about preferred backup destinations only. This object holds information about the associated backup destinations, such as secondary backup destinations created for local backups or remote replicated backups. + items: + $ref: '#/components/schemas/BackupDestinationConfigurationSummary' + type: array + autonomousExadataInfrastructureId: + description: | + **No longer used.** For Autonomous AI Database on dedicated Exadata infrastructure, the container database is created within a specified `cloudAutonomousVmCluster`. + maxLength: 255 + minLength: 1 + type: string + autonomousVmClusterId: + description: The OCID of the Autonomous VM Cluster. + maxLength: 255 + minLength: 1 + type: string + availabilityDomain: + description: The availability domain of the Autonomous Container Database. + maxLength: 255 + minLength: 1 + type: string + availableCpus: + description: | + Sum of CPUs available on the Autonomous VM Cluster + Sum of reclaimable CPUs available in the Autonomous Container Database. + format: float + type: number + backupConfig: + $ref: '#/components/schemas/AutonomousContainerDatabaseBackupConfig' + backupDestinationPropertiesList: + description: This list describes the backup destination properties associated with the Autonomous Container Database (ACD) 's preferred backup destination. The object at a given index is associated with the destination present at the same index in the backup destination details list of the ACD Backup Configuration. + items: + $ref: '#/components/schemas/BackupDestinationProperties' + type: array + cloudAutonomousVmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Autonomous Exadata VM Cluster. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeModel: + description: | + The compute model of the Autonomous Container Database. For Autonomous AI Database on Dedicated Exadata Infrastructure, the CPU type (ECPUs or OCPUs) is determined by the parent Autonomous Exadata VM Cluster's compute model. ECPU compute model is the recommended model and OCPU compute model is legacy. See [Compute Models in Autonomous AI Database on Dedicated Exadata Infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbak) for more details. + enum: + - ECPU + - OCPU + type: string + customerContacts: + description: | + Customer Contacts. Setting this to an empty list removes all customer contacts. + items: + $ref: '#/components/schemas/CustomerContact' + type: array + dataguard: + $ref: '#/components/schemas/AutonomousContainerDatabaseDataguard' + dataguardGroupMembers: + description: Array of Dg associations. + items: + $ref: '#/components/schemas/AutonomousContainerDatabaseDataguard' + type: array + dbName: + description: The Database name for the Autonomous Container Database. The name must be unique within the Cloud Autonomous VM Cluster, starting with an alphabetic character, followed by 1 to 7 alphanumeric characters. + maxLength: 8 + minLength: 2 + type: string + dbSplitThreshold: + description: The CPU value beyond which an Autonomous AI Database will be opened across multiple nodes. The default value of this attribute is 16 for OCPUs and 64 for ECPUs. + type: integer + dbUniqueName: + description: | + **Deprecated.** The `DB_UNIQUE_NAME` value is set by Oracle Cloud Infrastructure. Do not specify a value for this parameter. Specifying a value for this field will cause Terraform operations to fail. + maxLength: 32 + minLength: 1 + type: string + dbVersion: + description: Oracle AI Database version of the Autonomous Container Database. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-provided name for the Autonomous Container Database. + maxLength: 255 + minLength: 1 + type: string + distributionAffinity: + description: Determines whether an Autonomous AI Database must be opened across the maximum number of nodes or the least number of nodes. By default, Minimum nodes is selected. + enum: + - MINIMUM_DISTRIBUTION + - MAXIMUM_DISTRIBUTION + type: string + dstFileVersion: + description: DST Time-Zone File version of the Autonomous Container Database. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the Autonomous Container Database. + maxLength: 255 + minLength: 1 + type: string + infrastructureType: + description: The infrastructure type this resource belongs to. + enum: + - CLOUD + - CLOUD_AT_CUSTOMER + type: string + isDataGuardEnabled: + description: | + **Deprecated.** Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. + type: boolean + isDstFileUpdateEnabled: + description: Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner. + type: boolean + isMultipleStandby: + description: | + Indicates if it is multiple standby Autonomous Dataguard + type: boolean + keyHistoryEntry: + description: Key History Entry. + items: + $ref: '#/components/schemas/AutonomousDatabaseKeyHistoryEntry' + type: array + keyStoreId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. + maxLength: 255 + minLength: 1 + type: string + keyStoreWalletName: + description: The wallet name for Oracle Key Vault. + maxLength: 255 + minLength: 1 + type: string + kmsKeyId: + description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. + maxLength: 255 + minLength: 1 + type: string + kmsKeyVersionId: + description: | + The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. + maxLength: 255 + minLength: 1 + type: string + largestProvisionableAutonomousDatabaseInCpus: + description: The largest Autonomous AI Database (CPU) that can be created in a new Autonomous Container Database. + format: float + type: number + lastMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the Autonomous Container Database. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - BACKUP_IN_PROGRESS + - RESTORING + - RESTORE_FAILED + - RESTARTING + - MAINTENANCE_IN_PROGRESS + - ROLE_CHANGE_IN_PROGRESS + - ENABLING_AUTONOMOUS_DATA_GUARD + - UNAVAILABLE + type: string + listOneOffPatches: + description: List of One-Off patches that has been successfully applied to Autonomous Container Database + items: + type: string + type: array + maintenanceWindow: + $ref: '#/components/schemas/MaintenanceWindow' + memoryPerOracleComputeUnitInGBs: + description: | + The amount of memory (in GBs) enabled per ECPU or OCPU in the Autonomous VM Cluster. + type: integer + netServicesArchitecture: + default: DEDICATED + description: Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users. + enum: + - DEDICATED + - SHARED + - DRCP + type: string + nextMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run. + maxLength: 255 + minLength: 1 + type: string + okvEndPointGroupName: + description: | + The OKV End Point Group name for the Autonomous Container Database. + maxLength: 128 + minLength: 1 + type: string + patchId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last patch applied on the system. + maxLength: 255 + minLength: 1 + type: string + patchModel: + description: Database patch model preference. + enum: + - RELEASE_UPDATES + - RELEASE_UPDATE_REVISIONS + type: string + provisionableCpus: + description: | + An array of CPU values that can be used to successfully provision a single Autonomous AI Database. + items: + format: float + type: number + type: array + provisionedCpus: + description: The number of CPUs provisioned in an Autonomous Container Database. + format: float + type: number + reclaimableCpus: + description: | + CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous AI Database is terminated or scaled down. You can release them to the available CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database. + format: float + type: number + recoveryApplianceDetails: + $ref: '#/components/schemas/RecoveryApplianceDetails' + reservedCpus: + description: The number of CPUs reserved in an Autonomous Container Database. + format: float + type: number + role: + description: | + The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. + enum: + - PRIMARY + - STANDBY + - DISABLED_STANDBY + - BACKUP_COPY + - SNAPSHOT_STANDBY + type: string + serviceLevelAgreementType: + description: The service level agreement type of the container database. The default is STANDARD. + enum: + - STANDARD + - MISSION_CRITICAL + - AUTONOMOUS_DATAGUARD + type: string + standbyMaintenanceBufferInDays: + description: | + The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. + This value represents the number of days before scheduled maintenance of the primary database. + maximum: 7 + minimum: 1 + type: integer + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the Autonomous Container Database was created. + format: date-time + type: string + timeOfLastBackup: + description: The timestamp of last successful backup. Here NULL value represents either there are no successful backups or backups are not configured for this Autonomous Container Database. + format: date-time + type: string + timeSnapshotStandbyRevert: + description: The date and time the Autonomous Container Database will be reverted to Standby from Snapshot Standby. + format: date-time + type: string + totalCpus: + description: | + The number of CPUs allocated to the Autonomous VM cluster. + type: integer + vaultId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. + maxLength: 255 + minLength: 1 + type: string + versionPreference: + default: NEXT_RELEASE_UPDATE + description: | + The next maintenance version preference. + enum: + - NEXT_RELEASE_UPDATE + - LATEST_RELEASE_UPDATE + type: string + vmFailoverReservation: + description: The percentage of CPUs reserved across nodes to support node failover. Allowed values are 0%, 25%, 50%, 75%, and 100%, with 50% being the default option. + type: integer + required: + - id + - compartmentId + - lifecycleState + - displayName + - serviceLevelAgreementType + - patchModel + type: object + CreateAutonomousContainerDatabaseBase: + description: | + Describes the required parameters for the creation of an Autonomous Container Database. + discriminator: + propertyName: source + properties: + autonomousExadataInfrastructureId: + description: | + **No longer used.** This parameter is no longer used for Autonomous AI Database on dedicated Exadata infrasture. Specify a `cloudAutonomousVmClusterId` instead. Using this parameter will cause the operation to fail. + maxLength: 255 + minLength: 1 + type: string + autonomousVmClusterId: + description: The OCID of the Autonomous VM Cluster. + maxLength: 255 + minLength: 1 + type: string + backupConfig: + $ref: '#/components/schemas/AutonomousContainerDatabaseBackupConfig' + cloudAutonomousVmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Autonomous Exadata VM Cluster. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Autonomous Container Database. + maxLength: 255 + minLength: 1 + type: string + customerContacts: + description: | + Customer Contacts. Setting this to an empty list removes all customer contacts. + items: + $ref: '#/components/schemas/CustomerContact' + type: array + databaseSoftwareImageId: + description: The Autonomous AI Database Software Image [OCID](/Content/General/Concepts/identifiers.htm). + maxLength: 255 + minLength: 1 + type: string + dbName: + description: The Database name for the Autonomous Container Database. The name must be unique within the Cloud Autonomous VM Cluster, starting with an alphabetic character, followed by 1 to 7 alphanumeric characters. + maxLength: 8 + minLength: 2 + type: string + dbSplitThreshold: + description: The CPU value beyond which an Autonomous AI Database will be opened across multiple nodes. The default value of this attribute is 16 for OCPUs and 64 for ECPUs. + minimum: 1 + type: integer + dbUniqueName: + description: | + **Deprecated.** The `DB_UNIQUE_NAME` value is set by Oracle Cloud Infrastructure. Do not specify a value for this parameter. Specifying a value for this field will cause Terraform operations to fail. + maxLength: 32 + minLength: 1 + type: string + dbVersion: + description: The base version for the Autonomous Container Database. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The display name for the Autonomous Container Database. + maxLength: 255 + minLength: 1 + type: string + distributionAffinity: + description: Determines whether an Autonomous AI Database must be opened across a minimum or maximum of nodes. By default, Minimum nodes is selected. + enum: + - MINIMUM_DISTRIBUTION + - MAXIMUM_DISTRIBUTION + type: string + fastStartFailOverLagLimitInSeconds: + description: The lag time for my preference based on data loss tolerance in seconds. + maximum: 3600 + minimum: 5 + type: integer + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + isAutomaticFailoverEnabled: + description: | + Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association + type: boolean + isDstFileUpdateEnabled: + description: Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner. + type: boolean + keyStoreId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. + maxLength: 255 + minLength: 1 + type: string + kmsKeyId: + description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. + maxLength: 255 + minLength: 1 + type: string + kmsKeyVersionId: + description: | + The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. + maxLength: 255 + minLength: 1 + type: string + maintenanceWindowDetails: + $ref: '#/components/schemas/MaintenanceWindow' + netServicesArchitecture: + default: DEDICATED + description: Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users. + enum: + - DEDICATED + - SHARED + - DRCP + type: string + okvEndPointGroupName: + description: | + The OKV End Point Group name for the Autonomous Container Database. + maxLength: 128 + minLength: 1 + type: string + patchModel: + description: Database Patch model preference. + enum: + - RELEASE_UPDATES + - RELEASE_UPDATE_REVISIONS + type: string + peerAutonomousContainerDatabaseBackupConfig: + $ref: '#/components/schemas/PeerAutonomousContainerDatabaseBackupConfig' + peerAutonomousContainerDatabaseCompartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the standby Autonomous Container Database + will be created. + maxLength: 255 + minLength: 1 + type: string + peerAutonomousContainerDatabaseDisplayName: + description: The display name for the peer Autonomous Container Database. + maxLength: 255 + minLength: 1 + type: string + peerAutonomousExadataInfrastructureId: + description: | + *No longer used.* This parameter is no longer used for Autonomous AI Database on dedicated Exadata infrasture. Specify a `peerCloudAutonomousVmClusterId` instead. Using this parameter will cause the operation to fail. + maxLength: 255 + minLength: 1 + type: string + peerAutonomousVmClusterId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the peer Autonomous VM cluster for Autonomous Data Guard. Required to enable Data Guard. + maxLength: 255 + minLength: 1 + type: string + peerCloudAutonomousVmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the peer cloud Autonomous Exadata VM Cluster. + maxLength: 255 + minLength: 1 + type: string + peerDbUniqueName: + description: | + **Deprecated.** The `DB_UNIQUE_NAME` of the peer Autonomous Container Database in a Data Guard association is set by Oracle Cloud Infrastructure. Do not specify a value for this parameter. Specifying a value for this field will cause Terraform operations to fail. + maxLength: 32 + minLength: 1 + type: string + x-default-description: This field will have a value if the Autonomous Container Database is Data Guard enabled. The value will be dynamically generated if it is null. + protectionMode: + description: | + The protection mode of this Autonomous Data Guard association. For more information, see + [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) + in the Oracle Data Guard documentation. + enum: + - MAXIMUM_AVAILABILITY + - MAXIMUM_PERFORMANCE + type: string + serviceLevelAgreementType: + description: The service level agreement type of the Autonomous Container Database. The default is STANDARD. For an autonomous dataguard Autonomous Container Database, the specified Autonomous Exadata Infrastructure must be associated with a remote Autonomous Exadata Infrastructure. + enum: + - STANDARD + - AUTONOMOUS_DATAGUARD + type: string + source: + default: NONE + description: | + The source of the database. Use `NONE` to create a new Autonomous Container Database (ACD). Use `BACKUP_FROM_ID` to create a new ACD from a specified backup. + enum: + - NONE + - BACKUP_FROM_ID + type: string + standbyMaintenanceBufferInDays: + description: | + The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. + This value represents the number of days before scheduled maintenance of the primary database. + maximum: 7 + minimum: 1 + type: integer + vaultId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. + maxLength: 255 + minLength: 1 + type: string + versionPreference: + default: NEXT_RELEASE_UPDATE + description: | + The next maintenance version preference. + enum: + - NEXT_RELEASE_UPDATE + - LATEST_RELEASE_UPDATE + type: string + vmFailoverReservation: + default: 50 + description: The percentage of CPUs reserved across nodes to support node failover. Allowed values are 0%, 25%, 50%, 75%, and 100%, with 50% being the default option. + type: integer + required: + - displayName + - patchModel + type: object + AutonomousContainerDatabase: + description: | + An Autonomous Container Database is a container database service that enables the customer to host one or more databases within the container database. A basic container database runs on a single Autonomous Exadata Infrastructure from an availability domain without the Extreme Availability features enabled. + properties: + associatedBackupConfigurationDetails: + description: A backup config object holds information about preferred backup destinations only. This object holds information about the associated backup destinations, such as secondary backup destinations created for local backups or remote replicated backups. + items: + $ref: '#/components/schemas/BackupDestinationConfigurationSummary' + type: array + autonomousExadataInfrastructureId: + description: | + **No longer used.** For Autonomous AI Database on dedicated Exadata infrastructure, the container database is created within a specified `cloudAutonomousVmCluster`. + maxLength: 255 + minLength: 1 + type: string + autonomousVmClusterId: + description: The OCID of the Autonomous VM Cluster. + maxLength: 255 + minLength: 1 + type: string + availabilityDomain: + description: The availability domain of the Autonomous Container Database. + maxLength: 255 + minLength: 1 + type: string + availableCpus: + description: | + Sum of CPUs available on the Autonomous VM Cluster + Sum of reclaimable CPUs available in the Autonomous Container Database. + format: float + type: number + backupConfig: + $ref: '#/components/schemas/AutonomousContainerDatabaseBackupConfig' + backupDestinationPropertiesList: + description: This list describes the backup destination properties associated with the Autonomous Container Database (ACD) 's preferred backup destination. The object at a given index is associated with the destination present at the same index in the backup destination details list of the ACD Backup Configuration. + items: + $ref: '#/components/schemas/BackupDestinationProperties' + type: array + cloudAutonomousVmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Autonomous Exadata VM Cluster. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeModel: + description: | + The compute model of the Autonomous Container Database. For Autonomous AI Database on Dedicated Exadata Infrastructure, the CPU type (ECPUs or OCPUs) is determined by the parent Autonomous Exadata VM Cluster's compute model. ECPU compute model is the recommended model and OCPU compute model is legacy. See [Compute Models in Autonomous AI Database on Dedicated Exadata Infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbak) for more details. + enum: + - ECPU + - OCPU + type: string + customerContacts: + description: | + Customer Contacts. Setting this to an empty list removes all customer contacts. + items: + $ref: '#/components/schemas/CustomerContact' + type: array + dataguard: + $ref: '#/components/schemas/AutonomousContainerDatabaseDataguard' + dataguardGroupMembers: + description: Array of Dg associations. + items: + $ref: '#/components/schemas/AutonomousContainerDatabaseDataguard' + type: array + dbName: + description: The Database name for the Autonomous Container Database. The name must be unique within the Cloud Autonomous VM Cluster, starting with an alphabetic character, followed by 1 to 7 alphanumeric characters. + maxLength: 8 + minLength: 2 + type: string + dbSplitThreshold: + description: The CPU value beyond which an Autonomous AI Database will be opened across multiple nodes. The default value of this attribute is 16 for OCPUs and 64 for ECPUs. + type: integer + dbUniqueName: + description: | + **Deprecated.** The `DB_UNIQUE_NAME` value is set by Oracle Cloud Infrastructure. Do not specify a value for this parameter. Specifying a value for this field will cause Terraform operations to fail. + maxLength: 32 + minLength: 1 + type: string + dbVersion: + description: Oracle AI Database version of the Autonomous Container Database. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-provided name for the Autonomous Container Database. + maxLength: 255 + minLength: 1 + type: string + distributionAffinity: + description: Determines whether an Autonomous AI Database must be opened across the maximum number of nodes or the least number of nodes. By default, Minimum nodes is selected. + enum: + - MINIMUM_DISTRIBUTION + - MAXIMUM_DISTRIBUTION + type: string + dstFileVersion: + description: DST Time-Zone File version of the Autonomous Container Database. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the Autonomous Container Database. + maxLength: 255 + minLength: 1 + type: string + infrastructureType: + description: The infrastructure type this resource belongs to. + enum: + - CLOUD + - CLOUD_AT_CUSTOMER + type: string + isDataGuardEnabled: + description: | + **Deprecated.** Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. + type: boolean + isDstFileUpdateEnabled: + description: Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner. + type: boolean + isMultipleStandby: + description: | + Indicates if it is multiple standby Autonomous Dataguard + type: boolean + keyHistoryEntry: + description: Key History Entry. + items: + $ref: '#/components/schemas/AutonomousDatabaseKeyHistoryEntry' + type: array + keyStoreId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. + maxLength: 255 + minLength: 1 + type: string + keyStoreWalletName: + description: The wallet name for Oracle Key Vault. + maxLength: 255 + minLength: 1 + type: string + kmsKeyId: + description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. + maxLength: 255 + minLength: 1 + type: string + kmsKeyVersionId: + description: | + The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. + maxLength: 255 + minLength: 1 + type: string + largestProvisionableAutonomousDatabaseInCpus: + description: The largest Autonomous AI Database (CPU) that can be created in a new Autonomous Container Database. + format: float + type: number + lastMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the Autonomous Container Database. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - BACKUP_IN_PROGRESS + - RESTORING + - RESTORE_FAILED + - RESTARTING + - MAINTENANCE_IN_PROGRESS + - ROLE_CHANGE_IN_PROGRESS + - ENABLING_AUTONOMOUS_DATA_GUARD + - UNAVAILABLE + type: string + listOneOffPatches: + description: List of One-Off patches that has been successfully applied to Autonomous Container Database + items: + type: string + type: array + maintenanceWindow: + $ref: '#/components/schemas/MaintenanceWindow' + memoryPerOracleComputeUnitInGBs: + description: | + The amount of memory (in GBs) enabled per ECPU or OCPU in the Autonomous VM Cluster. + type: integer + netServicesArchitecture: + default: DEDICATED + description: Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users. + enum: + - DEDICATED + - SHARED + - DRCP + type: string + nextMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run. + maxLength: 255 + minLength: 1 + type: string + okvEndPointGroupName: + description: | + The OKV End Point Group name for the Autonomous Container Database. + maxLength: 128 + minLength: 1 + type: string + patchId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last patch applied on the system. + maxLength: 255 + minLength: 1 + type: string + patchModel: + description: Database patch model preference. + enum: + - RELEASE_UPDATES + - RELEASE_UPDATE_REVISIONS + type: string + provisionableCpus: + description: | + An array of CPU values that can be used to successfully provision a single Autonomous AI Database. + items: + format: float + type: number + type: array + provisionedCpus: + description: The number of CPUs provisioned in an Autonomous Container Database. + format: float + type: number + reclaimableCpus: + description: | + CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous AI Database is terminated or scaled down. You can release them to the available CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database. + format: float + type: number + recoveryApplianceDetails: + $ref: '#/components/schemas/RecoveryApplianceDetails' + reservedCpus: + description: The number of CPUs reserved in an Autonomous Container Database. + format: float + type: number + role: + description: | + The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. + enum: + - PRIMARY + - STANDBY + - DISABLED_STANDBY + - BACKUP_COPY + - SNAPSHOT_STANDBY + type: string + serviceLevelAgreementType: + description: The service level agreement type of the container database. The default is STANDARD. + enum: + - STANDARD + - MISSION_CRITICAL + - AUTONOMOUS_DATAGUARD + type: string + standbyMaintenanceBufferInDays: + description: | + The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. + This value represents the number of days before scheduled maintenance of the primary database. + maximum: 7 + minimum: 1 + type: integer + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the Autonomous Container Database was created. + format: date-time + type: string + timeOfLastBackup: + description: The timestamp of last successful backup. Here NULL value represents either there are no successful backups or backups are not configured for this Autonomous Container Database. + format: date-time + type: string + timeSnapshotStandbyRevert: + description: The date and time the Autonomous Container Database will be reverted to Standby from Snapshot Standby. + format: date-time + type: string + totalCpus: + description: | + The number of CPUs allocated to the Autonomous VM cluster. + type: integer + vaultId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. + maxLength: 255 + minLength: 1 + type: string + versionPreference: + default: NEXT_RELEASE_UPDATE + description: | + The next maintenance version preference. + enum: + - NEXT_RELEASE_UPDATE + - LATEST_RELEASE_UPDATE + type: string + vmFailoverReservation: + description: The percentage of CPUs reserved across nodes to support node failover. Allowed values are 0%, 25%, 50%, 75%, and 100%, with 50% being the default option. + type: integer + required: + - id + - compartmentId + - lifecycleState + - displayName + - serviceLevelAgreementType + - patchModel + type: object + UpdateAutonomousContainerDatabaseDetails: + description: | + Describes the modification parameters for the Autonomous Container Database. + properties: + backupConfig: + $ref: '#/components/schemas/AutonomousContainerDatabaseBackupConfig' + customerContacts: + description: | + Customer Contacts. Setting this to an empty list removes all customer contacts. + items: + $ref: '#/components/schemas/CustomerContact' + type: array + dbSplitThreshold: + description: The CPU value beyond which an Autonomous AI Database will be opened across multiple nodes. The default value of this attribute is 16 for OCPUs and 64 for ECPUs. + minimum: 1 + type: integer + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The display name for the Autonomous Container Database. + maxLength: 255 + minLength: 1 + type: string + distributionAffinity: + description: Determines whether an Autonomous AI Database must be opened across a minimum or maximum of nodes. By default, Minimum nodes is selected. + enum: + - MINIMUM_DISTRIBUTION + - MAXIMUM_DISTRIBUTION + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + isDstFileUpdateEnabled: + description: Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner. + type: boolean + maintenanceWindowDetails: + $ref: '#/components/schemas/MaintenanceWindow' + netServicesArchitecture: + default: DEDICATED + description: Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users. + enum: + - DEDICATED + - SHARED + - DRCP + type: string + okvEndPointGroupName: + description: | + The OKV End Point Group name for the Autonomous Container Database. + maxLength: 128 + minLength: 1 + type: string + patchModel: + description: Database Patch model preference. + enum: + - RELEASE_UPDATES + - RELEASE_UPDATE_REVISIONS + type: string + standbyMaintenanceBufferInDays: + description: | + The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. + This value represents the number of days before schedlued maintenance of the primary database. + maximum: 7 + minimum: 1 + type: integer + versionPreference: + default: NEXT_RELEASE_UPDATE + description: | + The next maintenance version preference. + enum: + - NEXT_RELEASE_UPDATE + - LATEST_RELEASE_UPDATE + type: string + vmFailoverReservation: + default: 50 + description: The percentage of CPUs reserved across nodes to support node failover. Allowed values are 0%, 25%, 50%, 75%, and 100%, with 50% being the default option. + type: integer + type: object + AddStandbyAutonomousContainerDatabaseDetails: + description: | + Create Standby Autonomous Container Database to an existing Autonomous Container Database + properties: + fastStartFailOverLagLimitInSeconds: + description: The lag time for my preference based on data loss tolerance in seconds. + maximum: 3600 + minimum: 5 + type: integer + isAutomaticFailoverEnabled: + description: | + Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association + type: boolean + peerAutonomousContainerDatabaseBackupConfig: + $ref: '#/components/schemas/PeerAutonomousContainerDatabaseBackupConfig' + peerAutonomousContainerDatabaseCompartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the standby Autonomous Container Database + will be created. + maxLength: 255 + minLength: 1 + type: string + peerAutonomousContainerDatabaseDisplayName: + description: The display name for the peer Autonomous Container Database. + maxLength: 255 + minLength: 1 + type: string + peerAutonomousVmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the peer Autonomous Exadata VM Cluster. + maxLength: 255 + minLength: 1 + type: string + peerCloudAutonomousVmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the peer cloud Autonomous Exadata VM Cluster. + maxLength: 255 + minLength: 1 + type: string + peerDbUniqueName: + description: | + Specifies the `DB_UNIQUE_NAME` of the peer database to be created. + maxLength: 32 + minLength: 1 + type: string + protectionMode: + description: | + The protection mode of this Autonomous Data Guard association. For more information, see + [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) + in the Oracle Data Guard documentation. + enum: + - MAXIMUM_AVAILABILITY + - MAXIMUM_PERFORMANCE + type: string + standbyMaintenanceBufferInDays: + description: | + The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. + This value represents the number of days before scheduled maintenance of the primary database. + maximum: 7 + minimum: 1 + type: integer + type: object + ChangeCompartmentDetails: + description: | + The configuration details for moving the resource. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the resource to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ChangeDataguardRoleDetails: + description: | + The configuration details for change Autonomous Container Database Dataguard role + properties: + autonomousContainerDatabaseDataguardAssociationId: + description: The Autonomous Container Database-Autonomous Data Guard association [OCID](/Content/General/Concepts/identifiers.htm). + maxLength: 255 + minLength: 1 + type: string + connectionStringsType: + description: type of connection strings when converting database to snapshot mode + enum: + - SNAPSHOT_SERVICES + - PRIMARY_SERVICES + type: string + role: + description: | + The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. + enum: + - PRIMARY + - STANDBY + - DISABLED_STANDBY + - BACKUP_COPY + - SNAPSHOT_STANDBY + type: string + required: + - role + - autonomousContainerDatabaseDataguardAssociationId + type: object + EditAutonomousContainerDatabaseDataguardDetails: + description: | + The configuration details for updating a Autonomous Container DatabaseData Guard for a Autonomous Container Database. + properties: + fastStartFailOverLagLimitInSeconds: + description: The lag time for my preference based on data loss tolerance in seconds. + maximum: 3600 + minimum: 5 + type: integer + isAutomaticFailoverEnabled: + description: | + Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association + type: boolean + protectionMode: + description: | + The protection mode of this Autonomous Data Guard association. For more information, see + [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) + in the Oracle Data Guard documentation. + enum: + - MAXIMUM_AVAILABILITY + - MAXIMUM_PERFORMANCE + type: string + type: object + RestartAutonomousContainerDatabaseDetails: + description: Request details to restart an Autonomous Container Database with force option. + properties: + isForceRestart: + description: If set to `true`, restarts the Autonomous Container Database with force option. + type: boolean + type: object + RotateAutonomousContainerDatabaseEncryptionKeyDetails: + description: Key details provided by the user for rotate key operation for Autonomous AI Database. + properties: + keyVersionId: + description: Key version ocid of the key provided by the user for rotate operation. [OCID](/Content/General/Concepts/identifiers.htm). + maxLength: 255 + minLength: 1 + type: string + type: object + ConvertStandbyAutonomousContainerDatabaseDetails: + description: | + The configuration details for change Autonomous Container Database Dataguard role + properties: + connectionStringsType: + description: type of connection strings when converting database to snapshot mode + enum: + - SNAPSHOT_SERVICES + - PRIMARY_SERVICES + type: string + role: + description: | + The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. + enum: + - PRIMARY + - STANDBY + - DISABLED_STANDBY + - BACKUP_COPY + - SNAPSHOT_STANDBY + type: string + required: + - role + type: object + AutonomousContainerDatabaseDataguardAssociation: + description: | + The properties that define Autonomous Data Guard association between two different Autonomous Container Databases. + properties: + applyLag: + description: | + The lag time between updates to the primary Autonomous Container Database and application of the redo data on the standby Autonomous Container Database, + as computed by the reporting database. + + Example: `9 seconds` + type: string + applyRate: + description: | + The rate at which redo logs are synchronized between the associated Autonomous Container Databases. + + Example: `180 Mb per second` + type: string + autonomousContainerDatabaseId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous Container Database that has a relationship with the peer Autonomous Container Database. Used only by Autonomous AI Database on Dedicated Exadata Infrastructure. + maxLength: 255 + minLength: 1 + type: string + fastStartFailOverLagLimitInSeconds: + description: The lag time for my preference based on data loss tolerance in seconds. + maximum: 3600 + minimum: 5 + type: integer + id: + description: The OCID of the Autonomous Data Guard created for a given Autonomous Container Database. + maxLength: 255 + minLength: 1 + type: string + isAutomaticFailoverEnabled: + description: | + Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association + type: boolean + lifecycleDetails: + description: | + Additional information about the current lifecycleState, if available. + type: string + lifecycleState: + description: The current state of Autonomous Data Guard. + enum: + - PROVISIONING + - AVAILABLE + - ROLE_CHANGE_IN_PROGRESS + - TERMINATING + - TERMINATED + - FAILED + - UNAVAILABLE + - UPDATING + type: string + peerAutonomousContainerDatabaseDataguardAssociationId: + description: The OCID of the peer Autonomous Container Database-Autonomous Data Guard association. + maxLength: 255 + minLength: 1 + type: string + peerAutonomousContainerDatabaseId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the peer Autonomous Container Database. + maxLength: 255 + minLength: 1 + type: string + peerLifecycleState: + description: The current state of the Autonomous Container Database. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - BACKUP_IN_PROGRESS + - RESTORING + - RESTORE_FAILED + - RESTARTING + - MAINTENANCE_IN_PROGRESS + - ROLE_CHANGE_IN_PROGRESS + - ENABLING_AUTONOMOUS_DATA_GUARD + - UNAVAILABLE + type: string + peerRole: + description: | + The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. + enum: + - PRIMARY + - STANDBY + - DISABLED_STANDBY + - BACKUP_COPY + - SNAPSHOT_STANDBY + type: string + protectionMode: + description: | + The protection mode of this Autonomous Data Guard association. For more information, see + [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) + in the Oracle Data Guard documentation. + enum: + - MAXIMUM_AVAILABILITY + - MAXIMUM_PERFORMANCE + type: string + role: + description: | + The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. + enum: + - PRIMARY + - STANDBY + - DISABLED_STANDBY + - BACKUP_COPY + - SNAPSHOT_STANDBY + type: string + timeCreated: + description: The date and time the Autonomous DataGuard association was created. + format: date-time + type: string + timeLastRoleChanged: + description: The date and time when the last role change action happened. + format: date-time + type: string + timeLastSynced: + description: The date and time of the last update to the apply lag, apply rate, and transport lag values. + format: date-time + type: string + transportLag: + description: | + The approximate number of seconds of redo data not yet available on the standby Autonomous Container Database, + as computed by the reporting database. + + Example: `7 seconds` + type: string + required: + - id + - lifecycleState + - autonomousContainerDatabaseId + - role + - peerRole + type: object + CreateAutonomousContainerDatabaseDataguardAssociationDetails: + description: | + Create Autonomous Dataguard Association to an existing Autonomous Container Database + properties: + fastStartFailOverLagLimitInSeconds: + description: The lag time for my preference based on data loss tolerance in seconds. + maximum: 3600 + minimum: 5 + type: integer + isAutomaticFailoverEnabled: + description: | + Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association + type: boolean + peerAutonomousContainerDatabaseBackupConfig: + $ref: '#/components/schemas/PeerAutonomousContainerDatabaseBackupConfig' + peerAutonomousContainerDatabaseCompartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the standby Autonomous Container Database + will be created. + maxLength: 255 + minLength: 1 + type: string + peerAutonomousContainerDatabaseDisplayName: + description: The display name for the peer Autonomous Container Database. + maxLength: 255 + minLength: 1 + type: string + peerAutonomousVmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the peer Autonomous Exadata VM Cluster. + maxLength: 255 + minLength: 1 + type: string + peerCloudAutonomousVmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the peer cloud Autonomous Exadata VM Cluster. + maxLength: 255 + minLength: 1 + type: string + peerDbUniqueName: + description: | + Specifies the `DB_UNIQUE_NAME` of the peer database to be created. + maxLength: 32 + minLength: 1 + type: string + protectionMode: + description: | + The protection mode of this Autonomous Data Guard association. For more information, see + [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) + in the Oracle Data Guard documentation. + enum: + - MAXIMUM_AVAILABILITY + - MAXIMUM_PERFORMANCE + type: string + standbyMaintenanceBufferInDays: + description: | + The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. + This value represents the number of days before scheduled maintenance of the primary database. + maximum: 7 + minimum: 1 + type: integer + required: + - peerAutonomousContainerDatabaseDisplayName + - protectionMode + type: object + UpdateAutonomousContainerDatabaseDataGuardAssociationDetails: + description: | + The configuration details for updating a Autonomous Container DatabaseData Guard association for a Autonomous Container Database. + properties: + fastStartFailOverLagLimitInSeconds: + description: The lag time for my preference based on data loss tolerance in seconds. + maximum: 3600 + minimum: 5 + type: integer + isAutomaticFailoverEnabled: + description: | + Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association + type: boolean + protectionMode: + description: | + The protection mode of this Autonomous Data Guard association. For more information, see + [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) + in the Oracle Data Guard documentation. + enum: + - MAXIMUM_AVAILABILITY + - MAXIMUM_PERFORMANCE + type: string + type: object + AutonomousPatchSummary: + description: | + A patch for an Autonomous Exadata Infrastructure or Autonomous Container Database. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + autonomousPatchType: + default: QUARTERLY + description: | + Maintenance run type, either "QUARTERLY" or "TIMEZONE". + enum: + - QUARTERLY + - TIMEZONE + type: string + description: + description: The text describing this patch package. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the patch. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: | + A descriptive text associated with the lifecycleState. + Typically can contain additional displayable text. + type: string + lifecycleState: + description: The current state of the patch as a result of lastAction. + enum: + - AVAILABLE + - SUCCESS + - IN_PROGRESS + - FAILED + type: string + patchModel: + description: Database patching model preference. See [My Oracle Support note 2285040.1](https://support.oracle.com/rs?type=doc&id=2285040.1) for information on the Release Update (RU) and Release Update Revision (RUR) patching models. + enum: + - RELEASE_UPDATES + - RELEASE_UPDATE_REVISIONS + type: string + quarter: + description: First month of the quarter in which the patch was released. + maxLength: 20 + minLength: 1 + type: string + timeReleased: + description: The date and time that the patch was released. + format: date-time + type: string + type: + description: The type of patch. BUNDLE is one example. + type: string + version: + description: The version of this patch package. + maxLength: 255 + minLength: 1 + type: string + year: + description: Year in which the patch was released. + maxLength: 10 + minLength: 1 + type: string + required: + - id + - description + - version + - timeReleased + - type + type: object + AutonomousContainerDatabaseResourceUsage: + description: Associated autonomous container databases usages. + properties: + autonomousContainerDatabaseVmUsage: + description: List of autonomous container database resource usage per autonomous virtual machine. + items: + $ref: '#/components/schemas/AcdAvmResourceStats' + maxItems: 1024 + type: array + availableCpus: + description: CPUs available for provisioning or scaling an Autonomous AI Database in the Autonomous Container Database. + format: float + type: number + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Autonomous Container Database. The name does not need to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous Container Database. + type: string + largestProvisionableAutonomousDatabaseInCpus: + description: Largest provisionable ADB in the Autonomous Container Database. + format: float + type: number + provisionableCpus: + description: Valid list of provisionable CPUs for Autonomous AI Database. + items: + format: float + type: number + type: array + provisionedCpus: + description: CPUs / cores assigned to ADBs in the Autonomous Container Database. + format: float + type: number + reclaimableCpus: + description: Number of CPUs that are reclaimable or released to the AVMC on Autonomous Container Database restart. + format: float + type: number + reservedCpus: + description: | + CPUs / cores reserved for scalability, resilliency and other overheads. + This includes failover, autoscaling and idle instance overhead. + format: float + type: number + usedCpus: + description: | + CPUs / cores assigned to the Autonomous Container Database. Sum of provisioned, + reserved and reclaimable CPUs/ cores. + format: float + type: number + required: + - displayName + type: object + AutonomousDatabaseBackupSummary: + description: | + An Autonomous AI Database backup. + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + autonomousDatabaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database. + maxLength: 255 + minLength: 1 + type: string + backupDestinationDetails: + $ref: '#/components/schemas/BackupDestinationDetails' + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + databaseSizeInTBs: + description: | + The size of the database in terabytes at the time the backup was taken. + format: integer + type: number + dbVersion: + description: | + A valid Oracle AI Database version for Autonomous AI Database. + When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai. + When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected. + For new databases, it is recommended to use either 19c or 26ai. + + **Note** Starting December 2026, 23ai will not be supported as a valid value for this parameter. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: The user-friendly name for the backup. The name does not have to be unique. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup. + maxLength: 255 + minLength: 1 + type: string + infrastructureType: + description: The infrastructure type this resource belongs to. + enum: + - CLOUD + - CLOUD_AT_CUSTOMER + type: string + isAutomatic: + description: Indicates whether the backup is user-initiated or automatic. + type: boolean + isRestorable: + default: true + description: Indicates whether the backup can be used to restore the associated Autonomous AI Database. + type: boolean + keyStoreId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. + maxLength: 255 + minLength: 1 + type: string + keyStoreWalletName: + description: The wallet name for Oracle Key Vault. + maxLength: 255 + minLength: 1 + type: string + kmsKeyId: + description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. + maxLength: 255 + minLength: 1 + type: string + kmsKeyVersionId: + description: | + The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the backup. + enum: + - CREATING + - ACTIVE + - DELETING + - DELETED + - FAILED + - UPDATING + type: string + region: + description: Name of the region in which backup is taken in. + maxLength: 50 + minLength: 1 + type: string + retentionPeriodInDays: + description: Retention period, in days, for long-term backups + maximum: 3650 + minimum: 90 + type: integer + sizeInTBs: + description: The backup size in terrabytes (TB). + format: double + type: number + sourceDatabaseDetails: + $ref: '#/components/schemas/SourceDatabaseDetails' + timeAvailableTill: + description: Timestamp until when the backup will be available + format: date-time + type: string + timeEnded: + description: The date and time the backup completed. + format: date-time + type: string + timeStarted: + description: The date and time the backup started. + format: date-time + type: string + type: + description: The type of backup. + enum: + - INCREMENTAL + - FULL + - LONGTERM + - VIRTUAL_FULL + - CUMULATIVE_INCREMENTAL + - ROLL_FORWARD_IMAGE_COPY + type: string + vaultId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - lifecycleState + - autonomousDatabaseId + - displayName + - type + - isAutomatic + type: object + CreateAutonomousDatabaseBackupDetails: + description: | + Details to create an Oracle Autonomous AI Database backup. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + autonomousDatabaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup. + maxLength: 255 + minLength: 1 + type: string + backupDestinationDetails: + $ref: '#/components/schemas/BackupDestinationDetails' + displayName: + description: The user-friendly name for the backup. The name does not have to be unique. + maxLength: 255 + minLength: 1 + type: string + isLongTermBackup: + description: Indicates whether the backup is long-term + type: boolean + retentionPeriodInDays: + description: Retention period, in days, for long-term backups + maximum: 3650 + minimum: 90 + type: integer + required: + - autonomousDatabaseId + type: object + AutonomousDatabaseBackup: + description: | + An Autonomous AI Database backup. + properties: + autonomousDatabaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database. + maxLength: 255 + minLength: 1 + type: string + backupDestinationDetails: + $ref: '#/components/schemas/BackupDestinationDetails' + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + databaseSizeInTBs: + description: | + The size of the database in terabytes at the time the backup was taken. + format: integer + type: number + dbVersion: + description: | + A valid Oracle AI Database version for Autonomous AI Database. + When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai. + When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected. + For new databases, it is recommended to use either 19c or 26ai. + + **Note** Starting December 2026, 23ai will not be supported as a valid value for this parameter. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: The user-friendly name for the backup. The name does not have to be unique. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup. + maxLength: 255 + minLength: 1 + type: string + infrastructureType: + description: The infrastructure type this resource belongs to. + enum: + - CLOUD + - CLOUD_AT_CUSTOMER + type: string + isAutomatic: + description: Indicates whether the backup is user-initiated or automatic. + type: boolean + isRestorable: + default: true + description: Indicates whether the backup can be used to restore the associated Autonomous AI Database. + type: boolean + keyStoreId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. + maxLength: 255 + minLength: 1 + type: string + keyStoreWalletName: + description: The wallet name for Oracle Key Vault. + maxLength: 255 + minLength: 1 + type: string + kmsKeyId: + description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. + maxLength: 255 + minLength: 1 + type: string + kmsKeyVersionId: + description: | + The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the backup. + enum: + - CREATING + - ACTIVE + - DELETING + - DELETED + - FAILED + - UPDATING + type: string + region: + description: Name of the region in which backup is taken in. + maxLength: 50 + minLength: 1 + type: string + retentionPeriodInDays: + description: Retention period, in days, for long-term backups + maximum: 3650 + minimum: 90 + type: integer + sizeInTBs: + description: The backup size in terrabytes (TB). + format: double + type: number + sourceDatabaseDetails: + $ref: '#/components/schemas/SourceDatabaseDetails' + timeAvailableTill: + description: Timestamp until when the backup will be available + format: date-time + type: string + timeEnded: + description: The date and time the backup completed. + format: date-time + type: string + timeStarted: + description: The date and time the backup started. + format: date-time + type: string + type: + description: The type of backup. + enum: + - INCREMENTAL + - FULL + - LONGTERM + - VIRTUAL_FULL + - CUMULATIVE_INCREMENTAL + - ROLL_FORWARD_IMAGE_COPY + type: string + vaultId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - lifecycleState + - autonomousDatabaseId + - displayName + - type + - isAutomatic + type: object + UpdateAutonomousDatabaseBackupDetails: + description: | + Details for updating the Autonomous AI Database backup. + + **Warning:** Oracle recommends avoiding using confidential information when you supply string values using the API. + properties: + retentionPeriodInDays: + description: Retention period, in days, for long-term backups + maximum: 3650 + minimum: 90 + type: integer + type: object + AutonomousDatabaseCharacterSets: + description: | + The Oracle Autonomous AI Database supported character sets. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + name: + description: A valid Oracle character set. + maxLength: 255 + minLength: 1 + type: string + type: object + AutonomousDatabaseSoftwareImageCollection: + description: Result of List Autonomous AI Database Software Images. + properties: + items: + description: List of Autonomous AI Database Software Images. + items: + $ref: '#/components/schemas/AutonomousDatabaseSoftwareImageSummary' + type: array + required: + - items + type: object + CreateAutonomousDatabaseSoftwareImageDetails: + description: | + Parameters for creating a Autonomous AI Database Software Image + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Autonomous AI Database Software Image. The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + imageShapeFamily: + description: To what shape the image is meant for. + enum: + - EXADATA_SHAPE + - EXACC_SHAPE + type: string + sourceCdbId: + description: The source Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm) from which to create Autonomous AI Database Software Image. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - displayName + - sourceCdbId + - imageShapeFamily + type: object + AutonomousDatabaseSoftwareImage: + description: | + Autonomous AI Database Software Images created from Autonomous Container Database + properties: + autonomousDsiOneOffPatches: + description: One-off patches included in the Autonomous AI Database Software Image + items: + type: string + type: array + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + databaseVersion: + description: The database version with which the Autonomous AI Database Software Image is to be built. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Autonomous AI Database Software Image. The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database Software Image. + maxLength: 255 + minLength: 1 + type: string + imageShapeFamily: + description: To what shape the image is meant for. + enum: + - EXACC_SHAPE + - EXADATA_SHAPE + type: string + lifecycleDetails: + description: Detailed message for the lifecycle state. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the Autonomous AI Database Software Image. + enum: + - AVAILABLE + - FAILED + - PROVISIONING + - EXPIRED + - TERMINATED + - TERMINATING + - UPDATING + type: string + releaseUpdate: + description: The Release Updates. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the Autonomous AI Database Software Image was created. + format: date-time + type: string + required: + - id + - compartmentId + - lifecycleState + - displayName + - timeCreated + - releaseUpdate + - databaseVersion + - imageShapeFamily + type: object + UpdateAutonomousDatabaseSoftwareImageDetails: + description: | + Describes the parameters for updating the Autonomous AI Database Software Image + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + type: object + ChangeAutonomousDatabaseSoftwareImageCompartmentDetails: + description: The configuration details for moving the resource. + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the resource to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + AutonomousDatabaseSummary: + description: | + An Oracle Autonomous AI Database. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + accessTypes: + description: List of access types for an Autonomous AI Database. + items: + maxLength: 1024 + minLength: 1 + type: string + maxItems: 1024 + minItems: 1 + type: array + actualUsedDataStorageSizeInTBs: + description: | + The current amount of storage in use for user and system data, in terabytes (TB). + format: double + type: number + allocatedStorageSizeInTBs: + description: | + The amount of storage currently allocated for the database tables and billed for, rounded up. When auto-scaling is not enabled, this value is equal to the `dataStorageSizeInTBs` value. You can compare this value to the `actualUsedDataStorageSizeInTBs` value to determine if a manual shrink operation is appropriate for your allocated storage. + + **Note:** Auto-scaling does not automatically decrease allocated storage when data is deleted from the database. + format: double + type: number + apexDetails: + $ref: '#/components/schemas/AutonomousDatabaseApex' + arePrimaryWhitelistedIpsUsed: + description: | + This field will be null if the Autonomous AI Database is not Data Guard enabled or Access Control is disabled. + It's value would be `TRUE` if Autonomous AI Database is Data Guard enabled and Access Control is enabled and if the Autonomous AI Database uses primary IP access control list (ACL) for standby. + It's value would be `FALSE` if Autonomous AI Database is Data Guard enabled and Access Control is enabled and if the Autonomous AI Database uses different IP access control list (ACL) for standby compared to primary. + type: boolean + autoRefreshFrequencyInSeconds: + description: The frequency a refreshable clone is refreshed after auto-refresh is enabled. The minimum is 1 hour. The maximum is 7 days. The date and time that auto-refresh is enabled is controlled by the `timeOfAutoRefreshStart` parameter. + maximum: 604800 + minimum: 3600 + type: integer + autoRefreshPointLagInSeconds: + description: The time, in seconds, the data of the refreshable clone lags the primary database at the point of refresh. The minimum is 0 minutes (0 mins means refresh to the latest available timestamp). The maximum is 7 days. The lag time increases after refreshing until the next data refresh happens. + maximum: 604800 + minimum: 0 + type: integer + autonomousContainerDatabaseId: + description: The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm). Used only by Autonomous AI Database on Dedicated Exadata Infrastructure. + maxLength: 255 + minLength: 1 + type: string + autonomousMaintenanceScheduleType: + description: | + The maintenance schedule type of the Autonomous AI Database Serverless. An EARLY maintenance schedule + follows a schedule applying patches prior to the REGULAR schedule. A REGULAR maintenance schedule follows the normal cycle + enum: + - EARLY + - REGULAR + type: string + availabilityDomain: + description: The availability domain where the Autonomous AI Database Serverless instance is located. + maxLength: 255 + minLength: 1 + type: string + availableUpgradeVersions: + description: List of Oracle AI Database versions available for a database upgrade. If there are no version upgrades available, this list is empty. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + backupConfig: + $ref: '#/components/schemas/AutonomousDatabaseBackupConfig' + byolComputeCountLimit: + description: The maximum number of CPUs allowed with a Bring Your Own License (BYOL), including those used for auto-scaling, disaster recovery, tools, etc. Any CPU usage above this limit is considered as License Included and billed. + format: float + minimum: 2 + type: number + characterSet: + description: | + The character set for the Autonomous AI Database. The default is AL32UTF8. Allowed values are: + + AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS + maxLength: 255 + minLength: 1 + type: string + cloneTableSpaceList: + description: A list of the source Autonomous AI Database's table space number(s) used to create this partial clone from the backup. + items: + type: integer + type: array + cloneType: + description: The Autonomous AI Database clone type. + enum: + - FULL + - METADATA + - PARTIAL + type: string + clusterPlacementGroupId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Autonomous Serverless Database. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeCount: + description: | + The compute amount (CPUs) available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous AI Database Serverless instance or an Autonomous AI Database on Dedicated Exadata Infrastructure. + The 'ECPU' compute model requires a minimum value of one, for databases in the elastic resource pool and minimum value of two, otherwise. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value. Providing `computeModel` and `computeCount` is the preferred method for both OCPU and ECPU. + format: float + type: number + x-default-description: Null used when unspecified. + computeModel: + description: | + The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. + enum: + - ECPU + - OCPU + type: string + x-default-description: Null used when unspecified. + connectionStrings: + $ref: '#/components/schemas/AutonomousDatabaseConnectionStrings' + connectionUrls: + $ref: '#/components/schemas/AutonomousDatabaseConnectionUrls' + cpuCoreCount: + description: | + The number of CPU cores to be made available to the database. When the ECPU is selected, the value for cpuCoreCount is 0. For Autonomous AI Database on Dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/) for shape details. + + **Note:** This parameter cannot be used with the `ocpuCount` parameter. + maximum: 128 + minimum: 1 + type: integer + customerContacts: + description: Customer Contacts. + items: + $ref: '#/components/schemas/CustomerContact' + type: array + dataSafeStatus: + description: Status of the Data Safe registration for this Autonomous AI Database. + enum: + - REGISTERING + - REGISTERED + - DEREGISTERING + - NOT_REGISTERED + - FAILED + type: string + dataStorageSizeInGBs: + description: | + The quantity of data in the database, in gigabytes. + + For Autonomous AI Transaction Processing databases using ECPUs on Serverless Infrastructure, this value is always populated. In all the other cases, this value will be null and `dataStorageSizeInTBs` will be populated instead. + type: integer + dataStorageSizeInTBs: + description: | + The quantity of data in the database, in terabytes. + + The following points apply to Autonomous AI Databases on Serverless Infrastructure: + - This is an integer field whose value remains null when the data size is in GBs and cannot be converted to TBs (by dividing the GB value by 1024) without rounding error. + - To get the exact value of data storage size without rounding error, please see `dataStorageSizeInGBs` of Autonomous AI Database. + type: integer + databaseEdition: + description: | + The Oracle AI Database Edition that applies to the Autonomous AI Databases. + enum: + - STANDARD_EDITION + - ENTERPRISE_EDITION + type: string + databaseManagementStatus: + description: Status of Database Management for this Autonomous AI Database. + enum: + - ENABLING + - ENABLED + - DISABLING + - NOT_ENABLED + - FAILED_ENABLING + - FAILED_DISABLING + type: string + dataguardRegionType: + description: | + **Deprecated.** The Autonomous Data Guard region type of the Autonomous AI Database. For Autonomous AI Database Serverless, Autonomous Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. The standby regions in Autonomous Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Autonomous Data Guard association, and cannot be performed when the database using the primary role is operating in a remote Autonomous Data Guard standby region. + enum: + - PRIMARY_DG_REGION + - REMOTE_STANDBY_DG_REGION + type: string + dbName: + description: The database name. + maxLength: 14 + minLength: 1 + type: string + dbToolsDetails: + description: | + The list of database tools details. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, isLocalDataGuardEnabled, or isFreeTier. + items: + $ref: '#/components/schemas/DatabaseTool' + type: array + x-default-description: 'null' + dbVersion: + description: | + A valid Oracle AI Database version for Autonomous AI Database. + When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai. + When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected. + For new databases, it is recommended to use either 19c or 26ai. + + **Note** Starting December 2026, 23ai will not be supported as a valid value for this parameter. + maxLength: 255 + minLength: 1 + type: string + dbWorkload: + description: | + The Autonomous AI Database workload type. The following values are valid: + - OLTP - indicates an Autonomous AI Transaction Processing database + - DW - indicates an Autonomous AI Lakehouse database + - AJD - indicates an Autonomous AI JSON Database + - APEX - indicates an Autonomous AI Database with the Oracle APEX AI Application Development workload type. + - LH - indicates an Oracle Autonomous AI Lakehouse database + + **Note** Starting December 2026, DW will not be supported as a valid value for this parameter. + When creating an Autonomous AI Database, if this parameter is not specified, the default value is `OLTP`. + + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + enum: + - OLTP + - DW + - AJD + - APEX + - LH + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + disasterRecoveryRegionType: + description: | + **Deprecated.** The disaster recovery (DR) region type of the Autonomous AI Database. For Autonomous AI Database Serverless instances, DR associations have designated primary and standby regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region. + enum: + - PRIMARY + - REMOTE + type: string + displayName: + description: The user-friendly name for the Autonomous AI Database. The name does not have to be unique. + maxLength: 255 + minLength: 1 + type: string + encryptionKey: + $ref: '#/components/schemas/AutonomousDatabaseEncryptionKeyDetails' + encryptionKeyHistoryEntry: + description: Key History Entry. + items: + $ref: '#/components/schemas/AutonomousDatabaseEncryptionKeyHistoryEntry' + type: array + failedDataRecoveryInSeconds: + description: Indicates the number of seconds of data loss for a Data Guard failover. + type: integer + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database. + maxLength: 255 + minLength: 1 + type: string + inMemoryAreaInGBs: + description: The area assigned to In-Memory tables in Autonomous AI Database. + type: integer + inMemoryPercentage: + description: The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous AI Database. This property is applicable only to Autonomous AI Databases on the Exadata Cloud@Customer platform. + minimum: 0 + type: integer + infrastructureType: + description: | + The infrastructure type this resource belongs to. + enum: + - CLOUD + - CLOUD_AT_CUSTOMER + type: string + isAccessControlEnabled: + description: | + Indicates if the database-level access control is enabled. + If disabled, database access is defined by the network security rules. + If enabled, database access is restricted to the IP addresses defined by the rules specified with the `whitelistedIps` property. While specifying `whitelistedIps` rules is optional, + if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using the `UpdateAutonomousDatabase` API operation or edit option in console. + When creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone. + + This property is applicable only to Autonomous AI Databases on the Exadata Cloud@Customer platform. For Autonomous AI Database Serverless instances, `whitelistedIps` is used. + type: boolean + isAutoScalingEnabled: + description: | + Indicates if auto scaling is enabled for the Autonomous AI Database CPU core count. The default value is `TRUE`. + type: boolean + isAutoScalingForStorageEnabled: + description: | + Indicates if auto scaling is enabled for the Autonomous AI Database storage. The default value is `FALSE`. + type: boolean + isBackupRetentionLocked: + description: Indicates if the Autonomous AI Database is backup retention locked. + type: boolean + isDataGuardEnabled: + description: | + **Deprecated.** Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. + type: boolean + isDedicated: + description: | + True if the database uses [dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html). + type: boolean + isDevTier: + default: false + description: | + Autonomous AI Database for Developers are fixed-shape Autonomous AI Databases that developers can use to build and test new applications. On Serverless, these are low-cost and billed per instance, on Dedicated and Cloud@Customer there is no additional cost to create Developer databases. Developer databases come with limited resources and is not intended for large-scale testing and production deployments. When you need more compute or storage resources, you may upgrade to a full paid production database. + type: boolean + isFreeTier: + default: false + description: | + Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous AI Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isLocalDataGuardEnabled + type: boolean + isLocalDataGuardEnabled: + description: Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. + type: boolean + isMtlsConnectionRequired: + description: | + Specifies if the Autonomous AI Database requires mTLS connections. + + This may not be updated in parallel with any of the following: licenseModel, databaseEdition, cpuCoreCount, computeCount, dataStorageSizeInTBs, whitelistedIps, openMode, permissionLevel, db-workload, privateEndpointLabel, nsgIds, customerContacts, dbVersion, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + + Service Change: The default value of the isMTLSConnectionRequired attribute will change from true to false on July 1, 2023 in the following APIs: + - CreateAutonomousDatabase + - GetAutonomousDatabase + - UpdateAutonomousDatabase + Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous AI Database Serverless. + Does this impact me? If you use or maintain custom scripts or Terraform scripts referencing the CreateAutonomousDatabase, GetAutonomousDatabase, or UpdateAutonomousDatabase APIs, you want to check, and possibly modify, the scripts for the changed default value of the attribute. Should you choose not to leave your scripts unchanged, the API calls containing this attribute will continue to work, but the default value will switch from true to false. + How do I make this change? Using either OCI SDKs or command line tools, update your custom scripts to explicitly set the isMTLSConnectionRequired attribute to true. + type: boolean + isPreview: + description: Indicates if the Autonomous AI Database version is a preview version. + type: boolean + isReconnectCloneEnabled: + description: Indicates if the refreshable clone can be reconnected to its source database. + type: boolean + isRefreshableClone: + description: | + Indicates if the Autonomous AI Database is a refreshable clone. + + This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + type: boolean + isRemoteDataGuardEnabled: + description: Indicates whether the Autonomous AI Database has Cross Region Data Guard enabled. Not applicable to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. + type: boolean + keyHistoryEntry: + description: Key History Entry. + items: + $ref: '#/components/schemas/AutonomousDatabaseKeyHistoryEntry' + type: array + keyStoreId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. + maxLength: 255 + minLength: 1 + type: string + keyStoreWalletName: + description: The wallet name for Oracle Key Vault. + maxLength: 255 + minLength: 1 + type: string + kmsKeyId: + description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. + maxLength: 255 + minLength: 1 + type: string + kmsKeyLifecycleDetails: + description: KMS key lifecycle details. + type: string + kmsKeyVersionId: + description: | + The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. + maxLength: 255 + minLength: 1 + type: string + licenseModel: + description: | + The Oracle license model that applies to the Oracle Autonomous AI Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle AI Database software licenses and the Oracle AI Database service. + Note that when provisioning an [Autonomous AI Database on dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html), this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. Bring your own license (BYOL) also allows you to select the DB edition using the optional parameter. + + This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + lifecycleDetails: + description: Information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the Autonomous AI Database. + enum: + - PROVISIONING + - AVAILABLE + - STOPPING + - STOPPED + - STARTING + - TERMINATING + - TERMINATED + - UNAVAILABLE + - RESTORE_IN_PROGRESS + - RESTORE_FAILED + - BACKUP_IN_PROGRESS + - SCALE_IN_PROGRESS + - AVAILABLE_NEEDS_ATTENTION + - UPDATING + - MAINTENANCE_IN_PROGRESS + - RESTARTING + - RECREATING + - ROLE_CHANGE_IN_PROGRESS + - UPGRADING + - INACCESSIBLE + - STANDBY + - TRANSPORTING + type: string + localAdgAutoFailoverMaxDataLossLimit: + description: Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard + maximum: 3600 + minimum: 0 + type: integer + localDisasterRecoveryType: + description: | + Indicates the local disaster recovery (DR) type of the Autonomous AI Database Serverless instance. + Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. + Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. + type: string + x-obmcs-enumref: '#/definitions/DisasterRecoveryConfiguration/disasterRecoveryType' + localStandbyDb: + $ref: '#/components/schemas/AutonomousDatabaseStandbySummary' + longTermBackupSchedule: + $ref: '#/components/schemas/LongTermBackUpScheduleDetails' + maintenanceTargetComponent: + description: The component chosen for maintenance. + type: string + memoryPerOracleComputeUnitInGBs: + description: | + The amount of memory (in GBs) to be enabled per OCPU or ECPU. + type: integer + ncharacterSet: + description: | + The national character set for the Autonomous AI Database. The default is AL16UTF16. Allowed values are: + AL16UTF16 or UTF8. + maxLength: 255 + minLength: 1 + type: string + netServicesArchitecture: + description: | + Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users. + enum: + - DEDICATED + - SHARED + type: string + nextLongTermBackupTimeStamp: + description: The date and time when the next long-term backup would be created. + format: date-time + type: string + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + ocpuCount: + description: | + The number of OCPU cores to be made available to the database. + + The following points apply: + - For Autonomous AI Databases on Dedicated Exadata Infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous AI Database Serverless instances.) + - To provision cores, enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to Autonomous AI Databases on both serverless and dedicated Exadata infrastructure. + - For Autonomous AI Database Serverless instances, this parameter is not used. + + For Autonomous AI Databases on Dedicated Exadata Infrastructure, the maximum number of cores is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/index.html) for shape details. + + **Note:** This parameter cannot be used with the `cpuCoreCount` parameter. + format: float + minimum: 0.1 + type: number + openMode: + description: | + Indicates the Autonomous AI Database mode. The database can be opened in `READ_ONLY` or `READ_WRITE` mode. + + This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + enum: + - READ_ONLY + - READ_WRITE + type: string + x-default-description: 'null' + operationsInsightsStatus: + description: Status of Operations Insights for this Autonomous AI Database. + enum: + - ENABLING + - ENABLED + - DISABLING + - NOT_ENABLED + - FAILED_ENABLING + - FAILED_DISABLING + type: string + peerDbIds: + description: The list of [OCIDs](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous AI Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs. + items: + type: string + type: array + permissionLevel: + description: | + The Autonomous AI Database permission level. Restricted mode allows access only by admin users. + + This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + enum: + - RESTRICTED + - UNRESTRICTED + type: string + x-default-description: 'null' + privateEndpoint: + description: The private endpoint for the resource. + type: string + privateEndpointIp: + description: The private endpoint Ip address for the resource. + type: string + privateEndpointLabel: + description: | + The resource's private endpoint label. + - Setting the endpoint label to a non-empty string creates a private endpoint database. + - Resetting the endpoint label to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database. + - Setting the endpoint label to a non-empty string value, updates to a new private endpoint database, when the database is disabled and re-enabled. + + This setting cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + type: string + provisionableCpus: + description: An array of CPU values that an Autonomous AI Database can be scaled to. + items: + format: float + type: number + type: array + publicConnectionUrls: + $ref: '#/components/schemas/AutonomousDatabaseConnectionUrls' + publicEndpoint: + description: The public endpoint for the private endpoint enabled resource. + type: string + refreshableMode: + description: The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous AI Database. + enum: + - AUTOMATIC + - MANUAL + type: string + refreshableStatus: + description: The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous AI Database. + enum: + - REFRESHING + - NOT_REFRESHING + type: string + x-default-description: This property is only valid for refreshable clones and is null for for databases that are not refreshable clones. + remoteDisasterRecoveryConfiguration: + $ref: '#/components/schemas/DisasterRecoveryConfiguration' + resourcePoolLeaderId: + description: The unique identifier for leader Autonomous AI Database OCID [OCID](/Content/General/Concepts/identifiers.htm). + maxLength: 255 + minLength: 1 + type: string + resourcePoolSummary: + $ref: '#/components/schemas/ResourcePoolSummary' + role: + description: | + The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. + enum: + - PRIMARY + - STANDBY + - DISABLED_STANDBY + - BACKUP_COPY + - SNAPSHOT_STANDBY + type: string + scheduledOperations: + description: | + The list of scheduled operations. Consists of values such as dayOfWeek, scheduledStartTime, scheduledStopTime. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + items: + $ref: '#/components/schemas/ScheduledOperationDetails' + type: array + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) + (opaque JSON object) + type: string + description: | + Key-value pair representing a ZPR tag key and value, scoped to a namespace. + Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` + type: object + description: | + Security Attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` + type: object + serviceConsoleUrl: + description: The URL of the Service Console for the Autonomous AI Database. + maxLength: 255 + minLength: 10 + type: string + sourceId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the source Autonomous AI Database that was cloned to create the current Autonomous AI Database. + maxLength: 255 + minLength: 1 + type: string + sqlWebDeveloperUrl: + description: The SQL Web Developer URL for the Oracle Autonomous AI Database. The sqlWebDeveloperUrl is only returned if isSqlWebDeveloperEnabled boolean is set to TRUE. + maxLength: 2048 + minLength: 10 + type: string + standbyDb: + $ref: '#/components/schemas/AutonomousDatabaseStandbySummary' + standbyWhitelistedIps: + description: | + The client IP access control list (ACL). This feature is available for [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. + Only clients connecting from an IP address included in the ACL may access the Autonomous AI Database instance. + If `arePrimaryWhitelistedIpsUsed` is 'TRUE' then Autonomous AI Database uses this primary's IP access control list (ACL) for the disaster recovery peer called `standbywhitelistedips`. + + For Autonomous AI Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). + Multiple IPs and VCN OCIDs should be separate strings separated by commas, but if it’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. + Example: `["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.","ocid1.vcn.oc1.sea.;1.1.1.1","ocid1.vcn.oc1.sea.;1.1.0.0/16"]` + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. + Example: `["1.1.1.1","1.1.1.0/24","1.1.2.25"]` + + For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + items: + maxLength: 1024 + minLength: 0 + type: string + type: array + subnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the resource is associated with. + + **Subnet Restrictions:** + - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. + - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20. + - For Autonomous AI Database, setting this will disable public secure access to the database. + + These subnets are used by the Oracle Clusterware private interconnect on the database instance. + Specifying an overlapping subnet will cause the private interconnect to malfunction. + This restriction applies to both the client subnet and the backup subnet. + maxLength: 255 + minLength: 1 + type: string + subscriptionId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. + maxLength: 255 + minLength: 1 + type: string + supportedRegionsToCloneTo: + description: | + The list of regions that support the creation of an Autonomous AI Database clone or an Autonomous Data Guard standby database. + items: + maxLength: 50 + minLength: 1 + type: string + type: array + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the Autonomous AI Database was created. + format: date-time + type: string + timeDataGuardRoleChanged: + description: The date and time the Autonomous Data Guard role was switched for the Autonomous AI Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region. + format: date-time + type: string + timeDeletionOfFreeAutonomousDatabase: + description: | + The date and time the Always Free database will be automatically deleted because of inactivity. If the database is in the STOPPED state and without activity until this time, it will be deleted. + format: date-time + type: string + timeDisasterRecoveryRoleChanged: + description: The date and time the Disaster Recovery role was switched for the standby Autonomous AI Database. + format: date-time + type: string + timeLocalDataGuardEnabled: + description: The date and time that Autonomous Data Guard was enabled for an Autonomous AI Database where the standby was provisioned in the same region as the primary database. + format: date-time + type: string + timeMaintenanceBegin: + description: The date and time when maintenance will begin. + format: date-time + type: string + timeMaintenanceEnd: + description: The date and time when maintenance will end. + format: date-time + type: string + timeOfAutoRefreshStart: + description: The the date and time that auto-refreshing will begin for an Autonomous AI Database refreshable clone. This value controls only the start time for the first refresh operation. Subsequent (ongoing) refresh operations have start times controlled by the value of the `autoRefreshFrequencyInSeconds` parameter. + format: date-time + type: string + timeOfJoiningResourcePool: + description: The time the member joined the resource pool. + format: date-time + type: string + timeOfLastFailover: + description: The timestamp of the last failover operation. + format: date-time + type: string + timeOfLastRefresh: + description: The date and time when last refresh happened. + format: date-time + type: string + timeOfLastRefreshPoint: + description: The refresh point timestamp (UTC). The refresh point is the time to which the database was most recently refreshed. Data created after the refresh point is not included in the refresh. + format: date-time + type: string + timeOfLastSwitchover: + description: The timestamp of the last switchover operation for the Autonomous AI Database. + format: date-time + type: string + timeOfNextRefresh: + description: The date and time of next refresh. + format: date-time + type: string + timeReclamationOfFreeAutonomousDatabase: + description: | + The date and time the Always Free database will be stopped because of inactivity. If this time is reached without any database activity, the database will automatically be put into the STOPPED state. + format: date-time + type: string + timeUndeleted: + description: | + The date and time the Autonomous AI Database was most recently undeleted. + format: date-time + type: string + timeUntilReconnectCloneEnabled: + description: The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database. + format: date-time + type: string + usedDataStorageSizeInGBs: + description: The storage space consumed by Autonomous AI Database in GBs. + type: integer + usedDataStorageSizeInTBs: + description: The amount of storage that has been used for Autonomous AI Databases in dedicated infrastructure, in terabytes. + type: integer + vaultId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. + maxLength: 255 + minLength: 1 + type: string + whitelistedIps: + description: | + The client IP access control list (ACL). This feature is available for [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. + Only clients connecting from an IP address included in the ACL may access the Autonomous AI Database instance. + If `arePrimaryWhitelistedIpsUsed` is 'TRUE' then Autonomous AI Database uses this primary's IP access control list (ACL) for the disaster recovery peer called `standbywhitelistedips`. + + For Autonomous AI Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). + Multiple IPs and VCN OCIDs should be separate strings separated by commas, but if it’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. + Example: `["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.","ocid1.vcn.oc1.sea.;1.1.1.1","ocid1.vcn.oc1.sea.;1.1.0.0/16"]` + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. + Example: `["1.1.1.1","1.1.1.0/24","1.1.2.25"]` + + For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + items: + maxLength: 1024 + minLength: 0 + type: string + type: array + required: + - id + - compartmentId + - lifecycleState + - dbName + - cpuCoreCount + - dataStorageSizeInTBs + type: object + CreateAutonomousDatabaseBase: + description: | + Details to create an Oracle Autonomous AI Database. + + **Notes:** + - To specify OCPU core count, you must use either `ocpuCount` or `cpuCoreCount`. You cannot use both parameters at the same time. For Autonomous AI Database Serverless instances, `ocpuCount` is not used. + - To specify a storage allocation, you must use either `dataStorageSizeInGBs` or `dataStorageSizeInTBs`. + - See the individual parameter discriptions for more information on the OCPU and storage value parameters. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + discriminator: + propertyName: source + properties: + adminPassword: + description: | + **Important** The `adminPassword` or `secretId` must be specified for all Autonomous AI Databases except for refreshable clones. The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (") or the username "admin", regardless of casing. + + This cannot be used in conjunction with with OCI vault secrets (secretId). + maxLength: 30 + minLength: 12 + type: string + arePrimaryWhitelistedIpsUsed: + description: | + This field will be null if the Autonomous AI Database is not Data Guard enabled or Access Control is disabled. + It's value would be `TRUE` if Autonomous AI Database is Data Guard enabled and Access Control is enabled and if the Autonomous AI Database uses primary IP access control list (ACL) for standby. + It's value would be `FALSE` if Autonomous AI Database is Data Guard enabled and Access Control is enabled and if the Autonomous AI Database uses different IP access control list (ACL) for standby compared to primary. + type: boolean + x-default-description: | + This field will be used only if Autonomous AI Database is Data Guard enabled and Access Control is enabled. + autonomousContainerDatabaseId: + description: The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm). Used only by Autonomous AI Database on Dedicated Exadata Infrastructure. + maxLength: 255 + minLength: 1 + type: string + autonomousMaintenanceScheduleType: + description: | + The maintenance schedule type of the Autonomous AI Database Serverless. An EARLY maintenance schedule + follows a schedule applying patches prior to the REGULAR schedule. A REGULAR maintenance schedule follows the normal cycle + enum: + - EARLY + - REGULAR + type: string + byolComputeCountLimit: + description: The maximum number of CPUs allowed with a Bring Your Own License (BYOL), including those used for auto-scaling, disaster recovery, tools, etc. Any CPU usage above this limit is considered as License Included and billed. + format: float + minimum: 2 + type: number + characterSet: + description: | + The character set for the Autonomous AI Database. The default is AL32UTF8. Allowed values for an Autonomous AI Database Serverless instance as as returned by [List Autonomous AI Database Character Sets](https://docs.oracle.com/iaas/autonomous-database-serverless/doc/autonomous-character-set-selection.html) + + For an Autonomous AI Database on dedicated infrastructure, the allowed values are: + + AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment of the Autonomous AI Database. + maxLength: 255 + minLength: 1 + type: string + computeCount: + description: | + The compute amount (CPUs) available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous AI Database Serverless instance or an Autonomous AI Database on Dedicated Exadata Infrastructure. + The 'ECPU' compute model requires a minimum value of one, for databases in the elastic resource pool and minimum value of two, otherwise. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value. Providing `computeModel` and `computeCount` is the preferred method for both OCPU and ECPU. + format: float + maximum: 512 + minimum: 0.1 + type: number + computeModel: + description: | + The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. + enum: + - ECPU + - OCPU + type: string + x-default-description: Null used when unspecified. + cpuCoreCount: + description: | + The number of CPU cores to be made available to the database. For Autonomous AI Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/) for shape details. + + **Note:** This parameter cannot be used with the `ocpuCount` parameter. + maximum: 128 + minimum: 1 + type: integer + customerContacts: + description: Customer Contacts. + items: + $ref: '#/components/schemas/CustomerContact' + type: array + dataStorageSizeInGBs: + description: | + The size, in gigabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. The maximum storage value is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/) for shape details. + + **Notes** + - This parameter is only supported for dedicated Exadata infrastructure. + - This parameter cannot be used with the `dataStorageSizeInTBs` parameter. + maximum: 131072 + minimum: 32 + type: integer + dataStorageSizeInTBs: + description: | + The size, in terabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. For Autonomous AI Databases on dedicated Exadata infrastructure, the maximum storage value is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/) for shape details. + A full Exadata service is allocated when the Autonomous AI Database size is set to the upper limit (384 TB). + + **Note:** This parameter cannot be used with the `dataStorageSizeInGBs` parameter. + maximum: 384 + minimum: 1 + type: integer + databaseEdition: + description: | + The Oracle AI Database Edition that applies to the Autonomous AI Databases. This parameter accepts options `STANDARD_EDITION` and `ENTERPRISE_EDITION`. + type: string + x-obmcs-enumref: '#/definitions/AutonomousDatabaseSummary/databaseEdition' + dbName: + description: The database name. The name must begin with an alphabetic character and can contain a maximum of 30 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. It is required in all cases except when creating a cross-region Autonomous Data Guard standby instance or a cross-region disaster recovery standby instance. + maxLength: 30 + minLength: 1 + type: string + dbToolsDetails: + description: | + The list of database tools details. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, isLocalDataGuardEnabled, or isFreeTier. + items: + $ref: '#/components/schemas/DatabaseTool' + type: array + x-default-description: 'null' + dbVersion: + description: | + A valid Oracle AI Database version for Autonomous AI Database. + When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai. + When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected. + For new databases, it is recommended to use either 19c or 26ai. + + **Note** Starting December 2026, 23ai will not be supported as a valid value for this parameter. + maxLength: 255 + minLength: 1 + type: string + dbWorkload: + description: | + The Autonomous AI Database workload type. The following values are valid: + - OLTP - indicates an Autonomous AI Transaction Processing database + - DW - indicates an Autonomous AI Lakehouse database + - AJD - indicates an Autonomous AI JSON Database + - APEX - indicates an Autonomous AI Database with the Oracle APEX AI Application Development workload type. + - LH - indicates an Oracle Autonomous AI Lakehouse database + + **Note** Starting December 2026, DW will not be supported as a valid value for this parameter. + When creating an Autonomous AI Database, if this parameter is not specified, the default value is `OLTP`. + + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + enum: + - OLTP + - DW + - AJD + - APEX + - LH + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Autonomous AI Database. The name does not have to be unique. + maxLength: 255 + minLength: 1 + type: string + encryptionKey: + $ref: '#/components/schemas/AutonomousDatabaseEncryptionKeyDetails' + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + inMemoryPercentage: + default: 0 + description: The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous AI Database. This property is applicable only to Autonomous AI Databases on the Exadata Cloud@Customer platform. + minimum: 0 + type: integer + isAccessControlEnabled: + description: | + Indicates if the database-level access control is enabled. + If disabled, database access is defined by the network security rules. + If enabled, database access is restricted to the IP addresses defined by the rules specified with the `whitelistedIps` property. While specifying `whitelistedIps` rules is optional, + if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using the `UpdateAutonomousDatabase` API operation or edit option in console. + When creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone. + + This property is applicable only to Autonomous AI Databases on the Exadata Cloud@Customer platform. For Autonomous AI Database Serverless instances, `whitelistedIps` is used. + type: boolean + isAutoScalingEnabled: + default: false + description: | + Indicates if auto scaling is enabled for the Autonomous AI Database CPU core count. The default value is `TRUE`. + type: boolean + isAutoScalingForStorageEnabled: + description: | + Indicates if auto scaling is enabled for the Autonomous AI Database storage. The default value is `FALSE`. + type: boolean + isBackupRetentionLocked: + description: True if the Autonomous AI Database is backup retention locked. + type: boolean + isDataGuardEnabled: + description: | + **Deprecated.** Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. + type: boolean + isDedicated: + description: | + True if the database is on [dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html). + type: boolean + isDevTier: + default: false + description: | + Autonomous AI Database for Developers are fixed-shape Autonomous AI Databases that developers can use to build and test new applications. On Serverless, these are low-cost and billed per instance, on Dedicated and Cloud@Customer there is no additional cost to create Developer databases. Developer databases come with limited resources and is not intended for large-scale testing and production deployments. When you need more compute or storage resources, you may upgrade to a full paid production database. + type: boolean + isFreeTier: + default: false + description: | + Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous AI Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isLocalDataGuardEnabled + type: boolean + isLocalDataGuardEnabled: + description: Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. + type: boolean + isMtlsConnectionRequired: + description: | + Specifies if the Autonomous AI Database requires mTLS connections. + + This may not be updated in parallel with any of the following: licenseModel, databaseEdition, cpuCoreCount, computeCount, dataStorageSizeInTBs, whitelistedIps, openMode, permissionLevel, db-workload, privateEndpointLabel, nsgIds, customerContacts, dbVersion, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + + Service Change: The default value of the isMTLSConnectionRequired attribute will change from true to false on July 1, 2023 in the following APIs: + - CreateAutonomousDatabase + - GetAutonomousDatabase + - UpdateAutonomousDatabase + Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous AI Database Serverless. + Does this impact me? If you use or maintain custom scripts or Terraform scripts referencing the CreateAutonomousDatabase, GetAutonomousDatabase, or UpdateAutonomousDatabase APIs, you want to check, and possibly modify, the scripts for the changed default value of the attribute. Should you choose not to leave your scripts unchanged, the API calls containing this attribute will continue to work, but the default value will switch from true to false. + How do I make this change? Using either OCI SDKs or command line tools, update your custom scripts to explicitly set the isMTLSConnectionRequired attribute to true. + type: boolean + isPreviewVersionWithServiceTermsAccepted: + default: false + description: | + If set to `TRUE`, indicates that an Autonomous AI Database preview version is being provisioned, and that the preview version's terms of service have been accepted. Note that preview version software is only available for Autonomous AI Database Serverless instances (https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/). + type: boolean + kmsKeyId: + description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. + maxLength: 255 + minLength: 1 + type: string + licenseModel: + description: | + The Oracle license model that applies to the Oracle Autonomous AI Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle AI Database software licenses and the Oracle AI Database service. + Note that when provisioning an [Autonomous AI Database on dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html), this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. Bring your own license (BYOL) also allows you to select the DB edition using the optional parameter. + + This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + ncharacterSet: + description: | + The character set for the Autonomous AI Database. The default is AL32UTF8. Use [List Autonomous AI Database Character Sets](https://docs.oracle.com/iaas/autonomous-database-serverless/doc/autonomous-character-set-selection.html) to list the allowed values for an Autonomous AI Database Serverless instance. + For an Autonomous AI Database on dedicated Exadata infrastructure, the allowed values are: + AL16UTF16 or UTF8. + maxLength: 255 + minLength: 1 + type: string + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + ocpuCount: + description: | + The number of OCPU cores to be made available to the database. + + The following points apply: + - For Autonomous AI Databases on Dedicated Exadata infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous AI Database Serverless instances.) + - To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to an Autonomous AI Database Serverless instance or an Autonomous AI Database on Dedicated Exadata Infrastructure. + - For Autonomous AI Database Serverless instances, this parameter is not used. + + For Autonomous AI Databases on Dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/) for shape details. + + **Note:** This parameter cannot be used with the `cpuCoreCount` parameter. + format: float + minimum: 0.1 + type: number + privateEndpointIp: + description: The private endpoint Ip address for the resource. + type: string + privateEndpointLabel: + description: | + The resource's private endpoint label. + - Setting the endpoint label to a non-empty string creates a private endpoint database. + - Resetting the endpoint label to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database. + - Setting the endpoint label to a non-empty string value, updates to a new private endpoint database, when the database is disabled and re-enabled. + + This setting cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + type: string + resourcePoolLeaderId: + description: The unique identifier for leader Autonomous AI Database OCID [OCID](/Content/General/Concepts/identifiers.htm). + maxLength: 255 + minLength: 1 + type: string + resourcePoolSummary: + $ref: '#/components/schemas/ResourcePoolSummary' + scheduledOperations: + description: | + The list of scheduled operations. Consists of values such as dayOfWeek, scheduledStartTime, scheduledStopTime. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + items: + $ref: '#/components/schemas/ScheduledOperationDetails' + type: array + secretId: + description: | + The OCI vault secret [/Content/General/Concepts/identifiers.htm]OCID. + + This cannot be used in conjunction with adminPassword. + maxLength: 255 + minLength: 1 + type: string + secretVersionNumber: + description: The version of the vault secret. If no version is specified, the latest version will be used. + maximum: 60 + minimum: 1 + type: integer + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) + (opaque JSON object) + type: string + description: | + Key-value pair representing a ZPR tag key and value, scoped to a namespace. + Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` + type: object + description: | + Security Attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` + type: object + source: + default: NONE + description: | + The source of the database: Use `NONE` for creating a new Autonomous AI Database. Use `DATABASE` for creating a new Autonomous AI Database by cloning an existing Autonomous AI Database. Use `CROSS_REGION_DATAGUARD` to create a standby Data Guard database in another region. + + For [Autonomous AI Database Serverless instances](https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/), the following cloning options are available: Use `BACKUP_FROM_ID` for creating a new Autonomous AI Database from a specified backup. Use `BACKUP_FROM_TIMESTAMP` for creating a point-in-time Autonomous AI Database clone using backups. For more information, see [Cloning and Moving an Autonomous AI Database](https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/clone-autonomous-database.html#GUID-D771796F-5081-4CFB-A7FF-0F893EABD7BC). + enum: + - NONE + - DATABASE + - BACKUP_FROM_ID + - BACKUP_FROM_TIMESTAMP + - UNDELETE_ADB + - CLONE_TO_REFRESHABLE + - CROSS_REGION_DATAGUARD + - CROSS_REGION_DISASTER_RECOVERY + type: string + standbyWhitelistedIps: + description: | + The client IP access control list (ACL). This feature is available for [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. + Only clients connecting from an IP address included in the ACL may access the Autonomous AI Database instance. + If `arePrimaryWhitelistedIpsUsed` is 'TRUE' then Autonomous AI Database uses this primary's IP access control list (ACL) for the disaster recovery peer called `standbywhitelistedips`. + + For Autonomous AI Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). + Multiple IPs and VCN OCIDs should be separate strings separated by commas, but if it’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. + Example: `["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.","ocid1.vcn.oc1.sea.;1.1.1.1","ocid1.vcn.oc1.sea.;1.1.0.0/16"]` + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. + Example: `["1.1.1.1","1.1.1.0/24","1.1.2.25"]` + + For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + items: + maxLength: 1024 + minLength: 0 + type: string + type: array + subnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the resource is associated with. + + **Subnet Restrictions:** + - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. + - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20. + - For Autonomous AI Database, setting this will disable public secure access to the database. + + These subnets are used by the Oracle Clusterware private interconnect on the database instance. + Specifying an overlapping subnet will cause the private interconnect to malfunction. + This restriction applies to both the client subnet and the backup subnet. + maxLength: 255 + minLength: 1 + type: string + subscriptionId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. + maxLength: 255 + minLength: 1 + type: string + transportableTablespace: + $ref: '#/components/schemas/ImportTransportableTablespaceDetails' + vaultId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. + maxLength: 255 + minLength: 1 + type: string + whitelistedIps: + description: | + The client IP access control list (ACL). This feature is available for [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. + Only clients connecting from an IP address included in the ACL may access the Autonomous AI Database instance. + If `arePrimaryWhitelistedIpsUsed` is 'TRUE' then Autonomous AI Database uses this primary's IP access control list (ACL) for the disaster recovery peer called `standbywhitelistedips`. + + For Autonomous AI Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). + Multiple IPs and VCN OCIDs should be separate strings separated by commas, but if it’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. + Example: `["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.","ocid1.vcn.oc1.sea.;1.1.1.1","ocid1.vcn.oc1.sea.;1.1.0.0/16"]` + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. + Example: `["1.1.1.1","1.1.1.0/24","1.1.2.25"]` + + For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + items: + maxLength: 1024 + minLength: 0 + type: string + type: array + required: + - compartmentId + type: object + AutonomousDatabase: + description: | + An Oracle Autonomous AI Database. + properties: + accessTypes: + description: List of access types for an Autonomous AI Database. + items: + maxLength: 1024 + minLength: 1 + type: string + maxItems: 1024 + minItems: 1 + type: array + actualUsedDataStorageSizeInTBs: + description: | + The current amount of storage in use for user and system data, in terabytes (TB). + format: double + type: number + allocatedStorageSizeInTBs: + description: | + The amount of storage currently allocated for the database tables and billed for, rounded up. When auto-scaling is not enabled, this value is equal to the `dataStorageSizeInTBs` value. You can compare this value to the `actualUsedDataStorageSizeInTBs` value to determine if a manual shrink operation is appropriate for your allocated storage. + + **Note:** Auto-scaling does not automatically decrease allocated storage when data is deleted from the database. + format: double + type: number + apexDetails: + $ref: '#/components/schemas/AutonomousDatabaseApex' + arePrimaryWhitelistedIpsUsed: + description: | + This field will be null if the Autonomous AI Database is not Data Guard enabled or Access Control is disabled. + It's value would be `TRUE` if Autonomous AI Database is Data Guard enabled and Access Control is enabled and if the Autonomous AI Database uses primary IP access control list (ACL) for standby. + It's value would be `FALSE` if Autonomous AI Database is Data Guard enabled and Access Control is enabled and if the Autonomous AI Database uses different IP access control list (ACL) for standby compared to primary. + type: boolean + autoRefreshFrequencyInSeconds: + description: The frequency a refreshable clone is refreshed after auto-refresh is enabled. The minimum is 1 hour. The maximum is 7 days. The date and time that auto-refresh is enabled is controlled by the `timeOfAutoRefreshStart` parameter. + maximum: 604800 + minimum: 3600 + type: integer + autoRefreshPointLagInSeconds: + description: The time, in seconds, the data of the refreshable clone lags the primary database at the point of refresh. The minimum is 0 minutes (0 mins means refresh to the latest available timestamp). The maximum is 7 days. The lag time increases after refreshing until the next data refresh happens. + maximum: 604800 + minimum: 0 + type: integer + autonomousContainerDatabaseId: + description: The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm). Used only by Autonomous AI Database on Dedicated Exadata Infrastructure. + maxLength: 255 + minLength: 1 + type: string + autonomousMaintenanceScheduleType: + description: | + The maintenance schedule type of the Autonomous AI Database Serverless. An EARLY maintenance schedule + follows a schedule applying patches prior to the REGULAR schedule. A REGULAR maintenance schedule follows the normal cycle + enum: + - EARLY + - REGULAR + type: string + availabilityDomain: + description: The availability domain where the Autonomous AI Database Serverless instance is located. + maxLength: 255 + minLength: 1 + type: string + availableUpgradeVersions: + description: List of Oracle AI Database versions available for a database upgrade. If there are no version upgrades available, this list is empty. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + backupConfig: + $ref: '#/components/schemas/AutonomousDatabaseBackupConfig' + byolComputeCountLimit: + description: The maximum number of CPUs allowed with a Bring Your Own License (BYOL), including those used for auto-scaling, disaster recovery, tools, etc. Any CPU usage above this limit is considered as License Included and billed. + format: float + minimum: 2 + type: number + characterSet: + description: | + The character set for the Autonomous AI Database. The default is AL32UTF8. Allowed values are: + + AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS + maxLength: 255 + minLength: 1 + type: string + cloneTableSpaceList: + description: A list of the source Autonomous AI Database's table space number(s) used to create this partial clone from the backup. + items: + type: integer + type: array + cloneType: + description: The Autonomous AI Database clone type. + enum: + - FULL + - METADATA + - PARTIAL + type: string + clusterPlacementGroupId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Autonomous Serverless Database. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeCount: + description: | + The compute amount (CPUs) available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous AI Database Serverless instance or an Autonomous AI Database on Dedicated Exadata Infrastructure. + The 'ECPU' compute model requires a minimum value of one, for databases in the elastic resource pool and minimum value of two, otherwise. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value. Providing `computeModel` and `computeCount` is the preferred method for both OCPU and ECPU. + format: float + type: number + x-default-description: Null used when unspecified. + computeModel: + description: | + The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. + enum: + - ECPU + - OCPU + type: string + x-default-description: Null used when unspecified. + connectionStrings: + $ref: '#/components/schemas/AutonomousDatabaseConnectionStrings' + connectionUrls: + $ref: '#/components/schemas/AutonomousDatabaseConnectionUrls' + cpuCoreCount: + description: | + The number of CPU cores to be made available to the database. When the ECPU is selected, the value for cpuCoreCount is 0. For Autonomous AI Database on Dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/) for shape details. + + **Note:** This parameter cannot be used with the `ocpuCount` parameter. + maximum: 128 + minimum: 1 + type: integer + customerContacts: + description: Customer Contacts. + items: + $ref: '#/components/schemas/CustomerContact' + type: array + dataSafeStatus: + description: Status of the Data Safe registration for this Autonomous AI Database. + enum: + - REGISTERING + - REGISTERED + - DEREGISTERING + - NOT_REGISTERED + - FAILED + type: string + dataStorageSizeInGBs: + description: | + The quantity of data in the database, in gigabytes. + + For Autonomous AI Transaction Processing databases using ECPUs on Serverless Infrastructure, this value is always populated. In all the other cases, this value will be null and `dataStorageSizeInTBs` will be populated instead. + type: integer + dataStorageSizeInTBs: + description: | + The quantity of data in the database, in terabytes. + + The following points apply to Autonomous AI Databases on Serverless Infrastructure: + - This is an integer field whose value remains null when the data size is in GBs and cannot be converted to TBs (by dividing the GB value by 1024) without rounding error. + - To get the exact value of data storage size without rounding error, please see `dataStorageSizeInGBs` of Autonomous AI Database. + type: integer + databaseEdition: + description: | + The Oracle AI Database Edition that applies to the Autonomous AI Databases. + enum: + - STANDARD_EDITION + - ENTERPRISE_EDITION + type: string + databaseManagementStatus: + description: Status of Database Management for this Autonomous AI Database. + enum: + - ENABLING + - ENABLED + - DISABLING + - NOT_ENABLED + - FAILED_ENABLING + - FAILED_DISABLING + type: string + dataguardRegionType: + description: | + **Deprecated.** The Autonomous Data Guard region type of the Autonomous AI Database. For Autonomous AI Database Serverless, Autonomous Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. The standby regions in Autonomous Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Autonomous Data Guard association, and cannot be performed when the database using the primary role is operating in a remote Autonomous Data Guard standby region. + enum: + - PRIMARY_DG_REGION + - REMOTE_STANDBY_DG_REGION + type: string + dbName: + description: The database name. + maxLength: 14 + minLength: 1 + type: string + dbToolsDetails: + description: | + The list of database tools details. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, isLocalDataGuardEnabled, or isFreeTier. + items: + $ref: '#/components/schemas/DatabaseTool' + type: array + x-default-description: 'null' + dbVersion: + description: | + A valid Oracle AI Database version for Autonomous AI Database. + When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai. + When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected. + For new databases, it is recommended to use either 19c or 26ai. + + **Note** Starting December 2026, 23ai will not be supported as a valid value for this parameter. + maxLength: 255 + minLength: 1 + type: string + dbWorkload: + description: | + The Autonomous AI Database workload type. The following values are valid: + - OLTP - indicates an Autonomous AI Transaction Processing database + - DW - indicates an Autonomous AI Lakehouse database + - AJD - indicates an Autonomous AI JSON Database + - APEX - indicates an Autonomous AI Database with the Oracle APEX AI Application Development workload type. + - LH - indicates an Oracle Autonomous AI Lakehouse database + + **Note** Starting December 2026, DW will not be supported as a valid value for this parameter. + When creating an Autonomous AI Database, if this parameter is not specified, the default value is `OLTP`. + + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + enum: + - OLTP + - DW + - AJD + - APEX + - LH + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + disasterRecoveryRegionType: + description: | + **Deprecated.** The disaster recovery (DR) region type of the Autonomous AI Database. For Autonomous AI Database Serverless instances, DR associations have designated primary and standby regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region. + enum: + - PRIMARY + - REMOTE + type: string + displayName: + description: The user-friendly name for the Autonomous AI Database. The name does not have to be unique. + maxLength: 255 + minLength: 1 + type: string + encryptionKey: + $ref: '#/components/schemas/AutonomousDatabaseEncryptionKeyDetails' + encryptionKeyHistoryEntry: + description: Key History Entry. + items: + $ref: '#/components/schemas/AutonomousDatabaseEncryptionKeyHistoryEntry' + type: array + failedDataRecoveryInSeconds: + description: Indicates the number of seconds of data loss for a Data Guard failover. + type: integer + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database. + maxLength: 255 + minLength: 1 + type: string + inMemoryAreaInGBs: + description: The area assigned to In-Memory tables in Autonomous AI Database. + type: integer + inMemoryPercentage: + description: The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous AI Database. This property is applicable only to Autonomous AI Databases on the Exadata Cloud@Customer platform. + minimum: 0 + type: integer + infrastructureType: + description: | + The infrastructure type this resource belongs to. + enum: + - CLOUD + - CLOUD_AT_CUSTOMER + type: string + isAccessControlEnabled: + description: | + Indicates if the database-level access control is enabled. + If disabled, database access is defined by the network security rules. + If enabled, database access is restricted to the IP addresses defined by the rules specified with the `whitelistedIps` property. While specifying `whitelistedIps` rules is optional, + if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using the `UpdateAutonomousDatabase` API operation or edit option in console. + When creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone. + + This property is applicable only to Autonomous AI Databases on the Exadata Cloud@Customer platform. For Autonomous AI Database Serverless instances, `whitelistedIps` is used. + type: boolean + isAutoScalingEnabled: + description: | + Indicates if auto scaling is enabled for the Autonomous AI Database CPU core count. The default value is `TRUE`. + type: boolean + isAutoScalingForStorageEnabled: + description: | + Indicates if auto scaling is enabled for the Autonomous AI Database storage. The default value is `FALSE`. + type: boolean + isBackupRetentionLocked: + description: Indicates if the Autonomous AI Database is backup retention locked. + type: boolean + isDataGuardEnabled: + description: | + **Deprecated.** Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. + type: boolean + isDedicated: + description: | + True if the database uses [dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html). + type: boolean + isDevTier: + default: false + description: | + Autonomous AI Database for Developers are fixed-shape Autonomous AI Databases that developers can use to build and test new applications. On Serverless, these are low-cost and billed per instance, on Dedicated and Cloud@Customer there is no additional cost to create Developer databases. Developer databases come with limited resources and is not intended for large-scale testing and production deployments. When you need more compute or storage resources, you may upgrade to a full paid production database. + type: boolean + isFreeTier: + default: false + description: | + Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous AI Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isLocalDataGuardEnabled + type: boolean + isLocalDataGuardEnabled: + description: Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. + type: boolean + isMtlsConnectionRequired: + description: | + Specifies if the Autonomous AI Database requires mTLS connections. + + This may not be updated in parallel with any of the following: licenseModel, databaseEdition, cpuCoreCount, computeCount, dataStorageSizeInTBs, whitelistedIps, openMode, permissionLevel, db-workload, privateEndpointLabel, nsgIds, customerContacts, dbVersion, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + + Service Change: The default value of the isMTLSConnectionRequired attribute will change from true to false on July 1, 2023 in the following APIs: + - CreateAutonomousDatabase + - GetAutonomousDatabase + - UpdateAutonomousDatabase + Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous AI Database Serverless. + Does this impact me? If you use or maintain custom scripts or Terraform scripts referencing the CreateAutonomousDatabase, GetAutonomousDatabase, or UpdateAutonomousDatabase APIs, you want to check, and possibly modify, the scripts for the changed default value of the attribute. Should you choose not to leave your scripts unchanged, the API calls containing this attribute will continue to work, but the default value will switch from true to false. + How do I make this change? Using either OCI SDKs or command line tools, update your custom scripts to explicitly set the isMTLSConnectionRequired attribute to true. + type: boolean + isPreview: + description: Indicates if the Autonomous AI Database version is a preview version. + type: boolean + isReconnectCloneEnabled: + description: Indicates if the refreshable clone can be reconnected to its source database. + type: boolean + isRefreshableClone: + description: | + Indicates if the Autonomous AI Database is a refreshable clone. + + This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + type: boolean + isRemoteDataGuardEnabled: + description: Indicates whether the Autonomous AI Database has Cross Region Data Guard enabled. Not applicable to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. + type: boolean + keyHistoryEntry: + description: Key History Entry. + items: + $ref: '#/components/schemas/AutonomousDatabaseKeyHistoryEntry' + type: array + keyStoreId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. + maxLength: 255 + minLength: 1 + type: string + keyStoreWalletName: + description: The wallet name for Oracle Key Vault. + maxLength: 255 + minLength: 1 + type: string + kmsKeyId: + description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. + maxLength: 255 + minLength: 1 + type: string + kmsKeyLifecycleDetails: + description: KMS key lifecycle details. + type: string + kmsKeyVersionId: + description: | + The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. + maxLength: 255 + minLength: 1 + type: string + licenseModel: + description: | + The Oracle license model that applies to the Oracle Autonomous AI Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle AI Database software licenses and the Oracle AI Database service. + Note that when provisioning an [Autonomous AI Database on dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html), this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. Bring your own license (BYOL) also allows you to select the DB edition using the optional parameter. + + This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + lifecycleDetails: + description: Information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the Autonomous AI Database. + enum: + - PROVISIONING + - AVAILABLE + - STOPPING + - STOPPED + - STARTING + - TERMINATING + - TERMINATED + - UNAVAILABLE + - RESTORE_IN_PROGRESS + - RESTORE_FAILED + - BACKUP_IN_PROGRESS + - SCALE_IN_PROGRESS + - AVAILABLE_NEEDS_ATTENTION + - UPDATING + - MAINTENANCE_IN_PROGRESS + - RESTARTING + - RECREATING + - ROLE_CHANGE_IN_PROGRESS + - UPGRADING + - INACCESSIBLE + - STANDBY + - TRANSPORTING + type: string + localAdgAutoFailoverMaxDataLossLimit: + description: Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard + maximum: 3600 + minimum: 0 + type: integer + localDisasterRecoveryType: + description: | + Indicates the local disaster recovery (DR) type of the Autonomous AI Database Serverless instance. + Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. + Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. + type: string + x-obmcs-enumref: '#/definitions/DisasterRecoveryConfiguration/disasterRecoveryType' + localStandbyDb: + $ref: '#/components/schemas/AutonomousDatabaseStandbySummary' + longTermBackupSchedule: + $ref: '#/components/schemas/LongTermBackUpScheduleDetails' + maintenanceTargetComponent: + description: The component chosen for maintenance. + type: string + memoryPerOracleComputeUnitInGBs: + description: | + The amount of memory (in GBs) to be enabled per OCPU or ECPU. + type: integer + ncharacterSet: + description: | + The national character set for the Autonomous AI Database. The default is AL16UTF16. Allowed values are: + AL16UTF16 or UTF8. + maxLength: 255 + minLength: 1 + type: string + netServicesArchitecture: + description: | + Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users. + enum: + - DEDICATED + - SHARED + type: string + nextLongTermBackupTimeStamp: + description: The date and time when the next long-term backup would be created. + format: date-time + type: string + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + ocpuCount: + description: | + The number of OCPU cores to be made available to the database. + + The following points apply: + - For Autonomous AI Databases on Dedicated Exadata Infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous AI Database Serverless instances.) + - To provision cores, enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to Autonomous AI Databases on both serverless and dedicated Exadata infrastructure. + - For Autonomous AI Database Serverless instances, this parameter is not used. + + For Autonomous AI Databases on Dedicated Exadata Infrastructure, the maximum number of cores is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/index.html) for shape details. + + **Note:** This parameter cannot be used with the `cpuCoreCount` parameter. + format: float + minimum: 0.1 + type: number + openMode: + description: | + Indicates the Autonomous AI Database mode. The database can be opened in `READ_ONLY` or `READ_WRITE` mode. + + This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + enum: + - READ_ONLY + - READ_WRITE + type: string + x-default-description: 'null' + operationsInsightsStatus: + description: Status of Operations Insights for this Autonomous AI Database. + enum: + - ENABLING + - ENABLED + - DISABLING + - NOT_ENABLED + - FAILED_ENABLING + - FAILED_DISABLING + type: string + peerDbIds: + description: The list of [OCIDs](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous AI Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs. + items: + type: string + type: array + permissionLevel: + description: | + The Autonomous AI Database permission level. Restricted mode allows access only by admin users. + + This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + enum: + - RESTRICTED + - UNRESTRICTED + type: string + x-default-description: 'null' + privateEndpoint: + description: The private endpoint for the resource. + type: string + privateEndpointIp: + description: The private endpoint Ip address for the resource. + type: string + privateEndpointLabel: + description: | + The resource's private endpoint label. + - Setting the endpoint label to a non-empty string creates a private endpoint database. + - Resetting the endpoint label to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database. + - Setting the endpoint label to a non-empty string value, updates to a new private endpoint database, when the database is disabled and re-enabled. + + This setting cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + type: string + provisionableCpus: + description: An array of CPU values that an Autonomous AI Database can be scaled to. + items: + format: float + type: number + type: array + publicConnectionUrls: + $ref: '#/components/schemas/AutonomousDatabaseConnectionUrls' + publicEndpoint: + description: The public endpoint for the private endpoint enabled resource. + type: string + refreshableMode: + description: The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous AI Database. + enum: + - AUTOMATIC + - MANUAL + type: string + refreshableStatus: + description: The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous AI Database. + enum: + - REFRESHING + - NOT_REFRESHING + type: string + x-default-description: This property is only valid for refreshable clones and is null for for databases that are not refreshable clones. + remoteDisasterRecoveryConfiguration: + $ref: '#/components/schemas/DisasterRecoveryConfiguration' + resourcePoolLeaderId: + description: The unique identifier for leader Autonomous AI Database OCID [OCID](/Content/General/Concepts/identifiers.htm). + maxLength: 255 + minLength: 1 + type: string + resourcePoolSummary: + $ref: '#/components/schemas/ResourcePoolSummary' + role: + description: | + The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. + enum: + - PRIMARY + - STANDBY + - DISABLED_STANDBY + - BACKUP_COPY + - SNAPSHOT_STANDBY + type: string + scheduledOperations: + description: | + The list of scheduled operations. Consists of values such as dayOfWeek, scheduledStartTime, scheduledStopTime. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + items: + $ref: '#/components/schemas/ScheduledOperationDetails' + type: array + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) + (opaque JSON object) + type: string + description: | + Key-value pair representing a ZPR tag key and value, scoped to a namespace. + Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` + type: object + description: | + Security Attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` + type: object + serviceConsoleUrl: + description: The URL of the Service Console for the Autonomous AI Database. + maxLength: 255 + minLength: 10 + type: string + sourceId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the source Autonomous AI Database that was cloned to create the current Autonomous AI Database. + maxLength: 255 + minLength: 1 + type: string + sqlWebDeveloperUrl: + description: The SQL Web Developer URL for the Oracle Autonomous AI Database. The sqlWebDeveloperUrl is only returned if isSqlWebDeveloperEnabled boolean is set to TRUE. + maxLength: 2048 + minLength: 10 + type: string + standbyDb: + $ref: '#/components/schemas/AutonomousDatabaseStandbySummary' + standbyWhitelistedIps: + description: | + The client IP access control list (ACL). This feature is available for [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. + Only clients connecting from an IP address included in the ACL may access the Autonomous AI Database instance. + If `arePrimaryWhitelistedIpsUsed` is 'TRUE' then Autonomous AI Database uses this primary's IP access control list (ACL) for the disaster recovery peer called `standbywhitelistedips`. + + For Autonomous AI Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). + Multiple IPs and VCN OCIDs should be separate strings separated by commas, but if it’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. + Example: `["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.","ocid1.vcn.oc1.sea.;1.1.1.1","ocid1.vcn.oc1.sea.;1.1.0.0/16"]` + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. + Example: `["1.1.1.1","1.1.1.0/24","1.1.2.25"]` + + For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + items: + maxLength: 1024 + minLength: 0 + type: string + type: array + subnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the resource is associated with. + + **Subnet Restrictions:** + - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. + - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20. + - For Autonomous AI Database, setting this will disable public secure access to the database. + + These subnets are used by the Oracle Clusterware private interconnect on the database instance. + Specifying an overlapping subnet will cause the private interconnect to malfunction. + This restriction applies to both the client subnet and the backup subnet. + maxLength: 255 + minLength: 1 + type: string + subscriptionId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. + maxLength: 255 + minLength: 1 + type: string + supportedRegionsToCloneTo: + description: | + The list of regions that support the creation of an Autonomous AI Database clone or an Autonomous Data Guard standby database. + items: + maxLength: 50 + minLength: 1 + type: string + type: array + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the Autonomous AI Database was created. + format: date-time + type: string + timeDataGuardRoleChanged: + description: The date and time the Autonomous Data Guard role was switched for the Autonomous AI Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region. + format: date-time + type: string + timeDeletionOfFreeAutonomousDatabase: + description: | + The date and time the Always Free database will be automatically deleted because of inactivity. If the database is in the STOPPED state and without activity until this time, it will be deleted. + format: date-time + type: string + timeDisasterRecoveryRoleChanged: + description: The date and time the Disaster Recovery role was switched for the standby Autonomous AI Database. + format: date-time + type: string + timeLocalDataGuardEnabled: + description: The date and time that Autonomous Data Guard was enabled for an Autonomous AI Database where the standby was provisioned in the same region as the primary database. + format: date-time + type: string + timeMaintenanceBegin: + description: The date and time when maintenance will begin. + format: date-time + type: string + timeMaintenanceEnd: + description: The date and time when maintenance will end. + format: date-time + type: string + timeOfAutoRefreshStart: + description: The the date and time that auto-refreshing will begin for an Autonomous AI Database refreshable clone. This value controls only the start time for the first refresh operation. Subsequent (ongoing) refresh operations have start times controlled by the value of the `autoRefreshFrequencyInSeconds` parameter. + format: date-time + type: string + timeOfJoiningResourcePool: + description: The time the member joined the resource pool. + format: date-time + type: string + timeOfLastFailover: + description: The timestamp of the last failover operation. + format: date-time + type: string + timeOfLastRefresh: + description: The date and time when last refresh happened. + format: date-time + type: string + timeOfLastRefreshPoint: + description: The refresh point timestamp (UTC). The refresh point is the time to which the database was most recently refreshed. Data created after the refresh point is not included in the refresh. + format: date-time + type: string + timeOfLastSwitchover: + description: The timestamp of the last switchover operation for the Autonomous AI Database. + format: date-time + type: string + timeOfNextRefresh: + description: The date and time of next refresh. + format: date-time + type: string + timeReclamationOfFreeAutonomousDatabase: + description: | + The date and time the Always Free database will be stopped because of inactivity. If this time is reached without any database activity, the database will automatically be put into the STOPPED state. + format: date-time + type: string + timeUndeleted: + description: | + The date and time the Autonomous AI Database was most recently undeleted. + format: date-time + type: string + timeUntilReconnectCloneEnabled: + description: The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database. + format: date-time + type: string + usedDataStorageSizeInGBs: + description: The storage space consumed by Autonomous AI Database in GBs. + type: integer + usedDataStorageSizeInTBs: + description: The amount of storage that has been used for Autonomous AI Databases in dedicated infrastructure, in terabytes. + type: integer + vaultId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. + maxLength: 255 + minLength: 1 + type: string + whitelistedIps: + description: | + The client IP access control list (ACL). This feature is available for [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. + Only clients connecting from an IP address included in the ACL may access the Autonomous AI Database instance. + If `arePrimaryWhitelistedIpsUsed` is 'TRUE' then Autonomous AI Database uses this primary's IP access control list (ACL) for the disaster recovery peer called `standbywhitelistedips`. + + For Autonomous AI Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). + Multiple IPs and VCN OCIDs should be separate strings separated by commas, but if it’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. + Example: `["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.","ocid1.vcn.oc1.sea.;1.1.1.1","ocid1.vcn.oc1.sea.;1.1.0.0/16"]` + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. + Example: `["1.1.1.1","1.1.1.0/24","1.1.2.25"]` + + For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + items: + maxLength: 1024 + minLength: 0 + type: string + type: array + required: + - id + - compartmentId + - lifecycleState + - dbName + - cpuCoreCount + - dataStorageSizeInTBs + type: object + ResourcePoolShapeCollection: + description: Results of an Autonomous AI Database resouce pool shape collection that contains ResourcePoolShapeSummary items. + properties: + items: + description: List of Autonomous AI Database resource pools Shapes. + items: + $ref: '#/components/schemas/ResourcePoolShapeSummary' + type: array + type: object + AutonomousDatabaseWallet: + description: | + The Autonomous AI Database wallet details. + properties: + lifecycleState: + description: The current lifecycle state of the Autonomous AI Database wallet. + enum: + - ACTIVE + - UPDATING + type: string + timeDownloaded: + description: The date and time the Autonomous AI Database wallet was downloaded. + format: date-time + type: string + timeRotated: + description: The date and time the wallet was last rotated. + format: date-time + type: string + type: object + UpdateAutonomousDatabaseWalletDetails: + description: | + Details to update an Autonomous AI Database wallet. + properties: + gracePeriod: + description: The number of hours that the old wallet can be used after it has been rotated. The old wallet will no longer be valid after the number of hours in the wallet rotation grace period has passed. During the grace period, both the old wallet and the current wallet can be used. + maximum: 24 + minimum: 1 + type: integer + shouldRotate: + default: false + description: Indicates whether to rotate the wallet or not. If `false`, the wallet will not be rotated. The default is `false`. + type: boolean + type: object + UpdateAutonomousDatabaseDetails: + description: | + Details to update an Oracle Autonomous AI Database. + + **Notes** + - To specify OCPU core count, you must use either `ocpuCount` or `cpuCoreCount`. You cannot use both parameters at the same time. For Autonomous AI Database Serverless instances, `ocpuCount` is not used. + - To specify a storage allocation, you must use either `dataStorageSizeInGBs` or `dataStorageSizeInTBs`. + - See the individual parameter discriptions for more information on the OCPU and storage value parameters. + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + adminPassword: + description: | + The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (") or the username "admin", regardless of casing. It must be different from the last four passwords and it must not be a password used within the last 24 hours. + + This cannot be used in conjunction with with OCI vault secrets (secretId). + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, whitelistedIps, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, or isFreeTier. + maxLength: 30 + minLength: 12 + type: string + arePrimaryWhitelistedIpsUsed: + description: | + This field will be null if the Autonomous AI Database is not Data Guard enabled or Access Control is disabled. + `TRUE` if the Autonomous AI Database has Data Guard and Access Control enabled, and the Autonomous AI Database uses the primary's IP access control list (ACL) for standby. + `FALSE` if the Autonomous AI Database has Data Guard and Access Control enabled, and the Autonomous AI Database uses a different IP access control list (ACL) for standby compared to primary. + type: boolean + autoRefreshFrequencyInSeconds: + description: The frequency a refreshable clone is refreshed after auto-refresh is enabled. The minimum is 1 hour. The maximum is 7 days. The date and time that auto-refresh is enabled is controlled by the `timeOfAutoRefreshStart` parameter. + maximum: 604800 + minimum: 3600 + type: integer + autoRefreshPointLagInSeconds: + description: The time, in seconds, the data of the refreshable clone lags the primary database at the point of refresh. The minimum is 0 minutes (0 mins means refresh to the latest available timestamp). The maximum is 7 days. The lag time increases after refreshing until the next data refresh happens. + maximum: 604800 + minimum: 0 + type: integer + autonomousMaintenanceScheduleType: + description: | + The maintenance schedule type of the Autonomous AI Database Serverless. An EARLY maintenance schedule + follows a schedule applying patches prior to the REGULAR schedule. A REGULAR maintenance schedule follows the normal cycle + enum: + - EARLY + - REGULAR + type: string + backupRetentionPeriodInDays: + description: Retention period, in days, for long-term backups + maximum: 3650 + minimum: 90 + type: integer + byolComputeCountLimit: + description: The maximum number of CPUs allowed with a Bring Your Own License (BYOL), including those used for auto-scaling, disaster recovery, tools, etc. Any CPU usage above this limit is considered as License Included and billed. + format: float + minimum: 2 + type: number + computeCount: + description: | + The compute amount (CPUs) available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous AI Database Serverless instance or an Autonomous AI Database on Dedicated Exadata Infrastructure. The 'ECPU' compute model requires a minimum value of one, for databases in the elastic resource pool and minimum value of two, otherwise. Required when using the `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value. Providing `computeModel` and `computeCount` is the preferred method for both OCPU and ECPU.
+ For Autonomous AI Databases on Dedicated Exadata Infrastructure, the following points apply: + - The CPU type (ECPUs or OCPUs) is determined by the parent Autonomous Exadata VM Cluster's compute model. + - You can enter a fractional value to provision less than 1 CPU. This lets you provision more Autonomous AI Databases than the available physical CPU cores, known as CPU overprovisioning. The exact implementation details vary with the compute model (ECPUs or OCPUs) that is inherited from the parent Autonomous Exadata VM Cluster. See [CPU Overprovisioning in Dedicated Exadata Infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/crsrb/index.html) for more details. + - To provision 1 or more OCPUs, you must enter an integer between 1 and the maximum number of OCPUscores available in the Autonomous VM Cluster. To provision 2 or more ECPUs, you must enter an even number between 2 and the maximum number of ECPUs available in the Autonomous VM Cluster. + - The maximum number of cores is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/) for shape details. + + This cannot be updated in parallel with any of the following: licenseModel, databaseEdition, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + format: float + maximum: 512 + minimum: 0.1 + type: number + computeModel: + description: | + The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. + enum: + - ECPU + - OCPU + type: string + x-default-description: Null used when unspecified. + cpuCoreCount: + description: | + The number of CPUs to be made available to the Autonomous AI Database.
+ For Autonomous AI Databases on Dedicated Exadata Infrastructure: + - The CPU type (OCPUs or ECPUs) is determined by the parent Autonomous Exadata VM Cluster's compute model. + - It is suggested to use 'computeCount' parameter if you want to use fractional value to provision less than 1 core. + + **Note:** This parameter cannot be used with the `ocpuCount` or `computeCount` parameter. + + This cannot be updated in parallel with any of the following: licenseModel, databaseEdition, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + maximum: 128 + minimum: 1 + type: integer + customerContacts: + description: | + Customer Contacts. Setting this to an empty list removes all customer contacts of an Oracle + + This cannot be updated in parallel with any of the following: isMTLSConnectionRequired, scheduledOperations, or dbToolsDetails. + items: + $ref: '#/components/schemas/CustomerContact' + type: array + dataStorageSizeInGBs: + description: | + Applies to dedicated Exadata infrastructure only. + + The size, in gigabytes, of the data volume that will be created and attached to the database. The maximum storage value depends on the system shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/) for shape details. + + **Note:** This parameter cannot be used with the `dataStorageSizeInTBs` parameter. + maximum: 131072 + minimum: 32 + type: integer + dataStorageSizeInTBs: + description: | + The size, in terabytes, of the data volume that will be created and attached to the database. For Autonomous AI Databases on dedicated Exadata infrastructure, the maximum storage value is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/) for shape details. + A full Exadata service is allocated when the Autonomous AI Database size is set to the upper limit (384 TB). + + **Note:** This parameter cannot be used with the `dataStorageSizeInGBs` parameter. + + This cannot be updated in parallel with any of the following: licenseModel, databaseEdition, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + maximum: 384 + minimum: 1 + type: integer + databaseEdition: + description: | + The Oracle AI Database Edition that applies to the Autonomous AI Databases. This parameter accepts options `STANDARD_EDITION` and `ENTERPRISE_EDITION`. + + This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + type: string + x-obmcs-enumref: '#/definitions/AutonomousDatabaseSummary/databaseEdition' + dbName: + description: | + New name for this Autonomous AI Database. + For Autonomous AI Databases on Dedicated Exadata Infrastructure, the name must begin with an alphabetic character, and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. + For Autonomous AI Database Serverless instances, the name must begin with an alphabetic character, and can contain a maximum of 30 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails. + type: string + dbToolsDetails: + description: | + The list of database tools details. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, isLocalDataGuardEnabled, or isFreeTier. + items: + $ref: '#/components/schemas/DatabaseTool' + type: array + x-default-description: 'null' + dbVersion: + description: | + A valid Oracle AI Database version for Autonomous AI Database. + When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai. + When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected. + For new databases, it is recommended to use either 19c or 26ai. + + **Note** Starting December 2026, 23ai will not be supported as a valid value for this parameter. + maxLength: 255 + minLength: 1 + type: string + dbWorkload: + description: | + The Autonomous AI Database workload type. The following values are valid: + - OLTP - indicates an Autonomous AI Transaction Processing database + - DW - indicates an Autonomous AI Lakehouse database + - AJD - indicates an Autonomous AI JSON Database + - APEX - indicates an Autonomous AI Database with the Oracle APEX AI Application Development workload type. + - LH - indicates an Oracle Autonomous AI Lakehouse database + + **Note** Starting December 2026, DW will not be supported as a valid value for this parameter. + When creating an Autonomous AI Database, if this parameter is not specified, the default value is `OLTP`. + + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + enum: + - OLTP + - DW + - AJD + - APEX + - LH + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: | + The user-friendly name for the Autonomous AI Database. The name does not have to be unique. The display name can only be updated for Autonomous AI Databases using dedicated Exadata Infrastructure. This parameter may not be updated in parallel with dbVersion. + maxLength: 255 + minLength: 1 + type: string + encryptionKey: + $ref: '#/components/schemas/AutonomousDatabaseEncryptionKeyDetails' + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + inMemoryPercentage: + description: The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous AI Database. This property is applicable only to Autonomous AI Databases on the Exadata Cloud@Customer platform. + minimum: 0 + type: integer + isAccessControlEnabled: + description: | + Indicates if the database-level access control is enabled. + If disabled, database access is defined by the network security rules. + If enabled, database access is restricted to the IP addresses defined by the rules specified with the `whitelistedIps` property. While specifying `whitelistedIps` rules is optional, + if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using the `UpdateAutonomousDatabase` API operation or edit option in console. + When creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone. + + This property is applicable only to Autonomous AI Databases on the Exadata Cloud@Customer platform. For Autonomous AI Database Serverless instances, `whitelistedIps` is used. + type: boolean + isAutoScalingEnabled: + description: | + Indicates whether auto scaling is enabled for the Autonomous AI Database CPU core count. Setting to `TRUE` enables auto scaling. Setting to `FALSE` disables auto scaling. The default value is `TRUE`. Auto scaling is only available for [Autonomous AI Database Serverless instances](https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/). + type: boolean + isAutoScalingForStorageEnabled: + description: | + Indicates if auto scaling is enabled for the Autonomous AI Database storage. The default value is `FALSE`. + type: boolean + isBackupRetentionLocked: + description: True if the Autonomous AI Database is backup retention locked. + type: boolean + isDataGuardEnabled: + description: | + ** Deprecated. ** Indicates whether the Autonomous AI Database has a local (in-region) standby database. Not applicable when creating a cross-region Autonomous Data Guard associations, or to + Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. + + To create a local standby, set to `TRUE`. To delete a local standby, set to `FALSE`. For more information on using Autonomous Data Guard on an Autonomous AI Database Serverless instance (local and cross-region) , see [About Standby Databases](https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/autonomous-data-guard-about.html#GUID-045AD017-8120-4BDC-AF58-7430FFE28D2B) + + To enable cross-region Autonomous Data Guard on an Autonomous AI Database Serverless instance, see [Enable Autonomous Data Guard](https://docs-uat.us.oracle.com/en/cloud/paas/autonomous-database/adbsa/autonomous-data-guard-update-type.html#GUID-967ED737-4A05-4D6E-A7CA-C3F21ACF9BF0). + + To delete a cross-region standby database, provide the `peerDbId` for the standby database in a remote region, and set `isDataGuardEnabled` to `FALSE`. + type: boolean + isDevTier: + default: false + description: | + Autonomous AI Database for Developers are fixed-shape Autonomous AI Databases that developers can use to build and test new applications. On Serverless, these are low-cost and billed per instance, on Dedicated and Cloud@Customer there is no additional cost to create Developer databases. Developer databases come with limited resources and is not intended for large-scale testing and production deployments. When you need more compute or storage resources, you may upgrade to a full paid production database. + type: boolean + isDisconnectPeer: + description: | + If true, this disconnects the Autonomous AI Database from its peer. After the disconnect completes, the Autonomous AI Database works permanently as a standalone database. + + **Warning:** A disconnected standby is no longer part of the disaster recovery configuration. Operations and restrictions that apply to a connected standby do not apply in the same way after the database has been disconnected. + + To disconnect a cross region standby, also provide the OCID of the standby database in the `peerDbId` parameter. + type: boolean + isFreeTier: + default: false + description: | + Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous AI Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isLocalDataGuardEnabled + type: boolean + isLocalDataGuardEnabled: + description: | + Indicates whether the Autonomous AI Database has a local (in-region) standby database. Not applicable when creating a cross-region Autonomous Data Guard associations, or to + Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. + + To create a local standby, set to `TRUE`. To delete a local standby, set to `FALSE`. For more information on using Autonomous Data Guard on an Autonomous AI Database Serverless instance (local and cross-region) , see [About Standby Databases](https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/autonomous-data-guard-about.html#GUID-045AD017-8120-4BDC-AF58-7430FFE28D2B) + + To enable cross-region Autonomous Data Guard on an Autonomous AI Database Serverless instance, see [Enable Autonomous Data Guard](https://docs-uat.us.oracle.com/en/cloud/paas/autonomous-database/adbsa/autonomous-data-guard-update-type.html#GUID-967ED737-4A05-4D6E-A7CA-C3F21ACF9BF0). + + This cannot be updated in parallel with any of the following: isMTLSRequired, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + type: boolean + isMtlsConnectionRequired: + description: | + Specifies if the Autonomous AI Database requires mTLS connections. + + This may not be updated in parallel with any of the following: licenseModel, databaseEdition, cpuCoreCount, computeCount, dataStorageSizeInTBs, whitelistedIps, openMode, permissionLevel, db-workload, privateEndpointLabel, nsgIds, customerContacts, dbVersion, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + + Service Change: The default value of the isMTLSConnectionRequired attribute will change from true to false on July 1, 2023 in the following APIs: + - CreateAutonomousDatabase + - GetAutonomousDatabase + - UpdateAutonomousDatabase + Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous AI Database Serverless. + Does this impact me? If you use or maintain custom scripts or Terraform scripts referencing the CreateAutonomousDatabase, GetAutonomousDatabase, or UpdateAutonomousDatabase APIs, you want to check, and possibly modify, the scripts for the changed default value of the attribute. Should you choose not to leave your scripts unchanged, the API calls containing this attribute will continue to work, but the default value will switch from true to false. + How do I make this change? Using either OCI SDKs or command line tools, update your custom scripts to explicitly set the isMTLSConnectionRequired attribute to true. + type: boolean + isRefreshableClone: + description: | + Indicates if the Autonomous AI Database is a refreshable clone. + + This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + type: boolean + isSqlWebDeveloperEnabled: + description: Indicates whether SQL Web Developer is enabled. The default is `FALSE` and no option will be given during provisioning. + type: boolean + licenseModel: + description: | + The Oracle license model that applies to the Oracle Autonomous AI Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle AI Database software licenses and the Oracle AI Database service. + Note that when provisioning an [Autonomous AI Database on dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html), this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. Bring your own license (BYOL) also allows you to select the DB edition using the optional parameter. + + This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + localAdgAutoFailoverMaxDataLossLimit: + description: Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard + maximum: 3600 + minimum: 0 + type: integer + longTermBackupSchedule: + $ref: '#/components/schemas/LongTermBackUpScheduleDetails' + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + ocpuCount: + description: | + The number of OCPU cores to be made available to the Autonomous AI Database. + + For Autonomous AI Databases on Dedicated Exadata Infrastructure, you can specify a fractional value for this parameter. Fractional values are not supported for Autonomous AI Database Serverless instances. + For Autonomous AI Database Serverless instances, this parameter is not used. + + To provision less than 1 core, enter a fractional value in an increment of 0.1. To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available to the infrastructure shape. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. Likewise, you can provision 2 cores or 3 cores, but not 2.5 cores. The maximum number of cores is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/index.html) for shape details. + + **Note:** This parameter cannot be used with the `cpuCoreCount` parameter. + format: float + minimum: 0.1 + type: number + openMode: + description: | + Indicates the Autonomous AI Database mode. The database can be opened in `READ_ONLY` or `READ_WRITE` mode. + + This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + enum: + - READ_ONLY + - READ_WRITE + type: string + x-default-description: 'null' + peerDbId: + description: | + The database OCID(/Content/General/Concepts/identifiers.htm) of the Disaster Recovery peer (source Primary) database, which is located in a different (remote) region from the current peer database. + + To create or delete a local (in-region) standby, see the `isDataGuardEnabled` parameter. + + When disconnecting a cross-region standby, specify the standby database OCID in this parameter together with `isDisconnectPeer=true`. + maxLength: 255 + minLength: 1 + type: string + permissionLevel: + description: | + The Autonomous AI Database permission level. Restricted mode allows access only by admin users. + + This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + enum: + - RESTRICTED + - UNRESTRICTED + type: string + x-default-description: 'null' + privateEndpointIp: + description: The private endpoint Ip address for the resource. + type: string + privateEndpointLabel: + description: | + The resource's private endpoint label. + - Setting the endpoint label to a non-empty string creates a private endpoint database. + - Resetting the endpoint label to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database. + - Setting the endpoint label to a non-empty string value, updates to a new private endpoint database, when the database is disabled and re-enabled. + + This setting cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + type: string + refreshableMode: + description: The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous AI Database. + enum: + - AUTOMATIC + - MANUAL + type: string + resourcePoolLeaderId: + description: The unique identifier for leader Autonomous AI Database OCID [OCID](/Content/General/Concepts/identifiers.htm). + maxLength: 255 + minLength: 1 + type: string + resourcePoolSummary: + $ref: '#/components/schemas/ResourcePoolSummary' + scheduledOperations: + description: | + The list of scheduled operations. Consists of values such as dayOfWeek, scheduledStartTime, scheduledStopTime. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + items: + $ref: '#/components/schemas/ScheduledOperationDetails' + type: array + secretId: + description: The OCI vault secret [/Content/General/Concepts/identifiers.htm]OCID. This cannot be used in conjunction with adminPassword. + maxLength: 255 + minLength: 1 + type: string + secretVersionNumber: + description: The version of the vault secret. If no version is specified, the latest version will be used. + maximum: 60 + minimum: 1 + type: integer + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) + (opaque JSON object) + type: string + description: | + Key-value pair representing a ZPR tag key and value, scoped to a namespace. + Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` + type: object + description: | + Security Attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` + type: object + standbyWhitelistedIps: + description: | + The client IP access control list (ACL). This feature is available for [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. + Only clients connecting from an IP address included in the ACL may access the Autonomous AI Database instance. + If `arePrimaryWhitelistedIpsUsed` is 'TRUE' then Autonomous AI Database uses this primary's IP access control list (ACL) for the disaster recovery peer called `standbywhitelistedips`. + + For Autonomous AI Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). + Multiple IPs and VCN OCIDs should be separate strings separated by commas, but if it’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. + Example: `["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.","ocid1.vcn.oc1.sea.;1.1.1.1","ocid1.vcn.oc1.sea.;1.1.0.0/16"]` + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. + Example: `["1.1.1.1","1.1.1.0/24","1.1.2.25"]` + + For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + items: + maxLength: 1024 + minLength: 0 + type: string + type: array + subnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the resource is associated with. + + **Subnet Restrictions:** + - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. + - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20. + - For Autonomous AI Database, setting this will disable public secure access to the database. + + These subnets are used by the Oracle Clusterware private interconnect on the database instance. + Specifying an overlapping subnet will cause the private interconnect to malfunction. + This restriction applies to both the client subnet and the backup subnet. + maxLength: 255 + minLength: 1 + type: string + timeOfAutoRefreshStart: + description: The the date and time that auto-refreshing will begin for an Autonomous AI Database refreshable clone. This value controls only the start time for the first refresh operation. Subsequent (ongoing) refresh operations have start times controlled by the value of the `autoRefreshFrequencyInSeconds` parameter. + format: date-time + type: string + whitelistedIps: + description: | + The client IP access control list (ACL). This feature is available for [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. + Only clients connecting from an IP address included in the ACL may access the Autonomous AI Database instance. + If `arePrimaryWhitelistedIpsUsed` is 'TRUE' then Autonomous AI Database uses this primary's IP access control list (ACL) for the disaster recovery peer called `standbywhitelistedips`. + + For Autonomous AI Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). + Multiple IPs and VCN OCIDs should be separate strings separated by commas, but if it’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. + Example: `["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.","ocid1.vcn.oc1.sea.;1.1.1.1","ocid1.vcn.oc1.sea.;1.1.0.0/16"]` + For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. + Example: `["1.1.1.1","1.1.1.0/24","1.1.2.25"]` + + For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + items: + maxLength: 1024 + minLength: 0 + type: string + type: array + type: object + ChangeDisasterRecoveryConfigurationDetails: + description: Details to update the cross-region disaster recovery (DR) details of the standby Autonomous AI Database Serverless instance. + properties: + disasterRecoveryType: + description: | + Indicates the disaster recovery (DR) type of the Autonomous AI Database Serverless instance. + Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. + Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. + enum: + - ADG + - BACKUP_BASED + type: string + isReplicateAutomaticBackups: + description: If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database. + type: boolean + isSnapshotStandby: + description: | + Indicates if user wants to convert to a snapshot standby. For example, true would set a standby database to snapshot standby database. False would set a snapshot standby database back to regular standby database. + type: boolean + timeSnapshotStandbyEnabledTill: + description: Time and date stored as an RFC 3339 formatted timestamp string. For example, 2022-01-01T12:00:00.000Z would set a limit for the snapshot standby to be converted back to a cross-region standby database. + format: date-time + type: string + type: object + ChangeAutonomousDatabaseSubscriptionDetails: + description: | + The configuration details for associating the Autonomous AI Database with a different subscription. + properties: + isDefault: + description: | + Indicates if the subscription is UCM or not. + type: boolean + subscriptionId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. + maxLength: 255 + minLength: 1 + type: string + type: object + ConfigureAutonomousDatabaseVaultKeyDetails: + description: Configuration details for the Autonomous AI Database [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts) key. + properties: + isUsingOracleManagedKeys: + description: True if disable Customer Managed Keys and use Oracle Managed Keys. + type: boolean + kmsKeyId: + description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. + maxLength: 255 + minLength: 1 + type: string + vaultId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. + maxLength: 255 + minLength: 1 + type: string + type: object + ConfigureSaasAdminUserDetails: + description: Details to update SaaS administrative user configuration. + properties: + accessType: + description: The access type for the SaaS administrative user. If no access type is specified, the READ_ONLY access type is used. + enum: + - READ_ONLY + - READ_WRITE + - ADMIN + type: string + isEnabled: + description: Indicates if the SaaS administrative user is enabled for the Autonomous AI Database. + type: boolean + timeSaasAdminUserEnabled: + description: The date and time the SaaS administrative user was enabled at, for the Autonomous AI Database. + format: date-time + type: string + duration: + description: How long, in hours, the SaaS administrative user will stay enabled. If no duration is specified, the default value 1 will be used. + maximum: 24 + minimum: 1 + type: integer + password: + description: A strong password for SaaS administrative user. The password must be a minimum of nine (9) characters and contain a minimum of two (2) uppercase, two (2) lowercase, two (2) numbers, and two (2) special characters from _ (underscore), \# (hashtag), or - (dash). + maxLength: 255 + minLength: 9 + type: string + secretId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [secret](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). + maxLength: 255 + minLength: 1 + type: string + secretVersionNumber: + description: The version of the vault secret. If no version is specified, the latest version will be used. + maximum: 60 + minimum: 1 + type: integer + type: object + DeregisterAutonomousDatabaseDataSafeDetails: + description: | + Details to deregister an Autonomous AI Database with Data Safe. + properties: + pdbAdminPassword: + description: The admin password provided during the creation of the database. This password is between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (") or the username "admin", regardless of casing. + maxLength: 30 + minLength: 12 + type: string + required: + - pdbAdminPassword + type: object + GenerateAutonomousDatabaseWalletDetails: + description: | + Details to create and download an Oracle Autonomous AI Database wallet. + properties: + generateType: + default: SINGLE + description: | + The type of wallet to generate. + + **Serverless instance usage:** + * `SINGLE` - used to generate a wallet for a single database + * `ALL` - used to generate wallet for all databases in the region + + **Dedicated Exadata infrastructure usage:** Value must be `NULL` if attribute is used. + enum: + - ALL + - SINGLE + type: string + isRegional: + description: True when requesting regional connection strings in PDB connect info, applicable to cross-region DG only. + type: boolean + password: + description: The password to encrypt the keys inside the wallet. The password must be at least 8 characters long and must include at least 1 letter and either 1 numeric character or 1 special character. + minLength: 8 + type: string + required: + - password + type: object + SaasAdminUserStatus: + description: SaaS administrative user status. + properties: + accessType: + description: The access type for the SaaS administrative user. If no access type is specified, the READ_ONLY access type is used. + enum: + - READ_ONLY + - READ_WRITE + - ADMIN + type: string + isEnabled: + description: Indicates if the SaaS administrative user is enabled for the Autonomous AI Database. + type: boolean + timeSaasAdminUserEnabled: + description: The date and time the SaaS administrative user was enabled at, for the Autonomous AI Database. + format: date-time + type: string + type: object + ImportTransportableTablespaceDetails: + description: | + Details for importing transportable tablespace for an Autonomous AI Database. + properties: + ttsBundleUrl: + description: URL for OCI Storage location for a Transportable Tablespace (TTS) bundle. + type: string + required: + - ttsBundleUrl + type: object + AutonomousDatabaseManualRefreshDetails: + description: | + Details of manual refresh for an Autonomous AI Database refreshable clone. + properties: + timeRefreshCutoff: + description: The timestamp to which the Autonomous AI Database refreshable clone will be refreshed. Changes made in the primary database after this timestamp are not part of the data refresh. + format: date-time + type: string + type: object + RegisterAutonomousDatabaseDataSafeDetails: + description: | + Details for registering an Autonomous AI Database with Data Safe. + properties: + pdbAdminPassword: + description: The admin password provided during the creation of the database. This password is between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (") or the username "admin", regardless of casing. + maxLength: 30 + minLength: 12 + type: string + required: + - pdbAdminPassword + type: object + RestartAutonomousDatabaseDetails: + description: Request details to restart an Autonomous Database with force option. + properties: + isForceRestart: + description: If set to `true`, restarts the Autonomous Database with force option. + type: boolean + type: object + RestoreAutonomousDatabaseDetails: + description: | + Details to restore an Oracle Autonomous AI Database. + properties: + databaseSCN: + description: | + Restores using the backup with the System Change Number (SCN) specified. + maxLength: 255 + minLength: 1 + type: string + latest: + description: | + Restores to the last known good state with the least possible data loss. + type: boolean + timestamp: + description: The time to restore the database to. + format: date-time + type: string + type: object + RotateAutonomousDatabaseEncryptionKeyDetails: + description: Key details provided by the user for rotate key operation for Autonomous AI Database. + properties: + keyVersionId: + description: Key version ocid of the key provided by the user for rotate operation. [OCID](/Content/General/Concepts/identifiers.htm). + maxLength: 255 + minLength: 1 + type: string + type: object + StopAutonomousDatabaseDetails: + description: Request details to stop an Autonomous Database with force option. + properties: + isForceStop: + description: If set to `true`, stops the Autonomous Database with force option. + type: boolean + type: object + AutonomousDatabaseDataguardAssociation: + description: | + The properties that define dataguard association between two different Autonomous AI Databases. + Note that Autonomous AI Databases inherit DataGuard association from parent Autonomous Container Database. + No actions can be taken on AutonomousDatabaseDataguardAssociation, usage is strictly informational. + properties: + applyLag: + description: | + The lag time between updates to the primary database and application of the redo data on the standby database, + as computed by the reporting database. + + Example: `9 seconds` + type: string + applyRate: + description: | + The rate at which redo logs are synced between the associated databases. + + Example: `180 Mb per second` + type: string + autonomousDatabaseId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database that has a relationship with the peer Autonomous AI Database. + maxLength: 255 + minLength: 1 + type: string + id: + description: The OCID of the Autonomous Dataguard created for Autonomous Container Database where given Autonomous AI Database resides in. + maxLength: 255 + minLength: 1 + type: string + isAutomaticFailoverEnabled: + description: | + Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association + type: boolean + lifecycleDetails: + description: | + Additional information about the current lifecycleState, if available. + type: string + lifecycleState: + description: The current state of Autonomous Data Guard. + enum: + - PROVISIONING + - AVAILABLE + - ROLE_CHANGE_IN_PROGRESS + - TERMINATING + - TERMINATED + - FAILED + - UNAVAILABLE + - UPDATING + type: string + peerAutonomousDatabaseId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the peer Autonomous AI Database. + maxLength: 255 + minLength: 1 + type: string + peerAutonomousDatabaseLifeCycleState: + description: The current state of the Autonomous AI Database. + enum: + - PROVISIONING + - AVAILABLE + - STOPPING + - STOPPED + - STARTING + - TERMINATING + - TERMINATED + - UNAVAILABLE + - RESTORE_IN_PROGRESS + - RESTORE_FAILED + - BACKUP_IN_PROGRESS + - SCALE_IN_PROGRESS + - AVAILABLE_NEEDS_ATTENTION + - UPDATING + - MAINTENANCE_IN_PROGRESS + - RESTARTING + - RECREATING + - ROLE_CHANGE_IN_PROGRESS + - UPGRADING + - INACCESSIBLE + - STANDBY + - TRANSPORTING + type: string + peerRole: + description: | + The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. + enum: + - PRIMARY + - STANDBY + - DISABLED_STANDBY + - BACKUP_COPY + - SNAPSHOT_STANDBY + type: string + protectionMode: + description: | + The protection mode of this Autonomous Data Guard association. For more information, see + [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) + in the Oracle Data Guard documentation. + enum: + - MAXIMUM_AVAILABILITY + - MAXIMUM_PERFORMANCE + type: string + role: + description: | + The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. + enum: + - PRIMARY + - STANDBY + - DISABLED_STANDBY + - BACKUP_COPY + - SNAPSHOT_STANDBY + type: string + timeCreated: + description: The date and time the Data Guard association was created. + format: date-time + type: string + timeLastRoleChanged: + description: The date and time when the last role change action happened. + format: date-time + type: string + timeLastSynced: + description: The date and time of the last update to the apply lag, apply rate, and transport lag values. + format: date-time + type: string + transportLag: + description: | + The approximate number of seconds of redo data not yet available on the standby Autonomous Container Database, + as computed by the reporting database. + + Example: `7 seconds` + type: string + required: + - id + - lifecycleState + - autonomousDatabaseId + - role + - peerRole + type: object + EstimateCostSavingsSummaryCollection: + description: A list of estimate cost savings. + properties: + items: + description: List of estimate cost saving summary. + items: + $ref: '#/components/schemas/EstimateCostSavingSummary' + type: array + required: + - items + type: object + AutonomousDatabasePeerCollection: + description: | + The object holds details about the peer Autonomous AI Databases for an Oracle Autonomous AI Database. + properties: + items: + description: This array holds details about Autonomous AI Database Peers for Oracle an Autonomous AI Database. + items: + $ref: '#/components/schemas/AutonomousDatabasePeerSummary' + maxItems: 1000 + minItems: 0 + type: array + required: + - items + type: object + RefreshableCloneCollection: + description: A list of Autonomous AI Database RefreshableClone containing RefreshableCloneSummary items. + properties: + items: + items: + $ref: '#/components/schemas/RefreshableCloneSummary' + type: array + required: + - items + type: object + ResourcePoolMemberCollection: + description: A list of Autonomous AI Database resource pool member OCIDs. + properties: + items: + description: List of resource pool member summary. + items: + $ref: '#/components/schemas/ResourcePoolMemberSummary' + type: array + required: + - items + type: object + AutonomousDbPreviewVersionSummary: + description: | + The Autonomous AI Database preview version. Note that preview version software is only available for [Autonomous AI Database Serverless instances](https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/). + properties: + dbWorkload: + description: | + The Autonomous AI Database workload type. The following values are valid: + - OLTP - indicates an Autonomous AI Transaction Processing database + - DW - indicates an Autonomous AI Lakehouse database + - AJD - indicates an Autonomous AI JSON Database + - APEX - indicates an Autonomous AI Database with the Oracle APEX AI Application Development workload type. + - LH - indicates an Oracle Autonomous AI Lakehouse database + + **Note** Starting December 2026, DW will not be supported as a valid value for this parameter. + When creating an Autonomous AI Database, if this parameter is not specified, the default value is `OLTP`. + + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + enum: + - OLTP + - DW + - AJD + - APEX + - LH + type: string + details: + description: A URL that points to a detailed description of the preview version. + type: string + timePreviewBegin: + description: The date and time when the preview version availability begins. + format: date-time + type: string + timePreviewEnd: + description: The date and time when the preview version availability ends. + format: date-time + type: string + version: + description: A valid Autonomous AI Database preview version. + maxLength: 255 + minLength: 1 + type: string + required: + - version + type: object + AutonomousDbVersionSummary: + description: | + The supported Autonomous AI Database version. + properties: + dbWorkload: + description: | + The Autonomous AI Database workload type. The following values are valid: + - OLTP - indicates an Autonomous AI Transaction Processing database + - DW - indicates an Autonomous AI Lakehouse database + - AJD - indicates an Autonomous AI JSON Database + - APEX - indicates an Autonomous AI Database with the Oracle APEX AI Application Development workload type. + - LH - indicates an Oracle Autonomous AI Lakehouse database + + **Note** Starting December 2026, DW will not be supported as a valid value for this parameter. + When creating an Autonomous AI Database, if this parameter is not specified, the default value is `OLTP`. + + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + enum: + - OLTP + - DW + - AJD + - APEX + - LH + type: string + details: + description: A URL that points to a detailed description of the Autonomous AI Database version. + type: string + isDedicated: + description: | + True if the database uses [dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html). + type: boolean + isDefaultForFree: + description: True if this version of the Oracle AI Database software's default is free. + type: boolean + isDefaultForPaid: + description: True if this version of the Oracle AI Database software's default is paid. + type: boolean + isFreeTierEnabled: + description: True if this version of the Oracle AI Database software can be used for Always-Free Autonomous AI Databases. + type: boolean + isPaidEnabled: + description: True if this version of the Oracle AI Database software has payments enabled. + type: boolean + version: + description: | + A valid Oracle AI Database version for Autonomous AI Database. + When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai. + When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected. + For new databases, it is recommended to use either 19c or 26ai. + + **Note** Starting December 2026, 23ai will not be supported as a valid value for this parameter. + maxLength: 255 + minLength: 1 + type: string + required: + - version + type: object + AutonomousExadataInfrastructureShapeSummary: + description: | + The shape of the Autonomous Exadata Infrastructure. The shape determines resources to allocate to the Autonomous Exadata Infrastructure (CPU cores, memory and storage). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. + If you're an administrator who needs to write policies to give users access, + see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + availableCoreCount: + description: The maximum number of CPU cores that can be enabled on the Autonomous Exadata Infrastructure. + type: integer + coreCountIncrement: + description: The increment in which core count can be increased or decreased. + type: integer + maximumNodeCount: + description: The maximum number of nodes available for the shape. + type: integer + minimumCoreCount: + description: The minimum number of CPU cores that can be enabled on the Autonomous Exadata Infrastructure. + type: integer + minimumNodeCount: + description: The minimum number of nodes available for the shape. + type: integer + name: + description: The name of the shape used for the Autonomous Exadata Infrastructure. + maxLength: 255 + minLength: 1 + type: string + runtimeMinimumCoreCount: + description: The runtime minimum number of CPU cores that can be enabled on the DB system for this shape. + type: integer + required: + - name + - availableCoreCount + type: object + AutonomousExadataInfrastructureSummary: + description: | + **Deprecated** These APIs are deprecated with the introduction of the Autonomous Exadata VM Cluster resource and a shift to a common Exadata Infrastructure resource for all Exadata Cloud-based services, including Autonomous AI Database on dedicated Exadata infrastructure. For more details, see [Latest Resource Model](https://docs.oracle.com/en/cloud/paas/autonomous-database/flddd/#articletitle). + + Infrastructure that enables the running of multiple Autonomous AI Databases within a dedicated DB system. + For more information about Autonomous Exadata Infrastructure, see + [Oracle Autonomous AI Database](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + For information about access control and compartments, see + [Overview of the Identity Service](/Content/Identity/Concepts/overview.htm). + + For information about availability domains, see + [Regions and Availability Domains](/Content/General/Concepts/regions.htm). + + To get a list of availability domains, use the ListAvailabilityDomains operation + in the Identity service API. + properties: + availabilityDomain: + description: The name of the availability domain that the Autonomous Exadata Infrastructure is located in. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Autonomous Exadata Infrastructure. + maxLength: 255 + minLength: 1 + type: string + domain: + description: The domain name for the Autonomous Exadata Infrastructure. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + hostname: + description: The host name for the Autonomous Exadata Infrastructure node. + type: string + id: + description: The OCID of the Autonomous Exadata Infrastructure. + maxLength: 255 + minLength: 1 + type: string + lastMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run. + maxLength: 255 + minLength: 1 + type: string + licenseModel: + description: | + The Oracle license model that applies to all databases in the Autonomous Exadata Infrastructure. The default is BRING_YOUR_OWN_LICENSE. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state of the Autonomous Exadata Infrastructure. + type: string + lifecycleState: + description: The current lifecycle state of the Autonomous Exadata Infrastructure. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - MAINTENANCE_IN_PROGRESS + type: string + maintenanceWindow: + $ref: '#/components/schemas/MaintenanceWindow' + nextMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run. + maxLength: 255 + minLength: 1 + type: string + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + scanDnsName: + description: | + The FQDN of the DNS record for the SCAN IP addresses that are associated with the Autonomous Exadata Infrastructure. + maxLength: 72 + minLength: 1 + type: string + shape: + description: The shape of the Autonomous Exadata Infrastructure. The shape determines resources to allocate to the Autonomous Exadata Infrastructure (CPU cores, memory and storage). + maxLength: 255 + minLength: 1 + type: string + subnetId: + description: | + The OCID of the subnet the Autonomous Exadata Infrastructure is associated with. + + **Subnet Restrictions:** + - For Autonomous AI Databases with Autonomous Exadata Infrastructure, do not use a subnet that overlaps with 192.168.128.0/20 + + These subnets are used by the Oracle Clusterware private interconnect on the database instance. + Specifying an overlapping subnet will cause the private interconnect to malfunction. + This restriction applies to both the client subnet and backup subnet. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: The date and time the Autonomous Exadata Infrastructure was created. + format: date-time + type: string + zoneId: + description: | + The OCID of the zone the Autonomous Exadata Infrastructure is associated with. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - lifecycleState + - displayName + - availabilityDomain + - subnetId + - shape + - hostname + - domain + - maintenanceWindow + type: object + LaunchAutonomousExadataInfrastructureDetails: + description: | + Describes the input parameters to launch a new Autonomous Exadata Infrastructure. + properties: + availabilityDomain: + description: The availability domain where the Autonomous Exadata Infrastructure is located. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment the Autonomous Exadata Infrastructure belongs in. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Autonomous Exadata Infrastructure. It does not have to be unique. + maxLength: 255 + minLength: 1 + type: string + domain: + description: | + A domain name used for the Autonomous Exadata Infrastructure. If the Oracle-provided Internet and VCN + Resolver is enabled for the specified subnet, the domain name for the subnet is used + (don't provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + licenseModel: + description: | + The Oracle license model that applies to all the databases in the Autonomous Exadata Infrastructure. The default is BRING_YOUR_OWN_LICENSE. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + maintenanceWindowDetails: + $ref: '#/components/schemas/MaintenanceWindow' + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + shape: + description: The shape of the Autonomous Exadata Infrastructure. The shape determines resources allocated to the Autonomous Exadata Infrastructure (CPU cores, memory and storage). To get a list of shapes, use the ListDbSystemShapes operation. + maxLength: 255 + minLength: 1 + type: string + subnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the Autonomous Exadata Infrastructure is associated with. + + **Subnet Restrictions:** + - For Autonomous Exadata Infrastructures, do not use a subnet that overlaps with 192.168.128.0/20 + + These subnets are used by the Oracle Clusterware private interconnect on the database instance. + Specifying an overlapping subnet will cause the private interconnect to malfunction. + This restriction applies to both the client subnet and backup subnet. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - availabilityDomain + - subnetId + - shape + type: object + AutonomousExadataInfrastructure: + description: | + **Deprecated** These APIs are deprecated with the introduction of the Autonomous Exadata VM Cluster resource and a shift to a common Exadata Infrastructure resource for all Exadata Cloud-based services, including Autonomous AI Database on dedicated Exadata infrastructure. For more details, see [Latest Resource Model](https://docs.oracle.com/en/cloud/paas/autonomous-database/flddd/#articletitle). + + Infrastructure that enables the running of multiple Autonomous AI Databases within a dedicated DB system. + For more information about Autonomous Exadata Infrastructure, see + [Oracle Autonomous AI Database](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + For information about access control and compartments, see + [Overview of the Identity Service](/Content/Identity/Concepts/overview.htm). + + For information about availability domains, see + [Regions and Availability Domains](/Content/General/Concepts/regions.htm). + + To get a list of availability domains, use the ListAvailabilityDomains operation + in the Identity service API. + properties: + availabilityDomain: + description: The name of the availability domain that the Autonomous Exadata Infrastructure is located in. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Autonomous Exadata Infrastructure. + maxLength: 255 + minLength: 1 + type: string + domain: + description: The domain name for the Autonomous Exadata Infrastructure. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + hostname: + description: The host name for the Autonomous Exadata Infrastructure node. + type: string + id: + description: The OCID of the Autonomous Exadata Infrastructure. + maxLength: 255 + minLength: 1 + type: string + lastMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run. + maxLength: 255 + minLength: 1 + type: string + licenseModel: + description: | + The Oracle license model that applies to all databases in the Autonomous Exadata Infrastructure. The default is BRING_YOUR_OWN_LICENSE. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state of the Autonomous Exadata Infrastructure. + type: string + lifecycleState: + description: The current lifecycle state of the Autonomous Exadata Infrastructure. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - MAINTENANCE_IN_PROGRESS + type: string + maintenanceWindow: + $ref: '#/components/schemas/MaintenanceWindow' + nextMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run. + maxLength: 255 + minLength: 1 + type: string + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + scanDnsName: + description: | + The FQDN of the DNS record for the SCAN IP addresses that are associated with the Autonomous Exadata Infrastructure. + maxLength: 72 + minLength: 1 + type: string + shape: + description: The shape of the Autonomous Exadata Infrastructure. The shape determines resources to allocate to the Autonomous Exadata Infrastructure (CPU cores, memory and storage). + maxLength: 255 + minLength: 1 + type: string + subnetId: + description: | + The OCID of the subnet the Autonomous Exadata Infrastructure is associated with. + + **Subnet Restrictions:** + - For Autonomous AI Databases with Autonomous Exadata Infrastructure, do not use a subnet that overlaps with 192.168.128.0/20 + + These subnets are used by the Oracle Clusterware private interconnect on the database instance. + Specifying an overlapping subnet will cause the private interconnect to malfunction. + This restriction applies to both the client subnet and backup subnet. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: The date and time the Autonomous Exadata Infrastructure was created. + format: date-time + type: string + zoneId: + description: | + The OCID of the zone the Autonomous Exadata Infrastructure is associated with. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - lifecycleState + - displayName + - availabilityDomain + - subnetId + - shape + - hostname + - domain + - maintenanceWindow + type: object + UpdateAutonomousExadataInfrastructureDetails: + description: | + Describes the modification parameters for the Autonomous Exadata Infrastructure. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The display name is a user-friendly name for the Autonomous Exadata Infrastructure. The display name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + maintenanceWindowDetails: + $ref: '#/components/schemas/MaintenanceWindow' + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + type: object + OCPUs: + description: | + The details of the available and consumed CPU cores of the Autonomous Exadata Infrastructure instance, including consumption by database workload type. + properties: + byWorkloadType: + $ref: '#/components/schemas/WorkloadType' + consumedCpu: + description: The total number of consumed OCPUs in the Autonomous Exadata Infrastructure instance. + format: float + maximum: 92 + minimum: 0 + type: number + totalCpu: + description: The total number of OCPUs in the Autonomous Exadata Infrastructure instance. + format: float + maximum: 92 + minimum: 0 + type: number + type: object + AutonomousPatch: + description: | + A patch for an Autonomous Exadata Infrastructure or Autonomous Container Database. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + autonomousPatchType: + default: QUARTERLY + description: | + Maintenance run type, either "QUARTERLY" or "TIMEZONE". + enum: + - QUARTERLY + - TIMEZONE + type: string + description: + description: The text describing this patch package. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the patch. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: | + A descriptive text associated with the lifecycleState. + Typically can contain additional displayable text. + type: string + lifecycleState: + description: The current state of the patch as a result of lastAction. + enum: + - AVAILABLE + - SUCCESS + - IN_PROGRESS + - FAILED + type: string + patchModel: + description: Database patching model preference. See [My Oracle Support note 2285040.1](https://support.oracle.com/rs?type=doc&id=2285040.1) for information on the Release Update (RU) and Release Update Revision (RUR) patching models. + enum: + - RELEASE_UPDATES + - RELEASE_UPDATE_REVISIONS + type: string + quarter: + description: First month of the quarter in which the patch was released. + maxLength: 20 + minLength: 1 + type: string + timeReleased: + description: The date and time that the patch was released. + format: date-time + type: string + type: + description: The type of patch. BUNDLE is one example. + type: string + version: + description: The version of this patch package. + maxLength: 255 + minLength: 1 + type: string + year: + description: Year in which the patch was released. + maxLength: 10 + minLength: 1 + type: string + required: + - id + - description + - version + - timeReleased + - type + type: object + AutonomousVirtualMachineSummary: + description: | + Details of the Autonomous Virtual Machine. + properties: + autonomousVmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous VM Cluster associated with the Autonomous Virtual Machine. + maxLength: 255 + minLength: 1 + type: string + clientIpAddress: + description: Client IP Address. + maxLength: 255 + minLength: 1 + type: string + cloudAutonomousVmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Cloud Autonomous VM Cluster associated with the Autonomous Virtual Machine. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + cpuCoreCount: + description: The number of CPU cores enabled on the Autonomous Virtual Machine. + type: integer + dbNodeStorageSizeInGBs: + description: The allocated local node storage in GBs on the Autonomous Virtual Machine. + type: integer + dbServerDisplayName: + description: The display name of the dbServer associated with the Autonomous Virtual Machine. + maxLength: 255 + minLength: 1 + type: string + dbServerId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Db server associated with the Autonomous Virtual Machine. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous Virtual Machine. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the Autonomous Virtual Machine. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - MAINTENANCE_IN_PROGRESS + type: string + memorySizeInGBs: + description: The allocated memory in GBs on the Autonomous Virtual Machine. + type: integer + vmName: + description: The name of the Autonomous Virtual Machine. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - lifecycleState + type: object + AutonomousVirtualMachine: + description: Autonomous Virtual Machine details. + properties: + autonomousVmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous VM Cluster associated with the Autonomous Virtual Machine. + maxLength: 255 + minLength: 1 + type: string + clientIpAddress: + description: Client IP Address. + maxLength: 255 + minLength: 1 + type: string + cloudAutonomousVmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Cloud Autonomous VM Cluster associated with the Autonomous Virtual Machine. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + cpuCoreCount: + description: The number of CPU cores enabled on the Autonomous Virtual Machine. + type: integer + dbNodeStorageSizeInGBs: + description: The allocated local node storage in GBs on the Autonomous Virtual Machine. + type: integer + dbServerDisplayName: + description: The display name of the dbServer associated with the Autonomous Virtual Machine. + maxLength: 255 + minLength: 1 + type: string + dbServerId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Db server associated with the Autonomous Virtual Machine. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous Virtual Machine. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the Autonomous Virtual Machine. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - MAINTENANCE_IN_PROGRESS + type: string + memorySizeInGBs: + description: The allocated memory in GBs on the Autonomous Virtual Machine. + type: integer + vmName: + description: The name of the Autonomous Virtual Machine. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - lifecycleState + type: object + AutonomousVmClusterSummary: + description: | + Details of the Autonomous VM cluster. + properties: + autonomousDataStoragePercentage: + description: The percentage of the data storage used for the Autonomous Databases in an Autonomous VM Cluster. + format: float + type: number + autonomousDataStorageSizeInTBs: + description: The data disk group size allocated for Autonomous Databases, in TBs. + format: double + type: number + availableAutonomousDataStorageSizeInTBs: + description: The data disk group size available for Autonomous Databases, in TBs. + format: double + minimum: 0 + type: number + availableContainerDatabases: + description: The number of Autonomous Container Databases that can be created with the currently available local storage. + minimum: 0 + type: integer + availableCpus: + description: The numnber of CPU cores available. + type: integer + availableDataStorageSizeInTBs: + description: | + **Deprecated.** Use `availableAutonomousDataStorageSizeInTBs` for Autonomous Databases' data storage availability in TBs. + format: double + type: number + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeModel: + description: | + The compute model of the Autonomous VM Cluster. ECPU compute model is the recommended model and OCPU compute model is legacy. See [Compute Models in Autonomous Database on Dedicated Exadata #Infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbak) for more details. + enum: + - ECPU + - OCPU + type: string + cpuCoreCountPerNode: + description: The number of CPU cores enabled per VM cluster node. + type: integer + cpuPercentage: + description: The percentage of total number of CPUs used in an Autonomous VM Cluster. + format: float + type: number + cpusEnabled: + description: The number of enabled CPU cores. + type: integer + cpusLowestScaledValue: + description: The lowest value to which cpus can be scaled down. + format: int32 + type: integer + dataStorageSizeInGBs: + description: The total data storage allocated in GBs. + format: double + minimum: 32 + type: number + dataStorageSizeInTBs: + description: The total data storage allocated in TBs + format: double + type: number + dbNodeStorageSizeInGBs: + description: The local node storage allocated in GBs. + type: integer + dbServers: + description: The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Db servers. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Autonomous VM cluster. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + distributionAlgorithm: + description: The distribution algorithm used for the Autonomous VM cluster. + enum: + - RESOURCE_OPTIMIZED + - DISTRIBUTION_OPTIMIZED + type: string + exadataInfrastructureId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + exadataStorageInTBsLowestScaledValue: + description: The lowest value to which exadataStorage(in TBs) can be scaled down. + format: double + type: number + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous VM cluster. + maxLength: 255 + minLength: 1 + type: string + isLocalBackupEnabled: + description: | + If true, database backup on local Exadata storage is configured for the Autonomous VM cluster. If false, database backup on local Exadata storage is not available in the Autonomous VM cluster. + type: boolean + isMtlsEnabled: + default: false + description: Enable mutual TLS(mTLS) authentication for database while provisioning a VMCluster. Default is TLS. + type: boolean + lastMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run. + maxLength: 255 + minLength: 1 + type: string + licenseModel: + description: | + The Oracle license model that applies to the Autonomous VM cluster. The default is LICENSE_INCLUDED. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the Autonomous VM cluster. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - MAINTENANCE_IN_PROGRESS + type: string + maintenanceWindow: + $ref: '#/components/schemas/MaintenanceWindow' + maxAcdsLowestScaledValue: + description: The lowest value to which maximum number of ACDs can be scaled down. + format: int32 + type: integer + memoryPerOracleComputeUnitInGBs: + description: | + The amount of memory (in GBs) to be enabled per each CPU core. + type: integer + memorySizeInGBs: + description: The memory allocated in GBs. + type: integer + nextMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run. + maxLength: 255 + minLength: 1 + type: string + nodeCount: + description: | + The number of nodes in the Autonomous VM Cluster. + format: int32 + minimum: 1 + type: integer + nonProvisionableAutonomousContainerDatabases: + description: The number of non-provisionable Autonomous Container Databases in an Autonomous VM Cluster. + type: integer + ocpusEnabled: + description: The number of enabled OCPU cores. + format: float + minimum: 0.1 + type: number + provisionableAutonomousContainerDatabases: + description: | + **Deprecated.** Use field totalContainerDatabases. + type: integer + provisionedAutonomousContainerDatabases: + description: The number of provisioned Autonomous Container Databases in an Autonomous VM Cluster. + type: integer + provisionedCpus: + description: The number of CPUs provisioned in an Autonomous VM Cluster. + format: float + type: number + reclaimableCpus: + description: | + CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous Database is terminated or scaled down. You can release them to the available CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database. + type: integer + reservedCpus: + description: The number of CPUs reserved in an Autonomous VM Cluster. + format: float + type: number + scanListenerPortNonTls: + description: The SCAN Listener Non TLS port number. Default value is 1521. + maximum: 8999 + minimum: 1024 + type: integer + scanListenerPortTls: + description: The SCAN Listener TLS port number. Default value is 2484. + maximum: 8999 + minimum: 1024 + type: integer + sgaPercentage: + description: Percentage of ECPU memory allocated for SGA(System Global Area). + format: float + type: number + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time that the Autonomous VM cluster was created. + format: date-time + type: string + timeDatabaseSslCertificateExpires: + description: The date and time of the Database SSL certificate expiration. + format: date-time + type: string + timeOrdsCertificateExpires: + description: The date and time of the ORDS certificate expiration. + format: date-time + type: string + timeZone: + description: The time zone to use for the Autonomous VM cluster. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm). + maxLength: 255 + minLength: 1 + type: string + totalAutonomousDataStorageInTBs: + description: The total data disk group size for Autonomous Databases, in TBs. + format: float + type: number + totalContainerDatabases: + description: The total number of Autonomous Container Databases that can be created. + type: integer + vmClusterNetworkId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - lifecycleState + - displayName + - exadataInfrastructureId + - vmClusterNetworkId + type: object + CreateAutonomousVmClusterDetails: + description: | + Details for the create Autonomous VM cluster operation. + properties: + autonomousDataStorageSizeInTBs: + description: The data disk group size to be allocated for Autonomous Databases, in TBs. + format: double + type: number + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeModel: + default: ECPU + description: | + The compute model of the Autonomous VM Cluster. ECPU compute model is the recommended model and OCPU compute model is legacy. + enum: + - ECPU + - OCPU + type: string + cpuCoreCountPerNode: + description: The number of CPU cores to enable per VM cluster node. + type: integer + dbServers: + description: The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Db servers. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Autonomous VM cluster. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + distributionAlgorithm: + description: The distribution algorithm used for the Autonomous VM cluster. + enum: + - RESOURCE_OPTIMIZED + - DISTRIBUTION_OPTIMIZED + type: string + exadataInfrastructureId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + isLocalBackupEnabled: + description: | + If true, database backup on local Exadata storage is configured for the Autonomous VM cluster. If false, database backup on local Exadata storage is not available in the Autonomous VM cluster. + type: boolean + isMtlsEnabled: + default: false + description: Enable mutual TLS(mTLS) authentication for database while provisioning a VMCluster. Default is TLS. + type: boolean + licenseModel: + description: | + The Oracle license model that applies to the Autonomous VM cluster. The default is BRING_YOUR_OWN_LICENSE. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + maintenanceWindowDetails: + $ref: '#/components/schemas/MaintenanceWindow' + memoryPerOracleComputeUnitInGBs: + description: | + The amount of memory (in GBs) to be enabled per OCPU or ECPU. + type: integer + scanListenerPortNonTls: + description: The SCAN Listener Non TLS port number. Default value is 1521. + maximum: 8999 + minimum: 1024 + type: integer + scanListenerPortTls: + description: The SCAN Listener TLS port number. Default value is 2484. + maximum: 8999 + minimum: 1024 + type: integer + sgaPercentage: + description: Percentage of ECPU memory allocated for SGA(System Global Area). + format: float + type: number + timeZone: + description: The time zone to use for the Autonomous VM cluster. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm). + format: x-obmcs-time-zone + maxLength: 255 + minLength: 1 + type: string + totalContainerDatabases: + description: The total number of Autonomous Container Databases that can be created. + type: integer + vmClusterNetworkId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - displayName + - exadataInfrastructureId + - vmClusterNetworkId + type: object + AutonomousVmCluster: + description: | + Details of the Autonomous VM cluster. + properties: + autonomousDataStoragePercentage: + description: The percentage of the data storage used for the Autonomous Databases in an Autonomous VM Cluster. + format: float + type: number + autonomousDataStorageSizeInTBs: + description: The data disk group size allocated for Autonomous Databases, in TBs. + format: double + type: number + availableAutonomousDataStorageSizeInTBs: + description: The data disk group size available for Autonomous Databases, in TBs. + format: double + minimum: 0 + type: number + availableContainerDatabases: + description: The number of Autonomous Container Databases that can be created with the currently available local storage. + minimum: 0 + type: integer + availableCpus: + description: The numnber of CPU cores available. + type: integer + availableDataStorageSizeInTBs: + description: | + **Deprecated.** Use `availableAutonomousDataStorageSizeInTBs` for Autonomous Databases' data storage availability in TBs. + format: double + type: number + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeModel: + description: | + The compute model of the Autonomous VM Cluster. ECPU compute model is the recommended model and OCPU compute model is legacy. See [Compute Models in Autonomous Database on Dedicated Exadata #Infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbak) for more details. + enum: + - ECPU + - OCPU + type: string + cpuCoreCountPerNode: + description: The number of CPU cores enabled per VM cluster node. + type: integer + cpuPercentage: + description: The percentage of total number of CPUs used in an Autonomous VM Cluster. + format: float + type: number + cpusEnabled: + description: The number of enabled CPU cores. + type: integer + cpusLowestScaledValue: + description: The lowest value to which cpus can be scaled down. + format: int32 + type: integer + dataStorageSizeInGBs: + description: The total data storage allocated in GBs. + format: double + minimum: 32 + type: number + dataStorageSizeInTBs: + description: The total data storage allocated in TBs + format: double + type: number + dbNodeStorageSizeInGBs: + description: The local node storage allocated in GBs. + type: integer + dbServers: + description: The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Db servers. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Autonomous VM cluster. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + distributionAlgorithm: + description: The distribution algorithm used for the Autonomous VM cluster. + enum: + - RESOURCE_OPTIMIZED + - DISTRIBUTION_OPTIMIZED + type: string + exadataInfrastructureId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + exadataStorageInTBsLowestScaledValue: + description: The lowest value to which exadataStorage(in TBs) can be scaled down. + format: double + type: number + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous VM cluster. + maxLength: 255 + minLength: 1 + type: string + isLocalBackupEnabled: + description: | + If true, database backup on local Exadata storage is configured for the Autonomous VM cluster. If false, database backup on local Exadata storage is not available in the Autonomous VM cluster. + type: boolean + isMtlsEnabled: + default: false + description: Enable mutual TLS(mTLS) authentication for database while provisioning a VMCluster. Default is TLS. + type: boolean + lastMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run. + maxLength: 255 + minLength: 1 + type: string + licenseModel: + description: | + The Oracle license model that applies to the Autonomous VM cluster. The default is LICENSE_INCLUDED. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the Autonomous VM cluster. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - MAINTENANCE_IN_PROGRESS + type: string + maintenanceWindow: + $ref: '#/components/schemas/MaintenanceWindow' + maxAcdsLowestScaledValue: + description: The lowest value to which maximum number of ACDs can be scaled down. + format: int32 + type: integer + memoryPerOracleComputeUnitInGBs: + description: | + The amount of memory (in GBs) to be enabled per each CPU core. + type: integer + memorySizeInGBs: + description: The memory allocated in GBs. + type: integer + nextMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run. + maxLength: 255 + minLength: 1 + type: string + nodeCount: + description: | + The number of nodes in the Autonomous VM Cluster. + format: int32 + minimum: 1 + type: integer + nonProvisionableAutonomousContainerDatabases: + description: The number of non-provisionable Autonomous Container Databases in an Autonomous VM Cluster. + type: integer + ocpusEnabled: + description: The number of enabled OCPU cores. + format: float + minimum: 0.1 + type: number + provisionableAutonomousContainerDatabases: + description: | + **Deprecated.** Use field totalContainerDatabases. + type: integer + provisionedAutonomousContainerDatabases: + description: The number of provisioned Autonomous Container Databases in an Autonomous VM Cluster. + type: integer + provisionedCpus: + description: The number of CPUs provisioned in an Autonomous VM Cluster. + format: float + type: number + reclaimableCpus: + description: | + CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous Database is terminated or scaled down. You can release them to the available CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database. + type: integer + reservedCpus: + description: The number of CPUs reserved in an Autonomous VM Cluster. + format: float + type: number + scanListenerPortNonTls: + description: The SCAN Listener Non TLS port number. Default value is 1521. + maximum: 8999 + minimum: 1024 + type: integer + scanListenerPortTls: + description: The SCAN Listener TLS port number. Default value is 2484. + maximum: 8999 + minimum: 1024 + type: integer + sgaPercentage: + description: Percentage of ECPU memory allocated for SGA(System Global Area). + format: float + type: number + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time that the Autonomous VM cluster was created. + format: date-time + type: string + timeDatabaseSslCertificateExpires: + description: The date and time of the Database SSL certificate expiration. + format: date-time + type: string + timeOrdsCertificateExpires: + description: The date and time of the ORDS certificate expiration. + format: date-time + type: string + timeZone: + description: The time zone to use for the Autonomous VM cluster. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm). + maxLength: 255 + minLength: 1 + type: string + totalAutonomousDataStorageInTBs: + description: The total data disk group size for Autonomous Databases, in TBs. + format: float + type: number + totalContainerDatabases: + description: The total number of Autonomous Container Databases that can be created. + type: integer + vmClusterNetworkId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - lifecycleState + - displayName + - exadataInfrastructureId + - vmClusterNetworkId + type: object + UpdateAutonomousVmClusterDetails: + description: Details for updating the Autonomous VM cluster. + properties: + autonomousDataStorageSizeInTBs: + description: The new value of autonomous data storage (in TBs) for the Autonomous VM cluster. + format: double + type: number + cpuCoreCountPerNode: + description: The new value of cpus per Autonomous VM cluster per node for the Autonomous VM cluster. + type: integer + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + distributionAlgorithm: + description: The distribution algorithm used for the Autonomous VM cluster. + enum: + - RESOURCE_OPTIMIZED + - DISTRIBUTION_OPTIMIZED + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + isMtlsEnabled: + default: false + description: Enable mutual TLS(mTLS) authentication for database. Default is TLS. + type: boolean + licenseModel: + description: | + The Oracle license model that applies to the Autonomous VM cluster. The default is BRING_YOUR_OWN_LICENSE. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + maintenanceWindowDetails: + $ref: '#/components/schemas/MaintenanceWindow' + scanListenerPortNonTls: + description: The SCAN Listener Non TLS port number. Default value is 1521. + maximum: 8999 + minimum: 1024 + type: integer + scanListenerPortTls: + description: The SCAN Listener TLS port number. Default value is 2484. + maximum: 8999 + minimum: 1024 + type: integer + timeZone: + description: The time zone to use for the Autonomous VM cluster. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm). + format: x-obmcs-time-zone + maxLength: 255 + minLength: 1 + type: string + totalContainerDatabases: + description: The new value of maximum number of ACDs for the Autonomous VM cluster. + type: integer + type: object + ChangeAutonomousVmClusterCompartmentDetails: + description: | + The configuration details for moving the Autonomous VM cluster. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the Autonomous VM cluster to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + RotateAutonomousVmClusterOrdsCertsDetails: + description: | + The details for configuring the SSL certificates on Autonomous VM Cluster + properties: + caBundleId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate bundle. + maxLength: 255 + minLength: 1 + type: string + certificateAuthorityId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate authority. + maxLength: 255 + minLength: 1 + type: string + certificateGenerationType: + description: Specify SYSTEM to use Oracle-managed certificates. Specify BYOC when you want to bring your own certificate. + enum: + - SYSTEM + - BYOC + type: string + certificateId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate to use. + maxLength: 255 + minLength: 1 + type: string + required: + - certificateGenerationType + type: object + RotateAutonomousVmClusterSslCertsDetails: + description: | + Details for configuring the ORDS certificates on Autonomous Exadata VM Cluster + properties: + caBundleId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate bundle. + maxLength: 255 + minLength: 1 + type: string + certificateAuthorityId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate authority. + maxLength: 255 + minLength: 1 + type: string + certificateGenerationType: + description: Specify SYSTEM to use Oracle-managed certificates. Specify BYOC when you want to bring your own certificate. + enum: + - SYSTEM + - BYOC + type: string + certificateId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate to use. + maxLength: 255 + minLength: 1 + type: string + required: + - certificateGenerationType + type: object + AutonomousVmClusterResourceUsage: + description: | + Autonomous VM Cluster usage details, including the Autonomous Container Databases usage. + properties: + autonomousDataStorageSizeInTBs: + description: The data disk group size allocated for Autonomous Databases, in TBs. + format: float + type: number + autonomousVmResourceUsage: + description: List of autonomous vm cluster resource usages. + items: + $ref: '#/components/schemas/AutonomousVmResourceUsage' + maxItems: 1024 + type: array + availableAutonomousDataStorageSizeInTBs: + description: The data disk group size available for Autonomous Databases, in TBs. + format: float + type: number + availableCpus: + description: The number of CPU cores available. + format: float + type: number + dbNodeStorageSizeInGBs: + description: The local node storage allocated in GBs. + type: integer + displayName: + description: The user-friendly name for the Autonomous VM cluster. The name does not need to be unique. + type: string + exadataStorageInTBs: + description: Total exadata storage allocated for the Autonomous VM Cluster. DATA + RECOVERY + SPARSE + any overhead in TBs. + format: double + type: number + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous VM cluster. + type: string + isLocalBackupEnabled: + description: If true, database backup on local Exadata storage is configured for the Autonomous VM cluster. If false, database backup on local Exadata storage is not available in the Autonomous VM cluster. + type: boolean + memoryPerOracleComputeUnitInGBs: + description: | + The amount of memory (in GBs) to be enabled per each CPU core. + type: integer + memorySizeInGBs: + description: The memory allocated in GBs. + type: integer + nonProvisionableAutonomousContainerDatabases: + description: The number of non-provisionable Autonomous Container Databases in an Autonomous VM Cluster. + type: integer + provisionableAutonomousContainerDatabases: + description: The number of provisionable Autonomous Container Databases in an Autonomous VM Cluster. + type: integer + provisionedAutonomousContainerDatabases: + description: The number of provisioned Autonomous Container Databases in an Autonomous VM Cluster. + type: integer + provisionedCpus: + description: The number of CPUs provisioned in an Autonomous VM Cluster. + format: float + type: number + reclaimableCpus: + description: | + CPU cores that continue to be included in the count of OCPUs available to the + Autonomous Container Database even after one of its Autonomous Database is terminated or scaled down. + You can release them to the available OCPUs at its parent AVMC level by restarting the Autonomous Container Database. + format: float + type: number + reservedCpus: + description: The number of CPUs reserved in an Autonomous VM Cluster. + format: float + type: number + totalContainerDatabases: + description: The total number of Autonomous Container Databases that can be created. + type: integer + totalCpus: + description: The number of CPU cores enabled on the Autonomous VM cluster. + format: float + type: number + usedAutonomousDataStorageSizeInTBs: + description: The data disk group size used for Autonomous Databases, in TBs. + format: float + type: number + usedCpus: + description: The number of CPU cores alloted to the Autonomous Container Databases in an Autonomous VM cluster. + format: float + type: number + required: + - displayName + type: object + BackupDestinationSummary: + description: Backup destination details, including the list of databases using the backup destination. + properties: + associatedDatabases: + description: List of databases associated with the backup destination. + items: + $ref: '#/components/schemas/AssociatedDatabaseDetails' + type: array + associatedLongTermBackupCount: + description: Indicates the number of long term backups of Autonomous AI Databases associated with this backup destination. + type: integer + associatedLongTermBackups: + description: List of long term backups of Autonomous AI Databases associated with this backup destination.The maximum associated number of long term backup listed here would be 1024. + items: + $ref: '#/components/schemas/AssociatedLongTermBackup' + maxItems: 1024 + minItems: 0 + type: array + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + connectionString: + description: For a RECOVERY_APPLIANCE backup destination, the connection string for connecting to the Recovery Appliance. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-provided name of the backup destination. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the backup destination. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: | + A descriptive text associated with the lifecycleState. + Typically contains additional displayable text + type: string + lifecycleState: + description: The current lifecycle state of the backup destination. + enum: + - ACTIVE + - FAILED + - DELETED + type: string + localMountPointPath: + description: | + The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes. + type: string + nfsMountType: + description: NFS Mount type for backup destination. + enum: + - SELF_MOUNT + - AUTOMATED_MOUNT + type: string + nfsServer: + description: Host names or IP addresses for NFS Auto mount. + items: + type: string + maxItems: 4 + minItems: 1 + type: array + nfsServerExport: + description: Specifies the directory on which to mount the file system + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeAtWhichStorageDetailsAreUpdated: + description: The time when the total storage size and the utilized storage size of the backup destination are updated. + format: date-time + type: string + timeCreated: + description: The date and time the backup destination was created. + format: date-time + type: string + totalStorageSizeInGBs: + description: The total storage size of the backup destination in GBs, rounded to the nearest integer. + type: integer + type: + description: Type of the backup destination. + enum: + - NFS + - RECOVERY_APPLIANCE + type: string + utilizedStorageSizeInGBs: + description: The total amount of space utilized on the backup destination (in GBs), rounded to the nearest integer. + type: integer + vpcUsers: + description: For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance. + items: + type: string + maxItems: 50 + type: array + type: object + CreateBackupDestinationDetails: + description: Details for creating a backup destination. + discriminator: + propertyName: type + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-provided name of the backup destination. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + type: + description: Type of the backup destination. + enum: + - NFS + - RECOVERY_APPLIANCE + type: string + required: + - displayName + - compartmentId + - type + type: object + BackupDestination: + description: Backup destination details. + properties: + associatedDatabases: + description: List of databases associated with the backup destination. + items: + $ref: '#/components/schemas/AssociatedDatabaseDetails' + type: array + associatedLongTermBackupCount: + description: Indicates the number of long term backups of Autonomous AI Databases associated with this backup destination. + type: integer + associatedLongTermBackups: + description: List of long term backups of Autonomous AI Databases associated with this backup destination.The maximum associated number of long term backup listed here would be 1024. + items: + $ref: '#/components/schemas/AssociatedLongTermBackup' + maxItems: 1024 + minItems: 0 + type: array + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + connectionString: + description: For a RECOVERY_APPLIANCE backup destination, the connection string for connecting to the Recovery Appliance. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-provided name of the backup destination. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the backup destination. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: | + A descriptive text associated with the lifecycleState. + Typically contains additional displayable text + type: string + lifecycleState: + description: The current lifecycle state of the backup destination. + enum: + - ACTIVE + - FAILED + - DELETED + type: string + localMountPointPath: + description: | + The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes. + type: string + nfsMountType: + description: NFS Mount type for backup destination. + enum: + - SELF_MOUNT + - AUTOMATED_MOUNT + type: string + nfsServer: + description: Host names or IP addresses for NFS Auto mount. + items: + type: string + maxItems: 4 + minItems: 1 + type: array + nfsServerExport: + description: Specifies the directory on which to mount the file system + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeAtWhichStorageDetailsAreUpdated: + description: The time when the total storage size and the utilized storage size of the backup destination are updated. + format: date-time + type: string + timeCreated: + description: The date and time the backup destination was created. + format: date-time + type: string + totalStorageSizeInGBs: + description: The total storage size of the backup destination in GBs, rounded to the nearest integer. + type: integer + type: + description: Type of the backup destination. + enum: + - NFS + - RECOVERY_APPLIANCE + type: string + utilizedStorageSizeInGBs: + description: The total amount of space utilized on the backup destination (in GBs), rounded to the nearest integer. + type: integer + vpcUsers: + description: For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance. + items: + type: string + maxItems: 50 + type: array + type: object + UpdateBackupDestinationDetails: + description: | + For a RECOVERY_APPLIANCE backup destination, used to update the connection string and/or the list of VPC users. + For an NFS backup destination, there are 2 mount types - Self mount used for non-autonomous ExaCC and automated mount used for autonomous on ExaCC. + properties: + connectionString: + description: For a RECOVERY_APPLIANCE backup destination, the connection string for connecting to the Recovery Appliance. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + localMountPointPath: + description: | + The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes. + type: string + nfsMountType: + description: NFS Mount type for backup destination. + enum: + - SELF_MOUNT + - AUTOMATED_MOUNT + type: string + nfsServer: + description: IP addresses for NFS Auto mount. + items: + type: string + maxItems: 4 + minItems: 1 + type: array + nfsServerExport: + description: Specifies the directory on which to mount the file system + type: string + vpcUsers: + description: For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance. + items: + type: string + maxItems: 50 + type: array + type: object + BackupSummary: + description: | + A database backup. + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + availabilityDomain: + description: The name of the availability domain where the database backup is stored. + type: string + backupDestinationType: + description: Type of the backup destination. + enum: + - OBJECT_STORE + - DBRS + - AWS + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + databaseEdition: + description: | + The Oracle Database Edition that applies to all the databases on the DB system. + Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. + enum: + - STANDARD_EDITION + - ENTERPRISE_EDITION + - ENTERPRISE_EDITION_HIGH_PERFORMANCE + - ENTERPRISE_EDITION_EXTREME_PERFORMANCE + - ENTERPRISE_EDITION_DEVELOPER + type: string + databaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database. + maxLength: 255 + minLength: 1 + type: string + databaseSizeInGBs: + description: | + The size of the database in gigabytes at the time the backup was taken. + format: double + type: number + displayName: + description: The user-friendly name for the backup. The name does not have to be unique. + maxLength: 255 + minLength: 1 + type: string + encryptionKeyLocationDetails: + $ref: '#/components/schemas/EncryptionKeyLocationDetails' + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the backup. + maxLength: 255 + minLength: 1 + type: string + isUsingOracleManagedKeys: + description: True if Oracle Managed Keys is required for restore of the backup. + type: boolean + kmsKeyId: + description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. + maxLength: 255 + minLength: 1 + type: string + kmsKeyVersionId: + description: | + The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the backup. + enum: + - CREATING + - ACTIVE + - DELETING + - DELETED + - FAILED + - RESTORING + - UPDATING + type: string + retentionPeriodInDays: + description: The retention period of the long term backup in days. + maximum: 3650 + minimum: 90 + type: integer + retentionPeriodInYears: + description: The retention period of the long term backup in years. + maximum: 10 + minimum: 1 + type: integer + secondaryKmsKeyIds: + description: List of OCIDs of the key containers used as the secondary encryption key in database transparent data encryption (TDE) operations. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + shape: + description: Shape of the backup's source database. + type: string + timeEnded: + description: The date and time the backup was completed. + format: date-time + type: string + timeExpiryScheduled: + description: Expiration time of the long term database backup. + format: date-time + type: string + timeStarted: + description: The date and time the backup started. + format: date-time + type: string + type: + description: The type of backup. + enum: + - INCREMENTAL + - FULL + - VIRTUAL_FULL + type: string + vaultId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. + maxLength: 255 + minLength: 1 + type: string + version: + description: Version of the backup's source database + type: string + type: object + CreateBackupDetails: + description: | + Details for creating a database backup. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + databaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: The user-friendly name for the backup. The name does not have to be unique. + maxLength: 255 + minLength: 1 + type: string + retentionPeriodInDays: + description: The retention period of the long term backup in days. + maximum: 3650 + minimum: 90 + type: integer + retentionPeriodInYears: + description: The retention period of the long term backup in years. + maximum: 10 + minimum: 1 + type: integer + required: + - databaseId + - displayName + type: object + Backup: + description: | + A database backup. + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + availabilityDomain: + description: The name of the availability domain where the database backup is stored. + type: string + backupDestinationType: + description: Type of the backup destination. + enum: + - OBJECT_STORE + - DBRS + - AWS + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + databaseEdition: + description: | + The Oracle Database Edition that applies to all the databases on the DB system. + Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. + enum: + - STANDARD_EDITION + - ENTERPRISE_EDITION + - ENTERPRISE_EDITION_HIGH_PERFORMANCE + - ENTERPRISE_EDITION_EXTREME_PERFORMANCE + - ENTERPRISE_EDITION_DEVELOPER + type: string + databaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database. + maxLength: 255 + minLength: 1 + type: string + databaseSizeInGBs: + description: | + The size of the database in gigabytes at the time the backup was taken. + format: double + type: number + displayName: + description: The user-friendly name for the backup. The name does not have to be unique. + maxLength: 255 + minLength: 1 + type: string + encryptionKeyLocationDetails: + $ref: '#/components/schemas/EncryptionKeyLocationDetails' + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the backup. + maxLength: 255 + minLength: 1 + type: string + isUsingOracleManagedKeys: + description: True if Oracle Managed Keys is required for restore of the backup. + type: boolean + kmsKeyId: + description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. + maxLength: 255 + minLength: 1 + type: string + kmsKeyVersionId: + description: | + The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the backup. + enum: + - CREATING + - ACTIVE + - DELETING + - DELETED + - FAILED + - RESTORING + - UPDATING + type: string + retentionPeriodInDays: + description: The retention period of the long term backup in days. + maximum: 3650 + minimum: 90 + type: integer + retentionPeriodInYears: + description: The retention period of the long term backup in years. + maximum: 10 + minimum: 1 + type: integer + secondaryKmsKeyIds: + description: List of OCIDs of the key containers used as the secondary encryption key in database transparent data encryption (TDE) operations. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + shape: + description: Shape of the backup's source database. + type: string + timeEnded: + description: The date and time the backup was completed. + format: date-time + type: string + timeExpiryScheduled: + description: Expiration time of the long term database backup. + format: date-time + type: string + timeStarted: + description: The date and time the backup started. + format: date-time + type: string + type: + description: The type of backup. + enum: + - INCREMENTAL + - FULL + - VIRTUAL_FULL + type: string + vaultId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. + maxLength: 255 + minLength: 1 + type: string + version: + description: Version of the backup's source database + type: string + type: object + UpdateBackupDetails: + description: | + Describes the parameters for updating the backup details. + properties: + retentionPeriodInDays: + description: The retention period of the long term backup in days. + maximum: 3650 + minimum: 90 + type: integer + retentionPeriodInYears: + description: The retention period of the long term backup in years. + maximum: 10 + minimum: 1 + type: integer + type: object + CloudAutonomousVmClusterSummary: + description: | + Details of the cloud Autonomous VM cluster. + properties: + autonomousDataStoragePercentage: + description: The percentage of the data storage used for the Autonomous AI Databases in an Autonomous VM Cluster. + format: float + type: number + autonomousDataStorageSizeInTBs: + description: The data disk group size allocated for Autonomous AI Databases, in TBs. + format: double + type: number + availabilityDomain: + description: The name of the availability domain that the cloud Autonomous VM cluster is located in. + maxLength: 255 + minLength: 1 + type: string + availableAutonomousDataStorageSizeInTBs: + description: The data disk group size available for Autonomous AI Databases, in TBs. + format: double + type: number + availableContainerDatabases: + description: The number of Autonomous Container Databases that can be created with the currently available local storage. + type: integer + availableCpus: + description: CPU cores available for allocation to Autonomous AI Databases. + format: float + type: number + cloudExadataInfrastructureId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + clusterTimeZone: + description: The time zone of the Cloud Autonomous VM Cluster. + format: x-obmcs-time-zone + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeModel: + description: | + The compute model of the Cloud Autonomous VM Cluster. ECPU compute model is the recommended model and OCPU compute model is legacy. See [Compute Models in Autonomous AI Database on Dedicated Exadata #Infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbak) for more details. + enum: + - ECPU + - OCPU + type: string + cpuCoreCount: + description: The number of CPU cores on the cloud Autonomous VM cluster. + format: int32 + minimum: 1 + type: integer + cpuCoreCountPerNode: + description: The number of CPU cores enabled per VM cluster node. + type: integer + cpuPercentage: + description: The percentage of total number of CPUs used in an Autonomous VM Cluster. + format: float + type: number + dataStorageSizeInGBs: + description: The total data storage allocated, in gigabytes (GB). + format: double + minimum: 32 + type: number + dataStorageSizeInTBs: + description: The total data storage allocated, in terabytes (TB). + format: double + type: number + dbNodeStorageSizeInGBs: + description: The local node storage allocated in GBs. + type: integer + dbServers: + description: The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Db servers. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 255 + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + description: + description: User defined description of the cloud Autonomous VM cluster. + maxLength: 400 + minLength: 1 + type: string + displayName: + description: The user-friendly name for the cloud Autonomous VM cluster. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + distributionAlgorithm: + description: The distribution algorithm used for the Autonomous VM cluster. + enum: + - RESOURCE_OPTIMIZED + - DISTRIBUTION_OPTIMIZED + type: string + domain: + description: The domain name for the cloud Autonomous VM cluster. + type: string + exadataStorageInTBsLowestScaledValue: + description: The lowest value to which exadataStorage (in TBs) can be scaled down. + format: double + type: number + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + hostname: + description: The hostname for the cloud Autonomous VM cluster. + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Cloud Autonomous VM cluster. + maxLength: 255 + minLength: 1 + type: string + isMtlsEnabledVmCluster: + default: false + description: Enable mutual TLS(mTLS) authentication for database at time of provisioning a VMCluster. This is applicable to database TLS Certificates only. Default is TLS + type: boolean + lastMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run. + maxLength: 255 + minLength: 1 + type: string + lastUpdateHistoryEntryId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance update history. This value is updated when a maintenance update starts. + maxLength: 255 + minLength: 1 + type: string + licenseModel: + description: | + The Oracle license model that applies to the Oracle Autonomous AI Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle AI Database software licenses and the Oracle AI Database service. + Note that when provisioning an [Autonomous AI Database on dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html), this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. Bring your own license (BYOL) also allows you to select the DB edition using the optional parameter. + + This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the cloud Autonomous VM cluster. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - MAINTENANCE_IN_PROGRESS + type: string + maintenanceWindow: + $ref: '#/components/schemas/MaintenanceWindow' + maxAcdsLowestScaledValue: + description: The lowest value to which maximum number of ACDs can be scaled down. + format: int32 + type: integer + memoryPerOracleComputeUnitInGBs: + description: | + The amount of memory (in GBs) to be enabled per OCPU or ECPU. + format: int32 + type: integer + memorySizeInGBs: + description: The memory allocated in GBs. + format: int32 + type: integer + nextMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run. + maxLength: 255 + minLength: 1 + type: string + nodeCount: + description: | + The number of database servers in the cloud VM cluster. + format: int32 + minimum: 1 + type: integer + nonProvisionableAutonomousContainerDatabases: + description: The number of non-provisionable Autonomous Container Databases in an Autonomous VM Cluster. + type: integer + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + ocpuCount: + description: The number of CPU cores on the cloud Autonomous VM cluster. Only 1 decimal place is allowed for the fractional part. + format: float + minimum: 0.1 + type: number + x-example: 0.2 + ocpusLowestScaledValue: + description: The lowest value to which ocpus can be scaled down. + format: int32 + type: integer + provisionableAutonomousContainerDatabases: + description: The number of provisionable Autonomous Container Databases in an Autonomous VM Cluster. + type: integer + provisionedAutonomousContainerDatabases: + description: The number of provisioned Autonomous Container Databases in an Autonomous VM Cluster. + type: integer + provisionedCpus: + description: The number of CPUs provisioned in an Autonomous VM Cluster. + format: float + type: number + reclaimableCpus: + description: | + CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous AI Database is terminated or scaled down. You can release them to the available CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database. + format: float + type: number + reservedCpus: + description: The number of CPUs reserved in an Autonomous VM Cluster. + format: float + type: number + scanListenerPortNonTls: + description: The SCAN Listener Non TLS port. Default is 1521. + maximum: 8999 + minimum: 1024 + type: integer + scanListenerPortTls: + description: The SCAN Listenenr TLS port. Default is 2484. + maximum: 8999 + minimum: 1024 + type: integer + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) + (opaque JSON object) + type: string + description: | + Key-value pair representing a ZPR tag key and value, scoped to a namespace. + Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` + type: object + description: | + Security Attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` + type: object + sgaPercentage: + description: Percentage of ECPU memory allocated for SGA(System Global Area). + format: float + type: number + shape: + description: | + The model name of the Exadata hardware running the cloud Autonomous VM cluster. + maxLength: 255 + minLength: 1 + type: string + subnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the cloud Autonomous VM Cluster is associated with. + + **Subnet Restrictions:** + - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20. + + These subnets are used by the Oracle Clusterware private interconnect on the database instance. + Specifying an overlapping subnet will cause the private interconnect to malfunction. + This restriction applies to both the client subnet and backup subnet. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time that the cloud Autonomous VM cluster was created. + format: date-time + type: string + timeDatabaseSslCertificateExpires: + description: The date and time of Database SSL certificate expiration. + format: date-time + type: string + timeOrdsCertificateExpires: + description: The date and time of ORDS certificate expiration. + format: date-time + type: string + timeUpdated: + description: The last date and time that the cloud Autonomous VM cluster was updated. + format: date-time + type: string + totalAutonomousDataStorageInTBs: + description: The total data disk group size for Autonomous AI Databases, in TBs. + format: float + type: number + totalContainerDatabases: + description: The total number of Autonomous Container Databases that can be created with the allocated local storage. + type: integer + totalCpus: + description: The total number of CPUs in an Autonomous VM Cluster. + format: float + type: number + required: + - id + - cloudExadataInfrastructureId + - compartmentId + - lifecycleState + - displayName + - availabilityDomain + - subnetId + type: object + CreateCloudAutonomousVmClusterDetails: + description: | + Details for the create cloud Autonomous VM cluster operation. + properties: + autonomousDataStorageSizeInTBs: + description: The data disk group size to be allocated for Autonomous AI Databases, in TBs. + format: double + type: number + cloudExadataInfrastructureId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + clusterTimeZone: + default: Etc/UTC + description: The time zone to use for the Cloud Autonomous VM cluster. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm). + format: x-obmcs-time-zone + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeModel: + default: ECPU + description: | + The compute model of the Cloud Autonomous VM Cluster. ECPU compute model is the recommended model and OCPU compute model is legacy. + enum: + - ECPU + - OCPU + type: string + cpuCoreCountPerNode: + description: The number of CPU cores to be enabled per VM cluster node. + type: integer + dbServers: + description: The list of database servers. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + description: + description: User defined description of the cloud Autonomous VM cluster. + maxLength: 400 + minLength: 1 + type: string + displayName: + description: The user-friendly name for the cloud Autonomous VM cluster. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + distributionAlgorithm: + description: The distribution algorithm used for the Autonomous VM cluster. + enum: + - RESOURCE_OPTIMIZED + - DISTRIBUTION_OPTIMIZED + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + isMtlsEnabledVmCluster: + default: false + description: Enable mutual TLS(mTLS) authentication for database at time of provisioning a VMCluster. This is applicable to database TLS Certificates only. Default is TLS + type: boolean + licenseModel: + description: | + The Oracle license model that applies to the Oracle Autonomous AI Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle AI Database software licenses and the Oracle AI Database service. + Note that when provisioning an [Autonomous AI Database on dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html), this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. Bring your own license (BYOL) also allows you to select the DB edition using the optional parameter. + + This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + maintenanceWindowDetails: + $ref: '#/components/schemas/MaintenanceWindow' + memoryPerOracleComputeUnitInGBs: + description: | + The amount of memory (in GBs) to be enabled per OCPU or ECPU. + type: integer + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + scanListenerPortNonTls: + description: The SCAN Listener Non TLS port. Default is 1521. + maximum: 8999 + minimum: 1024 + type: integer + scanListenerPortTls: + description: The SCAN Listener TLS port. Default is 2484. + maximum: 8999 + minimum: 1024 + type: integer + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) + (opaque JSON object) + type: string + description: | + Key-value pair representing a ZPR tag key and value, scoped to a namespace. + Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` + type: object + description: | + Security Attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` + type: object + sgaPercentage: + description: Percentage of ECPU memory allocated for SGA(System Global Area). + format: float + type: number + subnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the cloud Autonomous VM Cluster is associated with. + maxLength: 255 + minLength: 1 + type: string + totalContainerDatabases: + description: The total number of Autonomous Container Databases that can be created. + type: integer + required: + - compartmentId + - displayName + - cloudExadataInfrastructureId + - subnetId + type: object + CloudAutonomousVmCluster: + description: | + Details of the cloud Autonomous VM cluster. + properties: + autonomousDataStoragePercentage: + description: The percentage of the data storage used for the Autonomous AI Databases in an Autonomous VM Cluster. + format: float + type: number + autonomousDataStorageSizeInTBs: + description: The data disk group size allocated for Autonomous AI Databases, in TBs. + format: double + type: number + availabilityDomain: + description: The name of the availability domain that the cloud Autonomous VM cluster is located in. + maxLength: 255 + minLength: 1 + type: string + availableAutonomousDataStorageSizeInTBs: + description: The data disk group size available for Autonomous AI Databases, in TBs. + format: double + type: number + availableContainerDatabases: + description: The number of Autonomous Container Databases that can be created with the currently available local storage. + type: integer + availableCpus: + description: CPU cores available for allocation to Autonomous AI Databases. + format: float + type: number + cloudExadataInfrastructureId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + clusterTimeZone: + description: The time zone of the Cloud Autonomous VM Cluster. + format: x-obmcs-time-zone + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeModel: + description: | + The compute model of the Cloud Autonomous VM Cluster. ECPU compute model is the recommended model and OCPU compute model is legacy. See [Compute Models in Autonomous AI Database on Dedicated Exadata #Infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbak) for more details. + enum: + - ECPU + - OCPU + type: string + cpuCoreCount: + description: The number of CPU cores on the cloud Autonomous VM cluster. + format: int32 + minimum: 1 + type: integer + cpuCoreCountPerNode: + description: The number of CPU cores enabled per VM cluster node. + type: integer + cpuPercentage: + description: The percentage of total number of CPUs used in an Autonomous VM Cluster. + format: float + type: number + dataStorageSizeInGBs: + description: The total data storage allocated, in gigabytes (GB). + format: double + minimum: 32 + type: number + dataStorageSizeInTBs: + description: The total data storage allocated, in terabytes (TB). + format: double + type: number + dbNodeStorageSizeInGBs: + description: The local node storage allocated in GBs. + type: integer + dbServers: + description: The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Db servers. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 255 + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + description: + description: User defined description of the cloud Autonomous VM cluster. + maxLength: 400 + minLength: 1 + type: string + displayName: + description: The user-friendly name for the cloud Autonomous VM cluster. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + distributionAlgorithm: + description: The distribution algorithm used for the Autonomous VM cluster. + enum: + - RESOURCE_OPTIMIZED + - DISTRIBUTION_OPTIMIZED + type: string + domain: + description: The domain name for the cloud Autonomous VM cluster. + type: string + exadataStorageInTBsLowestScaledValue: + description: The lowest value to which exadataStorage (in TBs) can be scaled down. + format: double + type: number + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + hostname: + description: The hostname for the cloud Autonomous VM cluster. + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Cloud Autonomous VM cluster. + maxLength: 255 + minLength: 1 + type: string + isMtlsEnabledVmCluster: + default: false + description: Enable mutual TLS(mTLS) authentication for database at time of provisioning a VMCluster. This is applicable to database TLS Certificates only. Default is TLS + type: boolean + lastMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run. + maxLength: 255 + minLength: 1 + type: string + lastUpdateHistoryEntryId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance update history. This value is updated when a maintenance update starts. + maxLength: 255 + minLength: 1 + type: string + licenseModel: + description: | + The Oracle license model that applies to the Oracle Autonomous AI Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle AI Database software licenses and the Oracle AI Database service. + Note that when provisioning an [Autonomous AI Database on dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html), this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. Bring your own license (BYOL) also allows you to select the DB edition using the optional parameter. + + This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the cloud Autonomous VM cluster. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - MAINTENANCE_IN_PROGRESS + type: string + maintenanceWindow: + $ref: '#/components/schemas/MaintenanceWindow' + maxAcdsLowestScaledValue: + description: The lowest value to which maximum number of ACDs can be scaled down. + format: int32 + type: integer + memoryPerOracleComputeUnitInGBs: + description: | + The amount of memory (in GBs) to be enabled per OCPU or ECPU. + format: int32 + type: integer + memorySizeInGBs: + description: The memory allocated in GBs. + format: int32 + type: integer + nextMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run. + maxLength: 255 + minLength: 1 + type: string + nodeCount: + description: | + The number of database servers in the cloud VM cluster. + format: int32 + minimum: 1 + type: integer + nonProvisionableAutonomousContainerDatabases: + description: The number of non-provisionable Autonomous Container Databases in an Autonomous VM Cluster. + type: integer + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + ocpuCount: + description: The number of CPU cores on the cloud Autonomous VM cluster. Only 1 decimal place is allowed for the fractional part. + format: float + minimum: 0.1 + type: number + x-example: 0.2 + ocpusLowestScaledValue: + description: The lowest value to which ocpus can be scaled down. + format: int32 + type: integer + provisionableAutonomousContainerDatabases: + description: The number of provisionable Autonomous Container Databases in an Autonomous VM Cluster. + type: integer + provisionedAutonomousContainerDatabases: + description: The number of provisioned Autonomous Container Databases in an Autonomous VM Cluster. + type: integer + provisionedCpus: + description: The number of CPUs provisioned in an Autonomous VM Cluster. + format: float + type: number + reclaimableCpus: + description: | + CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous AI Database is terminated or scaled down. You can release them to the available CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database. + format: float + type: number + reservedCpus: + description: The number of CPUs reserved in an Autonomous VM Cluster. + format: float + type: number + scanListenerPortNonTls: + description: The SCAN Listener Non TLS port. Default is 1521. + maximum: 8999 + minimum: 1024 + type: integer + scanListenerPortTls: + description: The SCAN Listenenr TLS port. Default is 2484. + maximum: 8999 + minimum: 1024 + type: integer + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) + (opaque JSON object) + type: string + description: | + Key-value pair representing a ZPR tag key and value, scoped to a namespace. + Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` + type: object + description: | + Security Attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` + type: object + sgaPercentage: + description: Percentage of ECPU memory allocated for SGA(System Global Area). + format: float + type: number + shape: + description: | + The model name of the Exadata hardware running the cloud Autonomous VM cluster. + maxLength: 255 + minLength: 1 + type: string + subnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the cloud Autonomous VM Cluster is associated with. + + **Subnet Restrictions:** + - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20. + + These subnets are used by the Oracle Clusterware private interconnect on the database instance. + Specifying an overlapping subnet will cause the private interconnect to malfunction. + This restriction applies to both the client subnet and backup subnet. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time that the cloud Autonomous VM cluster was created. + format: date-time + type: string + timeDatabaseSslCertificateExpires: + description: The date and time of Database SSL certificate expiration. + format: date-time + type: string + timeOrdsCertificateExpires: + description: The date and time of ORDS certificate expiration. + format: date-time + type: string + timeUpdated: + description: The last date and time that the cloud Autonomous VM cluster was updated. + format: date-time + type: string + totalAutonomousDataStorageInTBs: + description: The total data disk group size for Autonomous AI Databases, in TBs. + format: float + type: number + totalContainerDatabases: + description: The total number of Autonomous Container Databases that can be created with the allocated local storage. + type: integer + totalCpus: + description: The total number of CPUs in an Autonomous VM Cluster. + format: float + type: number + required: + - id + - cloudExadataInfrastructureId + - compartmentId + - lifecycleState + - displayName + - availabilityDomain + - subnetId + type: object + UpdateCloudAutonomousVmClusterDetails: + description: Details for updating the cloud Autonomous VM cluster. + properties: + autonomousDataStorageSizeInTBs: + description: The new value of autonomous data storage (in TBs) for the Autonomous VM cluster. + format: double + type: number + clusterTimeZone: + description: The time zone to use for the Autonomous VM cluster. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm). + format: x-obmcs-time-zone + maxLength: 255 + minLength: 1 + type: string + cpuCoreCountPerNode: + description: The new value of cpus per Autonomous VM cluster per node for the Autonomous VM cluster. + type: integer + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + description: + description: User defined description of the cloud Autonomous VM cluster. + maxLength: 400 + minLength: 1 + type: string + displayName: + description: | + The user-friendly name for the cloud Autonomous VM cluster. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + distributionAlgorithm: + description: The distribution algorithm used for the Autonomous VM cluster. + enum: + - RESOURCE_OPTIMIZED + - DISTRIBUTION_OPTIMIZED + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + isMtlsEnabledVmCluster: + default: false + description: Enable mutual TLS(mTLS) authentication for database at time of provisioning a VMCluster. This is applicable to database TLS Certificates only. Default is TLS + type: boolean + licenseModel: + description: | + The Oracle license model that applies to the Oracle Autonomous AI Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. + License Included allows you to subscribe to new Oracle AI Database software licenses and the Oracle AI Database service. + Note that when provisioning an [Autonomous AI Database on dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html), this attribute must be null. It is already set at the + Autonomous Exadata Infrastructure level. When provisioning an [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. Bring your own license (BYOL) also allows you to select the DB edition using the optional parameter. + + This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + maintenanceWindowDetails: + $ref: '#/components/schemas/MaintenanceWindow' + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + scanListenerPortNonTls: + description: The SCAN Listener Non TLS port. Default is 1521. + maximum: 8999 + minimum: 1024 + type: integer + scanListenerPortTls: + description: The SCAN Listener TLS port. Default is 2484. + maximum: 8999 + minimum: 1024 + type: integer + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) + (opaque JSON object) + type: string + description: | + Key-value pair representing a ZPR tag key and value, scoped to a namespace. + Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` + type: object + description: | + Security Attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` + type: object + totalContainerDatabases: + description: The new value of maximum number of ACDs for the Autonomous VM cluster. + type: integer + type: object + ChangeCloudAutonomousVmClusterCompartmentDetails: + description: | + The configuration details for moving the cloud Autonomous VM cluster. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + RotateCloudAutonomousVmClusterOrdsCertsDetails: + description: | + The details for configuring the ORDS certificates on Cloud Autonomous VM Cluster + properties: + caBundleId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate bundle. + maxLength: 255 + minLength: 1 + type: string + certificateAuthorityId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate authority. + maxLength: 255 + minLength: 1 + type: string + certificateGenerationType: + description: Specify SYSTEM to use Oracle-managed certificates. Specify BYOC when you want to bring your own certificate. + enum: + - SYSTEM + - BYOC + type: string + certificateId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate to use. + maxLength: 255 + minLength: 1 + type: string + required: + - certificateGenerationType + type: object + RotateCloudAutonomousVmClusterSslCertsDetails: + description: | + The details for configuring the SSL certificates on Cloud Autonomous VM Cluster + properties: + caBundleId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate bundle. + maxLength: 255 + minLength: 1 + type: string + certificateAuthorityId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate authority. + maxLength: 255 + minLength: 1 + type: string + certificateGenerationType: + description: Specify SYSTEM to use Oracle-managed certificates. Specify BYOC when you want to bring your own certificate. + enum: + - SYSTEM + - BYOC + type: string + certificateId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the certificate to use. + maxLength: 255 + minLength: 1 + type: string + required: + - certificateGenerationType + type: object + CloudAutonomousVmClusterResourceUsage: + description: | + Cloud Autonomous VM Cluster usage details, including the Autonomous Container Databases usage. + properties: + autonomousDataStorageSizeInTBs: + description: The data disk group size allocated for Autonomous AI Databases, in TBs. + format: float + type: number + autonomousVmResourceUsage: + description: List of Autonomous VM resource usages. + items: + $ref: '#/components/schemas/AutonomousVmResourceUsage' + maxItems: 1024 + type: array + availableAutonomousDataStorageSizeInTBs: + description: The data disk group size available for Autonomous AI Databases, in TBs. + format: float + type: number + availableCpus: + description: The number of CPU cores available. + format: float + type: number + dbNodeStorageSizeInGBs: + description: The local node storage allocated in GBs. + type: integer + displayName: + description: The user-friendly name for the Autonomous VM cluster. The name does not need to be unique. + type: string + exadataStorageInTBs: + description: Total exadata storage allocated for the Autonomous VM Cluster. DATA + RECOVERY + SPARSE + any overhead in TBs. + format: double + type: number + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Cloud Autonomous VM cluster. + type: string + memoryPerOracleComputeUnitInGBs: + description: | + The amount of memory (in GBs) to be enabled per each CPU core. + type: integer + memorySizeInGBs: + description: The memory allocated in GBs. + type: integer + nonProvisionableAutonomousContainerDatabases: + description: The number of non-provisionable Autonomous Container Databases in an Autonomous VM Cluster. + type: integer + provisionableAutonomousContainerDatabases: + description: The number of provisionable Autonomous Container Databases in an Autonomous VM Cluster. + type: integer + provisionedAutonomousContainerDatabases: + description: The number of provisioned Autonomous Container Databases in an Autonomous VM Cluster. + type: integer + provisionedCpus: + description: The number of CPUs provisioned in an Autonomous VM Cluster. + format: float + type: number + reclaimableCpus: + description: | + CPU cores that continue to be included in the count of OCPUs available + to the Autonomous Container Database even after one of its Autonomous AI Database is + terminated or scaled down. You can release them to the available OCPUs at its parent + AVMC level by restarting the Autonomous Container Database. + format: float + type: number + reservedCpus: + description: The number of CPUs reserved in an Autonomous VM Cluster. + format: float + type: number + totalContainerDatabases: + description: The total number of Autonomous Container Databases that can be created. + type: integer + totalCpus: + description: The number of CPU cores enabled on the Cloud Autonomous VM cluster. + format: float + type: number + usedAutonomousDataStorageSizeInTBs: + description: The data disk group size used for Autonomous AI Databases, in TBs. + format: float + type: number + usedCpus: + description: | + The number of CPU cores alloted to the Autonomous Container Databases + in an Cloud Autonomous VM cluster. + format: float + type: number + required: + - displayName + type: object + CloudExadataInfrastructureSummary: + description: | + Details of the cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances only. + properties: + activatedStorageCount: + description: The requested number of additional storage servers activated for the Exadata infrastructure. + type: integer + additionalStorageCount: + description: The requested number of additional storage servers for the Exadata infrastructure. + type: integer + availabilityDomain: + description: The name of the availability domain that the cloud Exadata infrastructure resource is located in. + maxLength: 255 + minLength: 1 + type: string + availableStorageSizeInGBs: + description: The available storage can be allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). + format: int32 + type: integer + clusterPlacementGroupId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Exadata Infrastructure. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeCount: + description: The number of compute servers for the cloud Exadata infrastructure. + format: int32 + type: integer + computeModel: + description: | + The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. + enum: + - ECPU + - OCPU + type: string + x-default-description: Null used when unspecified. + cpuCount: + description: The total number of CPU cores allocated. + type: integer + customerContacts: + description: | + The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. + Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. + Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. + items: + $ref: '#/components/schemas/CustomerContact' + type: array + dataStorageSizeInTBs: + description: | + Size, in terabytes, of the DATA disk group. + format: double + type: number + databaseServerType: + description: The database server type of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + dbNodeStorageSizeInGBs: + description: The local node storage allocated in GBs. + type: integer + dbServerVersion: + description: | + The software version of the database servers (dom0) in the cloud Exadata infrastructure. + Example: 20.1.15 + maxLength: 255 + minLength: 1 + type: string + definedFileSystemConfigurations: + description: Details of the file system configuration of the Exadata infrastructure. + items: + $ref: '#/components/schemas/DefinedFileSystemConfiguration' + maxItems: 1024 + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the cloud Exadata infrastructure resource. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + exascaleConfig: + $ref: '#/components/schemas/ExascaleConfigDetails' + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure resource. + maxLength: 255 + minLength: 1 + type: string + isSchedulingPolicyAssociated: + description: If true, the infrastructure is using granular maintenance scheduling preference. + type: boolean + lastMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current lifecycle state of the cloud Exadata infrastructure resource. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - MAINTENANCE_IN_PROGRESS + type: string + maintenanceVersionPreferences: + $ref: '#/components/schemas/MaintenanceVersionPreferenceDetails' + maintenanceWindow: + $ref: '#/components/schemas/MaintenanceWindow' + maxCpuCount: + description: The total number of CPU cores available. + type: integer + maxDataStorageInTBs: + description: The total available DATA disk group size. + format: double + type: number + maxDbNodeStorageInGBs: + description: The total local node storage available in GBs. + type: integer + maxMemoryInGBs: + description: The total memory available in GBs. + type: integer + memorySizeInGBs: + description: The memory allocated in GBs. + type: integer + monthlyDbServerVersion: + description: | + The monthly software version of the database servers (dom0) in the cloud Exadata infrastructure. + Example: 20.1.15 + maxLength: 255 + minLength: 1 + type: string + monthlyStorageServerVersion: + description: | + The monthly software version of the storage servers (cells) in the cloud Exadata infrastructure. + Example: 20.1.15 + maxLength: 255 + minLength: 1 + type: string + nextMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run. + maxLength: 255 + minLength: 1 + type: string + shape: + description: | + The model name of the cloud Exadata infrastructure resource. + maxLength: 255 + minLength: 1 + type: string + storageCount: + description: The number of storage servers for the cloud Exadata infrastructure. + format: int32 + type: integer + storageServerType: + description: The storage server type of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + storageServerVersion: + description: | + The software version of the storage servers (cells) in the cloud Exadata infrastructure. + Example: 20.1.15 + maxLength: 255 + minLength: 1 + type: string + subscriptionId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the cloud Exadata infrastructure resource was created. + format: date-time + type: string + totalStorageSizeInGBs: + description: The total storage allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). + format: int32 + type: integer + required: + - id + - compartmentId + - lifecycleState + - displayName + - shape + - availabilityDomain + type: object + CreateCloudExadataInfrastructureDetails: + description: | + Request to create cloud Exadata infrastructure. Applies to Exadata Cloud Service instances only. + properties: + availabilityDomain: + description: The availability domain where the cloud Exadata infrastructure is located. + maxLength: 255 + minLength: 1 + type: string + clusterPlacementGroupId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Exadata Infrastructure. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeCount: + description: The number of compute servers for the cloud Exadata infrastructure. + format: int32 + type: integer + customerContacts: + description: Customer contacts. + items: + $ref: '#/components/schemas/CustomerContact' + type: array + x-default-description: 'null' + databaseServerType: + description: The database server type of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: | + The user-friendly name for the cloud Exadata infrastructure resource. The name does not need to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + maintenanceVersionPreferences: + $ref: '#/components/schemas/MaintenanceVersionPreferenceDetails' + maintenanceWindow: + $ref: '#/components/schemas/MaintenanceWindow' + shape: + description: | + The shape of the cloud Exadata infrastructure resource. + maxLength: 255 + minLength: 1 + type: string + storageCount: + description: The number of storage servers for the cloud Exadata infrastructure. + format: int32 + type: integer + storageServerType: + description: The storage server type of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + subscriptionId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. + maxLength: 255 + minLength: 1 + type: string + required: + - availabilityDomain + - compartmentId + - displayName + - shape + type: object + CloudExadataInfrastructure: + description: | + Details of the cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances only. + properties: + activatedStorageCount: + description: The requested number of additional storage servers activated for the Exadata infrastructure. + type: integer + additionalStorageCount: + description: The requested number of additional storage servers for the Exadata infrastructure. + type: integer + availabilityDomain: + description: The name of the availability domain that the cloud Exadata infrastructure resource is located in. + maxLength: 255 + minLength: 1 + type: string + availableStorageSizeInGBs: + description: The available storage can be allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). + format: int32 + type: integer + clusterPlacementGroupId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Exadata Infrastructure. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeCount: + description: The number of compute servers for the cloud Exadata infrastructure. + format: int32 + type: integer + computeModel: + description: | + The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. + enum: + - ECPU + - OCPU + type: string + x-default-description: Null used when unspecified. + cpuCount: + description: The total number of CPU cores allocated. + type: integer + customerContacts: + description: | + The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. + Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. + Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. + items: + $ref: '#/components/schemas/CustomerContact' + type: array + dataStorageSizeInTBs: + description: | + Size, in terabytes, of the DATA disk group. + format: double + type: number + databaseServerType: + description: The database server type of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + dbNodeStorageSizeInGBs: + description: The local node storage allocated in GBs. + type: integer + dbServerVersion: + description: | + The software version of the database servers (dom0) in the cloud Exadata infrastructure. + Example: 20.1.15 + maxLength: 255 + minLength: 1 + type: string + definedFileSystemConfigurations: + description: Details of the file system configuration of the Exadata infrastructure. + items: + $ref: '#/components/schemas/DefinedFileSystemConfiguration' + maxItems: 1024 + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the cloud Exadata infrastructure resource. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + exascaleConfig: + $ref: '#/components/schemas/ExascaleConfigDetails' + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure resource. + maxLength: 255 + minLength: 1 + type: string + isSchedulingPolicyAssociated: + description: If true, the infrastructure is using granular maintenance scheduling preference. + type: boolean + lastMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current lifecycle state of the cloud Exadata infrastructure resource. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - MAINTENANCE_IN_PROGRESS + type: string + maintenanceVersionPreferences: + $ref: '#/components/schemas/MaintenanceVersionPreferenceDetails' + maintenanceWindow: + $ref: '#/components/schemas/MaintenanceWindow' + maxCpuCount: + description: The total number of CPU cores available. + type: integer + maxDataStorageInTBs: + description: The total available DATA disk group size. + format: double + type: number + maxDbNodeStorageInGBs: + description: The total local node storage available in GBs. + type: integer + maxMemoryInGBs: + description: The total memory available in GBs. + type: integer + memorySizeInGBs: + description: The memory allocated in GBs. + type: integer + monthlyDbServerVersion: + description: | + The monthly software version of the database servers (dom0) in the cloud Exadata infrastructure. + Example: 20.1.15 + maxLength: 255 + minLength: 1 + type: string + monthlyStorageServerVersion: + description: | + The monthly software version of the storage servers (cells) in the cloud Exadata infrastructure. + Example: 20.1.15 + maxLength: 255 + minLength: 1 + type: string + nextMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run. + maxLength: 255 + minLength: 1 + type: string + shape: + description: | + The model name of the cloud Exadata infrastructure resource. + maxLength: 255 + minLength: 1 + type: string + storageCount: + description: The number of storage servers for the cloud Exadata infrastructure. + format: int32 + type: integer + storageServerType: + description: The storage server type of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + storageServerVersion: + description: | + The software version of the storage servers (cells) in the cloud Exadata infrastructure. + Example: 20.1.15 + maxLength: 255 + minLength: 1 + type: string + subscriptionId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the cloud Exadata infrastructure resource was created. + format: date-time + type: string + totalStorageSizeInGBs: + description: The total storage allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). + format: int32 + type: integer + required: + - id + - compartmentId + - lifecycleState + - displayName + - shape + - availabilityDomain + type: object + UpdateCloudExadataInfrastructureDetails: + description: | + Updates the cloud Exadata infrastructure. Applies to Exadata Cloud Service instances only. + properties: + computeCount: + description: The number of compute servers for the cloud Exadata infrastructure. + format: int32 + type: integer + customerContacts: + description: Customer contacts. Setting this to an empty list removes all customer contact information (email addresses) for the specified OCI Database service resource. + items: + $ref: '#/components/schemas/CustomerContact' + type: array + x-default-description: 'null' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: | + The user-friendly name for the cloud Exadata infrastructure. The name does not need to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + maintenanceVersionPreferences: + $ref: '#/components/schemas/MaintenanceVersionPreferenceDetails' + maintenanceWindow: + $ref: '#/components/schemas/MaintenanceWindow' + storageCount: + description: The number of storage servers for the cloud Exadata infrastructure. + format: int32 + type: integer + type: object + ChangeCloudExadataInfrastructureCompartmentDetails: + description: | + The configuration details for moving the cloud Exadata infrastructure resource to another compartment. Applies to Exadata Cloud Service instances only. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ChangeCloudExadataInfrastructureSubscriptionDetails: + description: | + The configuration details for associating the cloud Exadata infrastructure resource with a different subscription. + properties: + isDefault: + description: | + Indicates if the subscription is UCM or not. + type: boolean + subscriptionId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. + maxLength: 255 + minLength: 1 + type: string + type: object + ConfigureExascaleCloudExadataInfrastructureDetails: + description: | + The exascale config request details for the Cloud Exadata infrastructure. + properties: + totalStorageInGBs: + description: Storage size needed for Exascale in GBs. + type: integer + totalVmStorageInGBs: + description: Storage size needed for VM storage on Exascale in GBs. + type: integer + required: + - totalStorageInGBs + type: object + CloudExadataInfrastructureUnallocatedResources: + description: | + Details of unallocated resources of the Cloud Exadata infrastructure. Applies to Cloud Exadata infrastructure instances only. + properties: + cloudAutonomousVmClusters: + description: The list of Cloud Autonomous VM Clusters on the Infrastructure and their associated unallocated resources details. + items: + $ref: '#/components/schemas/CloudAutonomousVmClusterResourceDetails' + type: array + cloudExadataInfrastructureDisplayName: + description: The user-friendly name for the Cloud Exadata infrastructure. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + cloudExadataInfrastructureId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Cloud Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + exadataStorageInTBs: + description: Total unallocated exadata storage in the infrastructure in TBs. + format: double + type: number + localStorageInGbs: + description: The minimum amount of unallocated storage available across all nodes in the infrastructure. + type: integer + memoryInGBs: + description: The minimum amount of unallocated memory available across all nodes in the infrastructure. + type: integer + ocpus: + description: The minimum amount of unallocated ocpus available across all nodes in the infrastructure. + type: integer + required: + - cloudExadataInfrastructureId + - cloudExadataInfrastructureDisplayName + type: object + CloudVmClusterSummary: + description: | + Details of the cloud VM cluster. Applies to Exadata Cloud Service instances only. + properties: + availabilityDomain: + description: The name of the availability domain that the cloud Exadata infrastructure resource is located in. + maxLength: 255 + minLength: 1 + type: string + backupNetworkNsgIds: + description: | + A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + backupSubnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the cloud VM cluster. + + **Subnet Restriction:** See the subnet restrictions information for **subnetId**. + maxLength: 255 + minLength: 1 + type: string + cloudExadataInfrastructureId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + clusterName: + description: | + The cluster name for cloud VM cluster. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeModel: + description: | + The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. + enum: + - ECPU + - OCPU + type: string + x-default-description: Null used when unspecified. + cpuCoreCount: + description: The number of CPU cores enabled on the cloud VM cluster. + format: int32 + type: integer + dataCollectionOptions: + $ref: '#/components/schemas/DataCollectionOptions' + dataStoragePercentage: + description: | + The percentage assigned to DATA storage (user data and database files). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + dataStorageSizeInTBs: + description: The data disk group size to be allocated in TBs. + format: double + type: number + dbNodeStorageSizeInGBs: + description: The local node storage to be allocated in GBs. + type: integer + dbServers: + description: The list of DB servers. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + diskRedundancy: + description: | + The type of redundancy configured for the cloud Vm cluster. + NORMAL is 2-way redundancy. + HIGH is 3-way redundancy. + enum: + - HIGH + - NORMAL + type: string + displayName: + description: The user-friendly name for the cloud VM cluster. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + domain: + description: The domain name for the cloud VM cluster. + type: string + exascaleDbStorageVaultId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault. + maxLength: 255 + minLength: 1 + type: string + fileSystemConfigurationDetails: + description: Details of the file system configuration of the VM cluster. + items: + $ref: '#/components/schemas/FileSystemConfigurationDetail' + maxItems: 1024 + type: array + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + giSoftwareImageId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of a grid infrastructure software image. This is a database software image of the type `GRID_IMAGE`. + maxLength: 255 + type: string + giVersion: + description: A valid Oracle Grid Infrastructure (GI) software version. + maxLength: 255 + minLength: 1 + type: string + hostname: + description: The hostname for the cloud VM cluster. + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud VM cluster. + maxLength: 255 + minLength: 1 + type: string + isLocalBackupEnabled: + description: | + If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. + type: boolean + isSparseDiskgroupEnabled: + description: | + If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created. + type: boolean + lastUpdateHistoryEntryId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance update history entry. This value is updated when a maintenance update starts. + maxLength: 255 + minLength: 1 + type: string + licenseModel: + description: | + The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the cloud VM cluster. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - MAINTENANCE_IN_PROGRESS + type: string + listenerPort: + description: The port number configured for the listener on the cloud VM cluster. + format: int64 + type: integer + memorySizeInGBs: + description: The memory to be allocated in GBs. + type: integer + multiCloudIdentityConnectorConfigs: + description: Details of the multi cloud identity connectors of the VM cluster. + items: + $ref: '#/components/schemas/IdentityConnectorDetails' + maxItems: 10 + type: array + nodeCount: + description: | + The number of nodes in the cloud VM cluster. + format: int32 + minimum: 1 + type: integer + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + ocpuCount: + description: The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part. + format: float + minimum: 0.1 + type: number + x-example: 0.2 + recoStoragePercentage: + description: | + The percentage assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + scanDnsName: + description: | + The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. + maxLength: 72 + minLength: 1 + type: string + scanDnsRecordId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. + maxLength: 255 + minLength: 1 + type: string + scanIpIds: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. + SCAN IP addresses are typically used for load balancing and are not assigned to any interface. + Oracle Clusterware directs the requests to the appropriate nodes in the cluster. + + **Note:** For a single-node DB system, this list is empty. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) + (opaque JSON object) + type: string + description: | + Key-value pair representing a ZPR tag key and value, scoped to a namespace. + Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` + type: object + description: | + Security Attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` + type: object + shape: + description: | + The model name of the Exadata hardware running the cloud VM cluster. + maxLength: 255 + minLength: 1 + type: string + sparseStoragePercentage: + description: | + The percentage assigned to SPARSE storage (Exadata snapshots). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + sshPublicKeys: + description: The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + storageManagementType: + description: Specifies the type of storage management for the Cloud VM Cluster if its ASM or Exascale. + enum: + - ASM + - EXASCALE + type: string + storageSizeInGBs: + description: The storage allocation for the disk group, in gigabytes (GB). + format: int32 + type: integer + subnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet associated with the cloud VM cluster. + + **Subnet Restrictions:** + - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20. + + These subnets are used by the Oracle Clusterware private interconnect on the database instance. + Specifying an overlapping subnet will cause the private interconnect to malfunction. + This restriction applies to both the client subnet and backup subnet. + maxLength: 255 + minLength: 1 + type: string + subscriptionId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + systemVersion: + description: Operating system version of the image. + maxLength: 255 + minLength: 1 + type: string + tdeKeyStoreType: + description: TDE keystore type + enum: + - AZURE + - OCI + type: string + x-default-description: 'null' + timeCreated: + description: The date and time that the cloud VM cluster was created. + format: date-time + type: string + timeZone: + description: The time zone of the cloud VM cluster. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). + maxLength: 255 + minLength: 1 + type: string + vipIds: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual IP (VIP) addresses associated with the cloud VM cluster. + The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to + enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. + + **Note:** For a single-node DB system, this list is empty. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + vmBackupStorageType: + description: Specifies the type of VM Backups Storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then VM Backups storage will be on DB Servers. - EXASCALE if selected then VM Backups storage will be on Exascale Storage Servers. Default Value is LOCAL + enum: + - LOCAL + - EXASCALE + type: string + vmFileSystemStorageType: + description: Specifies the type of file system storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then file system storage will be on DB Servers. - EXASCALE if selected then file system storage will be on Exascale Storage Servers. Default Value is LOCAL + enum: + - LOCAL + - EXASCALE + type: string + zoneId: + description: | + The OCID of the zone the cloud VM cluster is associated with. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - cloudExadataInfrastructureId + - compartmentId + - lifecycleState + - displayName + - availabilityDomain + - subnetId + - sshPublicKeys + - cpuCoreCount + - hostname + - domain + - shape + type: object + CreateCloudVmClusterDetails: + description: | + Details for the create cloud VM cluster operation. Applies to Exadata Cloud Service instances only. + properties: + backupNetworkNsgIds: + description: | + A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + backupSubnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the cloud VM cluster. + maxLength: 255 + minLength: 1 + type: string + cloudExadataInfrastructureId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure resource. + maxLength: 255 + minLength: 1 + type: string + clusterName: + description: | + The cluster name for cloud VM cluster. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. + maxLength: 11 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + cpuCoreCount: + description: | + For fixed shapes, this is the total number of OCPUs to enable across the VM cluster. + + - Exadata.Base.48 - Specify a multiple of 2, from 0 to 48. + - Exadata.Quarter3.100 - Specify a multiple of 2, from 0 to 100. + - Exadata.Half3.200 - Specify a multiple of 4, from 0 to 200. + - Exadata.Full3.400 - Specify a multiple of 8, from 0 to 400. + + The API specification for fixed shape values is https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary + + + For flexible shapes X8M and X9M, this is the total number of OCPUs to enable across the VM cluster. The number available for the VM cluster will be based on the number of database servers selected for provisioning the VM cluster on the Exadata Infrastructure. + + - Exadata.X8M - Specify a multiple of 2, from 2 to 50 per X8M database server. + - Exadata.X9M - Specify a multiple of 2, from 2 to 126 per X9M database server. + + For flexible shapes X11M and higher, this is the total number of ECPUs to enable across the VM cluster. The number available for the VM cluster will be based on the number of database servers selected for provisioning the VM cluster on the Exadata Infrastructure. + + - Exadata.X11M - Specify a multiple of 8, from 8 to 760 per X11M database server. + + The API specification for flexible shape values is https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/FlexComponentSummary + format: int32 + minimum: 0 + type: integer + dataCollectionOptions: + $ref: '#/components/schemas/DataCollectionOptions' + dataStoragePercentage: + description: | + The percentage assigned to DATA storage (user data and database files). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + dataStorageSizeInTBs: + description: The data disk group size to be allocated in TBs. + format: double + type: number + dbNodeStorageSizeInGBs: + description: The local node storage to be allocated in GBs. + type: integer + dbServers: + description: The list of DB servers. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the cloud VM cluster. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + domain: + description: | + A domain name used for the cloud VM cluster. If the Oracle-provided internet and VCN + resolver is enabled for the specified subnet, the domain name for the subnet is used + (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. + Applies to Exadata Cloud Service instances only. + type: string + exascaleDbStorageVaultId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault. + maxLength: 255 + minLength: 1 + type: string + fileSystemConfigurationDetails: + description: Details of the file system configuration of the VM cluster. + items: + $ref: '#/components/schemas/FileSystemConfigurationDetail' + maxItems: 1024 + type: array + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + giVersion: + description: A valid Oracle Grid Infrastructure (GI) software version. + maxLength: 255 + minLength: 1 + type: string + hostname: + description: | + The hostname for the cloud VM cluster. The hostname must begin with an alphabetic character, and + can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata systems. + + The maximum length of the combined hostname and domain is 63 characters. + + **Note:** The hostname must be unique within the subnet. If it is not unique, + the cloud VM Cluster will fail to provision. + type: string + isLocalBackupEnabled: + description: | + If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. + type: boolean + isSparseDiskgroupEnabled: + description: | + If true, the sparse disk group is configured for the cloud VM cluster. If false, the sparse disk group is not created. + type: boolean + licenseModel: + description: | + The Oracle license model that applies to the cloud VM cluster. The default is BRING_YOUR_OWN_LICENSE. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + memorySizeInGBs: + description: The memory to be allocated in GBs. + type: integer + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + ocpuCount: + description: The number of OCPU cores to enable for a cloud VM cluster. Only 1 decimal place is allowed for the fractional part. + format: float + minimum: 0.1 + type: number + x-example: 0.2 + privateZoneId: + description: The private zone id in which DNS records need to be created. + maxLength: 255 + minLength: 1 + type: string + recoStoragePercentage: + description: | + The percentage assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) + (opaque JSON object) + type: string + description: | + Key-value pair representing a ZPR tag key and value, scoped to a namespace. + Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` + type: object + description: | + Security Attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` + type: object + sparseStoragePercentage: + description: | + The percentage assigned to SPARSE storage (Exadata snapshots). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + sshPublicKeys: + description: The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + subnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet associated with the cloud VM cluster. + maxLength: 255 + minLength: 1 + type: string + subscriptionId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. + maxLength: 255 + minLength: 1 + type: string + systemVersion: + description: Operating system version of the image. + maxLength: 255 + minLength: 1 + type: string + timeZone: + description: | + The time zone to use for the cloud VM cluster. For details, see [Time Zones](/Content/Database/References/timezones.htm). + maxLength: 255 + minLength: 1 + type: string + vmBackupStorageType: + default: + - LOCAL + description: Specifies the type of VM Backups Storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then VM Backups storage will be on DB Servers. - EXASCALE if selected then VM Backups storage will be on Exascale Storage Servers. Default Value is LOCAL + enum: + - LOCAL + - EXASCALE + type: string + vmFileSystemStorageType: + default: + - LOCAL + description: Specifies the type of file system storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then file system storage will be on DB Servers. - EXASCALE if selected then file system storage will be on Exascale Storage Servers. Default Value is LOCAL + enum: + - LOCAL + - EXASCALE + type: string + required: + - compartmentId + - displayName + - cloudExadataInfrastructureId + - cpuCoreCount + - sshPublicKeys + - giVersion + - hostname + - subnetId + - backupSubnetId + type: object + CloudVmCluster: + description: | + Details of the cloud VM cluster. Applies to Exadata Cloud Service instances only. + properties: + availabilityDomain: + description: The name of the availability domain that the cloud Exadata infrastructure resource is located in. + maxLength: 255 + minLength: 1 + type: string + backupNetworkNsgIds: + description: | + A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + backupSubnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the cloud VM cluster. + + **Subnet Restriction:** See the subnet restrictions information for **subnetId**. + maxLength: 255 + minLength: 1 + type: string + cloudExadataInfrastructureId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + clusterName: + description: | + The cluster name for cloud VM cluster. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeModel: + description: | + The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. + enum: + - ECPU + - OCPU + type: string + x-default-description: Null used when unspecified. + cpuCoreCount: + description: The number of CPU cores enabled on the cloud VM cluster. + format: int32 + type: integer + dataCollectionOptions: + $ref: '#/components/schemas/DataCollectionOptions' + dataStoragePercentage: + description: | + The percentage assigned to DATA storage (user data and database files). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + dataStorageSizeInTBs: + description: The data disk group size to be allocated in TBs. + format: double + type: number + dbNodeStorageSizeInGBs: + description: The local node storage to be allocated in GBs. + type: integer + dbServers: + description: The list of DB servers. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + diskRedundancy: + description: | + The type of redundancy configured for the cloud Vm cluster. + NORMAL is 2-way redundancy. + HIGH is 3-way redundancy. + enum: + - HIGH + - NORMAL + type: string + displayName: + description: The user-friendly name for the cloud VM cluster. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + domain: + description: The domain name for the cloud VM cluster. + type: string + exascaleDbStorageVaultId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault. + maxLength: 255 + minLength: 1 + type: string + fileSystemConfigurationDetails: + description: Details of the file system configuration of the VM cluster. + items: + $ref: '#/components/schemas/FileSystemConfigurationDetail' + maxItems: 1024 + type: array + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + giSoftwareImageId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of a grid infrastructure software image. This is a database software image of the type `GRID_IMAGE`. + maxLength: 255 + type: string + giVersion: + description: A valid Oracle Grid Infrastructure (GI) software version. + maxLength: 255 + minLength: 1 + type: string + hostname: + description: The hostname for the cloud VM cluster. + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud VM cluster. + maxLength: 255 + minLength: 1 + type: string + isLocalBackupEnabled: + description: | + If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. + type: boolean + isSparseDiskgroupEnabled: + description: | + If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created. + type: boolean + lastUpdateHistoryEntryId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance update history entry. This value is updated when a maintenance update starts. + maxLength: 255 + minLength: 1 + type: string + licenseModel: + description: | + The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the cloud VM cluster. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - MAINTENANCE_IN_PROGRESS + type: string + listenerPort: + description: The port number configured for the listener on the cloud VM cluster. + format: int64 + type: integer + memorySizeInGBs: + description: The memory to be allocated in GBs. + type: integer + multiCloudIdentityConnectorConfigs: + description: Details of the multi cloud identity connectors of the VM cluster. + items: + $ref: '#/components/schemas/IdentityConnectorDetails' + maxItems: 10 + type: array + nodeCount: + description: | + The number of nodes in the cloud VM cluster. + format: int32 + minimum: 1 + type: integer + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + ocpuCount: + description: The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part. + format: float + minimum: 0.1 + type: number + x-example: 0.2 + recoStoragePercentage: + description: | + The percentage assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + scanDnsName: + description: | + The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. + maxLength: 72 + minLength: 1 + type: string + scanDnsRecordId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. + maxLength: 255 + minLength: 1 + type: string + scanIpIds: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. + SCAN IP addresses are typically used for load balancing and are not assigned to any interface. + Oracle Clusterware directs the requests to the appropriate nodes in the cluster. + + **Note:** For a single-node DB system, this list is empty. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) + (opaque JSON object) + type: string + description: | + Key-value pair representing a ZPR tag key and value, scoped to a namespace. + Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` + type: object + description: | + Security Attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` + type: object + shape: + description: | + The model name of the Exadata hardware running the cloud VM cluster. + maxLength: 255 + minLength: 1 + type: string + sparseStoragePercentage: + description: | + The percentage assigned to SPARSE storage (Exadata snapshots). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + sshPublicKeys: + description: The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + storageManagementType: + description: Specifies the type of storage management for the Cloud VM Cluster if its ASM or Exascale. + enum: + - ASM + - EXASCALE + type: string + storageSizeInGBs: + description: The storage allocation for the disk group, in gigabytes (GB). + format: int32 + type: integer + subnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet associated with the cloud VM cluster. + + **Subnet Restrictions:** + - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20. + + These subnets are used by the Oracle Clusterware private interconnect on the database instance. + Specifying an overlapping subnet will cause the private interconnect to malfunction. + This restriction applies to both the client subnet and backup subnet. + maxLength: 255 + minLength: 1 + type: string + subscriptionId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + systemVersion: + description: Operating system version of the image. + maxLength: 255 + minLength: 1 + type: string + tdeKeyStoreType: + description: TDE keystore type + enum: + - AZURE + - OCI + type: string + x-default-description: 'null' + timeCreated: + description: The date and time that the cloud VM cluster was created. + format: date-time + type: string + timeZone: + description: The time zone of the cloud VM cluster. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). + maxLength: 255 + minLength: 1 + type: string + vipIds: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual IP (VIP) addresses associated with the cloud VM cluster. + The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to + enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. + + **Note:** For a single-node DB system, this list is empty. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + vmBackupStorageType: + description: Specifies the type of VM Backups Storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then VM Backups storage will be on DB Servers. - EXASCALE if selected then VM Backups storage will be on Exascale Storage Servers. Default Value is LOCAL + enum: + - LOCAL + - EXASCALE + type: string + vmFileSystemStorageType: + description: Specifies the type of file system storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then file system storage will be on DB Servers. - EXASCALE if selected then file system storage will be on Exascale Storage Servers. Default Value is LOCAL + enum: + - LOCAL + - EXASCALE + type: string + zoneId: + description: | + The OCID of the zone the cloud VM cluster is associated with. + maxLength: 255 + minLength: 1 + type: string + iormConfigCache: + $ref: '#/components/schemas/ExadataIormConfig' + required: + - id + - cloudExadataInfrastructureId + - compartmentId + - lifecycleState + - displayName + - availabilityDomain + - subnetId + - sshPublicKeys + - cpuCoreCount + - hostname + - domain + - shape + type: object + UpdateCloudVmClusterDetails: + description: | + Details for updating the cloud VM cluster. Applies to Exadata Cloud Service instances only. + properties: + backupNetworkNsgIds: + description: | + A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + computeNodes: + description: The list of compute servers to be added to the cloud VM cluster. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + cpuCoreCount: + description: | + For fixed shapes, this is the total number of OCPUs to enable across the VM cluster. + + - Exadata.Base.48 - Specify a multiple of 2, from 0 to 48. + - Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84. + - Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168. + - Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336. + - Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92. + - Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184. + - Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368. + - Exadata.Quarter3.100 - Specify a multiple of 2, from 0 to 100. + - Exadata.Half3.200 - Specify a multiple of 4, from 0 to 200. + - Exadata.Full3.400 - Specify a multiple of 8, from 0 to 400. + + The API specification for fixed shape values is https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary + + + For flexible shapes X8M and X9M, this is the total number of OCPUs to enable across the VM cluster. The number available for the VM cluster will be based on the number of database servers selected for provisioning the VM cluster on the Exadata Infrastructure. + + - Exadata.X8M - Specify a multiple of 2, from 2 to 50 per X8M database server. + - Exadata.X9M - Specify a multiple of 2, from 2 to 126 per X9M database server. + + For flexible shapes X11M and higher, this is the total number of ECPUs to enable across the VM cluster. The number available for the VM cluster will be based on the number of database servers selected for provisioning the VM cluster on the Exadata Infrastructure. + + - Exadata.X11M - Specify a multiple of 8, from 8 to 760 per X11M database server. + + The API specification for flexible shape values is https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/FlexComponentSummary + format: int32 + type: integer + dataCollectionOptions: + $ref: '#/components/schemas/DataCollectionOptions' + dataStoragePercentage: + description: | + The percentage assigned to DATA storage (user data and database files). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + dataStorageSizeInTBs: + description: The data disk group size to be allocated in TBs. + format: double + type: number + dbNodeStorageSizeInGBs: + description: The local node storage to be allocated in GBs. + type: integer + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: | + The user-friendly name for the cloud VM cluster. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + fileSystemConfigurationDetails: + description: Details of the file system configuration of the VM cluster. + items: + $ref: '#/components/schemas/FileSystemConfigurationDetail' + maxItems: 1024 + type: array + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + isLocalBackupEnabled: + description: | + If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. + type: boolean + isSparseDiskgroupEnabled: + description: | + If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created. + type: boolean + licenseModel: + description: | + The Oracle license model that applies to the cloud VM cluster. The default is BRING_YOUR_OWN_LICENSE. Applies to Exadata Cloud Service instances only. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + memorySizeInGBs: + description: The memory to be allocated in GBs. + type: integer + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + ocpuCount: + description: The number of OCPU cores to enable for a cloud VM cluster. Only 1 decimal place is allowed for the fractional part. + format: float + minimum: 0.1 + type: number + x-example: 0.2 + recoStoragePercentage: + description: | + The percentage assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) + (opaque JSON object) + type: string + description: | + Key-value pair representing a ZPR tag key and value, scoped to a namespace. + Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` + type: object + description: | + Security Attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` + type: object + sparseStoragePercentage: + description: | + The percentage assigned to SPARSE storage (Exadata snapshots). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + sshPublicKeys: + description: The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + storageSizeInGBs: + description: The disk group size to be allocated in GBs. + format: int32 + type: integer + updateDetails: + $ref: '#/components/schemas/UpdateDetails' + vmBackupStorageType: + description: Specifies the type of VM Backups Storage and supported values are LOCAL and EXASCALE. Storage Type can only be changed once from LOCAL to EXASCALE. EXASCALE to LOCAL is not permitted. + enum: + - LOCAL + - EXASCALE + type: string + type: object + ExadataIormConfig: + description: | + The IORM settings of the Exadata DB system. + properties: + dbPlans: + description: | + An array of IORM settings for all the database in + the Exadata DB system. + items: + $ref: '#/components/schemas/dbIormConfig' + type: array + lifecycleDetails: + description: | + Additional information about the current `lifecycleState`. + type: string + lifecycleState: + description: | + The current state of IORM configuration for the Exadata DB system. + enum: + - BOOTSTRAPPING + - ENABLED + - DISABLED + - UPDATING + - FAILED + type: string + objective: + description: | + The current value for the IORM objective. + The default is `AUTO`. + enum: + - LOW_LATENCY + - HIGH_THROUGHPUT + - BALANCED + - AUTO + - BASIC + type: string + type: object + AddVirtualMachineToCloudVmClusterDetails: + description: | + Details of adding Virtual Machines to the Cloud VM Cluster. Applies to Exadata Cloud instances only. + properties: + dbServers: + description: The list of ExaCS DB servers for the cluster to be added. + items: + $ref: '#/components/schemas/CloudDbServerDetails' + type: array + required: + - dbServers + type: object + ChangeCloudVmClusterCompartmentDetails: + description: | + The configuration details for moving the cloud VM cluster to another compartment. Applies to Exadata Cloud Service instances only. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ChangeCloudVmClusterSubscriptionDetails: + description: | + The configuration details for associating the cloud VM cluster resource with a different subscription. + properties: + isDefault: + description: | + Indicates if the subscription is UCM or not. + type: boolean + subscriptionId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. + maxLength: 255 + minLength: 1 + type: string + type: object + RegisterCloudVmClusterPkcsDetails: + description: | + Details of registering PKCS11 driver. + properties: + tdeKeyStoreType: + description: TDE keystore type + enum: + - AZURE + - OCI + type: string + x-default-description: 'null' + required: + - tdeKeyStoreType + type: object + RemoveVirtualMachineFromCloudVmClusterDetails: + description: | + Details of removing Virtual Machines from the Cloud VM Cluster. Applies to Exadata Cloud instances only. + properties: + dbServers: + description: The list of ExaDB-D DB server for the cluster to be removed. + items: + $ref: '#/components/schemas/CloudDbServerDetails' + type: array + required: + - dbServers + type: object + UnregisterCloudVmClusterPkcsDetails: + description: | + Details of unregistering PKCS11 driver. + properties: + tdeKeyStoreType: + description: TDE keystore type + enum: + - AZURE + - OCI + type: string + x-default-description: 'null' + required: + - tdeKeyStoreType + type: object + UpdateHistoryEntrySummary: + description: | + The record of an maintenance update action on a specified cloud VM cluster. Applies to Exadata Cloud Service instances only. + properties: + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update history entry. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: | + Descriptive text providing additional details about the lifecycle state. + type: string + lifecycleState: + description: The current lifecycle state of the maintenance update operation. + enum: + - IN_PROGRESS + - SUCCEEDED + - FAILED + type: string + timeCompleted: + description: The date and time when the maintenance update action completed. + format: date-time + type: string + timeStarted: + description: The date and time when the maintenance update action started. + format: date-time + type: string + updateAction: + description: The update action. + enum: + - ROLLING_APPLY + - NON_ROLLING_APPLY + - PRECHECK + - ROLLBACK + type: string + updateId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. + maxLength: 255 + minLength: 1 + type: string + updateType: + description: The type of cloud VM cluster maintenance update. + enum: + - GI_UPGRADE + - GI_PATCH + - OS_UPDATE + type: string + required: + - id + - updateId + - lifecycleState + - timeStarted + - updateType + type: object + UpdateHistoryEntry: + description: | + The record of an maintenance update action on a specified cloud VM cluster. Applies to Exadata Cloud Service instances only. + properties: + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update history entry. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: | + Descriptive text providing additional details about the lifecycle state. + type: string + lifecycleState: + description: The current lifecycle state of the maintenance update operation. + enum: + - IN_PROGRESS + - SUCCEEDED + - FAILED + type: string + timeCompleted: + description: The date and time when the maintenance update action completed. + format: date-time + type: string + timeStarted: + description: The date and time when the maintenance update action started. + format: date-time + type: string + updateAction: + description: The update action. + enum: + - ROLLING_APPLY + - NON_ROLLING_APPLY + - PRECHECK + - ROLLBACK + type: string + updateId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. + maxLength: 255 + minLength: 1 + type: string + updateType: + description: The type of cloud VM cluster maintenance update. + enum: + - GI_UPGRADE + - GI_PATCH + - OS_UPDATE + type: string + required: + - id + - updateId + - lifecycleState + - timeStarted + - updateType + type: object + UpdateSummary: + description: | + A maintenance update for a cloud VM cluster. Applies to Exadata Cloud Service instances only. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + availableActions: + description: The possible actions performed by the update operation on the infrastructure components. + items: + enum: + - ROLLING_APPLY + - NON_ROLLING_APPLY + - PRECHECK + - ROLLBACK + type: string + type: array + description: + description: Details of the maintenance update package. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. + maxLength: 255 + minLength: 1 + type: string + lastAction: + description: The previous update action performed. + enum: + - ROLLING_APPLY + - NON_ROLLING_APPLY + - PRECHECK + - ROLLBACK + type: string + lifecycleDetails: + description: | + Descriptive text providing additional details about the lifecycle state. + type: string + lifecycleState: + description: The current state of the maintenance update. Dependent on value of `lastAction`. + enum: + - AVAILABLE + - SUCCESS + - IN_PROGRESS + - FAILED + type: string + timeReleased: + description: The date and time the maintenance update was released. + format: date-time + type: string + updateType: + description: The type of cloud VM cluster maintenance update. + enum: + - GI_UPGRADE + - GI_PATCH + - OS_UPDATE + type: string + version: + description: The version of the maintenance update package. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - description + - version + - timeReleased + - updateType + type: object + Update: + description: | + A maintenance update for a cloud VM cluster. Applies to Exadata Cloud Service instances only. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + availableActions: + description: The possible actions performed by the update operation on the infrastructure components. + items: + enum: + - ROLLING_APPLY + - NON_ROLLING_APPLY + - PRECHECK + - ROLLBACK + type: string + type: array + description: + description: Details of the maintenance update package. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. + maxLength: 255 + minLength: 1 + type: string + lastAction: + description: The previous update action performed. + enum: + - ROLLING_APPLY + - NON_ROLLING_APPLY + - PRECHECK + - ROLLBACK + type: string + lifecycleDetails: + description: | + Descriptive text providing additional details about the lifecycle state. + type: string + lifecycleState: + description: The current state of the maintenance update. Dependent on value of `lastAction`. + enum: + - AVAILABLE + - SUCCESS + - IN_PROGRESS + - FAILED + type: string + timeReleased: + description: The date and time the maintenance update was released. + format: date-time + type: string + updateType: + description: The type of cloud VM cluster maintenance update. + enum: + - GI_UPGRADE + - GI_PATCH + - OS_UPDATE + type: string + version: + description: The version of the maintenance update package. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - description + - version + - timeReleased + - updateType + type: object + DatabaseSoftwareImageSummary: + description: | + The Database service supports the creation of database software images for use in creating and patching DB systems and databases. + + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + For information about access control and compartments, see [Overview of the Identity Service](/Content/Identity/Concepts/overview.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + databaseSoftwareImageIncludedPatches: + description: List of one-off patches for Database Homes. + items: + type: string + type: array + databaseSoftwareImageOneOffPatches: + description: List of one-off patches for Database Homes. + items: + type: string + type: array + databaseVersion: + description: The database version with which the database software image is to be built. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the database software image. The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database software image. + maxLength: 255 + minLength: 1 + type: string + imageShapeFamily: + description: To what shape the image is meant for. + enum: + - VM_BM_SHAPE + - EXADATA_SHAPE + - EXACC_SHAPE + - EXADBXS_SHAPE + type: string + imageType: + description: The type of software image. Can be grid or database. + enum: + - GRID_IMAGE + - DATABASE_IMAGE + type: string + includedPatchesSummary: + description: The patches included in the image and the version of the image. + maxLength: 65536 + minLength: 1 + type: string + isUpgradeSupported: + description: True if this Database software image is supported for Upgrade. + type: boolean + lifecycleDetails: + description: Detailed message for the lifecycle state. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the database software image. + enum: + - PROVISIONING + - AVAILABLE + - DELETING + - DELETED + - FAILED + - TERMINATING + - TERMINATED + - UPDATING + type: string + lsInventory: + description: The output from the OPatch lsInventory command, which is passed as a string. + maxLength: 262144 + minLength: 1 + type: string + patchSet: + description: The PSU or PBP or Release Updates. To get a list of supported versions, use the [ListDbVersions](#/en/database/latest/DbVersionSummary/ListDbVersions) operation. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the database software image was created. + format: date-time + type: string + required: + - id + - compartmentId + - lifecycleState + - displayName + - timeCreated + - imageType + - imageShapeFamily + - patchSet + - databaseVersion + type: object + CreateDatabaseSoftwareImageDetails: + description: | + Parameters for creating a database software image in the specified compartment. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment the database software image belongs in. + maxLength: 255 + minLength: 1 + type: string + databaseSoftwareImageOneOffPatches: + description: List of one-off patches for Database Homes. + items: + type: string + type: array + databaseVersion: + description: The database version with which the database software image is to be built. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the database software image. The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + imageShapeFamily: + default: VM_BM_SHAPE + description: To what shape the image is meant for. + enum: + - VM_BM_SHAPE + - EXADATA_SHAPE + - EXACC_SHAPE + - EXADBXS_SHAPE + type: string + imageType: + default: DATABASE_IMAGE + description: The type of software image. Can be grid or database. + enum: + - GRID_IMAGE + - DATABASE_IMAGE + type: string + lsInventory: + description: The output from the OPatch lsInventory command, which is passed as a string. + maxLength: 262144 + minLength: 1 + type: string + patchSet: + description: The PSU or PBP or Release Updates. To get a list of supported versions, use the [ListDbVersions](#/en/database/latest/DbVersionSummary/ListDbVersions) operation. + maxLength: 255 + minLength: 1 + type: string + sourceDbHomeId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - displayName + type: object + DatabaseSoftwareImage: + description: | + Database software images are created by specifying a patch set, one-off patches and patches for the database home (listed by `ls inventory`). + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + databaseSoftwareImageIncludedPatches: + description: List of one-off patches for Database Homes. + items: + type: string + type: array + databaseSoftwareImageOneOffPatches: + description: List of one-off patches for Database Homes. + items: + type: string + type: array + databaseVersion: + description: The database version with which the database software image is to be built. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the database software image. The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database software image. + maxLength: 255 + minLength: 1 + type: string + imageShapeFamily: + description: To what shape the image is meant for. + enum: + - VM_BM_SHAPE + - EXADATA_SHAPE + - EXACC_SHAPE + - EXADBXS_SHAPE + type: string + imageType: + description: The type of software image. Can be grid or database. + enum: + - GRID_IMAGE + - DATABASE_IMAGE + type: string + includedPatchesSummary: + description: The patches included in the image and the version of the image. + maxLength: 65536 + minLength: 1 + type: string + isUpgradeSupported: + description: True if this Database software image is supported for Upgrade. + type: boolean + lifecycleDetails: + description: Detailed message for the lifecycle state. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the database software image. + enum: + - PROVISIONING + - AVAILABLE + - DELETING + - DELETED + - FAILED + - TERMINATING + - TERMINATED + - UPDATING + type: string + lsInventory: + description: The output from the OPatch lsInventory command, which is passed as a string. + maxLength: 262144 + minLength: 1 + type: string + patchSet: + description: The PSU or PBP or Release Updates. To get a list of supported versions, use the [ListDbVersions](#/en/database/latest/DbVersionSummary/ListDbVersions) operation. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the database software image was created. + format: date-time + type: string + required: + - id + - compartmentId + - lifecycleState + - displayName + - timeCreated + - imageType + - imageShapeFamily + - patchSet + - databaseVersion + type: object + UpdateDatabaseSoftwareImageDetails: + description: | + Describes the parameters for updating the Database Software Image + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the database software image. The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + type: object + DatabaseSummary: + description: | + An Oracle Database on a bare metal or virtual machine DB system. For more information, see [Bare Metal and Virtual Machine DB Systems](/Content/Database/Concepts/overview.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + characterSet: + description: The character set for the database. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + connectionStrings: + $ref: '#/components/schemas/DatabaseConnectionStrings' + dataGuardGroup: + $ref: '#/components/schemas/DataGuardGroup' + databaseManagementConfig: + $ref: '#/components/schemas/CloudDatabaseManagementConfig' + databaseSoftwareImageId: + description: The database software image [OCID](/Content/General/Concepts/identifiers.htm) + maxLength: 255 + minLength: 1 + type: string + dbBackupConfig: + $ref: '#/components/schemas/DbBackupConfig' + dbHomeId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home. + maxLength: 255 + minLength: 1 + type: string + dbName: + description: The database name. + maxLength: 255 + minLength: 1 + type: string + dbSystemId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. + maxLength: 255 + minLength: 1 + type: string + dbUniqueName: + description: | + A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed. + maxLength: 30 + minLength: 1 + type: string + dbWorkload: + description: | + **Deprecated.** The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. + Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored. + + The database workload type. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + encryptionKeyLocationDetails: + $ref: '#/components/schemas/EncryptionKeyLocationDetails' + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + homeType: + description: | + Represents database will be under oracle managed home or customer managed home + enum: + - ORACLE_MANAGED + - CUSTOMER_MANAGED + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database. + maxLength: 255 + minLength: 1 + type: string + isCdb: + description: True if the database is a container database. + type: boolean + kmsKeyId: + description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. + maxLength: 255 + minLength: 1 + type: string + kmsKeyVersionId: + description: | + The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. + maxLength: 255 + minLength: 1 + type: string + lastBackupDurationInSeconds: + description: The duration when the latest database backup created. + type: integer + lastBackupTimestamp: + description: The date and time when the latest database backup was created. + format: date-time + type: string + lastFailedBackupTimestamp: + description: The date and time when the latest database backup failed. + format: date-time + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the database. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - BACKUP_IN_PROGRESS + - UPGRADING + - CONVERTING + - TERMINATING + - TERMINATED + - RESTORE_FAILED + - FAILED + type: string + managedSoftwareUpdateDetails: + $ref: '#/components/schemas/ManagedSoftwareUpdateDetails' + ncharacterSet: + description: The national character set for the database. + maxLength: 255 + minLength: 1 + type: string + pdbName: + description: The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. + maxLength: 30 + minLength: 1 + type: string + sidPrefix: + description: | + Specifies a prefix for the `Oracle SID` of the database to be created. + maxLength: 12 + minLength: 1 + type: string + sourceDatabasePointInTimeRecoveryTimestamp: + description: Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) + format: date-time + type: string + storageSizeDetails: + $ref: '#/components/schemas/DatabaseStorageSizeResponseDetails' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the database was created. + format: date-time + type: string + vaultId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. + maxLength: 255 + minLength: 1 + type: string + vmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - lifecycleState + - dbName + - dbUniqueName + type: object + CreateDatabaseBase: + description: | + Details for creating a database. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + discriminator: + propertyName: source + properties: + dbHomeId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home. + maxLength: 255 + minLength: 1 + type: string + dbVersion: + description: | + A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + type: string + kmsKeyId: + description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. + maxLength: 255 + minLength: 1 + type: string + kmsKeyVersionId: + description: | + The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. + maxLength: 255 + minLength: 1 + type: string + source: + default: NONE + description: | + The source of the database: + Use `NONE` for creating a new database. + Use `DB_BACKUP` for creating a new database by restoring from a backup. + Use `DATAGUARD` for creating a new STANDBY database for a Data Guard setup.. + The default is `NONE`. + enum: + - NONE + - DB_BACKUP + - DATABASE + - DATAGUARD + type: string + required: + - source + type: object + Database: + description: | + An Oracle Database on a bare metal or virtual machine DB system. For more information, see [Bare Metal and Virtual Machine DB Systems](/Content/Database/Concepts/overview.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + characterSet: + description: The character set for the database. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + connectionStrings: + $ref: '#/components/schemas/DatabaseConnectionStrings' + dataGuardGroup: + $ref: '#/components/schemas/DataGuardGroup' + databaseManagementConfig: + $ref: '#/components/schemas/CloudDatabaseManagementConfig' + databaseSoftwareImageId: + description: The database software image [OCID](/Content/General/Concepts/identifiers.htm) + maxLength: 255 + minLength: 1 + type: string + dbBackupConfig: + $ref: '#/components/schemas/DbBackupConfig' + dbHomeId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home. + maxLength: 255 + minLength: 1 + type: string + dbName: + description: The database name. + maxLength: 255 + minLength: 1 + type: string + dbSystemId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. + maxLength: 255 + minLength: 1 + type: string + dbUniqueName: + description: | + A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed. + maxLength: 30 + minLength: 1 + type: string + dbWorkload: + description: | + **Deprecated.** The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. + Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored. + + The database workload type. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + encryptionKeyLocationDetails: + $ref: '#/components/schemas/EncryptionKeyLocationDetails' + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + homeType: + description: | + Represents database will be under oracle managed home or customer managed home + enum: + - ORACLE_MANAGED + - CUSTOMER_MANAGED + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database. + maxLength: 255 + minLength: 1 + type: string + isCdb: + description: True if the database is a container database. + type: boolean + kmsKeyId: + description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. + maxLength: 255 + minLength: 1 + type: string + kmsKeyVersionId: + description: | + The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. + maxLength: 255 + minLength: 1 + type: string + lastBackupDurationInSeconds: + description: The duration when the latest database backup created. + type: integer + lastBackupTimestamp: + description: The date and time when the latest database backup was created. + format: date-time + type: string + lastFailedBackupTimestamp: + description: The date and time when the latest database backup failed. + format: date-time + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the database. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - BACKUP_IN_PROGRESS + - UPGRADING + - CONVERTING + - TERMINATING + - TERMINATED + - RESTORE_FAILED + - FAILED + type: string + managedSoftwareUpdateDetails: + $ref: '#/components/schemas/ManagedSoftwareUpdateDetails' + ncharacterSet: + description: The national character set for the database. + maxLength: 255 + minLength: 1 + type: string + pdbName: + description: The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. + maxLength: 30 + minLength: 1 + type: string + sidPrefix: + description: | + Specifies a prefix for the `Oracle SID` of the database to be created. + maxLength: 12 + minLength: 1 + type: string + sourceDatabasePointInTimeRecoveryTimestamp: + description: Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) + format: date-time + type: string + storageSizeDetails: + $ref: '#/components/schemas/DatabaseStorageSizeResponseDetails' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the database was created. + format: date-time + type: string + vaultId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. + maxLength: 255 + minLength: 1 + type: string + vmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - lifecycleState + - dbName + - dbUniqueName + type: object + UpdateDatabaseDetails: + description: | + Details to update a database. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + dbBackupConfig: + $ref: '#/components/schemas/DbBackupConfig' + dbHomeId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + managedSoftwareUpdateDetails: + $ref: '#/components/schemas/ManagedSoftwareUpdateInputDetails' + newAdminPassword: + description: A new strong password for SYS, SYSTEM, and the plugbable database ADMIN user. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, \#, or -. + format: password + maxLength: 255 + minLength: 9 + type: string + newTdeWalletPassword: + description: The new password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, \#, or -. + format: password + maxLength: 255 + minLength: 8 + type: string + oldTdeWalletPassword: + description: The existing TDE wallet password. You must provide the existing password in order to set a new TDE wallet password. + format: password + maxLength: 255 + minLength: 8 + type: string + storageSizeDetails: + $ref: '#/components/schemas/DatabaseStorageSizeDetails' + type: object + EncryptionKeyLocationDetails: + description: Types of providers supported for managing database encryption keys + discriminator: + propertyName: providerType + properties: + providerType: + description: | + Use 'EXTERNAL' for creating a new database or migrating a database key to an External HSM. + Use 'AZURE' for creating a new database or migrating a database key to Azure. + enum: + - EXTERNAL + - AZURE + type: string + x-default-description: 'null' + required: + - providerType + type: object + ConvertToPdbDetails: + description: | + Details for converting a non-container database to pluggable database. + properties: + action: + description: | + The operations used to convert a non-container database to a pluggable database. + - Use `PRECHECK` to run a pre-check operation on non-container database prior to converting it into a pluggable database. + - Use `CONVERT` to convert a non-container database into a pluggable database. + - Use `SYNC` if the non-container database was manually converted into a pluggable database using the dbcli command-line utility. Databases may need to be converted manually if the CONVERT action fails when converting a non-container database using the API. + - Use `SYNC_ROLLBACK` if the conversion of a non-container database into a pluggable database was manually rolled back using the dbcli command line utility. Conversions may need to be manually rolled back if the CONVERT action fails when converting a non-container database using the API. + enum: + - PRECHECK + - CONVERT + - SYNC + - SYNC_ROLLBACK + type: string + convertToPdbTargetDetails: + $ref: '#/components/schemas/ConvertToPdbTargetBase' + required: + - action + type: object + EnableDatabaseManagementDetails: + description: | + Data to enable the Database Management service for the database. + properties: + credentialDetails: + $ref: '#/components/schemas/DatabaseCredentialDetails' + managementType: + default: BASIC + description: The Database Management type. + enum: + - BASIC + - ADVANCED + type: string + privateEndPointId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the private endpoint. + maxLength: 255 + minLength: 1 + type: string + serviceName: + description: The name of the Oracle Database service that will be used to connect to the database. + maxLength: 255 + minLength: 1 + type: string + required: + - credentialDetails + - privateEndPointId + - serviceName + type: object + MigrateVaultKeyDetails: + description: | + Details for replacing existing Oracle-managed keys with customer-managed [Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) keys and vice-versa is not supported. + properties: + adminPassword: + description: The existing admin password of the database. + format: password + maxLength: 255 + minLength: 9 + type: string + x-default-description: 'null' + kmsKeyId: + description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. + maxLength: 255 + minLength: 1 + type: string + kmsKeyVersionId: + description: | + The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. + maxLength: 255 + minLength: 1 + type: string + tdeWalletPassword: + description: The existing TDE wallet password of the database. + format: password + maxLength: 255 + minLength: 8 + type: string + x-default-description: 'null' + vaultId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. + maxLength: 255 + minLength: 1 + type: string + required: + - kmsKeyId + type: object + ModifyDatabaseManagementDetails: + description: | + Data to update one or more attributes of the Database Management configuration for the database. + properties: + credentialDetails: + $ref: '#/components/schemas/DatabaseCredentialDetails' + managementType: + default: BASIC + description: The Database Management type. + enum: + - BASIC + - ADVANCED + type: string + privateEndPointId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the private endpoint. + maxLength: 255 + minLength: 1 + type: string + serviceName: + description: The name of the Oracle Database service that will be used to connect to the database. + maxLength: 255 + minLength: 1 + type: string + type: object + RestoreDatabaseDetails: + properties: + databaseSCN: + description: | + Restores using the backup with the System Change Number (SCN) specified. + This field is applicable for both use cases - Restoring Container Database or Restoring specific Pluggable Database. + maxLength: 255 + minLength: 1 + type: string + latest: + description: | + Restores to the last known good state with the least possible data loss. + type: boolean + pluggableDatabaseName: + description: | + Restores only the Pluggable Database (if specified) using the inputs provided in request. + type: string + timestamp: + description: | + Restores to the timestamp specified. + format: date-time + type: string + type: object + UpgradeDatabaseDetails: + description: | + Details for upgrading a database to a specific Oracle Database version. + properties: + action: + description: The database upgrade action. + enum: + - PRECHECK + - UPGRADE + - ROLLBACK + type: string + databaseUpgradeSourceDetails: + $ref: '#/components/schemas/DatabaseUpgradeSourceBase' + required: + - action + type: object + ConvertToStandaloneDetails: + description: | + The properties for converting a standby database to a standalone. + properties: + databaseAdminPassword: + description: | + The administrator password of the primary database in this Data Guard association. + + **The password MUST be the same as the primary admin password.** + format: password + maxLength: 255 + minLength: 1 + type: string + required: + - databaseAdminPassword + type: object + FailoverDataGuardDetails: + description: | + The Data Guard failover parameters. + properties: + databaseAdminPassword: + description: | + The administrator password of the primary database in this Data Guard association. + + **The password MUST be the same as the primary admin password.** + format: password + maxLength: 255 + minLength: 1 + type: string + required: + - databaseAdminPassword + type: object + ReinstateDataGuardDetails: + description: | + The Data Guard reinstate parameters. + properties: + databaseAdminPassword: + description: | + The administrator password of the primary database in this Data Guard association. + + **The password MUST be the same as the primary admin password.** + format: password + maxLength: 255 + minLength: 1 + type: string + sourceDatabaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the source (primary) database in the Data Guard group. + type: string + required: + - databaseAdminPassword + - sourceDatabaseId + type: object + SwitchOverDataGuardDetails: + description: | + The Data Guard switchover parameters. + properties: + databaseAdminPassword: + description: | + The administrator password of the primary database in this Data Guard association. + + **The password MUST be the same as the primary admin password.** + format: password + maxLength: 255 + minLength: 1 + type: string + required: + - databaseAdminPassword + type: object + UpdateDataGuardDetails: + description: The properties for updating a standby database. + properties: + databaseAdminPassword: + description: | + The administrator password of the primary database in this Data Guard association. + + **The password MUST be the same as the primary admin password.** + format: password + maxLength: 255 + minLength: 1 + type: string + isActiveDataGuardEnabled: + description: True if active Data Guard is enabled. + type: boolean + protectionMode: + description: | + The protection mode of this Data Guard. For more information, see + [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) + in the Oracle Data Guard documentation. + enum: + - MAXIMUM_AVAILABILITY + - MAXIMUM_PERFORMANCE + - MAXIMUM_PROTECTION + type: string + transportType: + description: | + The redo transport type to use for this Data Guard association. Valid values depend on the specified `protectionMode`: + + * MAXIMUM_AVAILABILITY - SYNC or FASTSYNC + * MAXIMUM_PERFORMANCE - ASYNC + * MAXIMUM_PROTECTION - SYNC + + For more information, see + [Redo Transport Services](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-redo-transport-services.htm#SBYDB00400) + in the Oracle Data Guard documentation. + + **IMPORTANT** - The only transport type currently supported by the Database service is ASYNC. + enum: + - SYNC + - ASYNC + - FASTSYNC + type: string + type: object + DataGuardAssociationSummary: + description: | + The properties that define a Data Guard association. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an + administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + For information about endpoints and signing API requests, see + [About the API](/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see + [SDKS and Other Tools](/Content/API/Concepts/sdks.htm). + properties: + applyLag: + description: | + The lag time between updates to the primary database and application of the redo data on the standby database, + as computed by the reporting database. + + Example: `9 seconds` + type: string + applyRate: + description: | + The rate at which redo logs are synced between the associated databases. + + Example: `180 Mb per second` + type: string + databaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the reporting database. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Guard association. + maxLength: 255 + minLength: 1 + type: string + isActiveDataGuardEnabled: + description: True if active Data Guard is enabled. + type: boolean + lifecycleDetails: + description: | + Additional information about the current lifecycleState, if available. + type: string + lifecycleState: + description: The current state of the Data Guard association. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - UPGRADING + type: string + peerDataGuardAssociationId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the peer database's Data Guard association. + maxLength: 255 + minLength: 1 + type: string + peerDatabaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the associated peer database. + maxLength: 255 + minLength: 1 + type: string + peerDbHomeId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home containing the associated peer database. + maxLength: 255 + minLength: 1 + type: string + peerDbSystemId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system containing the associated + peer database. + maxLength: 255 + minLength: 1 + type: string + peerRole: + description: The role of the peer database in this Data Guard association. + enum: + - PRIMARY + - STANDBY + - DISABLED_STANDBY + type: string + protectionMode: + description: | + The protection mode of this Data Guard association. For more information, see + [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) + in the Oracle Data Guard documentation. + enum: + - MAXIMUM_AVAILABILITY + - MAXIMUM_PERFORMANCE + - MAXIMUM_PROTECTION + type: string + role: + description: The role of the reporting database in this Data Guard association. + enum: + - PRIMARY + - STANDBY + - DISABLED_STANDBY + type: string + timeCreated: + description: The date and time the Data Guard association was created. + format: date-time + type: string + transportType: + description: | + The redo transport type used by this Data Guard association. For more information, see + [Redo Transport Services](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-redo-transport-services.htm#SBYDB00400) + in the Oracle Data Guard documentation. + enum: + - SYNC + - ASYNC + - FASTSYNC + type: string + required: + - id + - databaseId + - role + - peerDbSystemId + - peerRole + - protectionMode + - lifecycleState + type: object + CreateDataGuardAssociationDetails: + description: | + The configuration details for creating a Data Guard association between databases. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + discriminator: + propertyName: creationType + properties: + creationType: + description: | + Specifies whether to create the peer database in an existing DB system or in a new DB system. + maxLength: 255 + minLength: 1 + type: string + databaseAdminPassword: + description: | + A strong password for the `SYS`, `SYSTEM`, and `PDB Admin` users to apply during standby creation. + + The password must contain no fewer than nine characters and include: + + * At least two uppercase characters. + + * At least two lowercase characters. + + * At least two numeric characters. + + * At least two special characters. Valid special characters include "_", "#", and "-" only. + + **The password MUST be the same as the primary admin password.** + maxLength: 255 + minLength: 1 + type: string + databaseSoftwareImageId: + description: The database software image [OCID](/Content/General/Concepts/identifiers.htm) + maxLength: 255 + minLength: 1 + type: string + isActiveDataGuardEnabled: + description: True if active Data Guard is enabled. + type: boolean + peerDbUniqueName: + description: | + Specifies the `DB_UNIQUE_NAME` of the peer database to be created. + maxLength: 30 + minLength: 1 + type: string + peerSidPrefix: + description: | + Specifies a prefix for the `Oracle SID` of the database to be created. + maxLength: 12 + minLength: 1 + type: string + protectionMode: + description: | + The protection mode to set up between the primary and standby databases. For more information, see + [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) + in the Oracle Data Guard documentation. + + **IMPORTANT** - The only protection mode currently supported by the Database service is MAXIMUM_PERFORMANCE. + enum: + - MAXIMUM_AVAILABILITY + - MAXIMUM_PERFORMANCE + - MAXIMUM_PROTECTION + type: string + sourceEncryptionKeyLocationDetails: + $ref: '#/components/schemas/EncryptionKeyLocationDetails' + transportType: + description: | + The redo transport type to use for this Data Guard association. Valid values depend on the specified `protectionMode`: + + * MAXIMUM_AVAILABILITY - SYNC or FASTSYNC + * MAXIMUM_PERFORMANCE - ASYNC + * MAXIMUM_PROTECTION - SYNC + + For more information, see + [Redo Transport Services](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-redo-transport-services.htm#SBYDB00400) + in the Oracle Data Guard documentation. + + **IMPORTANT** - The only transport type currently supported by the Database service is ASYNC. + enum: + - SYNC + - ASYNC + - FASTSYNC + type: string + required: + - databaseAdminPassword + - protectionMode + - transportType + - creationType + type: object + DataGuardAssociation: + description: | + The properties that define a Data Guard association. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an + administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + For information about endpoints and signing API requests, see + [About the API](/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see + [SDKS and Other Tools](/Content/API/Concepts/sdks.htm). + properties: + applyLag: + description: | + The lag time between updates to the primary database and application of the redo data on the standby database, + as computed by the reporting database. + + Example: `9 seconds` + type: string + applyRate: + description: | + The rate at which redo logs are synced between the associated databases. + + Example: `180 Mb per second` + type: string + databaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the reporting database. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Guard association. + maxLength: 255 + minLength: 1 + type: string + isActiveDataGuardEnabled: + description: True if active Data Guard is enabled. + type: boolean + lifecycleDetails: + description: | + Additional information about the current lifecycleState, if available. + type: string + lifecycleState: + description: The current state of the Data Guard association. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - UPGRADING + type: string + peerDataGuardAssociationId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the peer database's Data Guard association. + maxLength: 255 + minLength: 1 + type: string + peerDatabaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the associated peer database. + maxLength: 255 + minLength: 1 + type: string + peerDbHomeId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home containing the associated peer database. + maxLength: 255 + minLength: 1 + type: string + peerDbSystemId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system containing the associated + peer database. + maxLength: 255 + minLength: 1 + type: string + peerRole: + description: The role of the peer database in this Data Guard association. + enum: + - PRIMARY + - STANDBY + - DISABLED_STANDBY + type: string + protectionMode: + description: | + The protection mode of this Data Guard association. For more information, see + [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) + in the Oracle Data Guard documentation. + enum: + - MAXIMUM_AVAILABILITY + - MAXIMUM_PERFORMANCE + - MAXIMUM_PROTECTION + type: string + role: + description: The role of the reporting database in this Data Guard association. + enum: + - PRIMARY + - STANDBY + - DISABLED_STANDBY + type: string + timeCreated: + description: The date and time the Data Guard association was created. + format: date-time + type: string + transportType: + description: | + The redo transport type used by this Data Guard association. For more information, see + [Redo Transport Services](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-redo-transport-services.htm#SBYDB00400) + in the Oracle Data Guard documentation. + enum: + - SYNC + - ASYNC + - FASTSYNC + type: string + required: + - id + - databaseId + - role + - peerDbSystemId + - peerRole + - protectionMode + - lifecycleState + type: object + UpdateDataGuardAssociationDetails: + description: | + The configuration details for updating a Data Guard association for a database. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + databaseAdminPassword: + description: | + A strong password for the 'SYS', 'SYSTEM', and 'PDB Admin' users to apply during standby creation. + + The password must contain no fewer than nine characters and include: + + * At least two uppercase characters. + + * At least two lowercase characters. + + * At least two numeric characters. + + * At least two special characters. Valid special characters include "_", "#", and "-" only. + + **The password MUST be the same as the primary admin password.** + maxLength: 255 + minLength: 1 + type: string + isActiveDataGuardEnabled: + description: True if active Data Guard is enabled. Update this parameter to change the Data Guard setting. + type: boolean + protectionMode: + description: | + The protection mode for the Data Guard association's primary and standby database. For more information, see + [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) + in the Oracle Data Guard documentation. + enum: + - MAXIMUM_AVAILABILITY + - MAXIMUM_PERFORMANCE + - MAXIMUM_PROTECTION + type: string + transportType: + description: | + The redo transport type to use for this Data Guard association. Valid values depend on the specified 'protectionMode': + * MAXIMUM_AVAILABILITY - Use SYNC or FASTSYNC + * MAXIMUM_PERFORMANCE - Use ASYNC + * MAXIMUM_PROTECTION - Use SYNC + + For more information, see + [Redo Transport Services](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-redo-transport-services.htm#SBYDB00400) + in the Oracle Data Guard documentation. + enum: + - SYNC + - ASYNC + - FASTSYNC + type: string + type: object + FailoverDataGuardAssociationDetails: + description: | + The Data Guard association failover parameters. + properties: + databaseAdminPassword: + description: The DB system administrator password. + maxLength: 255 + minLength: 1 + type: string + required: + - databaseAdminPassword + type: object + ReinstateDataGuardAssociationDetails: + description: | + The Data Guard association reinstate parameters. + properties: + databaseAdminPassword: + description: The DB system administrator password. + maxLength: 255 + minLength: 1 + type: string + required: + - databaseAdminPassword + type: object + SwitchoverDataGuardAssociationDetails: + description: | + The Data Guard association switchover parameters. + properties: + databaseAdminPassword: + description: The DB system administrator password. + maxLength: 255 + minLength: 1 + type: string + required: + - databaseAdminPassword + type: object + PdbConversionHistoryEntrySummary: + description: | + Details of operations performed to convert a non-container database to pluggable database. + properties: + action: + description: | + The operations used to convert a non-container database to a pluggable database. + - Use `PRECHECK` to run a pre-check operation on non-container database prior to converting it into a pluggable database. + - Use `CONVERT` to convert a non-container database into a pluggable database. + - Use `SYNC` if the non-container database was manually converted into a pluggable database using the dbcli command-line utility. Databases may need to be converted manually if the CONVERT action fails when converting a non-container database using the API. + - Use `SYNC_ROLLBACK` if the conversion of a non-container database into a pluggable database was manually rolled back using the dbcli command line utility. Conversions may need to be manually rolled back if the CONVERT action fails when converting a non-container database using the API. + enum: + - PRECHECK + - CONVERT + - SYNC + - SYNC_ROLLBACK + type: string + additionalCdbParams: + description: | + Additional container database parameter. + type: string + cdbName: + description: The database name. The name must begin with an alphabetic character and can contain a maximum of 8 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. + maxLength: 8 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database conversion history. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state for the conversion operation. + type: string + lifecycleState: + description: Status of an operation performed during the conversion of a non-container database to a pluggable database. + enum: + - SUCCEEDED + - FAILED + - IN_PROGRESS + type: string + sourceDatabaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database. + maxLength: 255 + minLength: 1 + type: string + target: + description: | + The target container database of the pluggable database created by the database conversion operation. Currently, the database conversion operation only supports creating the pluggable database in a new container database. + - Use `NEW_DATABASE` to specify that the pluggable database be created within a new container database in the same database home. + enum: + - NEW_DATABASE + type: string + targetDatabaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database. + maxLength: 255 + minLength: 1 + type: string + timeEnded: + description: The date and time when the database conversion operation ended. + format: date-time + type: string + timeStarted: + description: The date and time when the database conversion operation started. + format: date-time + type: string + required: + - id + - action + - sourceDatabaseId + - lifecycleState + - timeStarted + - cdbName + type: object + PdbConversionHistoryEntry: + description: | + Details of operations performed to convert a non-container database to pluggable database. + properties: + action: + description: | + The operations used to convert a non-container database to a pluggable database. + - Use `PRECHECK` to run a pre-check operation on non-container database prior to converting it into a pluggable database. + - Use `CONVERT` to convert a non-container database into a pluggable database. + - Use `SYNC` if the non-container database was manually converted into a pluggable database using the dbcli command-line utility. Databases may need to be converted manually if the CONVERT action fails when converting a non-container database using the API. + - Use `SYNC_ROLLBACK` if the conversion of a non-container database into a pluggable database was manually rolled back using the dbcli command line utility. Conversions may need to be manually rolled back if the CONVERT action fails when converting a non-container database using the API. + enum: + - PRECHECK + - CONVERT + - SYNC + - SYNC_ROLLBACK + type: string + additionalCdbParams: + description: | + Additional container database parameter. + type: string + cdbName: + description: The database name. The name must begin with an alphabetic character and can contain a maximum of 8 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. + maxLength: 8 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database conversion history. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state for the conversion operation. + type: string + lifecycleState: + description: Status of an operation performed during the conversion of a non-container database to a pluggable database. + enum: + - SUCCEEDED + - FAILED + - IN_PROGRESS + type: string + sourceDatabaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database. + maxLength: 255 + minLength: 1 + type: string + target: + description: | + The target container database of the pluggable database created by the database conversion operation. Currently, the database conversion operation only supports creating the pluggable database in a new container database. + - Use `NEW_DATABASE` to specify that the pluggable database be created within a new container database in the same database home. + enum: + - NEW_DATABASE + type: string + targetDatabaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database. + maxLength: 255 + minLength: 1 + type: string + timeEnded: + description: The date and time when the database conversion operation ended. + format: date-time + type: string + timeStarted: + description: The date and time when the database conversion operation started. + format: date-time + type: string + required: + - id + - action + - sourceDatabaseId + - lifecycleState + - timeStarted + - cdbName + type: object + DatabaseUpgradeHistoryEntrySummary: + description: | + The Database service supports the upgrade history of databases. + + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + For information about access control and compartments, see + [Overview of the Identity Service](/Content/Identity/Concepts/overview.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + action: + description: The database upgrade action. + enum: + - PRECHECK + - UPGRADE + - ROLLBACK + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database upgrade history. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: Status of database upgrade history SUCCEEDED|IN_PROGRESS|FAILED. + enum: + - SUCCEEDED + - FAILED + - IN_PROGRESS + type: string + options: + description: | + Additional upgrade options supported by DBUA(Database Upgrade Assistant). + Example: "-upgradeTimezone false -keepEvents" + type: string + source: + description: | + The source of the Oracle Database software to be used for the upgrade. + - Use `DB_HOME` to specify an existing Database Home to upgrade the database. The database is moved to the target Database Home and makes use of the Oracle Database software version of the target Database Home. + - Use `DB_VERSION` to specify a generally-available Oracle Database software version to upgrade the database. + - Use `DB_SOFTWARE_IMAGE` to specify a [database software image](/iaas/Content/Database/Concepts/databasesoftwareimage.htm) to upgrade the database. + enum: + - DB_HOME + - DB_VERSION + - DB_SOFTWARE_IMAGE + type: string + sourceDbHomeId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home. + maxLength: 255 + minLength: 1 + type: string + targetDBVersion: + description: | + A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + type: string + targetDatabaseSoftwareImageId: + description: the database software image used for upgrading database. + maxLength: 255 + minLength: 1 + type: string + targetDbHomeId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home. + maxLength: 255 + minLength: 1 + type: string + timeEnded: + description: The date and time when the database upgrade ended. + format: date-time + type: string + timeStarted: + description: The date and time when the database upgrade started. + format: date-time + type: string + required: + - id + - action + - lifecycleState + - timeStarted + type: object + DatabaseUpgradeHistoryEntry: + description: | + The Database service supports the upgrade history of databases. + + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + For information about access control and compartments, see + [Overview of the Identity Service](/Content/Identity/Concepts/overview.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + action: + description: The database upgrade action. + enum: + - PRECHECK + - UPGRADE + - ROLLBACK + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database upgrade history. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: Status of database upgrade history SUCCEEDED|IN_PROGRESS|FAILED. + enum: + - SUCCEEDED + - FAILED + - IN_PROGRESS + type: string + options: + description: | + Additional upgrade options supported by DBUA(Database Upgrade Assistant). + Example: "-upgradeTimezone false -keepEvents" + type: string + source: + description: | + The source of the Oracle Database software to be used for the upgrade. + - Use `DB_HOME` to specify an existing Database Home to upgrade the database. The database is moved to the target Database Home and makes use of the Oracle Database software version of the target Database Home. + - Use `DB_VERSION` to specify a generally-available Oracle Database software version to upgrade the database. + - Use `DB_SOFTWARE_IMAGE` to specify a [database software image](/iaas/Content/Database/Concepts/databasesoftwareimage.htm) to upgrade the database. + enum: + - DB_HOME + - DB_VERSION + - DB_SOFTWARE_IMAGE + type: string + sourceDbHomeId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home. + maxLength: 255 + minLength: 1 + type: string + targetDBVersion: + description: | + A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + type: string + targetDatabaseSoftwareImageId: + description: the database software image used for upgrading database. + maxLength: 255 + minLength: 1 + type: string + targetDbHomeId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home. + maxLength: 255 + minLength: 1 + type: string + timeEnded: + description: The date and time when the database upgrade ended. + format: date-time + type: string + timeStarted: + description: The date and time when the database upgrade started. + format: date-time + type: string + required: + - id + - action + - lifecycleState + - timeStarted + type: object + DbConnectionBundleSummary: + description: Summary of a database connection bundle. + properties: + associatedResourceDetails: + description: Details about the resources associated with the connection bundle. + items: + $ref: '#/components/schemas/AssociatedResourceDetails' + type: array + compartmentId: + description: The OCID of the compartment containing the database connection bundle. + maxLength: 255 + minLength: 1 + type: string + dbConnectionBundleType: + description: The type of the database connection bundle. + enum: + - TLS + - MTLS + type: string + definedTags: + additionalProperties: + additionalProperties: + type: string + type: object + description: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: Display name for the connection bundle. + 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](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). + type: object + id: + description: The OCID of the database connection bundle. + maxLength: 255 + minLength: 1 + type: string + isProtected: + description: True for the default, service-created Database Connection Bundle. + type: boolean + lifecycleState: + description: The current lifecycle state of the database connection bundle. + enum: + - CREATING + - ACTIVE + - INACTIVE + - UPDATING + - DELETING + - DELETED + - FAILED + type: string + systemTags: + additionalProperties: + additionalProperties: + type: string + readOnly: true + type: object + description: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The time the database connection bundle was created. An RFC3339 formatted datetime string. + format: date-time + type: string + timeLastRefreshed: + description: The time the database connection bundle was last refreshed. An RFC3339 formatted datetime string. + format: date-time + type: string + timeUpdated: + description: The time the database connection bundle was updated. An RFC3339 formatted datetime string. + format: date-time + type: string + required: + - id + - compartmentId + - lifecycleState + - timeCreated + - timeUpdated + - dbConnectionBundleType + - isProtected + - displayName + - freeformTags + - definedTags + - systemTags + type: object + DbConnectionBundle: + description: Details of a database connection bundle. + properties: + associatedResourceDetails: + description: Details about the resources associated with the connection bundle. + items: + $ref: '#/components/schemas/AssociatedResourceDetails' + type: array + compartmentId: + description: The OCID of the compartment containing the database connection bundle. + maxLength: 255 + minLength: 1 + type: string + dbConnectionBundleType: + description: The type of the database connection bundle. + enum: + - TLS + - MTLS + type: string + definedTags: + additionalProperties: + additionalProperties: + type: string + type: object + description: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: Display name for the connection bundle. + 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](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). + type: object + id: + description: The OCID of the database connection bundle. + maxLength: 255 + minLength: 1 + type: string + isProtected: + description: True for the default, service-created Database Connection Bundle. + type: boolean + lifecycleState: + description: The current lifecycle state of the database connection bundle. + enum: + - CREATING + - ACTIVE + - INACTIVE + - UPDATING + - DELETING + - DELETED + - FAILED + type: string + systemTags: + additionalProperties: + additionalProperties: + type: string + readOnly: true + type: object + description: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The time the database connection bundle was created. An RFC3339 formatted datetime string. + format: date-time + type: string + timeLastRefreshed: + description: The time the database connection bundle was last refreshed. An RFC3339 formatted datetime string. + format: date-time + type: string + timeUpdated: + description: The time the database connection bundle was updated. An RFC3339 formatted datetime string. + format: date-time + type: string + required: + - id + - compartmentId + - lifecycleState + - timeCreated + - timeUpdated + - dbConnectionBundleType + - isProtected + - displayName + - freeformTags + - definedTags + - systemTags + type: object + DownloadDbConnectionBundleDetails: + description: | + Details to download a database connection bundle. + properties: + password: + description: The password to encrypt the keys inside the bundle. The password must be at least 8 characters long and must include at least 1 letter and either 1 numeric character or 1 special character. + minLength: 8 + type: string + required: + - password + type: object + DbHomeSummary: + description: | + A directory where Oracle Database software is installed. A bare metal or Exadata DB system can have multiple Database Homes + and each Database Home can run a different supported version of Oracle Database. A virtual machine DB system can have only one Database Home. + For more information, see [Bare Metal and Virtual Machine DB Systems](/Content/Database/Concepts/overview.htm) and [Exadata DB Systems](/Content/Database/Concepts/exaoverview.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an + administrator. If you're an administrator who needs to write policies to give users access, + see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + databaseSoftwareImageId: + description: The database software image [OCID](/Content/General/Concepts/identifiers.htm) + maxLength: 255 + minLength: 1 + type: string + dbHomeLocation: + description: The location of the Oracle Database Home. + maxLength: 255 + minLength: 1 + type: string + dbSystemId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. + maxLength: 255 + minLength: 1 + type: string + dbVersion: + description: The Oracle Database version. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-provided name for the Database Home. The name does not need to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + homeType: + description: | + Represents database home will be managed by oracle or customer + enum: + - ORACLE_MANAGED + - CUSTOMER_MANAGED + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home. + maxLength: 255 + minLength: 1 + type: string + kmsKeyId: + description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. + maxLength: 255 + minLength: 1 + type: string + lastPatchHistoryEntryId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last patch history. This value is updated as soon as a patch operation is started. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the Database Home. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + type: string + oneOffPatches: + description: List of one-off patches for Database Homes. + items: + type: string + type: array + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the Database Home was created. + format: date-time + type: string + vmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - lifecycleState + - displayName + - dbVersion + - dbHomeLocation + type: object + CreateDbHomeBase: + description: | + Details for creating a Database Home. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + discriminator: + propertyName: source + properties: + databaseSoftwareImageId: + description: The database software image [OCID](/Content/General/Concepts/identifiers.htm) + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-provided name of the Database Home. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + isDesupportedVersion: + description: If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI. + type: boolean + kmsKeyId: + description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. + maxLength: 255 + minLength: 1 + type: string + kmsKeyVersionId: + description: | + The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. + maxLength: 255 + minLength: 1 + type: string + source: + default: NONE + description: | + The source of database: NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a database backup. + enum: + - NONE + - DB_BACKUP + - DATABASE + - VM_CLUSTER_BACKUP + - VM_CLUSTER_NEW + - VM_CLUSTER_DATABASE + type: string + type: object + DbHome: + description: | + A directory where Oracle Database software is installed. A bare metal or Exadata DB system can have multiple Database Homes + and each Database Home can run a different supported version of Oracle Database. A virtual machine DB system can have only one Database Home. + For more information, see [Bare Metal and Virtual Machine DB Systems](/Content/Database/Concepts/overview.htm) and [Exadata DB Systems](/Content/Database/Concepts/exaoverview.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an + administrator. If you're an administrator who needs to write policies to give users access, + see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + databaseSoftwareImageId: + description: The database software image [OCID](/Content/General/Concepts/identifiers.htm) + maxLength: 255 + minLength: 1 + type: string + dbHomeLocation: + description: The location of the Oracle Database Home. + maxLength: 255 + minLength: 1 + type: string + dbSystemId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. + maxLength: 255 + minLength: 1 + type: string + dbVersion: + description: The Oracle Database version. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-provided name for the Database Home. The name does not need to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + homeType: + description: | + Represents database home will be managed by oracle or customer + enum: + - ORACLE_MANAGED + - CUSTOMER_MANAGED + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Home. + maxLength: 255 + minLength: 1 + type: string + kmsKeyId: + description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. + maxLength: 255 + minLength: 1 + type: string + lastPatchHistoryEntryId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last patch history. This value is updated as soon as a patch operation is started. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the Database Home. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + type: string + oneOffPatches: + description: List of one-off patches for Database Homes. + items: + type: string + type: array + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the Database Home was created. + format: date-time + type: string + vmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - lifecycleState + - displayName + - dbVersion + - dbHomeLocation + type: object + UpdateDbHomeDetails: + description: | + Describes the modification parameters for the Database Home. + properties: + dbVersion: + $ref: '#/components/schemas/PatchDetails' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + oneOffPatches: + description: List of one-off patches for Database Homes. + items: + type: string + type: array + type: object + PatchHistoryEntrySummary: + description: The record of a patch action on a specified target. + properties: + action: + description: The action being performed or was completed. + enum: + - APPLY + - PRECHECK + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the patch history entry. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: | + A descriptive text associated with the lifecycleState. + Typically contains additional displayable text. + type: string + lifecycleState: + description: The current state of the action. + enum: + - IN_PROGRESS + - SUCCEEDED + - FAILED + type: string + patchId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the patch. + maxLength: 255 + minLength: 1 + type: string + timeEnded: + description: The date and time when the patch action completed + format: date-time + type: string + timeStarted: + description: The date and time when the patch action started. + format: date-time + type: string + required: + - id + - patchId + - lifecycleState + - timeStarted + type: object + PatchHistoryEntry: + description: The record of a patch action on a specified target. + properties: + action: + description: The action being performed or was completed. + enum: + - APPLY + - PRECHECK + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the patch history entry. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: | + A descriptive text associated with the lifecycleState. + Typically contains additional displayable text. + type: string + lifecycleState: + description: The current state of the action. + enum: + - IN_PROGRESS + - SUCCEEDED + - FAILED + type: string + patchId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the patch. + maxLength: 255 + minLength: 1 + type: string + timeEnded: + description: The date and time when the patch action completed + format: date-time + type: string + timeStarted: + description: The date and time when the patch action started. + format: date-time + type: string + required: + - id + - patchId + - lifecycleState + - timeStarted + type: object + PatchSummary: + description: | + A Patch for a DB system or DB Home. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + availableActions: + description: Actions that can possibly be performed using this patch. + items: + enum: + - APPLY + - PRECHECK + type: string + type: array + description: + description: The text describing this patch package. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the patch. + maxLength: 255 + minLength: 1 + type: string + lastAction: + description: Action that is currently being performed or was completed last. + enum: + - APPLY + - PRECHECK + type: string + lifecycleDetails: + description: | + A descriptive text associated with the lifecycleState. + Typically can contain additional displayable text. + type: string + lifecycleState: + description: The current state of the patch as a result of lastAction. + enum: + - AVAILABLE + - SUCCESS + - IN_PROGRESS + - FAILED + type: string + timeReleased: + description: The date and time that the patch was released. + format: date-time + type: string + version: + description: The version of this patch package. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - description + - version + - timeReleased + - type + type: object + Patch: + description: | + A Patch for a DB system or DB Home. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + availableActions: + description: Actions that can possibly be performed using this patch. + items: + enum: + - APPLY + - PRECHECK + type: string + type: array + description: + description: The text describing this patch package. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the patch. + maxLength: 255 + minLength: 1 + type: string + lastAction: + description: Action that is currently being performed or was completed last. + enum: + - APPLY + - PRECHECK + type: string + lifecycleDetails: + description: | + A descriptive text associated with the lifecycleState. + Typically can contain additional displayable text. + type: string + lifecycleState: + description: The current state of the patch as a result of lastAction. + enum: + - AVAILABLE + - SUCCESS + - IN_PROGRESS + - FAILED + type: string + timeReleased: + description: The date and time that the patch was released. + format: date-time + type: string + version: + description: The version of this patch package. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - description + - version + - timeReleased + - type + type: object + DbNodeSummary: + description: | + A server where Oracle Database software is running. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + additionalDetails: + description: Additional information about the planned maintenance. + type: string + backupIpId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the backup IP address associated with the database node. Use this OCID with either the + [GetPrivateIp](#/en/iaas/20160918/PrivateIp/GetPrivateIp) or the [GetPublicIpByPrivateIpId](#/en/iaas/20160918/PublicIp/GetPublicIpByPrivateIpId) API to get the IP address + needed to make a database connection. + + **Note:** Applies only to Exadata Cloud Service. + maxLength: 255 + minLength: 1 + type: string + backupVnic2Id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the second backup VNIC. + + **Note:** Applies only to Exadata Cloud Service. + maxLength: 255 + minLength: 1 + type: string + backupVnicId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the backup VNIC. + maxLength: 255 + minLength: 1 + type: string + computeCount: + description: The number of compute servers for the DB system. + format: int32 + type: integer + computeModel: + description: The compute model for Base Database Service. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. The ECPU compute model is the recommended model, and the OCPU compute model is legacy. + enum: + - ECPU + - OCPU + type: string + cpuCoreCount: + description: The number of CPU cores enabled on the Db node. + type: integer + dbNodeStorageSizeInGBs: + description: The allocated local node storage in GBs on the Db node. + type: integer + dbServerId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exacc Db server associated with the database node. + maxLength: 255 + minLength: 1 + type: string + dbSystemId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. + maxLength: 255 + minLength: 1 + type: string + faultDomain: + description: The name of the Fault Domain the instance is contained in. + maxLength: 255 + minLength: 1 + type: string + hostIpId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the host IP address associated with the database node. Use this OCID with either the + [GetPrivateIp](#/en/iaas/20160918/PrivateIp/GetPrivateIp) or the [GetPublicIpByPrivateIpId](#/en/iaas/20160918/PublicIp/GetPublicIpByPrivateIpId) API to get the IP address + needed to make a database connection. + + **Note:** Applies only to Exadata Cloud Service. + maxLength: 255 + minLength: 1 + type: string + hostname: + description: The host name for the database node. + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database node. + maxLength: 255 + minLength: 1 + type: string + isForceActionInProgress: + description: Indicates whether the node is in the process of being forcefully stopped or rebooted. + type: boolean + isOsPatchRebootRequired: + description: | + Indicates whether the database node must be rebooted after applying Operating System patches. + This flag becomes true after operations such as OS/kernel updates to indicate that a reboot of the node is required. After a successful reboot, this value is expected to return to false. + type: boolean + lifecycleState: + description: The current state of the database node. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - STOPPING + - STOPPED + - STARTING + - TERMINATING + - TERMINATED + - FAILED + type: string + maintenanceType: + description: The type of database node maintenance. + enum: + - VMDB_REBOOT_MIGRATION + - EXADBXS_REBOOT_MIGRATION + type: string + memorySizeInGBs: + description: The allocated memory in GBs on the Db node. + type: integer + softwareStorageSizeInGB: + description: | + The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems. + type: integer + timeCreated: + description: The date and time that the database node was created. + format: date-time + type: string + timeMaintenanceWindowEnd: + description: End date and time of maintenance window. + format: date-time + type: string + timeMaintenanceWindowStart: + description: Start date and time of maintenance window. + format: date-time + type: string + totalCpuCoreCount: + description: The total number of CPU cores reserved on the Db node. + type: integer + vnic2Id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the second VNIC. + + **Note:** Applies only to Exadata Cloud Service. + maxLength: 255 + minLength: 1 + type: string + vnicId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VNIC. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - dbSystemId + - vnicId + - lifecycleState + - timeCreated + type: object + DbNode: + description: | + A server where Oracle Database software is running. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + additionalDetails: + description: Additional information about the planned maintenance. + type: string + backupIpId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the backup IP address associated with the database node. Use this OCID with either the + [GetPrivateIp](#/en/iaas/20160918/PrivateIp/GetPrivateIp) or the [GetPublicIpByPrivateIpId](#/en/iaas/20160918/PublicIp/GetPublicIpByPrivateIpId) API to get the IP address + needed to make a database connection. + + **Note:** Applies only to Exadata Cloud Service. + maxLength: 255 + minLength: 1 + type: string + backupVnic2Id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the second backup VNIC. + + **Note:** Applies only to Exadata Cloud Service. + maxLength: 255 + minLength: 1 + type: string + backupVnicId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the backup VNIC. + maxLength: 255 + minLength: 1 + type: string + computeCount: + description: The number of compute servers for the DB system. + format: int32 + type: integer + computeModel: + description: The compute model for Base Database Service. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. The ECPU compute model is the recommended model, and the OCPU compute model is legacy. + enum: + - ECPU + - OCPU + type: string + cpuCoreCount: + description: The number of CPU cores enabled on the Db node. + type: integer + dbNodeStorageSizeInGBs: + description: The allocated local node storage in GBs on the Db node. + type: integer + dbServerId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exacc Db server associated with the database node. + maxLength: 255 + minLength: 1 + type: string + dbSystemId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. + maxLength: 255 + minLength: 1 + type: string + faultDomain: + description: The name of the Fault Domain the instance is contained in. + maxLength: 255 + minLength: 1 + type: string + hostIpId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the host IP address associated with the database node. Use this OCID with either the + [GetPrivateIp](#/en/iaas/20160918/PrivateIp/GetPrivateIp) or the [GetPublicIpByPrivateIpId](#/en/iaas/20160918/PublicIp/GetPublicIpByPrivateIpId) API to get the IP address + needed to make a database connection. + + **Note:** Applies only to Exadata Cloud Service. + maxLength: 255 + minLength: 1 + type: string + hostname: + description: The host name for the database node. + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database node. + maxLength: 255 + minLength: 1 + type: string + isForceActionInProgress: + description: Indicates whether the node is in the process of being forcefully stopped or rebooted. + type: boolean + isOsPatchRebootRequired: + description: | + Indicates whether the database node must be rebooted after applying Operating System patches. + This flag becomes true after operations such as OS/kernel updates to indicate that a reboot of the node is required. After a successful reboot, this value is expected to return to false. + type: boolean + lifecycleState: + description: The current state of the database node. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - STOPPING + - STOPPED + - STARTING + - TERMINATING + - TERMINATED + - FAILED + type: string + maintenanceType: + description: The type of database node maintenance. + enum: + - VMDB_REBOOT_MIGRATION + - EXADBXS_REBOOT_MIGRATION + type: string + memorySizeInGBs: + description: The allocated memory in GBs on the Db node. + type: integer + softwareStorageSizeInGB: + description: | + The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems. + type: integer + timeCreated: + description: The date and time that the database node was created. + format: date-time + type: string + timeMaintenanceWindowEnd: + description: End date and time of maintenance window. + format: date-time + type: string + timeMaintenanceWindowStart: + description: Start date and time of maintenance window. + format: date-time + type: string + totalCpuCoreCount: + description: The total number of CPU cores reserved on the Db node. + type: integer + vnic2Id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the second VNIC. + + **Note:** Applies only to Exadata Cloud Service. + maxLength: 255 + minLength: 1 + type: string + vnicId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VNIC. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - dbSystemId + - vnicId + - lifecycleState + - timeCreated + type: object + ConsoleConnectionSummary: + description: | + The `InstanceConsoleConnection` API provides you with console access to dbnode + enabling you to troubleshoot malfunctioning dbnode. + properties: + compartmentId: + description: The OCID of the compartment to contain the console connection. + maxLength: 255 + minLength: 1 + type: string + connectionString: + description: The SSH connection string for the console connection. + type: string + dbNodeId: + description: The OCID of the database node. + maxLength: 255 + minLength: 1 + type: string + fingerprint: + description: The SSH public key fingerprint for the console connection. + maxLength: 255 + minLength: 1 + type: string + id: + description: The OCID of the console connection. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the console connection. + enum: + - ACTIVE + - CREATING + - DELETED + - DELETING + - FAILED + type: string + required: + - id + - compartmentId + - dbNodeId + - connectionString + - fingerprint + - lifecycleState + x-example: | + { + "id": "ocid1.instanceconsoleconnection.oc1.iad.exampleunique_ID", + "compartmentId": "ocid1.compartment.oc1..exampleunique_ID", + "dbNodeId": "ocid1.dbnode.oc1.iad.exampleunique_ID", + "connectionString": "ssh -o ProxyCommand='ssh -W %h:%p -p 443 ocid1.ConsoleConnectionSummary.oc1.iad.exampleunique_ID@instance-console.us-ashburn-1.oraclecloud.com' ocid1.instance.oc1.iad.exampleunique_ID", + "fingerprint": "4a:46:c1:72:14:de:9f:a8:fe:89:a9:6c:6c:63:77:83", + "lifecycleState": "ACTIVE" + } + type: object + CreateConsoleConnectionDetails: + description: | + The details for creating a Db node console connection. + The Db node console connection is created in the same compartment as the dbNode. + properties: + publicKey: + description: The SSH public key used to authenticate the console connection. + format: ssh-authorized-key + maxLength: 900 + minLength: 1 + type: string + required: + - publicKey + type: object + ConsoleConnection: + description: | + The `InstanceConsoleConnection` API provides you with console access to dbnode + enabling you to troubleshoot malfunctioning dbnode. + properties: + compartmentId: + description: The OCID of the compartment to contain the console connection. + maxLength: 255 + minLength: 1 + type: string + connectionString: + description: The SSH connection string for the console connection. + type: string + dbNodeId: + description: The OCID of the database node. + maxLength: 255 + minLength: 1 + type: string + fingerprint: + description: The SSH public key fingerprint for the console connection. + maxLength: 255 + minLength: 1 + type: string + id: + description: The OCID of the console connection. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the console connection. + enum: + - ACTIVE + - CREATING + - DELETED + - DELETING + - FAILED + type: string + required: + - id + - compartmentId + - dbNodeId + - connectionString + - fingerprint + - lifecycleState + x-example: | + { + "id": "ocid1.instanceconsoleconnection.oc1.iad.exampleunique_ID", + "compartmentId": "ocid1.compartment.oc1..exampleunique_ID", + "dbNodeId": "ocid1.dbnode.oc1.iad.exampleunique_ID", + "connectionString": "ssh -o ProxyCommand='ssh -W %h:%p -p 443 ocid1.ConsoleConnectionSummary.oc1.iad.exampleunique_ID@instance-console.us-ashburn-1.oraclecloud.com' ocid1.instance.oc1.iad.exampleunique_ID", + "fingerprint": "4a:46:c1:72:14:de:9f:a8:fe:89:a9:6c:6c:63:77:83", + "lifecycleState": "ACTIVE" + } + type: object + ConsoleHistoryCollection: + description: Results of the Db Node console history lists. Contains ConsoleHistorySummary items. + properties: + items: + description: List of Db Node console histories. + items: + $ref: '#/components/schemas/ConsoleHistorySummary' + maxItems: 1024 + type: array + required: + - items + type: object + CreateConsoleHistoryDetails: + description: | + The details for creating a Db node console history. + The Db node console history is created in the same compartment as the dbNode. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: | + The user-friendly name for the console history. The name does not need to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + required: + - displayName + type: object + ConsoleHistory: + description: | + The details of the Db Node console history. + properties: + compartmentId: + description: The OCID of the compartment containing the console history. + maxLength: 255 + minLength: 1 + type: string + dbNodeId: + description: The OCID of the database node. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the console history. The name does not need to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the console history. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the console history. + enum: + - REQUESTED + - GETTING_HISTORY + - SUCCEEDED + - FAILED + - DELETED + - DELETING + type: string + timeCreated: + description: The date and time the console history was created. + format: date-time + type: string + required: + - id + - compartmentId + - dbNodeId + - lifecycleState + - timeCreated + x-example: | + { + "id": "ocid1.consolehistory.oc1.iad.exampleunique_ID", + "displayName" : "console-history-20221202-1943", + "compartmentId": "ocid1.compartment.oc1.iad.exampleunique_ID", + "dbNodeId": "ocid1.dbnode.oc1.iad.exampleunique_ID", + "lifecycleState": "REQUESTED", + "definedTags" : {}, + "freeformTags" : {}, + "timeCreated" : "2022-12-03T03:43:24.342Z" + } + type: object + UpdateConsoleHistoryDetails: + description: | + The details for updating a Db node console history. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: | + The user-friendly name for the console history. The name does not need to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + type: object + DbServerSummary: + description: | + Details of the Db server. + properties: + autonomousVirtualMachineIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Autonomous Virtual Machines associated with the Db server. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + autonomousVmClusterIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Autonomous VM Clusters associated with the Db server. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeModel: + description: | + The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. + enum: + - ECPU + - OCPU + type: string + x-default-description: Null used when unspecified. + cpuCoreCount: + description: The number of CPU cores enabled on the Db server. + minimum: 0 + type: integer + dbNodeIds: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Db nodes associated with the Db server. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + dbNodeStorageSizeInGBs: + description: The allocated local node storage in GBs on the Db server. + minimum: 0 + type: integer + dbServerPatchingDetails: + $ref: '#/components/schemas/DbServerPatchingDetails' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Db server. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + exadataInfrastructureId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Db server. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the Db server. + enum: + - CREATING + - AVAILABLE + - UNAVAILABLE + - DELETING + - DELETED + - MAINTENANCE_IN_PROGRESS + type: string + maxCpuCount: + description: The total number of CPU cores available. + type: integer + maxDbNodeStorageInGBs: + description: The total local node storage available in GBs. + type: integer + maxMemoryInGBs: + description: The total memory available in GBs. + type: integer + memorySizeInGBs: + description: The allocated memory in GBs on the Db server. + minimum: 0 + type: integer + shape: + description: | + The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time that the Db Server was created. + format: date-time + type: string + vmClusterIds: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the VM Clusters associated with the Db server. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + type: object + DbServer: + description: | + Details of the Db server resource. + properties: + autonomousVirtualMachineIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Autonomous Virtual Machines associated with the Db server. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + autonomousVmClusterIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Autonomous VM Clusters associated with the Db server. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeModel: + description: | + The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. + enum: + - ECPU + - OCPU + type: string + x-default-description: Null used when unspecified. + cpuCoreCount: + description: The number of CPU cores enabled on the Db server. + minimum: 0 + type: integer + dbNodeIds: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Db nodes associated with the Db server. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + dbNodeStorageSizeInGBs: + description: The allocated local node storage in GBs on the Db server. + minimum: 0 + type: integer + dbServerPatchingDetails: + $ref: '#/components/schemas/DbServerPatchingDetails' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Db server. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + exadataInfrastructureId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Db server. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the Db server. + enum: + - CREATING + - AVAILABLE + - UNAVAILABLE + - DELETING + - DELETED + - MAINTENANCE_IN_PROGRESS + type: string + maxCpuCount: + description: The total number of CPU cores available. + type: integer + maxDbNodeStorageInGBs: + description: The total local node storage available in GBs. + type: integer + maxMemoryInGBs: + description: The total memory available in GBs. + type: integer + memorySizeInGBs: + description: The allocated memory in GBs on the Db server. + minimum: 0 + type: integer + shape: + description: | + The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time that the Db Server was created. + format: date-time + type: string + vmClusterIds: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the VM Clusters associated with the Db server. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + type: object + DbSystemComputePerformanceSummary: + description: | + Representation of disk performance detail parameters. + properties: + computePerformanceList: + description: List of Compute performance details for the specified DB system shape. + items: + $ref: '#/components/schemas/ComputePerformanceSummary' + type: array + shape: + description: The shape of the DB system. + type: string + required: + - shape + - computePerformanceList + type: object + DbSystemShapeSummary: + description: | + The shape of the DB system. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. + + For Exadata fixed and flexible shapes, detailed specifications can be found in https://docs.oracle.com/en/engineered-systems/exadata-cloud-service/ecscm/exa-service-desc.html#GUID-9E090174-5C57-4EB1-9243-B470F9F10D6B + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. + If you're an administrator who needs to write policies to give users access, + see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + areServerTypesSupported: + description: If true, the shape supports configurable DB and Storage Server types. + type: boolean + availableCoreCount: + description: The maximum number of CPU cores that can be enabled on the DB system for this shape. + type: integer + availableCoreCountPerNode: + description: The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape, ExaCC Elastic shapes and VM Flex shapes. + format: int32 + type: integer + availableDataStorageInTBs: + description: The maximum DATA storage that can be enabled for this shape. + type: integer + availableDataStoragePerServerInTBs: + description: The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes. + format: double + type: number + availableDbNodePerNodeInGBs: + description: The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes. + type: integer + availableDbNodeStorageInGBs: + description: The maximum Db Node storage that can be enabled for this shape. + type: integer + availableMemoryInGBs: + description: The maximum memory that can be enabled for this shape. + type: integer + availableMemoryPerNodeInGBs: + description: The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes. + type: integer + computeModel: + description: | + The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. + enum: + - ECPU + - OCPU + type: string + x-default-description: Null used when unspecified. + coreCountIncrement: + description: The discrete number by which the CPU core count for this shape can be increased or decreased. + type: integer + displayName: + description: The display name of the shape used for the DB system. + maxLength: 255 + minLength: 1 + type: string + maxStorageCount: + description: The maximum number of Exadata storage servers available for the Exadata infrastructure. + type: integer + maximumNodeCount: + description: The maximum number of compute servers available for this shape. + type: integer + minCoreCountPerNode: + description: The minimum number of CPU cores that can be enabled per node for this shape. + type: integer + minDataStorageInTBs: + description: The minimum data storage that need be allocated for this shape. + type: integer + minDbNodeStoragePerNodeInGBs: + description: The minimum Db Node storage that need be allocated per node for this shape. + type: integer + minMemoryPerNodeInGBs: + description: The minimum memory that need be allocated per node for this shape. + type: integer + minStorageCount: + description: The minimum number of Exadata storage servers available for the Exadata infrastructure. + type: integer + minimumCoreCount: + description: The minimum number of CPU cores that can be enabled on the DB system for this shape. + type: integer + minimumNodeCount: + description: The minimum number of compute servers available for this shape. + type: integer + name: + description: The name of the shape used for the DB system. + maxLength: 255 + minLength: 1 + type: string + runtimeMinimumCoreCount: + description: The runtime minimum number of CPU cores that can be enabled on the DB system for this shape. + type: integer + shape: + description: Deprecated. Use `name` instead of `shape`. + maxLength: 255 + minLength: 1 + type: string + shapeAttributes: + description: | + The shapeAttributes of the DB system shape. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 20 + minItems: 0 + type: array + shapeFamily: + description: The family of the shape used for the DB system. + maxLength: 255 + minLength: 1 + type: string + shapeType: + description: The shape type for the virtual machine DB system. Shape type is determined by CPU hardware. Valid values are `AMD` , `INTEL`, `INTEL_FLEX_X9` or `AMPERE_FLEX_A1`. + enum: + - AMD + - INTEL + - INTEL_FLEX_X9 + - AMPERE_FLEX_A1 + maxLength: 255 + minLength: 1 + type: string + required: + - name + - availableCoreCount + type: object + FlexComponentCollection: + description: Results of a FlexComponent lists. Contains FlexComponentSummary items. + properties: + items: + items: + $ref: '#/components/schemas/FlexComponentSummary' + type: array + required: + - items + type: object + DbSystemStoragePerformanceSummary: + description: | + Representation of storage performance summary per shapeType . + properties: + dataStoragePerformanceList: + description: List of storage performance for the DATA disks + items: + $ref: '#/components/schemas/StoragePerformanceDetails' + type: array + recoStoragePerformanceList: + description: List of storage performance for the RECO disks + items: + $ref: '#/components/schemas/StoragePerformanceDetails' + type: array + shapeType: + description: ShapeType of the DbSystems INTEL , AMD, INTEL_FLEX_X9 or AMPERE_FLEX_A1 + enum: + - AMD + - INTEL + - INTEL_FLEX_X9 + - AMPERE_FLEX_A1 + type: string + required: + - shapeType + - dataStoragePerformanceList + - recoStoragePerformanceList + type: object + DbSystemSummary: + description: | + The Database Service supports several types of DB systems, ranging in size, price, and performance. For details about + each type of system, see [Bare Metal and Virtual Machine DB Systems](/Content/Database/Concepts/overview.htm). + + **Note:** Deprecated for Exadata Cloud Service instances using the new [resource model](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model). + To provision and manage new Exadata Cloud Service systems, use the + [CloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/) and [CloudVmCluster](#/en/database/latest/CloudVmCluster/). + See [Exadata Cloud Service](/Content/Database/Concepts/exaoverview.htm) for more information on Exadata systems. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model. + + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + For information about access control and compartments, see + [Overview of the Identity Service](/Content/Identity/Concepts/overview.htm). + + For information about availability domains, see + [Regions and Availability Domains](/Content/General/Concepts/regions.htm). + + To get a list of availability domains, use the `ListAvailabilityDomains` operation + in the Identity Service API. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + availabilityDomain: + description: The name of the availability domain that the DB system is located in. + maxLength: 255 + minLength: 1 + type: string + backupNetworkNsgIds: + description: | + A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + backupSubnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems. + + **Subnet Restriction:** See the subnet restrictions information for **subnetId**. + maxLength: 255 + minLength: 1 + type: string + clusterName: + description: | + The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeCount: + description: The number of compute servers for the DB system. + format: int32 + type: integer + computeModel: + description: The compute model for Base Database Service. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. The ECPU compute model is the recommended model, and the OCPU compute model is legacy. + enum: + - ECPU + - OCPU + type: string + cpuCoreCount: + description: The number of CPU cores enabled on the DB system. + type: integer + dataCollectionOptions: + $ref: '#/components/schemas/DataCollectionOptions' + dataStoragePercentage: + description: | + The percentage assigned to DATA storage (user data and database files). + The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. + type: integer + dataStorageSizeInGBs: + description: | + The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems. + type: integer + databaseEdition: + description: | + The Oracle Database Edition that applies to all the databases on the DB system. + Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. + enum: + - STANDARD_EDITION + - ENTERPRISE_EDITION + - ENTERPRISE_EDITION_HIGH_PERFORMANCE + - ENTERPRISE_EDITION_EXTREME_PERFORMANCE + - ENTERPRISE_EDITION_DEVELOPER + type: string + dbSystemOptions: + $ref: '#/components/schemas/DbSystemOptions' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + diskRedundancy: + description: | + The type of redundancy configured for the DB system. + NORMAL is 2-way redundancy. + HIGH is 3-way redundancy. + enum: + - HIGH + - NORMAL + type: string + displayName: + description: The user-friendly name for the DB system. The name does not have to be unique. + maxLength: 255 + minLength: 1 + type: string + domain: + description: The domain name for the DB system. + type: string + faultDomains: + description: List of the Fault Domains in which this DB system is provisioned. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + giSoftwareImageId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of a grid infrastructure software image. This is a database software image of the type `GRID_IMAGE`. + maxLength: 255 + type: string + hostname: + description: The hostname for the DB system. + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. + maxLength: 255 + minLength: 1 + type: string + kmsKeyId: + description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. + maxLength: 255 + minLength: 1 + type: string + lastMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run. + maxLength: 255 + minLength: 1 + type: string + lastPatchHistoryEntryId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last patch history. This value is updated as soon as a patch operation starts. + maxLength: 255 + minLength: 1 + type: string + licenseModel: + description: | + The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the DB system. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - MIGRATED + - MAINTENANCE_IN_PROGRESS + - NEEDS_ATTENTION + - UPGRADING + type: string + listenerPort: + description: The port number configured for the listener on the DB system. + type: integer + maintenanceWindow: + $ref: '#/components/schemas/MaintenanceWindow' + memorySizeInGBs: + description: Memory allocated to the DB system, in gigabytes. + maxLength: 1024 + minLength: 1 + type: integer + x-default-description: 'null' + nextMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run. + maxLength: 255 + minLength: 1 + type: string + nodeCount: + description: | + The number of nodes in the DB system. For RAC DB systems, the value is greater than 1. + minimum: 1 + type: integer + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + pointInTimeDataDiskCloneTimestamp: + description: The point in time for a cloned database system when the data disks were cloned from the source database system, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). + format: date-time + type: string + recoStorageSizeInGB: + description: | + The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems. + type: integer + scanDnsName: + description: | + The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system. + maxLength: 72 + minLength: 1 + type: string + scanDnsRecordId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the DNS record for the SCAN IP addresses that are associated with the DB system. + maxLength: 255 + minLength: 1 + type: string + scanIpIds: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Single Client Access Name (SCAN) IPv4 addresses associated with the DB system. + SCAN IPv4 addresses are typically used for load balancing and are not assigned to any interface. + Oracle Clusterware directs the requests to the appropriate nodes in the cluster. + + **Note:** For a single-node DB system, this list is empty. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + scanIpv6Ids: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Single Client Access Name (SCAN) IPv6 addresses associated with the DB system. + SCAN IPv6 addresses are typically used for load balancing and are not assigned to any interface. + Oracle Clusterware directs the requests to the appropriate nodes in the cluster. + + **Note:** For a single-node DB system, this list is empty. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) + (opaque JSON object) + type: string + description: | + Key-value pair representing a ZPR tag key and value, scoped to a namespace. + Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` + type: object + description: | + Security Attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` + type: object + shape: + description: | + The shape of the DB system. The shape determines resources to allocate to the DB system. + - For virtual machine shapes, the number of CPU cores and memory + - For bare metal and Exadata shapes, the number of CPU cores, storage, and memory + maxLength: 255 + minLength: 1 + type: string + sourceDbSystemId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. + maxLength: 255 + minLength: 1 + type: string + sparseDiskgroup: + description: | + True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured. + type: boolean + sshPublicKeys: + description: The public key portion of one or more key pairs used for SSH access to the DB system. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + storageVolumePerformanceMode: + default: BALANCED + description: | + The block storage volume performance level. Valid values are `BALANCED` and `HIGH_PERFORMANCE`. See [Block Volume Performance](/Content/Block/Concepts/blockvolumeperformance.htm) for more information. + enum: + - BALANCED + - HIGH_PERFORMANCE + type: string + subnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the DB system is associated with. + + **Subnet Restrictions:** + - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. + - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20. + + These subnets are used by the Oracle Clusterware private interconnect on the database instance. + Specifying an overlapping subnet will cause the private interconnect to malfunction. + This restriction applies to both the client subnet and backup subnet. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the DB system was created. + format: date-time + type: string + timeZone: + description: The time zone of the DB system. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm). + maxLength: 255 + minLength: 1 + type: string + version: + description: The Oracle Database version of the DB system. + type: string + vipIds: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual IPv4 (VIP) addresses associated with the DB system. + The Cluster Ready Services (CRS) creates and maintains one VIPv4 address for each node in the DB system to + enable failover. If one node fails, the VIPv4 is reassigned to another active node in the cluster. + + **Note:** For a single-node DB system, this list is empty. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + vipv6Ids: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual IPv6 (VIP) addresses associated with the DB system. + The Cluster Ready Services (CRS) creates and maintains one VIP IpV6 address for each node in the DB system to + enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. + + **Note:** For a single-node DB system, this list is empty. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + zoneId: + description: | + The OCID of the zone the DB system is associated with. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - lifecycleState + - displayName + - availabilityDomain + - subnetId + - shape + - sshPublicKeys + - cpuCoreCount + - databaseEdition + - hostname + - domain + type: object + LaunchDbSystemBase: + description: | + Parameters for provisioning a bare metal, virtual machine, or Exadata DB system. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + discriminator: + propertyName: source + properties: + availabilityDomain: + description: The availability domain where the DB system is located. + maxLength: 255 + minLength: 1 + type: string + backupNetworkNsgIds: + description: | + A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + backupSubnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems. + + **Subnet Restrictions:** See the subnet restrictions information for **subnetId**. + maxLength: 255 + minLength: 1 + type: string + clusterName: + description: | + The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. + maxLength: 11 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment the DB system belongs in. + maxLength: 255 + minLength: 1 + type: string + computeCount: + description: The number of compute servers for the DB system. + format: int32 + type: integer + computeModel: + description: The compute model for Base Database Service. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. The ECPU compute model is the recommended model, and the OCPU compute model is legacy. + enum: + - ECPU + - OCPU + type: string + cpuCoreCount: + description: | + The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape: + + - BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36. + - BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52. + - Exadata.Base.48 - Specify a multiple of 2, from 0 to 48. + - Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84. + - Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168. + - Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336. + - Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92. + - Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184. + - Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368. + - VM.Standard.E4.Flex - Specify any thing from 1 to 64. + + This parameter is not used for INTEL virtual machine DB systems because virtual machine DB systems have a set number of cores for each shape. + For information about the number of cores for a virtual machine DB system shape, see [Virtual Machine DB Systems](/Content/Database/Concepts/overview.htm#virtualmachine) + minimum: 1 + type: integer + dataCollectionOptions: + $ref: '#/components/schemas/DataCollectionOptions' + dataStoragePercentage: + description: | + The percentage assigned to DATA storage (user data and database files). + The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). + Specify 80 or 40. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. + type: integer + dbSystemOptions: + $ref: '#/components/schemas/DbSystemOptions' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the DB system. The name does not have to be unique. + maxLength: 255 + minLength: 1 + type: string + domain: + description: | + A domain name used for the DB system. If the Oracle-provided Internet and VCN + Resolver is enabled for the specified subnet, the domain name for the subnet is used + (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. + type: string + faultDomains: + description: | + A Fault Domain is a grouping of hardware and infrastructure within an availability domain. + Fault Domains let you distribute your instances so that they are not on the same physical + hardware within a single availability domain. A hardware failure or maintenance + that affects one Fault Domain does not affect DB systems in other Fault Domains. + + If you do not specify the Fault Domain, the system selects one for you. To change the Fault + Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain. + + If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. + The system assigns your nodes automatically to the Fault Domains you specify so that + no Fault Domain contains more than one node. + + To get a list of Fault Domains, use the + [ListFaultDomains](#/en/identity/latest/FaultDomain/ListFaultDomains) operation in the + Identity and Access Management Service API. + + Example: `FAULT-DOMAIN-1` + items: + maxLength: 255 + minLength: 1 + type: string + type: array + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + hostname: + description: | + The hostname for the DB system. The hostname must begin with an alphabetic character, and + can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata DB systems. + + The maximum length of the combined hostname and domain is 63 characters. + + **Note:** The hostname must be unique within the subnet. If it is not unique, + the DB system will fail to provision. + type: string + initialDataStorageSizeInGB: + description: | + Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume. By default this will be set to 256. + minimum: 2 + type: integer + kmsKeyId: + description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. + maxLength: 255 + minLength: 1 + type: string + kmsKeyVersionId: + description: | + The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. + maxLength: 255 + minLength: 1 + type: string + nodeCount: + description: | + The number of nodes to launch for a virtual machine DB system. Specify either 1 or 2. By default this will be set to 1. + minimum: 1 + type: integer + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + privateIp: + description: | + A private IP address of your choice. Must be an available IP address within the subnet's CIDR. + If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. + maxLength: 46 + minLength: 1 + type: string + privateIpV6: + description: | + A private IPv6 address of your choice. Must be an available IP address within the subnet's CIDR. + If you don't specify a value and the subnet is dual stack, Oracle automatically assigns a private IPv6 address from the subnet. + maxLength: 46 + minLength: 1 + type: string + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) + (opaque JSON object) + type: string + description: | + Key-value pair representing a ZPR tag key and value, scoped to a namespace. + Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` + type: object + description: | + Security Attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` + type: object + shape: + description: | + The shape of the DB system. The shape determines resources allocated to the DB system. + - For virtual machine shapes, the number of CPU cores and memory + - For bare metal and Exadata shapes, the number of CPU cores, memory, and storage + + To get a list of shapes, use the [ListDbSystemShapes](#/en/database/latest/DbSystemShapeSummary/ListDbSystemShapes) operation. + maxLength: 255 + minLength: 1 + type: string + source: + default: NONE + description: | + The source of the database: + Use `NONE` for creating a new database. Use `DB_BACKUP` for creating a new database by restoring from a backup. Use `DATABASE` for creating + a new database from an existing database, including archive redo log data. The default is `NONE`. + enum: + - NONE + - DB_BACKUP + - DATABASE + - DB_SYSTEM + - DATAGUARD + type: string + sparseDiskgroup: + description: | + If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. + type: boolean + sshPublicKeys: + description: The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + storageVolumePerformanceMode: + default: BALANCED + description: | + The block storage volume performance level. Valid values are `BALANCED` and `HIGH_PERFORMANCE`. See [Block Volume Performance](/Content/Block/Concepts/blockvolumeperformance.htm) for more information. + enum: + - BALANCED + - HIGH_PERFORMANCE + type: string + subnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the DB system is associated with. + + **Subnet Restrictions:** + - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. + - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20. + + These subnets are used by the Oracle Clusterware private interconnect on the database instance. + Specifying an overlapping subnet will cause the private interconnect to malfunction. + This restriction applies to both the client subnet and the backup subnet. + maxLength: 255 + minLength: 1 + type: string + timeZone: + description: The time zone to use for the DB system. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm). + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - availabilityDomain + - subnetId + - shape + - sshPublicKeys + - hostname + type: object + DbSystem: + description: | + The Database Service supports several types of DB systems, ranging in size, price, and performance. For details about + each type of system, see [Bare Metal and Virtual Machine DB Systems](/Content/Database/Concepts/overview.htm). + + **Note:** Deprecated for Exadata Cloud Service instances using the new [resource model](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model). + To provision and manage new Exadata Cloud Service systems, use the + [CloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/) and [CloudVmCluster](#/en/database/latest/CloudVmCluster/). + See [Exadata Cloud Service](/Content/Database/Concepts/exaoverview.htm) for more information on Exadata systems. + + For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model. + + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + For information about access control and compartments, see + [Overview of the Identity Service](/Content/Identity/Concepts/overview.htm). + + For information about availability domains, see + [Regions and Availability Domains](/Content/General/Concepts/regions.htm). + + To get a list of availability domains, use the `ListAvailabilityDomains` operation + in the Identity Service API. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + availabilityDomain: + description: The name of the availability domain that the DB system is located in. + maxLength: 255 + minLength: 1 + type: string + backupNetworkNsgIds: + description: | + A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + backupSubnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems. + + **Subnet Restriction:** See the subnet restrictions information for **subnetId**. + maxLength: 255 + minLength: 1 + type: string + clusterName: + description: | + The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeCount: + description: The number of compute servers for the DB system. + format: int32 + type: integer + computeModel: + description: The compute model for Base Database Service. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. The ECPU compute model is the recommended model, and the OCPU compute model is legacy. + enum: + - ECPU + - OCPU + type: string + cpuCoreCount: + description: The number of CPU cores enabled on the DB system. + type: integer + dataCollectionOptions: + $ref: '#/components/schemas/DataCollectionOptions' + dataStoragePercentage: + description: | + The percentage assigned to DATA storage (user data and database files). + The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. + type: integer + dataStorageSizeInGBs: + description: | + The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems. + type: integer + databaseEdition: + description: | + The Oracle Database Edition that applies to all the databases on the DB system. + Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. + enum: + - STANDARD_EDITION + - ENTERPRISE_EDITION + - ENTERPRISE_EDITION_HIGH_PERFORMANCE + - ENTERPRISE_EDITION_EXTREME_PERFORMANCE + - ENTERPRISE_EDITION_DEVELOPER + type: string + dbSystemOptions: + $ref: '#/components/schemas/DbSystemOptions' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + diskRedundancy: + description: | + The type of redundancy configured for the DB system. + NORMAL is 2-way redundancy. + HIGH is 3-way redundancy. + enum: + - HIGH + - NORMAL + type: string + displayName: + description: The user-friendly name for the DB system. The name does not have to be unique. + maxLength: 255 + minLength: 1 + type: string + domain: + description: The domain name for the DB system. + type: string + faultDomains: + description: List of the Fault Domains in which this DB system is provisioned. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + giSoftwareImageId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of a grid infrastructure software image. This is a database software image of the type `GRID_IMAGE`. + maxLength: 255 + type: string + hostname: + description: The hostname for the DB system. + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. + maxLength: 255 + minLength: 1 + type: string + kmsKeyId: + description: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. + maxLength: 255 + minLength: 1 + type: string + lastMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run. + maxLength: 255 + minLength: 1 + type: string + lastPatchHistoryEntryId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last patch history. This value is updated as soon as a patch operation starts. + maxLength: 255 + minLength: 1 + type: string + licenseModel: + description: | + The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the DB system. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - MIGRATED + - MAINTENANCE_IN_PROGRESS + - NEEDS_ATTENTION + - UPGRADING + type: string + listenerPort: + description: The port number configured for the listener on the DB system. + type: integer + maintenanceWindow: + $ref: '#/components/schemas/MaintenanceWindow' + memorySizeInGBs: + description: Memory allocated to the DB system, in gigabytes. + maxLength: 1024 + minLength: 1 + type: integer + x-default-description: 'null' + nextMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run. + maxLength: 255 + minLength: 1 + type: string + nodeCount: + description: | + The number of nodes in the DB system. For RAC DB systems, the value is greater than 1. + minimum: 1 + type: integer + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + pointInTimeDataDiskCloneTimestamp: + description: The point in time for a cloned database system when the data disks were cloned from the source database system, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). + format: date-time + type: string + recoStorageSizeInGB: + description: | + The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems. + type: integer + scanDnsName: + description: | + The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system. + maxLength: 72 + minLength: 1 + type: string + scanDnsRecordId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the DNS record for the SCAN IP addresses that are associated with the DB system. + maxLength: 255 + minLength: 1 + type: string + scanIpIds: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Single Client Access Name (SCAN) IPv4 addresses associated with the DB system. + SCAN IPv4 addresses are typically used for load balancing and are not assigned to any interface. + Oracle Clusterware directs the requests to the appropriate nodes in the cluster. + + **Note:** For a single-node DB system, this list is empty. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + scanIpv6Ids: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Single Client Access Name (SCAN) IPv6 addresses associated with the DB system. + SCAN IPv6 addresses are typically used for load balancing and are not assigned to any interface. + Oracle Clusterware directs the requests to the appropriate nodes in the cluster. + + **Note:** For a single-node DB system, this list is empty. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) + (opaque JSON object) + type: string + description: | + Key-value pair representing a ZPR tag key and value, scoped to a namespace. + Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` + type: object + description: | + Security Attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` + type: object + shape: + description: | + The shape of the DB system. The shape determines resources to allocate to the DB system. + - For virtual machine shapes, the number of CPU cores and memory + - For bare metal and Exadata shapes, the number of CPU cores, storage, and memory + maxLength: 255 + minLength: 1 + type: string + sourceDbSystemId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. + maxLength: 255 + minLength: 1 + type: string + sparseDiskgroup: + description: | + True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured. + type: boolean + sshPublicKeys: + description: The public key portion of one or more key pairs used for SSH access to the DB system. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + storageVolumePerformanceMode: + default: BALANCED + description: | + The block storage volume performance level. Valid values are `BALANCED` and `HIGH_PERFORMANCE`. See [Block Volume Performance](/Content/Block/Concepts/blockvolumeperformance.htm) for more information. + enum: + - BALANCED + - HIGH_PERFORMANCE + type: string + subnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the DB system is associated with. + + **Subnet Restrictions:** + - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. + - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20. + + These subnets are used by the Oracle Clusterware private interconnect on the database instance. + Specifying an overlapping subnet will cause the private interconnect to malfunction. + This restriction applies to both the client subnet and backup subnet. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the DB system was created. + format: date-time + type: string + timeZone: + description: The time zone of the DB system. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm). + maxLength: 255 + minLength: 1 + type: string + version: + description: The Oracle Database version of the DB system. + type: string + vipIds: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual IPv4 (VIP) addresses associated with the DB system. + The Cluster Ready Services (CRS) creates and maintains one VIPv4 address for each node in the DB system to + enable failover. If one node fails, the VIPv4 is reassigned to another active node in the cluster. + + **Note:** For a single-node DB system, this list is empty. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + vipv6Ids: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual IPv6 (VIP) addresses associated with the DB system. + The Cluster Ready Services (CRS) creates and maintains one VIP IpV6 address for each node in the DB system to + enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. + + **Note:** For a single-node DB system, this list is empty. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + zoneId: + description: | + The OCID of the zone the DB system is associated with. + maxLength: 255 + minLength: 1 + type: string + iormConfigCache: + $ref: '#/components/schemas/ExadataIormConfig' + required: + - id + - compartmentId + - lifecycleState + - displayName + - availabilityDomain + - subnetId + - shape + - sshPublicKeys + - cpuCoreCount + - databaseEdition + - hostname + - domain + type: object + UpdateDbSystemDetails: + description: | + Describes the parameters for updating the DB system. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + backupNetworkNsgIds: + description: | + A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + computeCount: + description: The number of compute servers for the DB system. + format: int32 + type: integer + computeModel: + description: The compute model for Base Database Service. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. The ECPU compute model is the recommended model, and the OCPU compute model is legacy. + enum: + - ECPU + - OCPU + type: string + cpuCoreCount: + description: The new number of CPU cores to set for the DB system. Not applicable for INTEL based virtual machine DB systems. + minimum: 1 + type: integer + dataCollectionOptions: + $ref: '#/components/schemas/DataCollectionOptions' + dataStorageSizeInGBs: + description: | + The size, in gigabytes, to scale the attached storage up to for this virtual machine DB system. This value must be greater than current storage size. Note that the resulting total storage size attached will be greater than the amount requested to allow for REDO/RECO space and software volume. Applies only to virtual machine DB systems. + type: integer + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + licenseModel: + description: | + The Oracle Database license model that applies to all databases on the DB system. The default is LICENSE_INCLUDED. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + maintenanceWindowDetails: + $ref: '#/components/schemas/MaintenanceWindow' + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) + (opaque JSON object) + type: string + description: | + Key-value pair representing a ZPR tag key and value, scoped to a namespace. + Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` + type: object + description: | + Security Attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` + type: object + shape: + description: | + The shape of the DB system. The shape determines resources allocated to the DB system. + - For virtual machine shapes, the number of CPU cores and memory + + To get a list of shapes, use the [ListDbSystemShapes](#/en/database/latest/DbSystemShapeSummary/ListDbSystemShapes) operation. + maxLength: 255 + minLength: 1 + type: string + sshPublicKeys: + description: The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + version: + $ref: '#/components/schemas/PatchDetails' + type: object + ExadataDbSystemMigration: + description: | + Information about the Exadata DB system migration. The migration is used to move the Exadata Cloud Service instance from the DB system resource model to the new cloud Exadata infrastructure resource model. + properties: + additionalMigrations: + description: The details of addtional resources related to the migration. + items: + $ref: '#/components/schemas/ExadataDbSystemMigrationSummary' + type: array + cloudExadataInfrastructureId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + cloudVmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud VM cluster. + maxLength: 255 + minLength: 1 + type: string + dbSystemId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. + maxLength: 255 + minLength: 1 + type: string + required: + - dbSystemId + - cloudVmClusterId + - cloudExadataInfrastructureId + type: object + ExecuteDbSystemOsPatchDetails: + description: | + Request details for submitting an operating system (OS) patch action on a DB system. + Use PRECHECK to validate prerequisites and surface the expected changes without applying them. Use APPLY to install the selected updates. Some updates may require a reboot to take effect. + properties: + action: + description: | + Operation system (OS) patch action to perform + * PRECHECK: No changes applied; runs validation/dry run. + * APPLY: Installs updates; may require a reboot (see OS patch history entry details to determine isRebootRequired). + enum: + - PRECHECK + - APPLY + type: string + dbNodeId: + description: The OCID of the DB node to target for this patch action. If omitted, the action applies to all nodes in the DB system. + maxLength: 255 + minLength: 1 + type: string + required: + - action + type: object + UpgradeDbSystemDetails: + description: | + Details for upgrading the operating system and Oracle Grid Infrastructure (GI) of a DB system. + properties: + action: + description: The operating system upgrade action. + enum: + - PRECHECK + - ROLLBACK + - UPDATE_SNAPSHOT_RETENTION_DAYS + - UPGRADE + type: string + isSnapshotRetentionDaysForceUpdated: + description: If true, rollback time is updated even if operating system upgrade history contains errors. + type: boolean + newGiVersion: + description: A valid Oracle Grid Infrastructure (GI) software version. + maxLength: 255 + minLength: 1 + type: string + newOsVersion: + description: A valid Oracle Software (OS) version eg. Oracle Linux Server release 8 + maxLength: 255 + minLength: 1 + type: string + snapshotRetentionPeriodInDays: + default: 0 + description: The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade. + maximum: 31 + minimum: 0 + type: integer + required: + - action + type: object + DbSystemUpgradeSummary: + description: | + It describes the various upgrade properties such as component, osversion, giversion for any VM DB system. + properties: + component: + description: The component on which upgrade is applicable. OS (Operating System upgrade), GI (Grid Infrastructure upgrade) or OS_GI (both Operating System and Grid Infrastructure upgrade) + enum: + - OS + - OS_GI + - GI + type: string + giVersion: + description: The version of the grid infrastructure for this upgrade. This is only applicable for ASM based DbSystems + type: string + osVersion: + description: The version of the OS for this upgrade eg. Oracle Linux Server release 7.9 + type: string + required: + - component + type: object + DbSystemOsPatchHistoryEntryCollection: + description: Results of OS patch history of a DB System. + properties: + items: + description: Array of OS patch history entry summaries. + items: + $ref: '#/components/schemas/DbSystemOsPatchHistoryEntrySummary' + type: array + required: + - items + type: object + DbSystemOsPatchHistoryEntry: + description: | + The record of an OS patch action on a DB system. + properties: + action: + description: The action being performed or was completed. + enum: + - PRECHECK + - APPLY + type: string + dbSystemId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the OS patch history entry. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: | + A descriptive text associated with the lifecycleState. + Typically contains additional displayable text. + type: string + lifecycleState: + description: The current state of the action. + enum: + - IN_PROGRESS + - SUCCEEDED + - FAILED + type: string + osPatchDetails: + $ref: '#/components/schemas/DbSystemOsPatchDetailsCollection' + timeEnded: + description: The date and time when the patch action completed + format: date-time + type: string + timeStarted: + description: The date and time when the patch action started. + format: date-time + type: string + required: + - action + - dbSystemId + - id + - osPatchDetails + - lifecycleState + - timeStarted + type: object + DbSystemUpgradeHistoryEntrySummary: + description: | + The summary for the record of an OS upgrade action on a DB system. + properties: + action: + description: The operating system upgrade action. + enum: + - PRECHECK + - ROLLBACK + - UPDATE_SNAPSHOT_RETENTION_DAYS + - UPGRADE + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the upgrade history entry. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: | + A descriptive text associated with the lifecycleState. + Typically contains additional displayable text. + type: string + lifecycleState: + description: The current state of the action. + enum: + - IN_PROGRESS + - SUCCEEDED + - FAILED + - NEEDS_ATTENTION + type: string + newGiVersion: + description: A valid Oracle Grid Infrastructure (GI) software version. + maxLength: 255 + minLength: 1 + type: string + newOsVersion: + description: A valid Oracle Software (OS) version eg. Oracle Linux Server release 8 + maxLength: 255 + minLength: 1 + type: string + oldGiVersion: + description: A valid Oracle Grid Infrastructure (GI) software version. + maxLength: 255 + minLength: 1 + type: string + oldOsVersion: + description: A valid Oracle Software (OS) version eg. Oracle Linux Server release 8 + maxLength: 255 + minLength: 1 + type: string + snapshotRetentionPeriodInDays: + default: 0 + description: The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade. + maximum: 31 + minimum: 0 + type: integer + timeEnded: + description: The date and time when the upgrade action completed + format: date-time + type: string + timeStarted: + description: The date and time when the upgrade action started. + format: date-time + type: string + required: + - id + - action + - lifecycleState + - snapshotRetentionPeriodInDays + - timeStarted + type: object + DbSystemUpgradeHistoryEntry: + description: | + The record of an OS upgrade action on a DB system. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + action: + description: The operating system upgrade action. + enum: + - PRECHECK + - ROLLBACK + - UPDATE_SNAPSHOT_RETENTION_DAYS + - UPGRADE + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the upgrade history entry. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: | + A descriptive text associated with the lifecycleState. + Typically contains additional displayable text. + type: string + lifecycleState: + description: The current state of the action. + enum: + - IN_PROGRESS + - SUCCEEDED + - FAILED + - NEEDS_ATTENTION + type: string + newGiVersion: + description: A valid Oracle Grid Infrastructure (GI) software version. + maxLength: 255 + minLength: 1 + type: string + newOsVersion: + description: A valid Oracle Software (OS) version eg. Oracle Linux Server release 8 + maxLength: 255 + minLength: 1 + type: string + oldGiVersion: + description: A valid Oracle Grid Infrastructure (GI) software version. + maxLength: 255 + minLength: 1 + type: string + oldOsVersion: + description: A valid Oracle Software (OS) version eg. Oracle Linux Server release 8 + maxLength: 255 + minLength: 1 + type: string + snapshotRetentionPeriodInDays: + default: 0 + description: The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade. + maximum: 31 + minimum: 0 + type: integer + timeEnded: + description: The date and time when the upgrade action completed + format: date-time + type: string + timeStarted: + description: The date and time when the upgrade action started. + format: date-time + type: string + required: + - id + - action + - lifecycleState + - snapshotRetentionPeriodInDays + - timeStarted + type: object + DbVersionSummary: + description: | + The Oracle Database software version. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + isLatestForMajorVersion: + description: True if this version of the Oracle Database software is the latest version for a release. + type: boolean + isPreviewDbVersion: + description: True if this version of the Oracle Database software is the preview version. + type: boolean + isUpgradeSupported: + description: True if this version of the Oracle Database software is supported for Upgrade. + type: boolean + supportsPdb: + description: True if this version of the Oracle Database software supports pluggable databases. + type: boolean + version: + description: A valid Oracle Database version. + maxLength: 255 + minLength: 1 + type: string + required: + - version + type: object + DbnodeSnapshotSummary: + description: | + Details of the Exadata Database Node Snapshot. + properties: + clusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Node Snapshot. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state of the Exadata Database Node Snapshot. + type: string + lifecycleState: + description: The current state of the Exadata Database Storage Vault. + type: string + x-obmcs-enumref: '#/definitions/DbnodeSnapshot/lifecycleState' + mountPoints: + description: Details of the mount points + items: + $ref: '#/components/schemas/MountPointDetails' + maxItems: 10 + type: array + name: + description: The user-friendly name for the Database Node Snapshot. The name should be unique. + maxLength: 255 + minLength: 1 + type: string + sourceDbnodeId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Node. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time that the Exadata Database Node Snapshot was created. + format: date-time + type: string + volumes: + description: Details of the volumes + items: + $ref: '#/components/schemas/VolumeDetails' + maxItems: 10 + type: array + required: + - id + - name + - sourceDbnodeId + type: object + DbnodeSnapshot: + description: | + Details of the Database Node Snapshot. + properties: + clusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Node Snapshot. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state of the Exadata Database Node Snapshot. + type: string + lifecycleState: + description: The current state of the Exadata Database Node Snapshot. + enum: + - CREATING + - AVAILABLE + - TERMINATING + - TERMINATED + - FAILED + - MOUNTED + - MOUNTING + - UNMOUNTING + type: string + mountPoints: + description: Details of the mount points + items: + $ref: '#/components/schemas/MountPointDetails' + maxItems: 10 + type: array + name: + description: The user-friendly name for the Database Node Snapshot. The name should be unique. + maxLength: 255 + minLength: 1 + type: string + sourceDbnodeId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Node. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time that the Exadata Database Node Snapshot was created. + format: date-time + type: string + volumes: + description: Details of the volumes + items: + $ref: '#/components/schemas/VolumeDetails' + maxItems: 10 + type: array + required: + - id + - name + - sourceDbnodeId + type: object + MountDbnodeSnapshotDetails: + description: | + Details of the Exadata Database Node Snapshot to be mounted. + properties: + dbNodeId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Node where snapshot needs to be mounted. + maxLength: 255 + minLength: 1 + type: string + required: + - dbNodeId + type: object + UnmountDbnodeSnapshotDetails: + description: | + Details of the Exadata Database Node Snapshot to be unmounted. + properties: + dbNodeId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Node where snapshot needs to be unmounted. + maxLength: 255 + minLength: 1 + type: string + required: + - dbNodeId + type: object + ExadataInfrastructureSummary: + description: | + Details of the Exadata Cloud@Customer infrastructure. Applies to Exadata Cloud@Customer instances only. + See [CloudExadataInfrastructureSummary Reference](#/en/database/latest/datatypes/CloudExadataInfrastructureSummary) for details of the cloud Exadata infrastructure resource used by Exadata Cloud Service instances. + properties: + activatedStorageCount: + description: The requested number of additional storage servers activated for the Exadata infrastructure. + type: integer + additionalComputeCount: + description: The requested number of additional compute servers for the Exadata infrastructure. + type: integer + additionalComputeSystemModel: + description: | + Oracle Exadata System Model specification. The system model determines the amount of compute or storage + server resources available for use. For more information, please see [System and Shape Configuration Options] + (https://docs.oracle.com/en/engineered-systems/exadata-cloud-at-customer/ecccm/ecc-system-config-options.html#GUID-9E090174-5C57-4EB1-9243-B470F9F10D6B) + enum: + - X7 + - X8 + - X8M + - X9M + - X11M + type: string + additionalStorageCount: + description: The requested number of additional storage servers for the Exadata infrastructure. + type: integer + adminNetworkCIDR: + description: The CIDR block for the Exadata administration network. + maxLength: 255 + minLength: 1 + type: string + availabilityDomain: + description: The name of the availability domain that the Exadata infrastructure is located in. + maxLength: 255 + minLength: 1 + type: string + cloudControlPlaneServer1: + description: The IP address for the first control plane server. + maxLength: 255 + minLength: 1 + type: string + cloudControlPlaneServer2: + description: The IP address for the second control plane server. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeCount: + description: The number of compute servers for the Exadata infrastructure. + type: integer + computeModel: + description: | + The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. + enum: + - ECPU + - OCPU + type: string + x-default-description: Null used when unspecified. + contacts: + description: The list of contacts for the Exadata infrastructure. + items: + $ref: '#/components/schemas/ExadataInfrastructureContact' + maxItems: 10 + minItems: 1 + type: array + corporateProxy: + description: The corporate network proxy for access to the control plane network. + maxLength: 255 + minLength: 1 + type: string + cpusEnabled: + description: The number of enabled CPU cores. + type: integer + csiNumber: + description: The CSI Number of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + dataStorageSizeInTBs: + description: | + Size, in terabytes, of the DATA disk group. + format: double + type: number + databaseServerType: + description: The database server type of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + dbNodeStorageSizeInGBs: + description: The local node storage allocated in GBs. + type: integer + dbServerVersion: + description: The software version of the database servers (dom0) in the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + definedFileSystemConfigurations: + description: Details of the file system configuration of the Exadata infrastructure. + items: + $ref: '#/components/schemas/DefinedFileSystemConfiguration' + maxItems: 1024 + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Exadata Cloud@Customer infrastructure. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + dnsServer: + description: The list of DNS server IP addresses. Maximum of 3 allowed. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + gateway: + description: The gateway for the control plane network. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + infiniBandNetworkCIDR: + description: The CIDR block for the Exadata InfiniBand interconnect. + maxLength: 255 + minLength: 1 + type: string + isMultiRackDeployment: + description: Indicates if deployment is Multi-Rack or not. + type: boolean + isSchedulingPolicyAssociated: + description: If true, the infrastructure is using granular maintenance scheduling preference. + type: boolean + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current lifecycle state of the Exadata infrastructure. + enum: + - CREATING + - REQUIRES_ACTIVATION + - ACTIVATING + - ACTIVE + - ACTIVATION_FAILED + - FAILED + - UPDATING + - DELETING + - DELETED + - DISCONNECTED + - MAINTENANCE_IN_PROGRESS + - WAITING_FOR_CONNECTIVITY + type: string + maintenanceSLOStatus: + description: A field to capture ‘Maintenance SLO Status’ for the Exadata infrastructure with values ‘OK’, ‘DEGRADED’. Default is ‘OK’ when the infrastructure is provisioned. + enum: + - OK + - DEGRADED + type: string + maintenanceVersionPreferences: + $ref: '#/components/schemas/MaintenanceVersionPreferenceDetails' + maintenanceWindow: + $ref: '#/components/schemas/MaintenanceWindow' + maxCpuCount: + description: The total number of CPU cores available. + type: integer + maxDataStorageInTBs: + description: The total available DATA disk group size. + format: double + type: number + maxDbNodeStorageInGBs: + description: The total local node storage available in GBs. + type: integer + maxMemoryInGBs: + description: The total memory available in GBs. + type: integer + memorySizeInGBs: + description: The memory allocated in GBs. + type: integer + monthlyDbServerVersion: + description: The monthly software version of the database servers (dom0) in the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + multiRackConfigurationFile: + description: The base64 encoded Multi-Rack configuration json file. + format: byte + type: string + netmask: + description: The netmask for the control plane network. + maxLength: 255 + minLength: 1 + type: string + networkBondingModeDetails: + $ref: '#/components/schemas/NetworkBondingModeDetails' + ntpServer: + description: The list of NTP server IP addresses. Maximum of 3 allowed. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + rackSerialNumber: + description: The serial number for the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + shape: + description: | + The shape of the Exadata infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance. + maxLength: 255 + minLength: 1 + type: string + storageCount: + description: The number of Exadata storage servers for the Exadata infrastructure. + type: integer + storageServerType: + description: The storage server type of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + storageServerVersion: + description: The software version of the storage servers (cells) in the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the Exadata infrastructure was created. + format: date-time + type: string + timeZone: + description: The time zone of the Exadata infrastructure. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). + format: x-obmcs-time-zone + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - lifecycleState + - displayName + - shape + type: object + CreateExadataInfrastructureDetails: + description: | + Request to create Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only. + See [CreateCloudExadataInfrastructureDetails Reference](#/en/database/latest/datatypes/CreateCloudExadataInfrastructureDetails) for information on creating a cloud Exadata infrastructure resource in an Exadata Cloud Service instance. + properties: + adminNetworkCIDR: + description: The CIDR block for the Exadata administration network. + maxLength: 255 + minLength: 1 + type: string + cloudControlPlaneServer1: + description: The IP address for the first control plane server. + maxLength: 255 + minLength: 1 + type: string + cloudControlPlaneServer2: + description: The IP address for the second control plane server. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeCount: + description: The number of compute servers for the Exadata infrastructure. + type: integer + contacts: + description: The list of contacts for the Exadata infrastructure. + items: + $ref: '#/components/schemas/ExadataInfrastructureContact' + maxItems: 10 + minItems: 1 + type: array + corporateProxy: + description: | + The corporate network proxy for access to the control plane network. Oracle recommends using an HTTPS proxy when possible + for enhanced security. + maxLength: 255 + minLength: 1 + type: string + databaseServerType: + description: The database server type of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: | + The user-friendly name for the Exadata infrastructure. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + dnsServer: + description: The list of DNS server IP addresses. Maximum of 3 allowed. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + gateway: + description: The gateway for the control plane network. + maxLength: 255 + minLength: 1 + type: string + infiniBandNetworkCIDR: + description: The CIDR block for the Exadata InfiniBand interconnect. + maxLength: 255 + minLength: 1 + type: string + isMultiRackDeployment: + description: Indicates if deployment is Multi-Rack or not. + type: boolean + maintenanceVersionPreferences: + $ref: '#/components/schemas/MaintenanceVersionPreferenceDetails' + maintenanceWindow: + $ref: '#/components/schemas/MaintenanceWindow' + multiRackConfigurationFile: + description: The base64 encoded Multi-Rack configuration json file. + format: byte + type: string + netmask: + description: The netmask for the control plane network. + maxLength: 255 + minLength: 1 + type: string + networkBondingModeDetails: + $ref: '#/components/schemas/NetworkBondingModeDetails' + ntpServer: + description: The list of NTP server IP addresses. Maximum of 3 allowed. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + shape: + description: | + The shape of the Exadata infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance. + maxLength: 255 + minLength: 1 + type: string + storageCount: + description: The number of storage servers for the Exadata infrastructure. + type: integer + storageServerType: + description: The storage server type of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + timeZone: + description: | + The time zone of the Exadata infrastructure. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). + format: x-obmcs-time-zone + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - displayName + - shape + - timeZone + - cloudControlPlaneServer1 + - cloudControlPlaneServer2 + - netmask + - gateway + - adminNetworkCIDR + - infiniBandNetworkCIDR + - dnsServer + - ntpServer + - corporateProxy + type: object + ExadataInfrastructure: + description: ExadataInfrastructure + properties: + activatedStorageCount: + description: The requested number of additional storage servers activated for the Exadata infrastructure. + type: integer + additionalComputeCount: + description: The requested number of additional compute servers for the Exadata infrastructure. + type: integer + additionalComputeSystemModel: + description: | + Oracle Exadata System Model specification. The system model determines the amount of compute or storage + server resources available for use. For more information, please see [System and Shape Configuration Options] + (https://docs.oracle.com/en/engineered-systems/exadata-cloud-at-customer/ecccm/ecc-system-config-options.html#GUID-9E090174-5C57-4EB1-9243-B470F9F10D6B) + enum: + - X7 + - X8 + - X8M + - X9M + - X11M + type: string + additionalStorageCount: + description: The requested number of additional storage servers for the Exadata infrastructure. + type: integer + adminNetworkCIDR: + description: The CIDR block for the Exadata administration network. + maxLength: 255 + minLength: 1 + type: string + availabilityDomain: + description: The name of the availability domain that the Exadata infrastructure is located in. + maxLength: 255 + minLength: 1 + type: string + cloudControlPlaneServer1: + description: The IP address for the first control plane server. + maxLength: 255 + minLength: 1 + type: string + cloudControlPlaneServer2: + description: The IP address for the second control plane server. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeCount: + description: The number of compute servers for the Exadata infrastructure. + type: integer + computeModel: + description: | + The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. + enum: + - ECPU + - OCPU + type: string + x-default-description: Null used when unspecified. + contacts: + description: The list of contacts for the Exadata infrastructure. + items: + $ref: '#/components/schemas/ExadataInfrastructureContact' + maxItems: 10 + minItems: 1 + type: array + corporateProxy: + description: The corporate network proxy for access to the control plane network. + maxLength: 255 + minLength: 1 + type: string + cpusEnabled: + description: The number of enabled CPU cores. + type: integer + csiNumber: + description: The CSI Number of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + dataStorageSizeInTBs: + description: | + Size, in terabytes, of the DATA disk group. + format: double + type: number + databaseServerType: + description: The database server type of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + dbNodeStorageSizeInGBs: + description: The local node storage allocated in GBs. + type: integer + dbServerVersion: + description: The software version of the database servers (dom0) in the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + definedFileSystemConfigurations: + description: Details of the file system configuration of the Exadata infrastructure. + items: + $ref: '#/components/schemas/DefinedFileSystemConfiguration' + maxItems: 1024 + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Exadata Cloud@Customer infrastructure. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + dnsServer: + description: The list of DNS server IP addresses. Maximum of 3 allowed. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + gateway: + description: The gateway for the control plane network. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + infiniBandNetworkCIDR: + description: The CIDR block for the Exadata InfiniBand interconnect. + maxLength: 255 + minLength: 1 + type: string + isMultiRackDeployment: + description: Indicates if deployment is Multi-Rack or not. + type: boolean + isSchedulingPolicyAssociated: + description: If true, the infrastructure is using granular maintenance scheduling preference. + type: boolean + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current lifecycle state of the Exadata infrastructure. + enum: + - CREATING + - REQUIRES_ACTIVATION + - ACTIVATING + - ACTIVE + - ACTIVATION_FAILED + - FAILED + - UPDATING + - DELETING + - DELETED + - DISCONNECTED + - MAINTENANCE_IN_PROGRESS + - WAITING_FOR_CONNECTIVITY + type: string + maintenanceSLOStatus: + description: A field to capture ‘Maintenance SLO Status’ for the Exadata infrastructure with values ‘OK’, ‘DEGRADED’. Default is ‘OK’ when the infrastructure is provisioned. + enum: + - OK + - DEGRADED + type: string + maintenanceVersionPreferences: + $ref: '#/components/schemas/MaintenanceVersionPreferenceDetails' + maintenanceWindow: + $ref: '#/components/schemas/MaintenanceWindow' + maxCpuCount: + description: The total number of CPU cores available. + type: integer + maxDataStorageInTBs: + description: The total available DATA disk group size. + format: double + type: number + maxDbNodeStorageInGBs: + description: The total local node storage available in GBs. + type: integer + maxMemoryInGBs: + description: The total memory available in GBs. + type: integer + memorySizeInGBs: + description: The memory allocated in GBs. + type: integer + monthlyDbServerVersion: + description: The monthly software version of the database servers (dom0) in the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + multiRackConfigurationFile: + description: The base64 encoded Multi-Rack configuration json file. + format: byte + type: string + netmask: + description: The netmask for the control plane network. + maxLength: 255 + minLength: 1 + type: string + networkBondingModeDetails: + $ref: '#/components/schemas/NetworkBondingModeDetails' + ntpServer: + description: The list of NTP server IP addresses. Maximum of 3 allowed. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + rackSerialNumber: + description: The serial number for the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + shape: + description: | + The shape of the Exadata infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance. + maxLength: 255 + minLength: 1 + type: string + storageCount: + description: The number of Exadata storage servers for the Exadata infrastructure. + type: integer + storageServerType: + description: The storage server type of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + storageServerVersion: + description: The software version of the storage servers (cells) in the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the Exadata infrastructure was created. + format: date-time + type: string + timeZone: + description: The time zone of the Exadata infrastructure. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). + format: x-obmcs-time-zone + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - lifecycleState + - displayName + - shape + type: object + UpdateExadataInfrastructureDetails: + description: | + Updates the Exadata infrastructure. Applies to Exadata Cloud@Customer instances only. + See [UpdateCloudExadataInfrastructureDetails Reference](#/en/database/latest/datatypes/UpdateCloudExadataInfrastructureDetails) for information on updating Exadata Cloud Service cloud Exadata infrastructure resources. + properties: + additionalComputeCount: + description: The requested number of additional compute servers for the Exadata infrastructure. + type: integer + additionalComputeSystemModel: + description: | + Oracle Exadata System Model specification. The system model determines the amount of compute or storage + server resources available for use. For more information, please see [System and Shape Configuration Options] + (https://docs.oracle.com/en/engineered-systems/exadata-cloud-at-customer/ecccm/ecc-system-config-options.html#GUID-9E090174-5C57-4EB1-9243-B470F9F10D6B) + enum: + - X7 + - X8 + - X8M + - X9M + - X11M + type: string + additionalStorageCount: + description: The requested number of additional storage servers for the Exadata infrastructure. + type: integer + adminNetworkCIDR: + description: The CIDR block for the Exadata administration network. + maxLength: 255 + minLength: 1 + type: string + cloudControlPlaneServer1: + description: The IP address for the first control plane server. + maxLength: 255 + minLength: 1 + type: string + cloudControlPlaneServer2: + description: The IP address for the second control plane server. + maxLength: 255 + minLength: 1 + type: string + contacts: + description: The list of contacts for the Exadata infrastructure. + items: + $ref: '#/components/schemas/ExadataInfrastructureContact' + maxItems: 10 + minItems: 1 + type: array + corporateProxy: + description: The corporate network proxy for access to the control plane network. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + dnsServer: + description: The list of DNS server IP addresses. Maximum of 3 allowed. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + gateway: + description: The gateway for the control plane network. + maxLength: 255 + minLength: 1 + type: string + infiniBandNetworkCIDR: + description: The CIDR block for the Exadata InfiniBand interconnect. + maxLength: 255 + minLength: 1 + type: string + isMultiRackDeployment: + description: Indicates if deployment is Multi-Rack or not. + type: boolean + maintenanceVersionPreferences: + $ref: '#/components/schemas/MaintenanceVersionPreferenceDetails' + maintenanceWindow: + $ref: '#/components/schemas/MaintenanceWindow' + multiRackConfigurationFile: + description: The base64 encoded Multi-Rack configuration json file. + format: byte + type: string + netmask: + description: The netmask for the control plane network. + maxLength: 255 + minLength: 1 + type: string + networkBondingModeDetails: + $ref: '#/components/schemas/NetworkBondingModeDetails' + ntpServer: + description: The list of NTP server IP addresses. Maximum of 3 allowed. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + timeZone: + description: | + The time zone of the Exadata infrastructure. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). + format: x-obmcs-time-zone + maxLength: 255 + minLength: 1 + type: string + type: object + ActivateExadataInfrastructureDetails: + description: | + The activation details for the Exadata Cloud@Customer infrastructure. Applies to Exadata Cloud@Customer instances only. + properties: + activationFile: + description: The activation zip file. + format: byte + type: string + required: + - activationFile + type: object + ChangeExadataInfrastructureCompartmentDetails: + description: | + The configuration details for moving the resource. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the resource to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ExadataInfrastructureUnAllocatedResources: + description: | + Displays details of unallocated resources for the Exadata Cloud@Customer infrastructure. + Applies to Exadata Cloud@Customer instances only. + properties: + autonomousVmClusters: + description: The list of Autonomous VM Clusters on the Infra and their associated unallocated resources details + items: + $ref: '#/components/schemas/AutonomousVmClusterResourceDetails' + type: array + displayName: + description: The user-friendly name for the Exadata Cloud@Customer infrastructure. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + exadataStorageInTBs: + description: Total unallocated exadata storage in the infrastructure in TBs. + format: double + type: number + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + localStorageInGbs: + description: The minimum amount of un allocated storage that is available across all nodes in the infrastructure. + type: integer + memoryInGBs: + description: The minimum amount of un allocated memory that is available across all nodes in the infrastructure. + type: integer + ocpus: + description: The minimum amount of un allocated ocpus that is available across all nodes in the infrastructure. + type: integer + required: + - id + - displayName + type: object + VmClusterNetworkSummary: + description: | + Details of the VM cluster network. Applies to Exadata Cloud@Customer instances only. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the VM cluster network. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + dns: + description: The list of DNS server IP addresses. Maximum of 3 allowed. + items: + maxLength: 1024 + minLength: 1 + type: string + maxItems: 3 + type: array + drScans: + description: The SCAN details for DR network + items: + $ref: '#/components/schemas/DrScanDetails' + type: array + exadataInfrastructureId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: | + The current state of the VM cluster network. + CREATING - The resource is being created + REQUIRES_VALIDATION - The resource is created and may not be usable until it is validated. + VALIDATING - The resource is being validated and not available to use. + VALIDATED - The resource is validated and is available for consumption by VM cluster. + VALIDATION_FAILED - The resource validation has failed and might require user input to be corrected. + UPDATING - The resource is being updated and not available to use. + ALLOCATED - The resource is is currently being used by VM cluster. + TERMINATING - The resource is being deleted and not available to use. + TERMINATED - The resource is deleted and unavailable. + FAILED - The resource is in a failed state due to validation or other errors. + NEEDS_ATTENTION - The resource is in needs attention state as some of it's child nodes are not validated + and unusable by VM cluster. + enum: + - CREATING + - REQUIRES_VALIDATION + - VALIDATING + - VALIDATED + - VALIDATION_FAILED + - UPDATING + - ALLOCATED + - TERMINATING + - TERMINATED + - FAILED + - NEEDS_ATTENTION + type: string + ntp: + description: The list of NTP server IP addresses. Maximum of 3 allowed. + items: + maxLength: 1024 + minLength: 1 + type: string + maxItems: 3 + type: array + scans: + description: The SCAN details. + items: + $ref: '#/components/schemas/ScanDetails' + maxItems: 3 + type: array + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time when the VM cluster network was created. + format: date-time + type: string + vmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the associated VM Cluster. + maxLength: 255 + minLength: 1 + type: string + vmNetworks: + description: Details of the client and backup networks. + items: + $ref: '#/components/schemas/VmNetworkDetails' + type: array + type: object + VmClusterNetworkDetails: + description: | + Details for an Exadata VM cluster network. Applies to Exadata Cloud@Customer instances only. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Exadata Cloud@Customer VM cluster network. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + dns: + description: The list of DNS server IP addresses. Maximum of 3 allowed. + items: + maxLength: 1024 + minLength: 1 + type: string + maxItems: 3 + type: array + drScans: + description: The SCAN details for DR network + items: + $ref: '#/components/schemas/DrScanDetails' + type: array + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + ntp: + description: The list of NTP server IP addresses. Maximum of 3 allowed. + items: + maxLength: 1024 + minLength: 1 + type: string + maxItems: 3 + type: array + scans: + description: The SCAN details. + items: + $ref: '#/components/schemas/ScanDetails' + maxItems: 3 + type: array + vmNetworks: + description: Details of the client and backup networks. + items: + $ref: '#/components/schemas/VmNetworkDetails' + type: array + required: + - compartmentId + - displayName + - scans + - vmNetworks + type: object + VmClusterNetwork: + description: The VM cluster network. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the VM cluster network. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + dns: + description: The list of DNS server IP addresses. Maximum of 3 allowed. + items: + maxLength: 1024 + minLength: 1 + type: string + maxItems: 3 + type: array + drScans: + description: The SCAN details for DR network + items: + $ref: '#/components/schemas/DrScanDetails' + type: array + exadataInfrastructureId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: | + The current state of the VM cluster network. + CREATING - The resource is being created + REQUIRES_VALIDATION - The resource is created and may not be usable until it is validated. + VALIDATING - The resource is being validated and not available to use. + VALIDATED - The resource is validated and is available for consumption by VM cluster. + VALIDATION_FAILED - The resource validation has failed and might require user input to be corrected. + UPDATING - The resource is being updated and not available to use. + ALLOCATED - The resource is is currently being used by VM cluster. + TERMINATING - The resource is being deleted and not available to use. + TERMINATED - The resource is deleted and unavailable. + FAILED - The resource is in a failed state due to validation or other errors. + NEEDS_ATTENTION - The resource is in needs attention state as some of it's child nodes are not validated + and unusable by VM cluster. + enum: + - CREATING + - REQUIRES_VALIDATION + - VALIDATING + - VALIDATED + - VALIDATION_FAILED + - UPDATING + - ALLOCATED + - TERMINATING + - TERMINATED + - FAILED + - NEEDS_ATTENTION + type: string + ntp: + description: The list of NTP server IP addresses. Maximum of 3 allowed. + items: + maxLength: 1024 + minLength: 1 + type: string + maxItems: 3 + type: array + scans: + description: The SCAN details. + items: + $ref: '#/components/schemas/ScanDetails' + maxItems: 3 + type: array + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time when the VM cluster network was created. + format: date-time + type: string + vmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the associated VM Cluster. + maxLength: 255 + minLength: 1 + type: string + vmNetworks: + description: Details of the client and backup networks. + items: + $ref: '#/components/schemas/VmNetworkDetails' + type: array + type: object + GenerateRecommendedNetworkDetails: + description: | + Generates a recommended VM cluster network configuration for an Exadata Cloud@Customer system. Applies to Exadata Cloud@Customer instances only. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + dbServers: + description: The list of Db server Ids to configure network. + items: + maxLength: 1024 + minLength: 1 + type: string + maxItems: 32 + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the VM cluster network. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + dns: + description: The list of DNS server IP addresses. Maximum of 3 allowed. + items: + maxLength: 1024 + minLength: 1 + type: string + maxItems: 3 + type: array + drScanListenerPortTcp: + description: The DR SCAN TCPIP port. Default is 1521. + maximum: 8999 + minimum: 1024 + type: integer + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + networks: + description: List of parameters for generation of the client and backup networks. + items: + $ref: '#/components/schemas/InfoForNetworkGenDetails' + type: array + ntp: + description: The list of NTP server IP addresses. Maximum of 3 allowed. + items: + maxLength: 1024 + minLength: 1 + type: string + maxItems: 3 + type: array + required: + - compartmentId + - displayName + - networks + type: object + UpdateVmClusterNetworkDetails: + description: | + Details for an Exadata VM cluster network. Applies to Exadata Cloud@Customer instances only. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + dns: + description: The list of DNS server IP addresses. Maximum of 3 allowed. + items: + maxLength: 1024 + minLength: 1 + type: string + maxItems: 3 + type: array + drScans: + description: The SCAN details for DR network + items: + $ref: '#/components/schemas/DrScanDetails' + maxItems: 3 + type: array + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + ntp: + description: The list of NTP server IP addresses. Maximum of 3 allowed. + items: + maxLength: 1024 + minLength: 1 + type: string + maxItems: 3 + type: array + scans: + description: The SCAN details. + items: + $ref: '#/components/schemas/ScanDetails' + maxItems: 3 + type: array + vmNetworks: + description: Details of the client and backup networks. + items: + $ref: '#/components/schemas/VmNetworkDetails' + type: array + type: object + ResizeVmClusterNetworkDetails: + description: | + Details of Db server network nodes to extend or shrink the VM cluster network. Applies to Exadata Cloud@Customer + instances only. + properties: + action: + description: | + Actions that can be performed on the VM cluster network. + ADD_DBSERVER_NETWORK - Provide Db server network details of network nodes to be added to the VM cluster network. + REMOVE_DBSERVER_NETWORK - Provide Db server network details of network nodes to be removed from the VM cluster network. + enum: + - ADD_DBSERVER_NETWORK + - REMOVE_DBSERVER_NETWORK + type: string + vmNetworks: + description: Details of the client and backup networks. + items: + $ref: '#/components/schemas/VmNetworkDetails' + type: array + required: + - vmNetworks + - action + type: object + ExadbVmClusterSummary: + description: | + Details of the Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only. + properties: + availabilityDomain: + description: | + The name of the availability domain in which the Exadata VM cluster on Exascale Infrastructure is located. + maxLength: 255 + minLength: 1 + type: string + backupNetworkNsgIds: + description: | + A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + backupSubnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the Exadata VM cluster on Exascale Infrastructure. + maxLength: 255 + minLength: 1 + type: string + clusterName: + description: | + The cluster name for Exadata VM cluster on Exascale Infrastructure. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. + maxLength: 11 + minLength: 1 + type: string + clusterPlacementGroupId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Exadata Infrastructure. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + dataCollectionOptions: + $ref: '#/components/schemas/DataCollectionOptions' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Exadata VM cluster on Exascale Infrastructure. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + domain: + description: | + A domain name used for the Exadata VM cluster on Exascale Infrastructure. If the Oracle-provided internet and VCN + resolver is enabled for the specified subnet, then the domain name for the subnet is used + (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. + Applies to Exadata Database Service on Exascale Infrastructure only. + type: string + enabledECpuCount: + description: | + The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. + format: int32 + minimum: 0 + type: integer + exascaleDbStorageVaultId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + giVersion: + description: A valid Oracle Grid Infrastructure (GI) software version. + maxLength: 255 + minLength: 1 + type: string + gridImageId: + description: | + Grid Setup will be done using this grid image id. + + The grid image ID can be obtained using the API /20160918/giVersions/{majorVersion}/minorVersions?compartmentId=&shapeFamily=EXADB_XS&availabilityDomain=. + The list of supported major versions can be obtained using the API /20160918/giVersions?compartmentId=&shape=ExaDbXS&availabilityDomain= + maxLength: 255 + minLength: 1 + type: string + gridImageType: + description: The type of Grid Image + enum: + - RELEASE_UPDATE + - CUSTOM_IMAGE + type: string + hostname: + description: | + The hostname for the Exadata VM cluster on Exascale Infrastructure. The hostname must begin with an alphabetic character, and + can contain alphanumeric characters and hyphens (-). For Exadata systems, the maximum length of the hostname is 12 characters. + + The maximum length of the combined hostname and domain is 63 characters. + + **Note:** The hostname must be unique within the subnet. If it is not unique, + then the Exadata VM cluster on Exascale Infrastructure will fail to provision. + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata VM cluster on Exascale Infrastructure. + maxLength: 255 + minLength: 1 + type: string + lastUpdateHistoryEntryId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance update history entry. This value is updated when a maintenance update starts. + maxLength: 255 + minLength: 1 + type: string + licenseModel: + description: | + The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the Exadata VM cluster on Exascale Infrastructure. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - MAINTENANCE_IN_PROGRESS + type: string + listenerPort: + description: The port number configured for the listener on the Exadata VM cluster on Exascale Infrastructure. + format: int64 + type: integer + memorySizeInGBs: + description: | + The memory that you want to be allocated in GBs. Memory is calculated based on 11 GB per VM core reserved. + type: integer + nodeCount: + description: | + The number of nodes in the Exadata VM cluster on Exascale Infrastructure. + format: int32 + type: integer + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + privateZoneId: + description: | + The private zone ID in which you want DNS records to be created. + maxLength: 255 + minLength: 1 + type: string + scanDnsName: + description: | + The FQDN of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. + maxLength: 72 + minLength: 1 + type: string + scanDnsRecordId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. + maxLength: 255 + minLength: 1 + type: string + scanIpIds: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Single Client Access Name (SCAN) IP addresses associated with the Exadata VM cluster on Exascale Infrastructure. + SCAN IP addresses are typically used for load balancing and are not assigned to any interface. + Oracle Clusterware directs the requests to the appropriate nodes in the cluster. + + **Note:** For a single-node DB system, this list is empty. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + scanListenerPortTcp: + description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. + type: integer + scanListenerPortTcpSsl: + description: | + The Secured Communication (TCPS) protocol Single Client Access Name (SCAN) port. The default port is 2484. + type: integer + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) + (opaque JSON object) + type: string + description: | + Key-value pair representing a ZPR tag key and value, scoped to a namespace. + Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` + type: object + description: | + Security Attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` + type: object + shape: + description: | + The shape of the Exadata VM cluster on Exascale Infrastructure resource + type: string + shapeAttribute: + description: | + The type of Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE which supports Oracle Database 23ai and later + enum: + - SMART_STORAGE + - BLOCK_STORAGE + type: string + snapshotFileSystemStorage: + $ref: '#/components/schemas/ExadbVmClusterStorageDetails' + sshPublicKeys: + description: The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + subnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet associated with the Exadata VM cluster on Exascale Infrastructure. + maxLength: 255 + minLength: 1 + type: string + subscriptionId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + systemVersion: + description: Operating system version of the image. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: The date and time that the Exadata VM cluster on Exascale Infrastructure was created. + format: date-time + type: string + timeZone: + description: | + The time zone to use for the Exadata VM cluster on Exascale Infrastructure. For details, see [Time Zones](/Content/Database/References/timezones.htm). + maxLength: 255 + minLength: 1 + type: string + totalECpuCount: + description: | + The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. + format: int32 + minimum: 2 + type: integer + totalFileSystemStorage: + $ref: '#/components/schemas/ExadbVmClusterStorageDetails' + vipIds: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual IP (VIP) addresses associated with the Exadata VM cluster on Exascale Infrastructure. + The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to + enable failover. If one node fails, then the VIP is reassigned to another active node in the cluster. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + vmFileSystemStorage: + $ref: '#/components/schemas/ExadbVmClusterStorageDetails' + zoneId: + description: | + The OCID of the zone with which the Exadata VM cluster on Exascale Infrastructure is associated. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - lifecycleState + - displayName + - availabilityDomain + - subnetId + - sshPublicKeys + - hostname + - domain + - backupSubnetId + - nodeCount + - totalECpuCount + - enabledECpuCount + - vmFileSystemStorage + - exascaleDbStorageVaultId + - shape + type: object + CreateExadbVmClusterDetails: + description: | + Details for the create Exadata VM cluster on Exascale Infrastructure operation. Applies to Exadata Database Service on Exascale Infrastructure only. + properties: + availabilityDomain: + description: | + The name of the availability domain in which the Exadata VM cluster on Exascale Infrastructure is located. + maxLength: 255 + minLength: 1 + type: string + backupNetworkNsgIds: + description: | + A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + backupSubnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the Exadata VM cluster on Exascale Infrastructure. + maxLength: 255 + minLength: 1 + type: string + clusterName: + description: | + The cluster name for Exadata VM cluster on Exascale Infrastructure. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. + maxLength: 11 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + dataCollectionOptions: + $ref: '#/components/schemas/DataCollectionOptions' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Exadata VM cluster on Exascale Infrastructure. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + domain: + description: | + A domain name used for the Exadata VM cluster on Exascale Infrastructure. If the Oracle-provided internet and VCN + resolver is enabled for the specified subnet, then the domain name for the subnet is used + (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. + Applies to Exadata Database Service on Exascale Infrastructure only. + type: string + enabledECpuCount: + description: | + The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. + format: int32 + minimum: 0 + type: integer + exascaleDbStorageVaultId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + gridImageId: + description: | + Grid Setup will be done using this grid image id. + + The grid image ID can be obtained using the API /20160918/giVersions/{majorVersion}/minorVersions?compartmentId=&shapeFamily=EXADB_XS&availabilityDomain=. + The list of supported major versions can be obtained using the API /20160918/giVersions?compartmentId=&shape=ExaDbXS&availabilityDomain= + maxLength: 255 + minLength: 1 + type: string + hostname: + description: | + The hostname for the Exadata VM cluster on Exascale Infrastructure. The hostname must begin with an alphabetic character, and + can contain alphanumeric characters and hyphens (-). For Exadata systems, the maximum length of the hostname is 12 characters. + + The maximum length of the combined hostname and domain is 63 characters. + + **Note:** The hostname must be unique within the subnet. If it is not unique, + then the Exadata VM cluster on Exascale Infrastructure will fail to provision. + type: string + licenseModel: + description: | + The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + nodeCount: + description: | + The number of nodes in the Exadata VM cluster on Exascale Infrastructure. + format: int32 + minimum: 1 + type: integer + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + privateZoneId: + description: | + The private zone ID in which you want DNS records to be created. + maxLength: 255 + minLength: 1 + type: string + scanListenerPortTcp: + description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. + type: integer + scanListenerPortTcpSsl: + description: | + The Secured Communication (TCPS) protocol Single Client Access Name (SCAN) port. The default port is 2484. + type: integer + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) + (opaque JSON object) + type: string + description: | + Key-value pair representing a ZPR tag key and value, scoped to a namespace. + Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` + type: object + description: | + Security Attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` + type: object + shape: + description: | + The shape of the Exadata VM cluster on Exascale Infrastructure resource + type: string + shapeAttribute: + description: | + The type of Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE which supports Oracle Database 23ai and later + enum: + - SMART_STORAGE + - BLOCK_STORAGE + type: string + sshPublicKeys: + description: The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + subnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet associated with the Exadata VM cluster on Exascale Infrastructure. + maxLength: 255 + minLength: 1 + type: string + subscriptionId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. + maxLength: 255 + minLength: 1 + type: string + systemVersion: + description: Operating system version of the image. + maxLength: 255 + minLength: 1 + type: string + timeZone: + description: | + The time zone to use for the Exadata VM cluster on Exascale Infrastructure. For details, see [Time Zones](/Content/Database/References/timezones.htm). + maxLength: 255 + minLength: 1 + type: string + totalECpuCount: + description: | + The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. + format: int32 + minimum: 2 + type: integer + vmFileSystemStorage: + $ref: '#/components/schemas/ExadbVmClusterStorageDetails' + required: + - compartmentId + - displayName + - sshPublicKeys + - gridImageId + - hostname + - subnetId + - backupSubnetId + - nodeCount + - totalECpuCount + - enabledECpuCount + - vmFileSystemStorage + - exascaleDbStorageVaultId + - availabilityDomain + - shape + type: object + ExadbVmCluster: + description: | + Details of the Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only. + properties: + availabilityDomain: + description: | + The name of the availability domain in which the Exadata VM cluster on Exascale Infrastructure is located. + maxLength: 255 + minLength: 1 + type: string + backupNetworkNsgIds: + description: | + A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + backupSubnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the Exadata VM cluster on Exascale Infrastructure. + maxLength: 255 + minLength: 1 + type: string + clusterName: + description: | + The cluster name for Exadata VM cluster on Exascale Infrastructure. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. + maxLength: 11 + minLength: 1 + type: string + clusterPlacementGroupId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Exadata Infrastructure. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + dataCollectionOptions: + $ref: '#/components/schemas/DataCollectionOptions' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Exadata VM cluster on Exascale Infrastructure. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + domain: + description: | + A domain name used for the Exadata VM cluster on Exascale Infrastructure. If the Oracle-provided internet and VCN + resolver is enabled for the specified subnet, then the domain name for the subnet is used + (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. + Applies to Exadata Database Service on Exascale Infrastructure only. + type: string + enabledECpuCount: + description: | + The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. + format: int32 + minimum: 0 + type: integer + exascaleDbStorageVaultId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + giVersion: + description: A valid Oracle Grid Infrastructure (GI) software version. + maxLength: 255 + minLength: 1 + type: string + gridImageId: + description: | + Grid Setup will be done using this grid image id. + + The grid image ID can be obtained using the API /20160918/giVersions/{majorVersion}/minorVersions?compartmentId=&shapeFamily=EXADB_XS&availabilityDomain=. + The list of supported major versions can be obtained using the API /20160918/giVersions?compartmentId=&shape=ExaDbXS&availabilityDomain= + maxLength: 255 + minLength: 1 + type: string + gridImageType: + description: The type of Grid Image + enum: + - RELEASE_UPDATE + - CUSTOM_IMAGE + type: string + hostname: + description: | + The hostname for the Exadata VM cluster on Exascale Infrastructure. The hostname must begin with an alphabetic character, and + can contain alphanumeric characters and hyphens (-). For Exadata systems, the maximum length of the hostname is 12 characters. + + The maximum length of the combined hostname and domain is 63 characters. + + **Note:** The hostname must be unique within the subnet. If it is not unique, + then the Exadata VM cluster on Exascale Infrastructure will fail to provision. + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata VM cluster on Exascale Infrastructure. + maxLength: 255 + minLength: 1 + type: string + lastUpdateHistoryEntryId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance update history entry. This value is updated when a maintenance update starts. + maxLength: 255 + minLength: 1 + type: string + licenseModel: + description: | + The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the Exadata VM cluster on Exascale Infrastructure. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - MAINTENANCE_IN_PROGRESS + type: string + listenerPort: + description: The port number configured for the listener on the Exadata VM cluster on Exascale Infrastructure. + format: int64 + type: integer + memorySizeInGBs: + description: | + The memory that you want to be allocated in GBs. Memory is calculated based on 11 GB per VM core reserved. + type: integer + nodeCount: + description: | + The number of nodes in the Exadata VM cluster on Exascale Infrastructure. + format: int32 + type: integer + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + privateZoneId: + description: | + The private zone ID in which you want DNS records to be created. + maxLength: 255 + minLength: 1 + type: string + scanDnsName: + description: | + The FQDN of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. + maxLength: 72 + minLength: 1 + type: string + scanDnsRecordId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. + maxLength: 255 + minLength: 1 + type: string + scanIpIds: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Single Client Access Name (SCAN) IP addresses associated with the Exadata VM cluster on Exascale Infrastructure. + SCAN IP addresses are typically used for load balancing and are not assigned to any interface. + Oracle Clusterware directs the requests to the appropriate nodes in the cluster. + + **Note:** For a single-node DB system, this list is empty. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + scanListenerPortTcp: + description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. + type: integer + scanListenerPortTcpSsl: + description: | + The Secured Communication (TCPS) protocol Single Client Access Name (SCAN) port. The default port is 2484. + type: integer + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) + (opaque JSON object) + type: string + description: | + Key-value pair representing a ZPR tag key and value, scoped to a namespace. + Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` + type: object + description: | + Security Attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` + type: object + shape: + description: | + The shape of the Exadata VM cluster on Exascale Infrastructure resource + type: string + shapeAttribute: + description: | + The type of Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE which supports Oracle Database 23ai and later + enum: + - SMART_STORAGE + - BLOCK_STORAGE + type: string + snapshotFileSystemStorage: + $ref: '#/components/schemas/ExadbVmClusterStorageDetails' + sshPublicKeys: + description: The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + subnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet associated with the Exadata VM cluster on Exascale Infrastructure. + maxLength: 255 + minLength: 1 + type: string + subscriptionId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + systemVersion: + description: Operating system version of the image. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: The date and time that the Exadata VM cluster on Exascale Infrastructure was created. + format: date-time + type: string + timeZone: + description: | + The time zone to use for the Exadata VM cluster on Exascale Infrastructure. For details, see [Time Zones](/Content/Database/References/timezones.htm). + maxLength: 255 + minLength: 1 + type: string + totalECpuCount: + description: | + The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. + format: int32 + minimum: 2 + type: integer + totalFileSystemStorage: + $ref: '#/components/schemas/ExadbVmClusterStorageDetails' + vipIds: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual IP (VIP) addresses associated with the Exadata VM cluster on Exascale Infrastructure. + The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to + enable failover. If one node fails, then the VIP is reassigned to another active node in the cluster. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + vmFileSystemStorage: + $ref: '#/components/schemas/ExadbVmClusterStorageDetails' + zoneId: + description: | + The OCID of the zone with which the Exadata VM cluster on Exascale Infrastructure is associated. + maxLength: 255 + minLength: 1 + type: string + iormConfigCache: + $ref: '#/components/schemas/ExadataIormConfig' + required: + - id + - compartmentId + - lifecycleState + - displayName + - availabilityDomain + - subnetId + - sshPublicKeys + - hostname + - domain + - backupSubnetId + - nodeCount + - totalECpuCount + - enabledECpuCount + - vmFileSystemStorage + - exascaleDbStorageVaultId + - shape + type: object + UpdateExadbVmClusterDetails: + description: | + Details for updating the Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only. + properties: + backupNetworkNsgIds: + description: | + A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + dataCollectionOptions: + $ref: '#/components/schemas/DataCollectionOptions' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Exadata VM cluster on Exascale Infrastructure. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + enabledECpuCount: + description: | + The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. + format: int32 + minimum: 0 + type: integer + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + gridImageId: + description: | + Grid Setup will be done using this grid image id. + + The grid image ID can be obtained using the API /20160918/giVersions/{majorVersion}/minorVersions?compartmentId=&shapeFamily=EXADB_XS&availabilityDomain=. + The list of supported major versions can be obtained using the API /20160918/giVersions?compartmentId=&shape=ExaDbXS&availabilityDomain= + maxLength: 255 + minLength: 1 + type: string + licenseModel: + description: | + The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + nodeCount: + description: | + The number of nodes to be added in the Exadata VM cluster on Exascale Infrastructure. + format: int32 + minimum: 1 + type: integer + nsgIds: + description: | + The list of [OCIDs](/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release) + (opaque JSON object) + type: string + description: | + Key-value pair representing a ZPR tag key and value, scoped to a namespace. + Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}` + type: object + description: | + Security Attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` + type: object + sshPublicKeys: + description: The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + systemVersion: + description: Operating system version of the image. + maxLength: 255 + minLength: 1 + type: string + totalECpuCount: + description: | + The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. + format: int32 + minimum: 2 + type: integer + updateAction: + description: The update action. + enum: + - ROLLING_APPLY + - NON_ROLLING_APPLY + - PRECHECK + - ROLLBACK + type: string + vmFileSystemStorage: + $ref: '#/components/schemas/ExadbVmClusterStorageDetails' + type: object + AddDbnodeSnapshotsForExadbVmClusterDetails: + description: | + Details to create a Database Node Snapshot. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + name: + description: The user-friendly name for the Database Node Snapshot. The name should be unique. + maxLength: 255 + minLength: 1 + type: string + sourceDbnodeIds: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Node. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 10 + minItems: 1 + type: array + required: + - name + - sourceDbnodeIds + type: object + DbnodeSnapshots: + description: | + Details of the Database Node Snapshot. + properties: + name: + description: The user-friendly name for the Database Node Snapshot. The name should be unique. + maxLength: 255 + minLength: 1 + type: string + snapshots: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Node. + items: + $ref: '#/components/schemas/DbnodeSnapshot' + maxItems: 10 + minItems: 1 + minLength: 1 + type: array + required: + - name + type: object + ChangeExadbVmClusterCompartmentDetails: + description: | + The configuration details for moving the Exadata VM cluster on Exascale Infrastructure to another compartment. Applies to Exadata Database Service on Exascale Infrastructure only. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ChangeExadbVmClusterSubscriptionDetails: + description: | + The configuration details for associating the Exadata VM cluster on Exascale Infrastructure with a different subscription. + properties: + isDefault: + description: | + Indicates if the subscription is UCM or not. + type: boolean + subscriptionId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. + maxLength: 255 + minLength: 1 + type: string + type: object + RemoveVirtualMachineFromExadbVmClusterDetails: + description: | + Details of removing Virtual Machines from the Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only. + properties: + dbNodes: + description: The list of ExaCS DB nodes for the Exadata VM cluster on Exascale Infrastructure to be removed. + items: + $ref: '#/components/schemas/DbNodeDetails' + type: array + required: + - dbNodes + type: object + ExadbVmClusterUpdateHistoryEntrySummary: + description: | + The record of an maintenance update action on a specified Exadata VM cluster on Exascale Infrastructure. + properties: + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update history entry. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: | + Descriptive text providing additional details about the lifecycle state. + type: string + lifecycleState: + description: The current lifecycle state of the maintenance update operation. + enum: + - IN_PROGRESS + - SUCCEEDED + - FAILED + type: string + timeCompleted: + description: The date and time when the maintenance update action completed. + format: date-time + type: string + timeStarted: + description: The date and time when the maintenance update action started. + format: date-time + type: string + updateAction: + description: The update action. + enum: + - ROLLING_APPLY + - NON_ROLLING_APPLY + - PRECHECK + - ROLLBACK + type: string + updateId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. + maxLength: 255 + minLength: 1 + type: string + updateType: + description: The type of cloud VM cluster maintenance update. + enum: + - GI_UPGRADE + - GI_PATCH + - OS_UPDATE + type: string + version: + description: The version of the maintenance update package. + maxLength: 255 + minLength: 1 + type: string + x-default-description: The version of the maintenance update package. + required: + - id + - updateId + - lifecycleState + - timeStarted + - updateType + type: object + ExadbVmClusterUpdateHistoryEntry: + description: | + The record of an maintenance update action on a specified Exadata VM cluster on Exascale Infrastructure. + properties: + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update history entry. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: | + Descriptive text providing additional details about the lifecycle state. + type: string + lifecycleState: + description: The current lifecycle state of the maintenance update operation. + enum: + - IN_PROGRESS + - SUCCEEDED + - FAILED + type: string + timeCompleted: + description: The date and time when the maintenance update action completed. + format: date-time + type: string + timeStarted: + description: The date and time when the maintenance update action started. + format: date-time + type: string + updateAction: + description: The update action. + enum: + - ROLLING_APPLY + - NON_ROLLING_APPLY + - PRECHECK + - ROLLBACK + type: string + updateId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. + maxLength: 255 + minLength: 1 + type: string + updateType: + description: The type of cloud VM cluster maintenance update. + enum: + - GI_UPGRADE + - GI_PATCH + - OS_UPDATE + type: string + version: + description: The version of the maintenance update package. + maxLength: 255 + minLength: 1 + type: string + x-default-description: The version of the maintenance update package. + required: + - id + - updateId + - lifecycleState + - timeStarted + - updateType + type: object + ExadbVmClusterUpdateSummary: + description: | + A maintenance update details for an Exadata VM cluster on Exascale Infrastructure. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + availableActions: + description: The possible actions performed by the update operation on the infrastructure components. + items: + enum: + - ROLLING_APPLY + - NON_ROLLING_APPLY + - PRECHECK + - ROLLBACK + type: string + type: array + description: + description: Details of the maintenance update package. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. + maxLength: 255 + minLength: 1 + type: string + lastAction: + description: The previous update action performed. + enum: + - ROLLING_APPLY + - NON_ROLLING_APPLY + - PRECHECK + - ROLLBACK + type: string + lifecycleDetails: + description: | + Descriptive text providing additional details about the lifecycle state. + type: string + lifecycleState: + description: The current state of the maintenance update. Dependent on value of `lastAction`. + enum: + - AVAILABLE + - SUCCESS + - IN_PROGRESS + - FAILED + type: string + timeReleased: + description: The date and time the maintenance update was released. + format: date-time + type: string + updateType: + description: The type of cloud VM cluster maintenance update. + enum: + - GI_UPGRADE + - GI_PATCH + - OS_UPDATE + type: string + version: + description: The version of the maintenance update package. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - description + - version + - timeReleased + - updateType + type: object + ExadbVmClusterUpdate: + description: | + A maintenance update details for an Exadata VM cluster on Exascale Infrastructure. + properties: + availableActions: + description: The possible actions performed by the update operation on the infrastructure components. + items: + enum: + - ROLLING_APPLY + - NON_ROLLING_APPLY + - PRECHECK + - ROLLBACK + type: string + type: array + description: + description: Details of the maintenance update package. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. + maxLength: 255 + minLength: 1 + type: string + lastAction: + description: The previous update action performed. + enum: + - ROLLING_APPLY + - NON_ROLLING_APPLY + - PRECHECK + - ROLLBACK + type: string + lifecycleDetails: + description: | + Descriptive text providing additional details about the lifecycle state. + type: string + lifecycleState: + description: The current state of the maintenance update. Dependent on value of `lastAction`. + enum: + - AVAILABLE + - SUCCESS + - IN_PROGRESS + - FAILED + type: string + timeReleased: + description: The date and time the maintenance update was released. + format: date-time + type: string + updateType: + description: The type of cloud VM cluster maintenance update. + enum: + - GI_UPGRADE + - GI_PATCH + - OS_UPDATE + type: string + version: + description: The version of the maintenance update package. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - description + - version + - timeReleased + - updateType + type: object + ExascaleDbStorageVaultSummary: + description: | + Details of the Exadata Database Storage Vault. + properties: + additionalFlashCacheInPercent: + description: | + The size of additional Flash Cache in percentage of High Capacity database storage. + format: int32 + minimum: 0 + type: integer + attachedShapeAttributes: + description: | + The shapeAttribute of the Exadata VM cluster(s) associated with the Exadata Database Storage Vault. + items: + enum: + - SMART_STORAGE + - BLOCK_STORAGE + maxItems: 2 + type: string + uniqueItems: true + type: array + autoscaleLimitInGBs: + description: The maximum limit, in gigabytes, to which the Vault storage size can automatically scale when auto scaling is enabled for the Database Storage Vault + type: integer + availabilityDomain: + description: The name of the availability domain in which the Exadata Database Storage Vault is located. + maxLength: 255 + minLength: 1 + type: string + clusterPlacementGroupId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Exadata Infrastructure. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + description: + description: Exadata Database Storage Vault description. + maxLength: 400 + minLength: 1 + type: string + displayName: + description: The user-friendly name for the Exadata Database Storage Vault. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + exadataInfrastructureId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + highCapacityDatabaseStorage: + $ref: '#/components/schemas/ExascaleDbStorageDetails' + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault. + maxLength: 255 + minLength: 1 + type: string + isAutoscaleEnabled: + description: Indicates if autoscale feature is enabled for the Database Storage Vault. The default value is `FALSE`. + type: boolean + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the Exadata Database Storage Vault. + type: string + x-obmcs-enumref: '#/definitions/ExascaleDbStorageVault/lifecycleState' + subscriptionId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time that the Exadata Database Storage Vault was created. + format: date-time + type: string + timeZone: + description: | + The time zone that you want to use for the Exadata Database Storage Vault. For details, see [Time Zones](/Content/Database/References/timezones.htm). + maxLength: 255 + minLength: 1 + type: string + vmClusterCount: + description: | + The number of Exadata VM clusters used the Exadata Database Storage Vault. + type: integer + required: + - id + - compartmentId + - availabilityDomain + - lifecycleState + - displayName + - highCapacityDatabaseStorage + type: object + CreateExascaleDbStorageVaultDetails: + description: | + Details to create a Exadata Database Storage Vault. + properties: + additionalFlashCacheInPercent: + description: | + The size of additional Flash Cache in percentage of High Capacity database storage. + format: int32 + minimum: 0 + type: integer + autoscaleLimitInGBs: + description: The maximum limit, in gigabytes, to which the Vault storage size can automatically scale when auto scaling is enabled for the Database Storage Vault + type: integer + availabilityDomain: + description: The name of the availability domain in which the Exadata Database Storage Vault is located. + maxLength: 255 + minLength: 1 + type: string + clusterPlacementGroupId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Exadata Infrastructure. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + description: + description: Exadata Database Storage Vault description. + maxLength: 400 + minLength: 1 + type: string + displayName: + description: The user-friendly name for the Exadata Database Storage Vault. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + exadataInfrastructureId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + highCapacityDatabaseStorage: + $ref: '#/components/schemas/ExascaleDbStorageInputDetails' + isAutoscaleEnabled: + description: Indicates if autoscale feature is enabled for the Database Storage Vault. The default value is `FALSE`. + type: boolean + subscriptionId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. + maxLength: 255 + minLength: 1 + type: string + timeZone: + description: | + The time zone that you want to use for the Exadata Database Storage Vault. For details, see [Time Zones](/Content/Database/References/timezones.htm). + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - displayName + - highCapacityDatabaseStorage + - availabilityDomain + type: object + ExascaleDbStorageVault: + description: | + Details of the Exadata Database Storage Vault. + properties: + additionalFlashCacheInPercent: + description: | + The size of additional Flash Cache in percentage of High Capacity database storage. + format: int32 + minimum: 0 + type: integer + attachedShapeAttributes: + description: | + The shapeAttribute of the Exadata VM cluster(s) associated with the Exadata Database Storage Vault. + items: + enum: + - SMART_STORAGE + - BLOCK_STORAGE + maxItems: 2 + type: string + uniqueItems: true + type: array + autoscaleLimitInGBs: + description: The maximum limit, in gigabytes, to which the Vault storage size can automatically scale when auto scaling is enabled for the Database Storage Vault + type: integer + availabilityDomain: + description: The name of the availability domain in which the Exadata Database Storage Vault is located. + maxLength: 255 + minLength: 1 + type: string + clusterPlacementGroupId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Exadata Infrastructure. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + description: + description: Exadata Database Storage Vault description. + maxLength: 400 + minLength: 1 + type: string + displayName: + description: The user-friendly name for the Exadata Database Storage Vault. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + exadataInfrastructureId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + highCapacityDatabaseStorage: + $ref: '#/components/schemas/ExascaleDbStorageDetails' + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault. + maxLength: 255 + minLength: 1 + type: string + isAutoscaleEnabled: + description: Indicates if autoscale feature is enabled for the Database Storage Vault. The default value is `FALSE`. + type: boolean + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the Exadata Database Storage Vault. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + type: string + subscriptionId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time that the Exadata Database Storage Vault was created. + format: date-time + type: string + timeZone: + description: | + The time zone that you want to use for the Exadata Database Storage Vault. For details, see [Time Zones](/Content/Database/References/timezones.htm). + maxLength: 255 + minLength: 1 + type: string + vmClusterCount: + description: | + The number of Exadata VM clusters used the Exadata Database Storage Vault. + type: integer + vmClusterIds: + description: | + The List of Exadata VM cluster on Exascale Infrastructure [OCIDs](/Content/General/Concepts/identifiers.htm) + **Note:** If Exadata Database Storage Vault is not used for any Exadata VM cluster on Exascale Infrastructure, this list is empty. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + required: + - id + - compartmentId + - availabilityDomain + - lifecycleState + - displayName + - highCapacityDatabaseStorage + type: object + UpdateExascaleDbStorageVaultDetails: + description: | + Details for updating the Exadata Database Storage Vault. + properties: + additionalFlashCacheInPercent: + description: | + The size of additional Flash Cache in percentage of High Capacity database storage. + format: int32 + minimum: 0 + type: integer + autoscaleLimitInGBs: + description: The maximum limit, in gigabytes, to which the Vault storage size can automatically scale when auto scaling is enabled for the Database Storage Vault + type: integer + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + description: + description: Exadata Database Storage Vault description. + maxLength: 400 + minLength: 1 + type: string + displayName: + description: The user-friendly name for the Exadata Database Storage Vault. The name does not need to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + highCapacityDatabaseStorage: + $ref: '#/components/schemas/ExascaleDbStorageInputDetails' + isAutoscaleEnabled: + description: Indicates if autoscale feature is enabled for the Database Storage Vault. The default value is `FALSE`. + type: boolean + type: object + ChangeExascaleDbStorageVaultCompartmentDetails: + description: | + The configuration details for moving the Exadata Database Storage Vault to another compartment. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ChangeExascaleDbStorageVaultSubscriptionDetails: + description: | + The configuration details for associating the Exadata Database Storage Vault with a different subscription. + properties: + isDefault: + description: | + Indicates if the subscription is UCM or not. + type: boolean + subscriptionId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. + maxLength: 255 + minLength: 1 + type: string + type: object + ExecutionActionSummary: + description: | + Details of an execution action. + properties: + actionMembers: + description: List of action members of this execution action. + items: + $ref: '#/components/schemas/ExecutionActionMember' + maxItems: 200 + type: array + actionParams: + additionalProperties: + type: string + description: | + Map where a key value pair describes the specific action parameter. + Example: `{"count": "3"}` + maxProperties: 100 + type: object + actionType: + description: The action type of the execution action being performed + enum: + - DB_SERVER_FULL_SOFTWARE_UPDATE + - STORAGE_SERVER_FULL_SOFTWARE_UPDATE + - NETWORK_SWITCH_FULL_SOFTWARE_UPDATE + - DB_SERVER_ONLINE_SOFTWARE_UPDATE + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + description: + description: Description of the execution action. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: The user-friendly name for the execution action. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + estimatedTimeInMins: + description: The estimated time of the execution action in minutes. + minimum: 0 + type: integer + executionActionOrder: + description: The priority order of the execution action. + minimum: 1 + type: integer + executionWindowId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the execution window resource the execution action belongs to. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the execution action. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: | + The current state of the execution action. Valid states are SCHEDULED, IN_PROGRESS, FAILED, CANCELED, + UPDATING, DELETED, SUCCEEDED and PARTIAL_SUCCESS. + enum: + - SCHEDULED + - IN_PROGRESS + - FAILED + - CANCELED + - UPDATING + - DELETED + - SUCCEEDED + - PARTIAL_SUCCESS + type: string + lifecycleSubstate: + description: | + The current sub-state of the execution action. Valid states are DURATION_EXCEEDED, MAINTENANCE_IN_PROGRESS and WAITING. + enum: + - DURATION_EXCEEDED + - MAINTENANCE_IN_PROGRESS + - WAITING + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the execution action was created. + format: date-time + type: string + timeUpdated: + description: The last date and time that the execution action was updated. + format: date-time + type: string + required: + - id + - compartmentId + - displayName + - lifecycleState + - executionWindowId + - actionType + - actionParams + type: object + CreateExecutionActionDetails: + description: | + Request to create execution action resource. + properties: + actionMembers: + description: List of action members of this execution action. + items: + $ref: '#/components/schemas/ExecutionActionMember' + maxItems: 200 + type: array + actionParams: + additionalProperties: + type: string + description: | + Map where a key value pair describes the specific action parameter. + Example: `{"count": "3"}` + maxProperties: 100 + type: object + actionType: + description: The action type of the execution action being performed + enum: + - DB_SERVER_FULL_SOFTWARE_UPDATE + - STORAGE_SERVER_FULL_SOFTWARE_UPDATE + - NETWORK_SWITCH_FULL_SOFTWARE_UPDATE + - DB_SERVER_ONLINE_SOFTWARE_UPDATE + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + executionWindowId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the execution window resource the execution action belongs to. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + required: + - executionWindowId + - actionType + type: object + ExecutionAction: + description: | + Details of an execution action. + properties: + actionMembers: + description: List of action members of this execution action. + items: + $ref: '#/components/schemas/ExecutionActionMember' + maxItems: 200 + type: array + actionParams: + additionalProperties: + type: string + description: | + Map where a key value pair describes the specific action parameter. + Example: `{"count": "3"}` + maxProperties: 100 + type: object + actionType: + description: The action type of the execution action being performed + enum: + - DB_SERVER_FULL_SOFTWARE_UPDATE + - STORAGE_SERVER_FULL_SOFTWARE_UPDATE + - NETWORK_SWITCH_FULL_SOFTWARE_UPDATE + - DB_SERVER_ONLINE_SOFTWARE_UPDATE + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + description: + description: Description of the execution action. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: The user-friendly name for the execution action. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + estimatedTimeInMins: + description: The estimated time of the execution action in minutes. + minimum: 0 + type: integer + executionActionOrder: + description: The priority order of the execution action. + minimum: 1 + type: integer + executionWindowId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the execution window resource the execution action belongs to. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the execution action. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: | + The current state of the execution action. Valid states are SCHEDULED, IN_PROGRESS, FAILED, CANCELED, + UPDATING, DELETED, SUCCEEDED and PARTIAL_SUCCESS. + enum: + - SCHEDULED + - IN_PROGRESS + - FAILED + - CANCELED + - UPDATING + - DELETED + - SUCCEEDED + - PARTIAL_SUCCESS + type: string + lifecycleSubstate: + description: | + The current sub-state of the execution action. Valid states are DURATION_EXCEEDED, MAINTENANCE_IN_PROGRESS and WAITING. + enum: + - DURATION_EXCEEDED + - MAINTENANCE_IN_PROGRESS + - WAITING + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the execution action was created. + format: date-time + type: string + timeUpdated: + description: The last date and time that the execution action was updated. + format: date-time + type: string + required: + - id + - compartmentId + - displayName + - lifecycleState + - executionWindowId + - actionType + - actionParams + type: object + UpdateExecutionActionDetails: + description: | + Describes the modification parameters for the execution action. + properties: + actionMembers: + description: List of action members of this execution action. + items: + $ref: '#/components/schemas/ExecutionActionMember' + maxItems: 200 + type: array + actionParams: + additionalProperties: + type: string + description: | + Map where a key value pair describes the specific action parameter. + Example: `{"count": "3"}` + maxProperties: 100 + type: object + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + executionWindowId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the execution window resource the execution action belongs to. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + type: object + MoveExecutionActionMemberDetails: + description: | + Request to move an execution action member to an execution action resource from another. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + executionActionMemberCount: + description: The number of execution action member without ocids to be moved. + minimum: 0 + type: integer + executionActionMemberId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the execution action member to be moved. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + sourceExecutionActionId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the source execution action resource. + maxLength: 255 + minLength: 1 + type: string + type: object + ExecutionWindowSummary: + description: | + Details of an execution window. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + description: + description: Description of the execution window. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: The user-friendly name for the execution window. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + estimatedTimeInMins: + description: The estimated time of the execution window in minutes. + minimum: 0 + type: integer + executionResourceId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the execution resource the execution window belongs to. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the execution window. + maxLength: 255 + minLength: 1 + type: string + isEnforcedDuration: + default: false + description: Indicates if duration the user plans to allocate for scheduling window is strictly enforced. The default value is `FALSE`. + type: boolean + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: | + The current state of the Schedule Policy. Valid states are CREATED, SCHEDULED, IN_PROGRESS, FAILED, CANCELED, + UPDATING, DELETED, SUCCEEDED and PARTIAL_SUCCESS. + enum: + - CREATED + - SCHEDULED + - IN_PROGRESS + - FAILED + - CANCELED + - UPDATING + - DELETED + - SUCCEEDED + - PARTIAL_SUCCESS + type: string + lifecycleSubstate: + description: | + The current sub-state of the execution window. Valid states are DURATION_EXCEEDED, MAINTENANCE_IN_PROGRESS and WAITING. + enum: + - DURATION_EXCEEDED + - MAINTENANCE_IN_PROGRESS + - WAITING + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the execution window was created. + format: date-time + type: string + timeEnded: + description: The date and time that the execution window ended. + format: date-time + type: string + timeScheduled: + description: The scheduled start date and time of the execution window. + format: date-time + type: string + timeStarted: + description: The date and time that the execution window was started. + format: date-time + type: string + timeUpdated: + description: The last date and time that the execution window was updated. + format: date-time + type: string + windowDurationInMins: + description: | + Duration window allows user to set a duration they plan to allocate for Scheduling window. The duration is in minutes. + minimum: 120 + type: integer + windowType: + description: The execution window is of PLANNED or UNPLANNED type. + enum: + - PLANNED + - UNPLANNED + type: string + required: + - id + - compartmentId + - displayName + - lifecycleState + - timeScheduled + - executionResourceId + - windowDurationInMins + type: object + CreateExecutionWindowDetails: + description: | + Request to create an execution window resource under an execution resource. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + executionResourceId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the execution resource the execution window belongs to. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + isEnforcedDuration: + default: false + description: Indicates if duration the user plans to allocate for scheduling window is strictly enforced. The default value is `FALSE`. + type: boolean + timeScheduled: + description: The scheduled start date and time of the execution window. + format: date-time + type: string + windowDurationInMins: + description: | + Duration window allows user to set a duration they plan to allocate for Scheduling window. The duration is in minutes. + minimum: 120 + type: integer + required: + - compartmentId + - executionResourceId + - timeScheduled + - windowDurationInMins + type: object + ExecutionWindow: + description: | + Details of an execution window. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + description: + description: Description of the execution window. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: The user-friendly name for the execution window. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + estimatedTimeInMins: + description: The estimated time of the execution window in minutes. + minimum: 0 + type: integer + executionResourceId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the execution resource the execution window belongs to. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the execution window. + maxLength: 255 + minLength: 1 + type: string + isEnforcedDuration: + default: false + description: Indicates if duration the user plans to allocate for scheduling window is strictly enforced. The default value is `FALSE`. + type: boolean + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: | + The current state of the Schedule Policy. Valid states are CREATED, SCHEDULED, IN_PROGRESS, FAILED, CANCELED, + UPDATING, DELETED, SUCCEEDED and PARTIAL_SUCCESS. + enum: + - CREATED + - SCHEDULED + - IN_PROGRESS + - FAILED + - CANCELED + - UPDATING + - DELETED + - SUCCEEDED + - PARTIAL_SUCCESS + type: string + lifecycleSubstate: + description: | + The current sub-state of the execution window. Valid states are DURATION_EXCEEDED, MAINTENANCE_IN_PROGRESS and WAITING. + enum: + - DURATION_EXCEEDED + - MAINTENANCE_IN_PROGRESS + - WAITING + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the execution window was created. + format: date-time + type: string + timeEnded: + description: The date and time that the execution window ended. + format: date-time + type: string + timeScheduled: + description: The scheduled start date and time of the execution window. + format: date-time + type: string + timeStarted: + description: The date and time that the execution window was started. + format: date-time + type: string + timeUpdated: + description: The last date and time that the execution window was updated. + format: date-time + type: string + windowDurationInMins: + description: | + Duration window allows user to set a duration they plan to allocate for Scheduling window. The duration is in minutes. + minimum: 120 + type: integer + windowType: + description: The execution window is of PLANNED or UNPLANNED type. + enum: + - PLANNED + - UNPLANNED + type: string + required: + - id + - compartmentId + - displayName + - lifecycleState + - timeScheduled + - executionResourceId + - windowDurationInMins + type: object + UpdateExecutionWindowDetails: + description: | + Describes the modification parameters for the execution window. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + isEnforcedDuration: + default: false + description: Indicates if duration the user plans to allocate for scheduling window is strictly enforced. The default value is `FALSE`. + type: boolean + timeScheduled: + description: The scheduled start date and time of the execution window. + format: date-time + type: string + windowDurationInMins: + description: | + Duration window allows user to set a duration they plan to allocate for Scheduling window. The duration is in minutes. + minimum: 120 + type: integer + type: object + ReorderExecutionActionDetails: + description: | + Describes the ordering list of execution actions for the execution window. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + executionActionOrderList: + description: | + List of action resources in a specific order. + Example: [{actionOrder: 1, actionResourceId: "resourceId1"}, {actionOrder: 2, actionResourceId: "resourceId2"}] + items: + $ref: '#/components/schemas/ActionOrderDetails' + maxItems: 100 + type: array + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + type: object + CreateExternalBackupJobDetails: + properties: + availabilityDomain: + description: The targeted availability domain for the backup. + maxLength: 255 + minLength: 1 + type: string + characterSet: + description: The character set for the database. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where this backup should be created. + maxLength: 255 + minLength: 1 + type: string + databaseEdition: + description: | + The Oracle Database Edition that applies to all the databases on the DB system. + Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. + enum: + - STANDARD_EDITION + - ENTERPRISE_EDITION + - ENTERPRISE_EDITION_HIGH_PERFORMANCE + - ENTERPRISE_EDITION_EXTREME_PERFORMANCE + - ENTERPRISE_EDITION_DEVELOPER + type: string + databaseMode: + description: The mode (single instance or RAC) of the database being backed up. + enum: + - SI + - RAC + type: string + dbName: + description: The name of the database from which the backup is being taken. + maxLength: 8 + minLength: 1 + type: string + dbUniqueName: + description: The `DB_UNIQUE_NAME` of the Oracle Database being backed up. + maxLength: 32 + minLength: 1 + type: string + dbVersion: + description: A valid Oracle Database version. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: A user-friendly name for the backup. This name does not have to be unique. + maxLength: 255 + minLength: 1 + type: string + externalDatabaseIdentifier: + description: The `DBID` of the Oracle Database being backed up. + format: int64 + type: integer + ncharacterSet: + description: The national character set for the database. + maxLength: 255 + minLength: 1 + type: string + pdbName: + description: The pluggable database name. + maxLength: 30 + minLength: 1 + type: string + required: + - availabilityDomain + - compartmentId + - dbVersion + - dbName + - externalDatabaseIdentifier + - displayName + - characterSet + - ncharacterSet + - databaseMode + - databaseEdition + type: object + ExternalBackupJob: + description: | + Provides all the details that apply to an external backup job. + properties: + backupId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the associated backup resource. + maxLength: 255 + minLength: 1 + type: string + bucketName: + description: The name of the Swift compartment bucket where the backup should be stored. + maxLength: 255 + minLength: 1 + type: string + provisioning: + description: An indicator for the provisioning state of the resource. If `TRUE`, the resource is still being provisioned. + type: boolean + swiftPassword: + description: | + The auth token to use for access to the Swift compartment bucket that will store the standalone backup. + For information about auth tokens, see [Working with Auth Tokens](/Content/Identity/Tasks/managingcredentials.htm#two). + maxLength: 255 + minLength: 1 + type: string + swiftPath: + description: The Swift path to use as a destination for the standalone backup. + maxLength: 1024 + minLength: 1 + type: string + tag: + description: The tag for RMAN to apply to the backup. + maxLength: 255 + minLength: 10 + type: string + userName: + description: The Swift user name to use for transferring the standalone backup to the designated Swift compartment bucket. + maxLength: 255 + minLength: 1 + type: string + required: + - backupId + - provisioning + - swiftPath + - bucketName + - userName + - tag + type: object + CompleteExternalBackupJobDetails: + properties: + cfBackupHandle: + description: The handle of the control file backup. + maxLength: 1024 + minLength: 1 + type: string + dataSize: + description: The size of the data in the database, in megabytes. + format: int64 + type: integer + redoSize: + description: The size of the redo in the database, in megabytes. + format: int64 + type: integer + spfBackupHandle: + description: The handle of the spfile backup. + maxLength: 1024 + minLength: 1 + type: string + sqlPatches: + description: The list of SQL patches that need to be applied to the backup during the restore. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + tdeWalletPath: + description: If the database being backed up is TDE enabled, this will be the path to the associated TDE wallet in Object Storage. + maxLength: 1024 + minLength: 1 + type: string + type: object + ExternalContainerDatabaseSummary: + description: | + An Oracle Cloud Infrastructure resource that allows you to manage an external Oracle container database. + properties: + characterSet: + description: The character set of the external database. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + databaseConfiguration: + description: The Oracle Database configuration + enum: + - RAC + - SINGLE_INSTANCE + type: string + databaseEdition: + description: | + The Oracle Database Edition that applies to all the databases on the DB system. + Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. + enum: + - STANDARD_EDITION + - ENTERPRISE_EDITION + - ENTERPRISE_EDITION_HIGH_PERFORMANCE + - ENTERPRISE_EDITION_EXTREME_PERFORMANCE + - ENTERPRISE_EDITION_DEVELOPER + type: string + databaseManagementConfig: + $ref: '#/components/schemas/DatabaseManagementConfig' + databaseVersion: + description: The Oracle Database version. + maxLength: 512 + minLength: 1 + type: string + dbId: + description: | + The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud. + maxLength: 512 + minLength: 1 + type: string + dbPacks: + description: The database packs licensed for the external Oracle Database. + maxLength: 512 + minLength: 1 + type: string + dbUniqueName: + description: The `DB_UNIQUE_NAME` of the external database. + maxLength: 32 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the external database. The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure external database resource. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the Oracle Cloud Infrastructure external database resource. + enum: + - PROVISIONING + - NOT_CONNECTED + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + type: string + ncharacterSet: + description: The national character of the external database. + maxLength: 255 + minLength: 1 + type: string + stackMonitoringConfig: + $ref: '#/components/schemas/StackMonitoringConfig' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the database was created. + format: date-time + type: string + timeZone: + description: | + The time zone of the external database. + It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, + depending on how the time zone value was specified when the database was created / last altered. + maxLength: 512 + minLength: 1 + type: string + required: + - id + - compartmentId + - displayName + - lifecycleState + - timeCreated + type: object + CreateExternalContainerDatabaseDetails: + description: | + Details for creating an external container database resource. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the external database. The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + required: + - compartmentId + - displayName + type: object + ExternalContainerDatabase: + description: | + An Oracle Cloud Infrastructure resource that allows you to manage an external container database. + properties: + characterSet: + description: The character set of the external database. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + databaseConfiguration: + description: The Oracle Database configuration + enum: + - RAC + - SINGLE_INSTANCE + type: string + databaseEdition: + description: | + The Oracle Database Edition that applies to all the databases on the DB system. + Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. + enum: + - STANDARD_EDITION + - ENTERPRISE_EDITION + - ENTERPRISE_EDITION_HIGH_PERFORMANCE + - ENTERPRISE_EDITION_EXTREME_PERFORMANCE + - ENTERPRISE_EDITION_DEVELOPER + type: string + databaseManagementConfig: + $ref: '#/components/schemas/DatabaseManagementConfig' + databaseVersion: + description: The Oracle Database version. + maxLength: 512 + minLength: 1 + type: string + dbId: + description: | + The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud. + maxLength: 512 + minLength: 1 + type: string + dbPacks: + description: The database packs licensed for the external Oracle Database. + maxLength: 512 + minLength: 1 + type: string + dbUniqueName: + description: The `DB_UNIQUE_NAME` of the external database. + maxLength: 32 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the external database. The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure external database resource. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the Oracle Cloud Infrastructure external database resource. + enum: + - PROVISIONING + - NOT_CONNECTED + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + type: string + ncharacterSet: + description: The national character of the external database. + maxLength: 255 + minLength: 1 + type: string + stackMonitoringConfig: + $ref: '#/components/schemas/StackMonitoringConfig' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the database was created. + format: date-time + type: string + timeZone: + description: | + The time zone of the external database. + It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, + depending on how the time zone value was specified when the database was created / last altered. + maxLength: 512 + minLength: 1 + type: string + required: + - id + - compartmentId + - displayName + - lifecycleState + - timeCreated + type: object + UpdateExternalContainerDatabaseDetails: + description: | + Details for updating an external container database. This API is not currently supported. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the external database. The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + required: + - displayName + type: object + EnableExternalContainerDatabaseDatabaseManagementDetails: + description: | + Details to enable Database Management on an external container database. + properties: + externalDatabaseConnectorId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the + [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). + maxLength: 255 + minLength: 1 + type: string + licenseModel: + description: | + The Oracle license model that applies to the external database. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + required: + - externalDatabaseConnectorId + - licenseModel + type: object + EnableExternalContainerDatabaseStackMonitoringDetails: + description: Details to enable Stack Monitoring on the external container database. + properties: + externalDatabaseConnectorId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the + [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). + maxLength: 255 + minLength: 1 + type: string + required: + - externalDatabaseConnectorId + type: object + ExternalDatabaseConnectorSummary: + description: | + An Oracle Cloud Infrastructure resource used to connect to an external Oracle Database. + This resource stores the database connection string, user credentials, and related details that allow you to + manage your external database using the Oracle Cloud Infrastructure Console and API interfaces. + discriminator: + propertyName: connectorType + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + connectionStatus: + description: The status of connectivity to the external database. + type: string + connectorType: + default: MACS + description: The type of connector used by the external database resource. + enum: + - MACS + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: | + The user-friendly name for the + [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). + The name does not have to be unique. + maxLength: 255 + minLength: 1 + type: string + externalDatabaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external database 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the + [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current lifecycle state of the external database connector resource. + type: string + x-obmcs-enumref: '#/definitions/ExternalDatabaseConnector/lifecycleState' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeConnectionStatusLastUpdated: + description: The date and time the `connectionStatus` of this external connector was last updated. + format: date-time + type: string + timeCreated: + description: The date and time the external connector was created. + format: date-time + type: string + required: + - id + - compartmentId + - displayName + - lifecycleState + - timeCreated + - connectorType + - externalDatabaseId + - connectionStatus + - timeConnectionStatusLastUpdated + type: object + CreateExternalDatabaseConnectorDetails: + description: | + Details for creating an external database connector resource. + discriminator: + propertyName: connectorType + properties: + connectorType: + default: MACS + description: The type of connector used by the external database resource. + enum: + - MACS + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: | + The user-friendly name for the + [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). + The name does not have to be unique. + maxLength: 255 + minLength: 1 + type: string + externalDatabaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external database 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + required: + - displayName + - externalDatabaseId + type: object + ExternalDatabaseConnector: + description: | + An Oracle Cloud Infrastructure resource used to connect to an external Oracle Database. + This resource stores the database connection string, user credentials, and related details that allow you to + manage your external database using the Oracle Cloud Infrastructure Console and API interfaces. + discriminator: + propertyName: connectorType + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + connectionStatus: + description: The status of connectivity to the external database. + type: string + connectorType: + default: MACS + description: The type of connector used by the external database resource. + enum: + - MACS + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: | + The user-friendly name for the + [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). + The name does not have to be unique. + maxLength: 255 + minLength: 1 + type: string + externalDatabaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external database 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the + [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current lifecycle state of the external database connector resource. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeConnectionStatusLastUpdated: + description: The date and time the connectionStatus of this external connector was last updated. + format: date-time + type: string + timeCreated: + description: The date and time the external connector was created. + format: date-time + type: string + required: + - id + - compartmentId + - displayName + - lifecycleState + - timeCreated + - connectorType + - externalDatabaseId + - connectionStatus + - timeConnectionStatusLastUpdated + type: object + UpdateExternalDatabaseConnectorDetails: + description: | + Details for updating an external database connector. + discriminator: + propertyName: connectorType + properties: + connectorType: + default: MACS + description: The type of connector used by the external database resource. + enum: + - MACS + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: | + The user-friendly name for the + [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). + The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + type: object + ExternalNonContainerDatabaseSummary: + description: | + An Oracle Cloud Infrastructure external non-container database resource. This resource is used to manage a non-container + database located outside of Oracle Cloud. + properties: + characterSet: + description: The character set of the external database. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + databaseConfiguration: + description: The Oracle Database configuration + enum: + - RAC + - SINGLE_INSTANCE + type: string + databaseEdition: + description: | + The Oracle Database Edition that applies to all the databases on the DB system. + Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. + enum: + - STANDARD_EDITION + - ENTERPRISE_EDITION + - ENTERPRISE_EDITION_HIGH_PERFORMANCE + - ENTERPRISE_EDITION_EXTREME_PERFORMANCE + - ENTERPRISE_EDITION_DEVELOPER + type: string + databaseManagementConfig: + $ref: '#/components/schemas/DatabaseManagementConfig' + databaseVersion: + description: The Oracle Database version. + maxLength: 512 + minLength: 1 + type: string + dbId: + description: | + The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud. + maxLength: 512 + minLength: 1 + type: string + dbPacks: + description: The database packs licensed for the external Oracle Database. + maxLength: 512 + minLength: 1 + type: string + dbUniqueName: + description: The `DB_UNIQUE_NAME` of the external database. + maxLength: 32 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the external database. The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure external database resource. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the Oracle Cloud Infrastructure external database resource. + enum: + - PROVISIONING + - NOT_CONNECTED + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + type: string + ncharacterSet: + description: The national character of the external database. + maxLength: 255 + minLength: 1 + type: string + stackMonitoringConfig: + $ref: '#/components/schemas/StackMonitoringConfig' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the database was created. + format: date-time + type: string + timeZone: + description: | + The time zone of the external database. + It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, + depending on how the time zone value was specified when the database was created / last altered. + maxLength: 512 + minLength: 1 + type: string + operationsInsightsConfig: + $ref: '#/components/schemas/OperationsInsightsConfig' + required: + - id + - compartmentId + - displayName + - lifecycleState + - timeCreated + type: object + CreateExternalNonContainerDatabaseDetails: + description: | + Details for creating an external non-container database resource. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the external database. The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + required: + - compartmentId + - displayName + type: object + ExternalNonContainerDatabase: + description: an external Oracle non-container database. + properties: + characterSet: + description: The character set of the external database. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + databaseConfiguration: + description: The Oracle Database configuration + enum: + - RAC + - SINGLE_INSTANCE + type: string + databaseEdition: + description: | + The Oracle Database Edition that applies to all the databases on the DB system. + Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. + enum: + - STANDARD_EDITION + - ENTERPRISE_EDITION + - ENTERPRISE_EDITION_HIGH_PERFORMANCE + - ENTERPRISE_EDITION_EXTREME_PERFORMANCE + - ENTERPRISE_EDITION_DEVELOPER + type: string + databaseManagementConfig: + $ref: '#/components/schemas/DatabaseManagementConfig' + databaseVersion: + description: The Oracle Database version. + maxLength: 512 + minLength: 1 + type: string + dbId: + description: | + The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud. + maxLength: 512 + minLength: 1 + type: string + dbPacks: + description: The database packs licensed for the external Oracle Database. + maxLength: 512 + minLength: 1 + type: string + dbUniqueName: + description: The `DB_UNIQUE_NAME` of the external database. + maxLength: 32 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the external database. The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure external database resource. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the Oracle Cloud Infrastructure external database resource. + enum: + - PROVISIONING + - NOT_CONNECTED + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + type: string + ncharacterSet: + description: The national character of the external database. + maxLength: 255 + minLength: 1 + type: string + stackMonitoringConfig: + $ref: '#/components/schemas/StackMonitoringConfig' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the database was created. + format: date-time + type: string + timeZone: + description: | + The time zone of the external database. + It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, + depending on how the time zone value was specified when the database was created / last altered. + maxLength: 512 + minLength: 1 + type: string + operationsInsightsConfig: + $ref: '#/components/schemas/OperationsInsightsConfig' + required: + - id + - compartmentId + - displayName + - lifecycleState + - timeCreated + type: object + UpdateExternalNonContainerDatabaseDetails: + description: | + Details for updating an external non-container database. This API is not currently supported. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the external database. The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + required: + - displayName + type: object + EnableExternalNonContainerDatabaseDatabaseManagementDetails: + description: | + Details to enable Database Management on an external non-container database. + properties: + externalDatabaseConnectorId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the + [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). + maxLength: 255 + minLength: 1 + type: string + licenseModel: + description: | + The Oracle license model that applies to the external database. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + required: + - externalDatabaseConnectorId + - licenseModel + type: object + EnableExternalNonContainerDatabaseOperationsInsightsDetails: + description: Details to enable Operations Insights on the external non-container database + properties: + externalDatabaseConnectorId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the + [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). + maxLength: 255 + minLength: 1 + type: string + required: + - externalDatabaseConnectorId + type: object + EnableExternalNonContainerDatabaseStackMonitoringDetails: + description: Details to enable Stack Monitoring on the external non-container database. + properties: + externalDatabaseConnectorId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the + [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). + maxLength: 255 + minLength: 1 + type: string + required: + - externalDatabaseConnectorId + type: object + ExternalPluggableDatabaseSummary: + description: | + An Oracle Cloud Infrastructure resource that allows you to manage an external pluggable database. + properties: + characterSet: + description: The character set of the external database. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + databaseConfiguration: + description: The Oracle Database configuration + enum: + - RAC + - SINGLE_INSTANCE + type: string + databaseEdition: + description: | + The Oracle Database Edition that applies to all the databases on the DB system. + Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. + enum: + - STANDARD_EDITION + - ENTERPRISE_EDITION + - ENTERPRISE_EDITION_HIGH_PERFORMANCE + - ENTERPRISE_EDITION_EXTREME_PERFORMANCE + - ENTERPRISE_EDITION_DEVELOPER + type: string + databaseManagementConfig: + $ref: '#/components/schemas/DatabaseManagementConfig' + databaseVersion: + description: The Oracle Database version. + maxLength: 512 + minLength: 1 + type: string + dbId: + description: | + The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud. + maxLength: 512 + minLength: 1 + type: string + dbPacks: + description: The database packs licensed for the external Oracle Database. + maxLength: 512 + minLength: 1 + type: string + dbUniqueName: + description: The `DB_UNIQUE_NAME` of the external database. + maxLength: 32 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the external database. The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure external database resource. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the Oracle Cloud Infrastructure external database resource. + enum: + - PROVISIONING + - NOT_CONNECTED + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + type: string + ncharacterSet: + description: The national character of the external database. + maxLength: 255 + minLength: 1 + type: string + stackMonitoringConfig: + $ref: '#/components/schemas/StackMonitoringConfig' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the database was created. + format: date-time + type: string + timeZone: + description: | + The time zone of the external database. + It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, + depending on how the time zone value was specified when the database was created / last altered. + maxLength: 512 + minLength: 1 + type: string + externalContainerDatabaseId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the + [external container database](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) that contains + the specified [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource. + type: string + operationsInsightsConfig: + $ref: '#/components/schemas/OperationsInsightsConfig' + sourceId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the the non-container database that was converted + to a pluggable database to create this resource. + type: string + required: + - id + - compartmentId + - displayName + - lifecycleState + - timeCreated + - externalContainerDatabaseId + type: object + CreateExternalPluggableDatabaseDetails: + description: | + Details for creating an external pluggable database resource. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the external database. The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + externalContainerDatabaseId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the + [external container database](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) that contains + the specified [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource. + type: string + sourceId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the the non-container database that was converted + to a pluggable database to create this resource. + type: string + required: + - compartmentId + - displayName + - externalContainerDatabaseId + type: object + ExternalPluggableDatabase: + description: an external Oracle pluggable database. + properties: + characterSet: + description: The character set of the external database. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + databaseConfiguration: + description: The Oracle Database configuration + enum: + - RAC + - SINGLE_INSTANCE + type: string + databaseEdition: + description: | + The Oracle Database Edition that applies to all the databases on the DB system. + Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. + enum: + - STANDARD_EDITION + - ENTERPRISE_EDITION + - ENTERPRISE_EDITION_HIGH_PERFORMANCE + - ENTERPRISE_EDITION_EXTREME_PERFORMANCE + - ENTERPRISE_EDITION_DEVELOPER + type: string + databaseManagementConfig: + $ref: '#/components/schemas/DatabaseManagementConfig' + databaseVersion: + description: The Oracle Database version. + maxLength: 512 + minLength: 1 + type: string + dbId: + description: | + The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud. + maxLength: 512 + minLength: 1 + type: string + dbPacks: + description: The database packs licensed for the external Oracle Database. + maxLength: 512 + minLength: 1 + type: string + dbUniqueName: + description: The `DB_UNIQUE_NAME` of the external database. + maxLength: 32 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the external database. The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure external database resource. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the Oracle Cloud Infrastructure external database resource. + enum: + - PROVISIONING + - NOT_CONNECTED + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + type: string + ncharacterSet: + description: The national character of the external database. + maxLength: 255 + minLength: 1 + type: string + stackMonitoringConfig: + $ref: '#/components/schemas/StackMonitoringConfig' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the database was created. + format: date-time + type: string + timeZone: + description: | + The time zone of the external database. + It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, + depending on how the time zone value was specified when the database was created / last altered. + maxLength: 512 + minLength: 1 + type: string + externalContainerDatabaseId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the + [external container database](#/en/database/latest/datatypes/CreateExternalContainerDatabaseDetails) that contains + the specified [external pluggable database](#/en/database/latest/datatypes/CreateExternalPluggableDatabaseDetails) resource. + type: string + operationsInsightsConfig: + $ref: '#/components/schemas/OperationsInsightsConfig' + sourceId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the the non-container database that was converted + to a pluggable database to create this resource. + type: string + required: + - id + - compartmentId + - displayName + - lifecycleState + - timeCreated + - externalContainerDatabaseId + type: object + UpdateExternalPluggableDatabaseDetails: + description: | + Details for updating an external pluggable database. This API is not currently supported. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the external database. The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + required: + - displayName + type: object + EnableExternalPluggableDatabaseDatabaseManagementDetails: + description: | + Details to enable Database Management on an external pluggable database. + properties: + externalDatabaseConnectorId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the + [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). + maxLength: 255 + minLength: 1 + type: string + required: + - externalDatabaseConnectorId + type: object + EnableExternalPluggableDatabaseOperationsInsightsDetails: + description: Details to enable Operations Insights on the external pluggable database + properties: + externalDatabaseConnectorId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the + [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). + maxLength: 255 + minLength: 1 + type: string + required: + - externalDatabaseConnectorId + type: object + EnableExternalPluggableDatabaseStackMonitoringDetails: + description: Details to enable Stack Monitoring on the external pluggable database. + properties: + externalDatabaseConnectorId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the + [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). + maxLength: 255 + minLength: 1 + type: string + required: + - externalDatabaseConnectorId + type: object + GiVersionSummary: + description: | + The Oracle Grid Infrastructure (GI) version. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + version: + description: A valid Oracle Grid Infrastructure (GI) software version. + maxLength: 255 + minLength: 1 + type: string + required: + - version + type: object + GiMinorVersionSummary: + description: | + The Oracle Grid Infrastructure (GI) minor version. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + gridImageId: + description: Grid Infrastructure Image Id + maxLength: 255 + minLength: 1 + type: string + version: + description: A valid Oracle Grid Infrastructure (GI) software version. + maxLength: 255 + minLength: 1 + type: string + required: + - version + type: object + KeyStoreSummary: + description: | + Details of the Key Store. + properties: + associatedDatabases: + description: List of databases associated with the key store. + items: + $ref: '#/components/schemas/KeyStoreAssociatedDatabaseDetails' + type: array + associatedLongTermBackupCount: + description: Indicates the number of long term backups of Autonomous AI Databases associated with this backup destination. + type: integer + associatedLongTermBackups: + description: List of long term backups of Autonomous AI Databases associated with this backup destination.The maximum associated number of long term backup listed here would be 1024. + items: + $ref: '#/components/schemas/AssociatedLongTermBackup' + maxItems: 1024 + minItems: 0 + type: array + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the key store. The name does not need to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the key store. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the key store. + enum: + - ACTIVE + - DELETED + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time that the key store was created. + format: date-time + type: string + typeDetails: + $ref: '#/components/schemas/KeyStoreTypeDetails' + required: + - id + - compartmentId + - lifecycleState + - displayName + - typeDetails + type: object + CreateKeyStoreDetails: + description: | + Details for the create key store operation. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the key store. The name does not need to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + typeDetails: + $ref: '#/components/schemas/KeyStoreTypeDetails' + required: + - compartmentId + - displayName + - typeDetails + type: object + KeyStore: + description: | + A key store to connect to an on-premise encryption key appliance like Oracle Key Vault. + properties: + associatedDatabases: + description: List of databases associated with the key store. + items: + $ref: '#/components/schemas/KeyStoreAssociatedDatabaseDetails' + type: array + associatedLongTermBackupCount: + description: Indicates the number of long term backups of Autonomous AI Databases associated with this backup destination. + type: integer + associatedLongTermBackups: + description: List of long term backups of Autonomous AI Databases associated with this backup destination.The maximum associated number of long term backup listed here would be 1024. + items: + $ref: '#/components/schemas/AssociatedLongTermBackup' + maxItems: 1024 + minItems: 0 + type: array + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the key store. The name does not need to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the key store. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the key store. + enum: + - ACTIVE + - DELETED + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time that the key store was created. + format: date-time + type: string + typeDetails: + $ref: '#/components/schemas/KeyStoreTypeDetails' + required: + - id + - compartmentId + - lifecycleState + - displayName + - typeDetails + type: object + UpdateKeyStoreDetails: + description: Details for updating the key store. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + typeDetails: + $ref: '#/components/schemas/KeyStoreTypeDetails' + type: object + ChangeKeyStoreCompartmentDetails: + description: | + The configuration details for moving the key store. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the key store to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + MaintenanceRunHistorySummary: + description: Details of a maintenance run history. + properties: + dbServersHistoryDetails: + description: List of database server history details. + items: + $ref: '#/components/schemas/DbServerHistorySummary' + type: array + granularMaintenanceHistory: + description: The list of granular maintenance history details. + items: + $ref: '#/components/schemas/GranularMaintenanceHistoryDetails' + type: array + id: + description: The OCID of the maintenance run history. + maxLength: 255 + minLength: 1 + type: string + maintenanceRunDetails: + $ref: '#/components/schemas/MaintenanceRunSummary' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + required: + - id + type: object + MaintenanceRunHistory: + description: | + Details of a maintenance run history. + properties: + dbServersHistoryDetails: + description: List of database server history details. + items: + $ref: '#/components/schemas/DbServerHistorySummary' + type: array + granularMaintenanceHistory: + description: The list of granular maintenance history details. + items: + $ref: '#/components/schemas/GranularMaintenanceHistoryDetails' + type: array + id: + description: The OCID of the maintenance run history. + maxLength: 255 + minLength: 1 + type: string + maintenanceRunDetails: + $ref: '#/components/schemas/MaintenanceRunSummary' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + required: + - id + type: object + MaintenanceRunSummary: + description: | + Details of a maintenance run. + properties: + compartmentId: + description: The OCID of the compartment. + maxLength: 255 + minLength: 1 + type: string + currentCustomActionTimeoutInMins: + description: Extend current custom action timeout between the current database servers during waiting state, from 0 (zero) to 30 minutes. + maximum: 30 + minimum: 0 + type: integer + currentPatchingComponent: + description: The name of the current infrastruture component that is getting patched. + maxLength: 255 + minLength: 1 + type: string + customActionTimeoutInMins: + description: | + Determines the amount of time the system will wait before the start of each database server patching operation. + Specify a number of minutes, from 15 to 120. + maximum: 120 + minimum: 15 + type: integer + description: + description: Description of the maintenance run. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: The user-friendly name for the maintenance run. + maxLength: 255 + minLength: 1 + type: string + estimatedComponentPatchingStartTime: + description: The estimated start time of the next infrastruture component patching operation. + format: date-time + type: string + estimatedPatchingTime: + $ref: '#/components/schemas/EstimatedPatchingTime' + id: + description: The OCID of the maintenance run. + maxLength: 255 + minLength: 1 + type: string + isCustomActionTimeoutEnabled: + description: If true, enables the configuration of a custom action timeout (waiting period) between database servers patching operations. + type: boolean + isDstFileUpdateEnabled: + description: Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner. + type: boolean + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: | + The current state of the maintenance run. For Autonomous AI Database Serverless instances, valid states are IN_PROGRESS, SUCCEEDED, and FAILED. + enum: + - SCHEDULED + - IN_PROGRESS + - SUCCEEDED + - SKIPPED + - FAILED + - UPDATING + - DELETING + - DELETED + - CANCELED + type: string + maintenanceSubtype: + description: Maintenance sub-type. + enum: + - QUARTERLY + - HARDWARE + - CRITICAL + - INFRASTRUCTURE + - DATABASE + - ONEOFF + - SECURITY_MONTHLY + - TIMEZONE + type: string + maintenanceType: + description: Maintenance type. + enum: + - PLANNED + - UNPLANNED + type: string + patchFailureCount: + description: Contain the patch failure count. + type: integer + patchId: + description: The unique identifier of the patch. The identifier string includes the patch type, the Oracle AI Database version, and the patch creation date (using the format YYMMDD). For example, the identifier `ru_patch_19.9.0.0_201030` is used for an RU patch for Oracle AI Database 19.9.0.0 that was released October 30, 2020. + maxLength: 255 + minLength: 1 + type: string + patchingEndTime: + description: The time when the patching operation ended. + format: date-time + type: string + patchingMode: + description: | + Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. + + *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See [Oracle-Managed Infrastructure Maintenance Updates](/iaas/Content/Database/Concepts/examaintenance.htm#Oracle) for more information. + enum: + - ROLLING + - NONROLLING + type: string + patchingStartTime: + description: The time when the patching operation started. + format: date-time + type: string + patchingStatus: + description: The status of the patching operation. + enum: + - PATCHING + - WAITING + - SCHEDULED + type: string + peerMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance run for the Autonomous Data Guard association's peer container database. + maxLength: 255 + minLength: 1 + type: string + peerMaintenanceRunIds: + description: The list of OCIDs for the maintenance runs associated with their Autonomous Data Guard peer container databases. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 32 + type: array + referenceResourceIdForImageUpdates: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the resource the maintenance run will refer to when trying to fetch target versions. + This field is set during maintenance run creation based on infrastructure's maintenance run version preferences. + Currently this is only be supported for monthly maintenance runs created via scheduling plans. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + targetDbServerVersion: + description: The target software version for the database server patching operation. + maxLength: 255 + minLength: 1 + type: string + targetResourceId: + description: The ID of the target resource on which the maintenance run occurs. + maxLength: 255 + minLength: 1 + type: string + targetResourceType: + description: The type of the target resource on which the maintenance run occurs. + enum: + - AUTONOMOUS_EXADATA_INFRASTRUCTURE + - AUTONOMOUS_CONTAINER_DATABASE + - EXADATA_DB_SYSTEM + - CLOUD_EXADATA_INFRASTRUCTURE + - EXACC_INFRASTRUCTURE + - AUTONOMOUS_VM_CLUSTER + - AUTONOMOUS_DATABASE + - CLOUD_AUTONOMOUS_VM_CLUSTER + type: string + targetStorageServerVersion: + description: The target Cell version that is to be patched to. + maxLength: 255 + minLength: 1 + type: string + timeEnded: + description: The date and time the maintenance run was completed. + format: date-time + type: string + timeScheduled: + description: The date and time the maintenance run is scheduled to occur. + format: date-time + type: string + timeStarted: + description: The date and time the maintenance run starts. + format: date-time + type: string + required: + - id + - compartmentId + - displayName + - lifecycleState + - timeScheduled + type: object + CreateMaintenanceRunDetails: + description: | + Details to schedule Maintenance Run with Latest Release Update along TimeZone File Update for the specified resource. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Maintenance Run. + maxLength: 255 + minLength: 1 + type: string + isDstFileUpdateEnabled: + description: Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner. + type: boolean + patchType: + description: | + Patch type, either "QUARTERLY" or "TIMEZONE". + enum: + - QUARTERLY + - TIMEZONE + type: string + patchingMode: + description: | + Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. + + *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See [Oracle-Managed Infrastructure Maintenance Updates](/iaas/Content/Database/Concepts/examaintenance.htm#Oracle) for more information. + enum: + - ROLLING + - NONROLLING + type: string + targetResourceId: + description: The ID of the target resource for which the maintenance run should be created. + maxLength: 255 + minLength: 1 + type: string + timeScheduled: + description: The date and time that update should be scheduled. + format: date-time + type: string + required: + - targetResourceId + - timeScheduled + - patchType + type: object + MaintenanceRun: + description: | + Details of a maintenance run. + properties: + compartmentId: + description: The OCID of the compartment. + maxLength: 255 + minLength: 1 + type: string + currentCustomActionTimeoutInMins: + description: Extend current custom action timeout between the current database servers during waiting state, from 0 (zero) to 30 minutes. + maximum: 30 + minimum: 0 + type: integer + currentPatchingComponent: + description: The name of the current infrastruture component that is getting patched. + maxLength: 255 + minLength: 1 + type: string + customActionTimeoutInMins: + description: | + Determines the amount of time the system will wait before the start of each database server patching operation. + Specify a number of minutes, from 15 to 120. + maximum: 120 + minimum: 15 + type: integer + description: + description: Description of the maintenance run. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: The user-friendly name for the maintenance run. + maxLength: 255 + minLength: 1 + type: string + estimatedComponentPatchingStartTime: + description: The estimated start time of the next infrastruture component patching operation. + format: date-time + type: string + estimatedPatchingTime: + $ref: '#/components/schemas/EstimatedPatchingTime' + id: + description: The OCID of the maintenance run. + maxLength: 255 + minLength: 1 + type: string + isCustomActionTimeoutEnabled: + description: If true, enables the configuration of a custom action timeout (waiting period) between database servers patching operations. + type: boolean + isDstFileUpdateEnabled: + description: Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner. + type: boolean + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: | + The current state of the maintenance run. For Autonomous AI Database Serverless instances, valid states are IN_PROGRESS, SUCCEEDED, and FAILED. + enum: + - SCHEDULED + - IN_PROGRESS + - SUCCEEDED + - SKIPPED + - FAILED + - UPDATING + - DELETING + - DELETED + - CANCELED + type: string + maintenanceSubtype: + description: Maintenance sub-type. + enum: + - QUARTERLY + - HARDWARE + - CRITICAL + - INFRASTRUCTURE + - DATABASE + - ONEOFF + - SECURITY_MONTHLY + - TIMEZONE + type: string + maintenanceType: + description: Maintenance type. + enum: + - PLANNED + - UNPLANNED + type: string + patchFailureCount: + description: Contain the patch failure count. + type: integer + patchId: + description: The unique identifier of the patch. The identifier string includes the patch type, the Oracle AI Database version, and the patch creation date (using the format YYMMDD). For example, the identifier `ru_patch_19.9.0.0_201030` is used for an RU patch for Oracle AI Database 19.9.0.0 that was released October 30, 2020. + maxLength: 255 + minLength: 1 + type: string + patchingEndTime: + description: The time when the patching operation ended. + format: date-time + type: string + patchingMode: + description: | + Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. + + *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See [Oracle-Managed Infrastructure Maintenance Updates](/iaas/Content/Database/Concepts/examaintenance.htm#Oracle) for more information. + enum: + - ROLLING + - NONROLLING + type: string + patchingStartTime: + description: The time when the patching operation started. + format: date-time + type: string + patchingStatus: + description: The status of the patching operation. + enum: + - PATCHING + - WAITING + - SCHEDULED + type: string + peerMaintenanceRunId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance run for the Autonomous Data Guard association's peer container database. + maxLength: 255 + minLength: 1 + type: string + peerMaintenanceRunIds: + description: The list of OCIDs for the maintenance runs associated with their Autonomous Data Guard peer container databases. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 32 + type: array + referenceResourceIdForImageUpdates: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the resource the maintenance run will refer to when trying to fetch target versions. + This field is set during maintenance run creation based on infrastructure's maintenance run version preferences. + Currently this is only be supported for monthly maintenance runs created via scheduling plans. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + targetDbServerVersion: + description: The target software version for the database server patching operation. + maxLength: 255 + minLength: 1 + type: string + targetResourceId: + description: The ID of the target resource on which the maintenance run occurs. + maxLength: 255 + minLength: 1 + type: string + targetResourceType: + description: The type of the target resource on which the maintenance run occurs. + enum: + - AUTONOMOUS_EXADATA_INFRASTRUCTURE + - AUTONOMOUS_CONTAINER_DATABASE + - EXADATA_DB_SYSTEM + - CLOUD_EXADATA_INFRASTRUCTURE + - EXACC_INFRASTRUCTURE + - AUTONOMOUS_VM_CLUSTER + - AUTONOMOUS_DATABASE + - CLOUD_AUTONOMOUS_VM_CLUSTER + type: string + targetStorageServerVersion: + description: The target Cell version that is to be patched to. + maxLength: 255 + minLength: 1 + type: string + timeEnded: + description: The date and time the maintenance run was completed. + format: date-time + type: string + timeScheduled: + description: The date and time the maintenance run is scheduled to occur. + format: date-time + type: string + timeStarted: + description: The date and time the maintenance run starts. + format: date-time + type: string + required: + - id + - compartmentId + - displayName + - lifecycleState + - timeScheduled + type: object + UpdateMaintenanceRunDetails: + description: | + Describes the modification parameters for the maintenance run. + properties: + currentCustomActionTimeoutInMins: + description: The current custom action timeout between the current database servers during waiting state in addition to custom action timeout, from 0 (zero) to 30 minutes. + maximum: 30 + minimum: 0 + type: integer + customActionTimeoutInMins: + description: | + Determines the amount of time the system will wait before the start of each database server patching operation. + Specify a number of minutes from 15 to 120. + maximum: 120 + minimum: 15 + type: integer + isCustomActionTimeoutEnabled: + description: If true, enables the configuration of a custom action timeout (waiting period) between database servers patching operations. + type: boolean + isEnabled: + description: If `FALSE`, skips the maintenance run. + type: boolean + isPatchNowEnabled: + description: If set to `TRUE`, starts patching immediately. + type: boolean + isResumePatching: + description: If true, then the patching is resumed and the next component will be patched immediately. + type: boolean + patchId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the patch to be applied in the maintenance run. + type: string + patchingMode: + description: | + Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. + + *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See [Oracle-Managed Infrastructure Maintenance Updates](/iaas/Content/Database/Concepts/examaintenance.htm#Oracle) for more information. + enum: + - ROLLING + - NONROLLING + type: string + targetDbServerVersion: + description: The target database server system software version for the patching operation. + maxLength: 255 + minLength: 1 + type: string + targetStorageServerVersion: + description: The target storage cell system software version for the patching operation. + maxLength: 255 + minLength: 1 + type: string + timeScheduled: + description: The scheduled date and time of the maintenance run to update. + format: date-time + type: string + type: object + OneoffPatchSummary: + description: | + An Oracle one-off patch for a specified database version. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + dbVersion: + description: | + A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: One-off patch 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the one-off patch. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Detailed message for the lifecycle state. + type: string + lifecycleState: + description: The current state of the one-off patch. + enum: + - CREATING + - AVAILABLE + - UPDATING + - INACTIVE + - FAILED + - EXPIRED + - DELETING + - DELETED + - TERMINATING + - TERMINATED + type: string + oneOffPatches: + description: List of one-off patches for Database Homes. + items: + type: string + type: array + releaseUpdate: + description: The PSU or PBP or Release Updates. To get a list of supported versions, use the [ListDbVersions](#/en/database/latest/DbVersionSummary/ListDbVersions) operation. + maxLength: 255 + minLength: 1 + type: string + sha256Sum: + description: SHA-256 checksum of the one-off patch. + maxLength: 320 + minLength: 1 + type: string + sizeInKBs: + description: The size of one-off patch in kilobytes. + format: float + type: number + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time one-off patch was created. + format: date-time + type: string + timeOfExpiration: + description: The date and time until which the one-off patch will be available for download. + format: date-time + type: string + timeUpdated: + description: The date and time one-off patch was updated. + format: date-time + type: string + required: + - id + - compartmentId + - displayName + - dbVersion + - releaseUpdate + - lifecycleState + - timeCreated + type: object + CreateOneoffPatchDetails: + description: | + Data to create the one-off patch for the specificed database version. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + dbVersion: + description: | + A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: One-off patch 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + oneOffPatches: + description: List of one-off patches for Database Homes. + items: + type: string + type: array + releaseUpdate: + description: The PSU or PBP or Release Updates. To get a list of supported versions, use the [ListDbVersions](#/en/database/latest/DbVersionSummary/ListDbVersions) operation. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - displayName + - dbVersion + - releaseUpdate + type: object + OneoffPatch: + description: | + One-off patches are created by specifying a database version, releaseUpdate and one-off patch number. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + dbVersion: + description: | + A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: One-off patch 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the one-off patch. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Detailed message for the lifecycle state. + type: string + lifecycleState: + description: The current state of the one-off patch. + enum: + - CREATING + - AVAILABLE + - UPDATING + - INACTIVE + - FAILED + - EXPIRED + - DELETING + - DELETED + - TERMINATING + - TERMINATED + type: string + oneOffPatches: + description: List of one-off patches for Database Homes. + items: + type: string + type: array + releaseUpdate: + description: The PSU or PBP or Release Updates. To get a list of supported versions, use the [ListDbVersions](#/en/database/latest/DbVersionSummary/ListDbVersions) operation. + maxLength: 255 + minLength: 1 + type: string + sha256Sum: + description: SHA-256 checksum of the one-off patch. + maxLength: 320 + minLength: 1 + type: string + sizeInKBs: + description: The size of one-off patch in kilobytes. + format: float + type: number + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time one-off patch was created. + format: date-time + type: string + timeOfExpiration: + description: The date and time until which the one-off patch will be available for download. + format: date-time + type: string + timeUpdated: + description: The date and time one-off patch was updated. + format: date-time + type: string + required: + - id + - compartmentId + - displayName + - dbVersion + - releaseUpdate + - lifecycleState + - timeCreated + type: object + UpdateOneoffPatchDetails: + description: | + Data to update the one-off patch. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + type: object + DownloadOneoffPatch: + description: | + Data to download one-off patch. + properties: + accessUri: + description: URI to download one-off patch. + type: string + timeCreated: + description: The date and time one-off patch URI was created. + format: date-time + type: string + timeExpires: + description: The date and time until which the one-off patch URI will be available for download. + format: date-time + type: string + required: + - accessUri + - timeCreated + - timeExpires + type: object + PluggableDatabaseSnapshotSummary: + description: | + Details of the Exadata Pluggable Database Snapshot. + properties: + clusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Pluggable Database Snapshot. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state of the Exadata Pluggable Database Snapshot. + type: string + lifecycleState: + description: The current state of the Exadata Pluggable Database Snapshot. + type: string + x-obmcs-enumref: '#/definitions/PluggableDatabaseSnapshot/lifecycleState' + name: + description: The user-friendly name for the Database Snapshot. The name should be unique. + maxLength: 255 + minLength: 1 + type: string + pluggableDatabaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Pluggable Database. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: | + The date and time that the Exadata Pluggable Database Snapshot was created, as expressed in RFC 3339 format. For example: 2023-06-27T21:10:29Z + format: date-time + type: string + required: + - id + - name + - pluggableDatabaseId + type: object + CreatePluggableDatabaseSnapshotDetails: + description: | + Details to create a Pluggable Database Snapshot. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + name: + description: The user-friendly name for the Database Snapshot. The name should be unique. + maxLength: 255 + minLength: 1 + type: string + pluggableDatabaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Pluggable Database. + maxLength: 255 + minLength: 1 + type: string + required: + - name + - pluggableDatabaseId + type: object + PluggableDatabaseSnapshot: + description: | + Details of the Pluggable Database Snapshot. + properties: + clusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Pluggable Database Snapshot. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state of the Exadata Pluggable Database Snapshot. + type: string + lifecycleState: + description: The current state of the Exadata Pluggable Database Snapshot. + enum: + - CREATING + - AVAILABLE + - TERMINATING + - TERMINATED + - FAILED + type: string + name: + description: The user-friendly name for the Database Snapshot. The name should be unique. + maxLength: 255 + minLength: 1 + type: string + pluggableDatabaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Pluggable Database. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: | + The date and time that the Exadata Pluggable Database Snapshot was created, as expressed in RFC 3339 format. For example: 2023-06-27T21:10:29Z + format: date-time + type: string + required: + - id + - name + - pluggableDatabaseId + type: object + PluggableDatabaseSummary: + description: | + A pluggable database (PDB) is portable collection of schemas, schema objects, and non-schema objects that appears to an Oracle client as a non-container database. To use a PDB, it needs to be plugged into a CDB. + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to a tenancy administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + connectionStrings: + $ref: '#/components/schemas/PluggableDatabaseConnectionStrings' + containerDatabaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the CDB. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the pluggable database. + maxLength: 255 + minLength: 1 + type: string + isRestricted: + description: | + The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, + the user needs both create a session and have restricted session privileges to connect to it. + type: boolean + lifecycleDetails: + description: Detailed message for the lifecycle state. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the pluggable database. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + - UPDATING + - FAILED + - RELOCATING + - RELOCATED + - REFRESHING + - RESTORE_IN_PROGRESS + - RESTORE_FAILED + - BACKUP_IN_PROGRESS + - DISABLED + type: string + openMode: + description: | + **Deprecated.** Use [PluggableDatabaseNodeLevelDetails](#/en/database/latest/datatypes/PluggableDatabaseNodeLevelDetails) for OpenMode details. + The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software). + enum: + - READ_ONLY + - READ_WRITE + - MOUNTED + - MIGRATE + type: string + pdbName: + description: The name for the pluggable database (PDB). The name is unique in the context of a [container database](#/en/database/latest/Database/). The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name. + maxLength: 30 + minLength: 1 + type: string + pdbNodeLevelDetails: + description: | + Pluggable Database Node Level Details. + Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}] + items: + $ref: '#/components/schemas/PluggableDatabaseNodeLevelDetails' + type: array + refreshableCloneConfig: + $ref: '#/components/schemas/PluggableDatabaseRefreshableCloneConfig' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the pluggable database was created. + format: date-time + type: string + required: + - id + - lifecycleState + - pdbName + - timeCreated + - containerDatabaseId + - openMode + - compartmentId + type: object + CreatePluggableDatabaseDetails: + description: | + Parameters for creating a pluggable database in a specified container database (CDB). + Additional option `pdbCreationTypeDetails` can be used for creating Pluggable Database using different operations, e.g. LocalClone, Remote Clone, Relocate. + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + containerDatabaseAdminPassword: + description: The DB system administrator password of the Container Database. + format: password + maxLength: 255 + minLength: 1 + type: string + containerDatabaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the CDB + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + pdbAdminPassword: + description: A strong password for PDB Admin. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, \#, or -. + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + pdbCreationTypeDetails: + $ref: '#/components/schemas/CreatePluggableDatabaseCreationTypeDetails' + pdbName: + description: The name for the pluggable database (PDB). The name is unique in the context of a [container database](#/en/database/latest/Database/). The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name. + maxLength: 30 + minLength: 1 + type: string + shouldCreatePdbBackup: + description: Indicates whether to take Pluggable Database Backup after the operation. + type: boolean + shouldPdbAdminAccountBeLocked: + default: false + description: | + The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. + If true, the pluggable database will be locked and user cannot login to it. + type: boolean + tdeWalletPassword: + description: The existing TDE wallet password of the CDB. + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + required: + - pdbName + - containerDatabaseId + type: object + PluggableDatabase: + description: | + A pluggable database (PDB) is portable collection of schemas, schema objects, and non-schema objects that appears to an Oracle client as a non-container database. To use a PDB, it needs to be plugged into a CDB. + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to a tenancy administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + connectionStrings: + $ref: '#/components/schemas/PluggableDatabaseConnectionStrings' + containerDatabaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the CDB. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the pluggable database. + maxLength: 255 + minLength: 1 + type: string + isRestricted: + description: | + The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, + the user needs both create a session and have restricted session privileges to connect to it. + type: boolean + lifecycleDetails: + description: Detailed message for the lifecycle state. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the pluggable database. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + - UPDATING + - FAILED + - RELOCATING + - RELOCATED + - REFRESHING + - RESTORE_IN_PROGRESS + - RESTORE_FAILED + - BACKUP_IN_PROGRESS + - DISABLED + type: string + openMode: + description: | + **Deprecated.** Use [PluggableDatabaseNodeLevelDetails](#/en/database/latest/datatypes/PluggableDatabaseNodeLevelDetails) for OpenMode details. + The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software). + enum: + - READ_ONLY + - READ_WRITE + - MOUNTED + - MIGRATE + type: string + pdbName: + description: The name for the pluggable database (PDB). The name is unique in the context of a [container database](#/en/database/latest/Database/). The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name. + maxLength: 30 + minLength: 1 + type: string + pdbNodeLevelDetails: + description: | + Pluggable Database Node Level Details. + Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}] + items: + $ref: '#/components/schemas/PluggableDatabaseNodeLevelDetails' + type: array + refreshableCloneConfig: + $ref: '#/components/schemas/PluggableDatabaseRefreshableCloneConfig' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the pluggable database was created. + format: date-time + type: string + required: + - id + - lifecycleState + - pdbName + - timeCreated + - containerDatabaseId + - openMode + - compartmentId + type: object + UpdatePluggableDatabaseDetails: + description: | + Details for updating a pluggable database (PDB). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + type: object + ConvertToRegularPluggableDatabaseDetails: + description: | + Parameters for converting Refreshable Clone Pluggable Database into Regular Pluggable Database. + properties: + containerDatabaseAdminPassword: + description: The DB system administrator password of the Container Database. + format: password + maxLength: 255 + minLength: 1 + type: string + shouldCreatePdbBackup: + description: Indicates whether to take Pluggable Database Backup after the operation. + type: boolean + tdeWalletPassword: + description: The existing TDE wallet password of the Container Database. + format: password + maxLength: 255 + minLength: 1 + type: string + type: object + LocalClonePluggableDatabaseDetails: + description: | + **Deprecated.** Use [CreatePluggableDatabaseDetails\](#/en/database/latest/datatypes/CreatePluggableDatabaseDetails) for Pluggable Database LocalClone Operation. + Parameters for cloning a pluggable database (PDB) within the same database (CDB). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + clonedPdbName: + description: The name for the pluggable database (PDB). The name is unique in the context of a [container database](#/en/database/latest/Database/). The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name. + maxLength: 30 + minLength: 1 + type: string + pdbAdminPassword: + description: A strong password for PDB Admin of the newly cloned PDB. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, \#, or -. + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + shouldPdbAdminAccountBeLocked: + default: false + description: | + The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. + If true, the pluggable database will be locked and user cannot login to it. + type: boolean + targetTdeWalletPassword: + description: The existing TDE wallet password of the target CDB. + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + required: + - clonedPdbName + type: object + RemoteClonePluggableDatabaseDetails: + description: | + **Deprecated.** Use [CreatePluggableDatabaseDetails\](#/en/database/latest/datatypes/CreatePluggableDatabaseDetails) for Pluggable Database RemoteClone Operation. + Parameters for cloning a pluggable database (PDB) in a remote database (CDB). A remote CDB is one that does not contain the source PDB. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + clonedPdbName: + description: The name for the pluggable database (PDB). The name is unique in the context of a [container database](#/en/database/latest/Database/). The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name. + maxLength: 30 + minLength: 1 + type: string + pdbAdminPassword: + description: A strong password for PDB Admin of the newly cloned PDB. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, \#, or -. + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + shouldPdbAdminAccountBeLocked: + default: false + description: | + The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. + If true, the pluggable database will be locked and user cannot login to it. + type: boolean + targetTdeWalletPassword: + description: The existing TDE wallet password of the target CDB. + maxLength: 255 + minLength: 1 + type: string + x-default-description: 'null' + sourceContainerDbAdminPassword: + description: The DB system administrator password of the source CDB. + maxLength: 255 + minLength: 1 + type: string + targetContainerDatabaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the target CDB + maxLength: 255 + minLength: 1 + type: string + required: + - clonedPdbName + - targetContainerDatabaseId + - sourceContainerDbAdminPassword + type: object + PrincipalTokenDetails: + description: | + This is a JsonWebToken JWT containing all the mapping information between the instance and the resource. + properties: + resourcePrincipalToken: + description: The base64 encoded intermediate Resource Principal Token. + type: string + servicePrincipalSessionToken: + description: The base64 encoded Session Token of the Service Principal that provided the intermediate Resource Principal Token. + type: string + required: + - resourcePrincipalToken + - servicePrincipalSessionToken + type: object + ActionParamValuesCollection: + description: A list of Action Parameters. Contains ActionParamValues items. + properties: + items: + description: List of Action Parameters and their possible values. + items: + $ref: '#/components/schemas/ActionParamValuesSummary' + maxItems: 50 + type: array + required: + - items + type: object + ScheduledActionCollection: + description: Results of Scheduled Action resources lists. Contains ScheduledActionSummary items. + properties: + items: + description: List of Scheduled Action resources. + items: + $ref: '#/components/schemas/ScheduledActionSummary' + type: array + required: + - items + type: object + CreateScheduledActionDetails: + description: | + Request to create Scheduled Action resource. + properties: + actionMembers: + description: The list of action members in a scheduled action. + items: + $ref: '#/components/schemas/ActionMember' + maxItems: 200 + type: array + actionOrder: + description: The array of [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduled Action and order paris. + items: + maxLength: 1024 + minLength: 1 + type: string + maxItems: 200 + type: array + actionParams: + additionalProperties: + type: string + description: | + Map where a key value pair describes the specific action parameter. + Example: `{"count": "3"}` + maxProperties: 100 + type: object + actionType: + default: DB_SERVER_FULL_SOFTWARE_UPDATE + description: The type of the scheduled action being performed + enum: + - DB_SERVER_FULL_SOFTWARE_UPDATE + - STORAGE_SERVER_FULL_SOFTWARE_UPDATE + - NETWORK_SWITCH_FULL_SOFTWARE_UPDATE + - DB_SERVER_ONLINE_SOFTWARE_UPDATE + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + schedulingPlanId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Plan. + maxLength: 255 + minLength: 1 + type: string + schedulingWindowId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Window. + maxLength: 255 + minLength: 1 + type: string + required: + - actionOrder + - actionType + - schedulingWindowId + - schedulingPlanId + - compartmentId + type: object + ScheduledAction: + description: | + Details of a Scheduled Action. + properties: + actionMembers: + description: The list of action members in a scheduled action. + items: + $ref: '#/components/schemas/ActionMember' + maxItems: 200 + type: array + actionOrder: + description: The order of the scheduled action. + maximum: 300 + minimum: 1 + type: integer + actionParams: + additionalProperties: + type: string + description: | + Map where a key value pair describes the specific action parameter. + Example: `{"count": "3"}` + maxProperties: 100 + type: object + actionType: + default: DB_SERVER_FULL_SOFTWARE_UPDATE + description: The type of the scheduled action being performed + enum: + - DB_SERVER_FULL_SOFTWARE_UPDATE + - STORAGE_SERVER_FULL_SOFTWARE_UPDATE + - NETWORK_SWITCH_FULL_SOFTWARE_UPDATE + - DB_SERVER_ONLINE_SOFTWARE_UPDATE + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The display name of the Scheduled Action. + maxLength: 255 + minLength: 1 + type: string + estimatedTimeInMins: + description: The estimated patching time for the scheduled action. + maximum: 500000 + minimum: 0 + type: integer + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduled Action. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: | + The current state of the Scheduled Action. Valid states are CREATING, NEEDS_ATTENTION, AVAILABLE, UPDATING, FAILED, DELETING and DELETED. + enum: + - CREATING + - NEEDS_ATTENTION + - AVAILABLE + - UPDATING + - FAILED + - DELETING + - DELETED + type: string + schedulingPlanId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Plan. + maxLength: 255 + minLength: 1 + type: string + schedulingWindowId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Window. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the Scheduled Action Resource was created. + format: date-time + type: string + timeUpdated: + description: The date and time the Scheduled Action Resource was updated. + format: date-time + type: string + required: + - id + - actionOrder + - actionType + - schedulingPlanId + - timeCreated + - displayName + - compartmentId + - lifecycleState + type: object + UpdateScheduledActionDetails: + description: | + Describes the modification parameters for the Scheduled Action. + properties: + actionMembers: + description: The list of action members in a scheduled action. + items: + $ref: '#/components/schemas/ActionMember' + maxItems: 200 + type: array + actionParams: + additionalProperties: + type: string + description: | + Map where a key value pair describes the specific action parameter. + Example: `{"count": "3"}` + maxProperties: 100 + type: object + type: object + SchedulingPlanCollection: + description: Results of Scheduling Plan resources lists. Contains ScheduledActionSummary items. + properties: + items: + description: List of Scheduling Plan resources. + items: + $ref: '#/components/schemas/SchedulingPlanSummary' + type: array + required: + - items + type: object + CreateSchedulingPlanDetails: + description: | + Request to create Scheduling Plan. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + isUsingRecommendedScheduledActions: + description: If true, recommended scheduled actions will be generated for the scheduling plan. + type: boolean + planIntent: + default: EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE + description: The current intent of the Scheduling Plan. Valid states are EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE and EXADATA_INFRASTRUCTURE_SECURITY_UPDATE. + enum: + - EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE + - EXADATA_INFRASTRUCTURE_SECURITY_UPDATE + type: string + resourceId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the resource. + maxLength: 255 + minLength: 1 + type: string + schedulingPolicyId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Policy. + maxLength: 255 + minLength: 1 + type: string + serviceType: + description: The service type of the Scheduling Plan. + enum: + - EXACC + - EXACS + - FPPPCS + type: string + required: + - schedulingPolicyId + - resourceId + - compartmentId + - serviceType + type: object + SchedulingPlan: + description: | + Details of a Scheduling Plan. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The display name of the Scheduling Plan. + maxLength: 255 + minLength: 1 + type: string + estimatedTimeInMins: + description: The estimated time for the Scheduling Plan. + maximum: 500000 + minimum: 0 + type: integer + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Plan. + maxLength: 255 + minLength: 1 + type: string + isUsingRecommendedScheduledActions: + description: If true, recommended scheduled actions will be generated for the scheduling plan. + type: boolean + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: | + The current state of the Scheduling Plan. Valid states are CREATING, NEEDS_ATTENTION, AVAILABLE, UPDATING, FAILED, DELETING and DELETED. + enum: + - CREATING + - NEEDS_ATTENTION + - AVAILABLE + - UPDATING + - FAILED + - DELETING + - DELETED + type: string + planIntent: + default: EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE + description: The current intent of the Scheduling Plan. Valid states are EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE and EXADATA_INFRASTRUCTURE_SECURITY_UPDATE. + enum: + - EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE + - EXADATA_INFRASTRUCTURE_SECURITY_UPDATE + type: string + resourceId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the resource. + maxLength: 255 + minLength: 1 + type: string + schedulingPolicyId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Policy. + maxLength: 255 + minLength: 1 + type: string + serviceType: + description: The service type of the Scheduling Plan. + enum: + - EXACC + - EXACS + - FPPPCS + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the Scheduling Plan Resource was created. + format: date-time + type: string + timeUpdated: + description: The date and time the Scheduling Plan Resource was updated. + format: date-time + type: string + required: + - id + - schedulingPolicyId + - resourceId + - compartmentId + - serviceType + - lifecycleState + - timeCreated + type: object + ChangeSchedulingPlanCompartmentDetails: + description: | + The configuration details for moving the Scheduling Plan. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ReorderScheduledActionsDetails: + description: | + Describes the re-order parameters for the Scheduled Action resources. + properties: + scheduledActionIdOrders: + description: | + List of action resources in a specific order. + Example: [{actionOrder: 1, actionResourceId: "resourceId1"}, {actionOrder: 2, actionResourceId: "resourceId2"}] + items: + $ref: '#/components/schemas/ActionOrderDetails' + maxItems: 100 + type: array + required: + - scheduledActionIdOrders + type: object + SchedulingPolicySummary: + description: | + Details of a Scheduling Policy. + properties: + cadence: + description: The cadence period. + enum: + - HALFYEARLY + - QUARTERLY + - MONTHLY + type: string + cadenceStartMonth: + $ref: '#/components/schemas/Month' + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Scheduling Policy. The name does not need to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Policy. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: | + The current state of the Scheduling Policy. Valid states are CREATING, NEEDS_ATTENTION, ACTIVE, UPDATING, FAILED, DELETING and DELETED. + enum: + - CREATING + - NEEDS_ATTENTION + - AVAILABLE + - UPDATING + - FAILED + - DELETING + - DELETED + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the Scheduling Policy was created. + format: date-time + type: string + timeNextWindowStarts: + description: The date and time of the next scheduling window associated with the schedulingPolicy is planned to start. + format: date-time + type: string + timeUpdated: + description: The last date and time that the Scheduling Policy was updated. + format: date-time + type: string + required: + - id + - compartmentId + - displayName + - lifecycleState + - cadence + type: object + CreateSchedulingPolicyDetails: + description: | + Request to create Scheduling Policy resource with Maintenance windows per cadence. + properties: + cadence: + description: The cadence period. + enum: + - HALFYEARLY + - QUARTERLY + - MONTHLY + type: string + cadenceStartMonth: + $ref: '#/components/schemas/Month' + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Scheduling Policy. The name does not need to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + required: + - compartmentId + - displayName + - cadence + type: object + SchedulingPolicy: + description: | + Details of a Scheduling Policy. + properties: + cadence: + description: The cadence period. + enum: + - HALFYEARLY + - QUARTERLY + - MONTHLY + type: string + cadenceStartMonth: + $ref: '#/components/schemas/Month' + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Scheduling Policy. The name does not need to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Policy. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: | + The current state of the Scheduling Policy. Valid states are CREATING, NEEDS_ATTENTION, ACTIVE, UPDATING, FAILED, DELETING and DELETED. + enum: + - CREATING + - NEEDS_ATTENTION + - AVAILABLE + - UPDATING + - FAILED + - DELETING + - DELETED + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the Scheduling Policy was created. + format: date-time + type: string + timeNextWindowStarts: + description: The date and time of the next scheduling window associated with the schedulingPolicy is planned to start. + format: date-time + type: string + timeUpdated: + description: The last date and time that the Scheduling Policy was updated. + format: date-time + type: string + required: + - id + - compartmentId + - displayName + - lifecycleState + - cadence + type: object + UpdateSchedulingPolicyDetails: + description: | + Describes the modification parameters for the Scheduling Policy. + properties: + cadence: + description: The cadence period. + enum: + - HALFYEARLY + - QUARTERLY + - MONTHLY + type: string + cadenceStartMonth: + $ref: '#/components/schemas/Month' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Scheduling Policy. The name does not need to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + type: object + ChangeSchedulingPolicyCompartmentDetails: + description: | + The configuration details for moving the Scheduling Policy. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + RecommendedScheduledActionsCollection: + description: A list of scheduled actions. Contains RecommendedScheduledAction items. + properties: + items: + description: List of scheduled actions. + items: + $ref: '#/components/schemas/RecommendedScheduledActionSummary' + maxItems: 100 + type: array + required: + - items + type: object + SchedulingWindowSummary: + description: | + Details of a Scheduling Window. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Scheduling Window. The name does not need to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Window. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: | + The current state of the Scheduling Window. Valid states are CREATING, ACTIVE, UPDATING, FAILED, DELETING and DELETED. + enum: + - CREATING + - AVAILABLE + - UPDATING + - FAILED + - DELETING + - DELETED + type: string + schedulingPolicyId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Policy. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the Scheduling Window was created. + format: date-time + type: string + timeNextSchedulingWindowStarts: + description: The date and time of the next upcoming window associated within the schedulingWindow is planned to start. + format: date-time + type: string + timeUpdated: + description: The last date and time that the Scheduling Window was updated. + format: date-time + type: string + windowPreference: + $ref: '#/components/schemas/WindowPreferenceDetail' + required: + - id + - lifecycleState + - schedulingPolicyId + - windowPreference + type: object + CreateSchedulingWindowDetails: + description: | + Request to create Scheduling Window resource. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + windowPreference: + $ref: '#/components/schemas/WindowPreferenceDetail' + required: + - windowPreference + type: object + SchedulingWindow: + description: | + Details of a Scheduling Window. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Scheduling Window. The name does not need to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Window. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: | + The current state of the Scheduling Window. Valid states are CREATING, ACTIVE, UPDATING, FAILED, DELETING and DELETED. + enum: + - CREATING + - AVAILABLE + - UPDATING + - FAILED + - DELETING + - DELETED + type: string + schedulingPolicyId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Policy. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the Scheduling Window was created. + format: date-time + type: string + timeNextSchedulingWindowStarts: + description: The date and time of the next upcoming window associated within the schedulingWindow is planned to start. + format: date-time + type: string + timeUpdated: + description: The last date and time that the Scheduling Window was updated. + format: date-time + type: string + windowPreference: + $ref: '#/components/schemas/WindowPreferenceDetail' + required: + - id + - lifecycleState + - schedulingPolicyId + - windowPreference + type: object + UpdateSchedulingWindowDetails: + description: | + Describes the modification parameters for the Scheduling Window. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + windowPreference: + $ref: '#/components/schemas/WindowPreferenceDetail' + type: object + SystemVersionCollection: + description: Results of the System version lists. Contains SystemVersionSummary items. + properties: + items: + description: List of System versions. + items: + $ref: '#/components/schemas/SystemVersionSummary' + maxItems: 50 + type: array + required: + - items + type: object + VmClusterSummary: + description: | + Details of the Exadata Cloud@Customer VM cluster. + properties: + availabilityDomain: + description: The name of the availability domain that the VM cluster is located in. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeModel: + description: | + The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. + enum: + - ECPU + - OCPU + type: string + x-default-description: Null used when unspecified. + cpusEnabled: + description: The number of enabled CPU cores. + type: integer + dataCollectionOptions: + $ref: '#/components/schemas/DataCollectionOptions' + dataStoragePercentage: + description: | + The percentage assigned to DATA storage (user data and database files). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + dataStorageSizeInGBs: + description: Size of the DATA disk group in GBs. + format: double + minimum: 32 + type: number + dataStorageSizeInTBs: + description: Size, in terabytes, of the DATA disk group. + format: double + type: number + dbNodeStorageSizeInGBs: + description: The local node storage allocated in GBs. + type: integer + dbServers: + description: The list of Db server. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Exadata Cloud@Customer VM cluster. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + exadataInfrastructureId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + fileSystemConfigurationDetails: + description: Details of the file system configuration of the VM cluster. + items: + $ref: '#/components/schemas/FileSystemConfigurationDetail' + maxItems: 1024 + type: array + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + giSoftwareImageId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of a grid infrastructure software image. This is a database software image of the type `GRID_IMAGE`. + maxLength: 255 + type: string + giVersion: + description: The Oracle Grid Infrastructure software version for the VM cluster. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster. + maxLength: 255 + minLength: 1 + type: string + isLocalBackupEnabled: + description: | + If true, database backup on local Exadata storage is configured for the VM cluster. If false, database backup on local Exadata storage is not available in the VM cluster. + type: boolean + isSparseDiskgroupEnabled: + description: | + If true, sparse disk group is configured for the VM cluster. If false, sparse disk group is not created. + type: boolean + lastPatchHistoryEntryId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last patch history. This value is updated as soon as a patch operation starts. + maxLength: 255 + minLength: 1 + type: string + licenseModel: + description: | + The Oracle license model that applies to the VM cluster. The default is LICENSE_INCLUDED. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the VM cluster. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - MAINTENANCE_IN_PROGRESS + type: string + memorySizeInGBs: + description: The memory allocated in GBs. + type: integer + ocpusEnabled: + description: The number of enabled OCPU cores. + format: float + minimum: 0.1 + type: number + recoStoragePercentage: + description: | + The percentage assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + shape: + description: | + The shape of the Exadata infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance. + type: string + sparseStoragePercentage: + description: | + The percentage assigned to SPARSE storage (Exadata snapshots). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + sshPublicKeys: + description: The public key portion of one or more key pairs used for SSH access to the VM cluster. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + systemVersion: + description: Operating system version of the image. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: The date and time that the VM cluster was created. + format: date-time + type: string + timeZone: + description: The time zone of the Exadata infrastructure. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). + format: x-obmcs-time-zone + maxLength: 255 + minLength: 1 + type: string + vmBackupStorageType: + description: Specifies the type of VM Backups Storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then VM Backups storage will be on DB Servers. - EXASCALE if selected then VM Backups storage will be on Exascale Storage Servers. Default Value is LOCAL. + enum: + - LOCAL + - EXASCALE + type: string + vmClusterNetworkId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network. + maxLength: 255 + minLength: 1 + type: string + vmFileSystemStorageType: + description: Specifies the type of file system storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then file system storage will be on DB Servers. - EXASCALE if selected then file system storage will be on Exascale Storage Servers. Default Value is LOCAL + enum: + - LOCAL + - EXASCALE + type: string + type: object + CreateVmClusterDetails: + description: | + Details for the create Exadata VM cluster operation. Applies to Exadata Cloud@Customer instances only. + For details on the create cloud Exadata VM cluster operation used with Exadata Cloud Service instances, see [CreateCloudVmClusterDetails Reference](#/en/database/latest/datatypes/CreateCloudVmClusterDetails) + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + cpuCoreCount: + description: The number of ECPUs (X11M and higher) or number of OCPUs (X10M and earlier) to enable for the VM cluster. + type: integer + dataCollectionOptions: + $ref: '#/components/schemas/DataCollectionOptions' + dataStoragePercentage: + description: | + The percentage assigned to DATA storage (user data and database files). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + dataStorageSizeInGBs: + description: The data disk group size to be allocated in GBs. + format: double + minimum: 32 + type: number + dataStorageSizeInTBs: + description: The data disk group size to be allocated in TBs. + format: double + type: number + dbNodeStorageSizeInGBs: + description: The local node storage to be allocated in GBs. + type: integer + dbServers: + description: The list of Db server. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the VM cluster. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + exadataInfrastructureId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + fileSystemConfigurationDetails: + description: Details of the file system configuration of the VM cluster. + items: + $ref: '#/components/schemas/FileSystemConfigurationDetail' + maxItems: 1024 + type: array + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + giVersion: + description: The Oracle Grid Infrastructure software version for the VM cluster. + maxLength: 255 + minLength: 1 + type: string + isLocalBackupEnabled: + description: | + If true, database backup on local Exadata storage is configured for the VM cluster. If false, database backup on local Exadata storage is not available in the VM cluster. + type: boolean + isSparseDiskgroupEnabled: + description: | + If true, the sparse disk group is configured for the VM cluster. If false, the sparse disk group is not created. + type: boolean + licenseModel: + description: | + The Oracle license model that applies to the VM cluster. The default is BRING_YOUR_OWN_LICENSE. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + memorySizeInGBs: + description: The memory to be allocated in GBs. + type: integer + ocpuCount: + description: The number of OCPU cores to enable for the VM cluster. Only one decimal place is allowed for the fractional part. + format: float + minimum: 0.1 + type: number + x-example: 0.2 + recoStoragePercentage: + description: | + The percentage assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + sparseStoragePercentage: + description: | + The percentage assigned to SPARSE storage (Exadata snapshots). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + sshPublicKeys: + description: The public key portion of one or more key pairs used for SSH access to the VM cluster. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + systemVersion: + description: Operating system version of the image. + maxLength: 255 + minLength: 1 + type: string + timeZone: + description: The time zone to use for the VM cluster. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm). + format: x-obmcs-time-zone + maxLength: 255 + minLength: 1 + type: string + vmBackupStorageType: + default: + - LOCAL + description: Specifies the type of VM Backups Storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then VM Backups storage will be on DB Servers. - EXASCALE if selected then VM Backups storage will be on Exascale Storage Servers. Default Value is LOCAL + enum: + - LOCAL + - EXASCALE + type: string + vmClusterNetworkId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network. + maxLength: 255 + minLength: 1 + type: string + vmFileSystemStorageType: + default: + - LOCAL + description: Specifies the type of file system storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then file system storage will be on DB Servers. - EXASCALE if selected then file system storage will be on Exascale Storage Servers. Default Value is LOCAL + enum: + - LOCAL + - EXASCALE + type: string + required: + - compartmentId + - displayName + - exadataInfrastructureId + - cpuCoreCount + - vmClusterNetworkId + - sshPublicKeys + - giVersion + type: object + VmCluster: + description: | + Details of the VM cluster resource. Applies to Exadata Cloud@Customer instances only. + properties: + availabilityDomain: + description: The name of the availability domain that the VM cluster is located in. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + computeModel: + description: | + The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. + enum: + - ECPU + - OCPU + type: string + x-default-description: Null used when unspecified. + cpusEnabled: + description: The number of enabled CPU cores. + type: integer + dataCollectionOptions: + $ref: '#/components/schemas/DataCollectionOptions' + dataStoragePercentage: + description: | + The percentage assigned to DATA storage (user data and database files). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + dataStorageSizeInGBs: + description: Size of the DATA disk group in GBs. + format: double + minimum: 32 + type: number + dataStorageSizeInTBs: + description: Size, in terabytes, of the DATA disk group. + format: double + type: number + dbNodeStorageSizeInGBs: + description: The local node storage allocated in GBs. + type: integer + dbServers: + description: The list of Db server. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Exadata Cloud@Customer VM cluster. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + exadataInfrastructureId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + fileSystemConfigurationDetails: + description: Details of the file system configuration of the VM cluster. + items: + $ref: '#/components/schemas/FileSystemConfigurationDetail' + maxItems: 1024 + type: array + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + giSoftwareImageId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of a grid infrastructure software image. This is a database software image of the type `GRID_IMAGE`. + maxLength: 255 + type: string + giVersion: + description: The Oracle Grid Infrastructure software version for the VM cluster. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster. + maxLength: 255 + minLength: 1 + type: string + isLocalBackupEnabled: + description: | + If true, database backup on local Exadata storage is configured for the VM cluster. If false, database backup on local Exadata storage is not available in the VM cluster. + type: boolean + isSparseDiskgroupEnabled: + description: | + If true, sparse disk group is configured for the VM cluster. If false, sparse disk group is not created. + type: boolean + lastPatchHistoryEntryId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the last patch history. This value is updated as soon as a patch operation starts. + maxLength: 255 + minLength: 1 + type: string + licenseModel: + description: | + The Oracle license model that applies to the VM cluster. The default is LICENSE_INCLUDED. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the VM cluster. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + - MAINTENANCE_IN_PROGRESS + type: string + memorySizeInGBs: + description: The memory allocated in GBs. + type: integer + ocpusEnabled: + description: The number of enabled OCPU cores. + format: float + minimum: 0.1 + type: number + recoStoragePercentage: + description: | + The percentage assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + shape: + description: | + The shape of the Exadata infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance. + type: string + sparseStoragePercentage: + description: | + The percentage assigned to SPARSE storage (Exadata snapshots). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + sshPublicKeys: + description: The public key portion of one or more key pairs used for SSH access to the VM cluster. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + systemVersion: + description: Operating system version of the image. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: The date and time that the VM cluster was created. + format: date-time + type: string + timeZone: + description: The time zone of the Exadata infrastructure. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). + format: x-obmcs-time-zone + maxLength: 255 + minLength: 1 + type: string + vmBackupStorageType: + description: Specifies the type of VM Backups Storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then VM Backups storage will be on DB Servers. - EXASCALE if selected then VM Backups storage will be on Exascale Storage Servers. Default Value is LOCAL. + enum: + - LOCAL + - EXASCALE + type: string + vmClusterNetworkId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network. + maxLength: 255 + minLength: 1 + type: string + vmFileSystemStorageType: + description: Specifies the type of file system storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then file system storage will be on DB Servers. - EXASCALE if selected then file system storage will be on Exascale Storage Servers. Default Value is LOCAL + enum: + - LOCAL + - EXASCALE + type: string + type: object + UpdateVmClusterDetails: + description: | + Details for updating the VM cluster. Applies to Exadata Cloud@Customer instances only. + For details on updating a cloud VM cluster in an Exadata Cloud Service instance, see [UpdateCloudVmClusterDetails Reference ](#/en/database/latest/datatypes/UpdateCloudVmClusterDetails) + properties: + cpuCoreCount: + description: The number of CPU cores to enable for the VM cluster. + type: integer + dataCollectionOptions: + $ref: '#/components/schemas/DataCollectionOptions' + dataStoragePercentage: + description: | + The percentage assigned to DATA storage (user data and database files). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + dataStorageSizeInGBs: + description: The data disk group size to be allocated in GBs. + format: double + minimum: 32 + type: number + dataStorageSizeInTBs: + description: The data disk group size to be allocated in TBs. + format: double + type: number + dbNodeStorageSizeInGBs: + description: The local node storage to be allocated in GBs. + type: integer + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + fileSystemConfigurationDetails: + description: Details of the file system configuration of the VM cluster. + items: + $ref: '#/components/schemas/FileSystemConfigurationDetail' + maxItems: 1024 + type: array + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + isLocalBackupEnabled: + description: | + If true, database backup on local Exadata storage is configured for the VM cluster. If false, database backup on local Exadata storage is not available in the VM cluster. + type: boolean + isSparseDiskgroupEnabled: + description: | + If true, sparse disk group is configured for the VM cluster. If false, sparse disk group is not created. + type: boolean + licenseModel: + description: | + The Oracle license model that applies to the VM cluster. The default is BRING_YOUR_OWN_LICENSE. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + memorySizeInGBs: + description: The memory to be allocated in GBs. + type: integer + ocpuCount: + description: The number of OCPU cores to enable for the VM cluster. Only 1 decimal place is allowed for the fractional part. + format: float + minimum: 0.1 + type: number + x-example: 0.2 + recoStoragePercentage: + description: | + The percentage assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + sparseStoragePercentage: + description: | + The percentage assigned to SPARSE storage (Exadata snapshots). See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. + format: int32 + maximum: 100 + minimum: 0 + type: integer + sshPublicKeys: + description: The public key portion of one or more key pairs used for SSH access to the VM cluster. + items: + maxLength: 1024 + minLength: 1 + type: string + type: array + updateDetails: + $ref: '#/components/schemas/VmClusterUpdateDetails' + version: + $ref: '#/components/schemas/PatchDetails' + vmBackupStorageType: + description: Specifies the type of VM Backups Storage and supported values are LOCAL and EXASCALE. Storage Type can only be changed once from LOCAL to EXASCALE. EXASCALE to LOCAL is not permitted. + enum: + - LOCAL + - EXASCALE + type: string + type: object + AddVirtualMachineToVmClusterDetails: + description: | + Details of adding Virtual Machines to the VM Cluster. Applies to Exadata Cloud@Customer instances only. + properties: + dbServers: + description: The list of Exacc DB servers for the cluster to be added. + items: + $ref: '#/components/schemas/DbServerDetails' + type: array + required: + - dbServers + type: object + ChangeVmClusterCompartmentDetails: + description: | + The configuration details for moving the VM cluster. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the VM cluster to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + RemoveVirtualMachineFromVmClusterDetails: + description: | + Details of removing Virtual Machines from the VM Cluster. Applies to Exadata Cloud@Customer instances only. + properties: + dbServers: + description: The list of Exacc DB servers for the cluster to be removed. + items: + $ref: '#/components/schemas/DbServerDetails' + type: array + required: + - dbServers + type: object + VmClusterUpdateHistoryEntrySummary: + description: | + The record of a maintenance update action performed on a specified VM cluster. Applies to Exadata Cloud@Customer instances only. + properties: + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update history entry. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: | + Descriptive text providing additional details about the lifecycle state. + type: string + lifecycleState: + description: The current lifecycle state of the maintenance update operation. + enum: + - IN_PROGRESS + - SUCCEEDED + - FAILED + type: string + timeCompleted: + description: The date and time when the maintenance update action completed. + format: date-time + type: string + timeStarted: + description: The date and time when the maintenance update action started. + format: date-time + type: string + updateAction: + description: The update action performed using this maintenance update. + enum: + - ROLLING_APPLY + - PRECHECK + - ROLLBACK + type: string + updateId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. + maxLength: 255 + minLength: 1 + type: string + updateType: + description: The type of VM cluster maintenance update. + enum: + - GI_UPGRADE + - GI_PATCH + - OS_UPDATE + type: string + required: + - id + - updateId + - lifecycleState + - timeStarted + - updateType + type: object + VmClusterUpdateHistoryEntry: + description: | + The record of a maintenance update action performed on a specified VM cluster. Applies to Exadata Cloud@Customer instances only. + properties: + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update history entry. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: | + Descriptive text providing additional details about the lifecycle state. + type: string + lifecycleState: + description: The current lifecycle state of the maintenance update operation. + enum: + - IN_PROGRESS + - SUCCEEDED + - FAILED + type: string + timeCompleted: + description: The date and time when the maintenance update action completed. + format: date-time + type: string + timeStarted: + description: The date and time when the maintenance update action started. + format: date-time + type: string + updateAction: + description: The update action performed using this maintenance update. + enum: + - ROLLING_APPLY + - PRECHECK + - ROLLBACK + type: string + updateId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. + maxLength: 255 + minLength: 1 + type: string + updateType: + description: The type of VM cluster maintenance update. + enum: + - GI_UPGRADE + - GI_PATCH + - OS_UPDATE + type: string + required: + - id + - updateId + - lifecycleState + - timeStarted + - updateType + type: object + VmClusterUpdateSummary: + description: | + A maintenance update for a VM cluster. Applies to Exadata Cloud@Customer instances only. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + availableActions: + description: The possible actions that can be performed using this maintenance update. + items: + enum: + - ROLLING_APPLY + - PRECHECK + - ROLLBACK + type: string + type: array + description: + description: Details of the maintenance update package. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. + maxLength: 255 + minLength: 1 + type: string + lastAction: + description: The update action performed most recently using this maintenance update. + enum: + - ROLLING_APPLY + - PRECHECK + - ROLLBACK + type: string + lifecycleDetails: + description: | + Descriptive text providing additional details about the lifecycle state. + type: string + lifecycleState: + description: The current state of the maintenance update. Dependent on value of `lastAction`. + enum: + - AVAILABLE + - SUCCESS + - IN_PROGRESS + - FAILED + type: string + timeReleased: + description: The date and time the maintenance update was released. + format: date-time + type: string + updateType: + description: The type of VM cluster maintenance update. + enum: + - GI_UPGRADE + - GI_PATCH + - OS_UPDATE + type: string + version: + description: The version of the maintenance update package. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - description + - version + - timeReleased + - updateType + type: object + VmClusterUpdate: + description: | + A maintenance update for a VM cluster. Applies to Exadata Cloud@Customer instances only. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + availableActions: + description: The possible actions that can be performed using this maintenance update. + items: + enum: + - ROLLING_APPLY + - PRECHECK + - ROLLBACK + type: string + type: array + description: + description: Details of the maintenance update package. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. + maxLength: 255 + minLength: 1 + type: string + lastAction: + description: The update action performed most recently using this maintenance update. + enum: + - ROLLING_APPLY + - PRECHECK + - ROLLBACK + type: string + lifecycleDetails: + description: | + Descriptive text providing additional details about the lifecycle state. + type: string + lifecycleState: + description: The current state of the maintenance update. Dependent on value of `lastAction`. + enum: + - AVAILABLE + - SUCCESS + - IN_PROGRESS + - FAILED + type: string + timeReleased: + description: The date and time the maintenance update was released. + format: date-time + type: string + updateType: + description: The type of VM cluster maintenance update. + enum: + - GI_UPGRADE + - GI_PATCH + - OS_UPDATE + type: string + version: + description: The version of the maintenance update package. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - description + - version + - timeReleased + - updateType + type: object + Error: + properties: + code: + description: | + A short error code that defines the error, meant for programmatic parsing. See + [API Errors](/Content/API/References/apierrors.htm). + type: string + message: + description: A human-readable error string. + type: string + required: + - code + - message + type: object + AutonomousContainerDatabaseBackupSummary: + description: | + An Autonomous Container Database backup. + To use any API operation, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + acdDisplayName: + description: The user-friendly name for the Autonomous Container Database when the Backup was initiated. This name need not be unique. This field captures the name at the time of backup creation, accounting for possible later updates to the display name. + maxLength: 255 + minLength: 1 + type: string + autonomousContainerDatabaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous Container Database. + maxLength: 255 + minLength: 1 + type: string + autonomousDatabases: + description: List of Autonomous AI Databases that is part of this Autonomous Container Database Backup + items: + $ref: '#/components/schemas/AutonomousDatabaseInBackup' + type: array + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: A user-friendly name for the backup. This name need not be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup. + maxLength: 255 + minLength: 1 + type: string + infrastructureType: + description: The infrastructure type this resource belongs to. + enum: + - CLOUD + - CLOUD_AT_CUSTOMER + type: string + isAutomatic: + description: Indicates whether the backup is user-initiated or automatic. + type: boolean + isRemoteBackup: + description: Whether backup is for remote-region or local region + type: boolean + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the backup. + enum: + - CREATING + - ACTIVE + - DELETING + - DELETED + - FAILED + type: string + retentionPeriodInDays: + description: Retention period, in days, for long-term backups + maximum: 3650 + minimum: 90 + type: integer + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeEnded: + description: The date and time the backup completed. + format: date-time + type: string + timeStarted: + description: The date and time the backup started. + format: date-time + type: string + type: + description: The type of backup. + enum: + - INCREMENTAL + - FULL + type: string + required: + - id + - compartmentId + - lifecycleState + - autonomousContainerDatabaseId + - displayName + - type + - isAutomatic + type: object + AppVersionSummary: + description: | + The version details specific to an app. + properties: + endOfSupport: + description: The Autonomous Container Database version end of support date. + type: string + isCertified: + description: Indicates if the image is certified. + type: boolean + releaseDate: + description: The Autonomous Container Database version release date. + type: string + supportedAppName: + description: The name of the supported application. + type: string + required: + - releaseDate + - endOfSupport + - supportedAppName + - isCertified + x-example: | + { + "releaseDate": "2022-09-23 06:24:34 +00:00", + "endOfSupport": "2023-09-23 06:24:34 +00:00", + "supportedAppName" : "ADBD_EBS", + "isCertified": true + } + type: object + BackupDestinationConfigurationSummary: + description: Information about the Autonomous Container Database's secondary backup destination(s). + properties: + backupRetentionPolicyOnTerminate: + default: RETAIN_FOR_72_HOURS + description: | + Defines the automatic and manual backup retention policy for the Autonomous AI Database termination. + The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. + Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. + enum: + - RETAIN_PER_RETENTION_WINDOW + - RETAIN_FOR_72_HOURS + type: string + dbrsPolicyId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the backup destination. + maxLength: 255 + minLength: 1 + type: string + internetProxy: + description: Proxy URL to connect to object store. + type: string + isRemote: + default: false + description: Indicates whether the backup destination is cross-region or local. + type: boolean + isRetentionLockEnabled: + description: | + Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. + Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. + If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. + The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. + type: boolean + remoteRegion: + description: | + The name of the remote region where the remote automatic incremental backups will be stored. + For information about valid region names, see + [Regions and Availability Domains](/Content/General/Concepts/regions.htm). + maxLength: 50 + minLength: 1 + type: string + type: + description: Type of the database backup destination. + enum: + - NFS + - RECOVERY_APPLIANCE + - OBJECT_STORE + - LOCAL + - DBRS + - AWS + type: string + vpcPassword: + description: For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. + type: string + vpcUser: + description: For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. + type: string + backupDestinationAttachHistory: + description: The timestamps at which this backup destination is used as the preferred destination to host the Autonomous Container Database backups. + items: + format: date-time + type: string + type: array + spaceUtilizedInGBs: + description: The total space utilized (in GBs) by this Autonomous Container Database on this backup destination, rounded to the nearest integer. + type: integer + timeAtWhichStorageDetailsAreUpdated: + description: The latest timestamp when the backup destination details, such as 'spaceUtilized,' are updated. + format: date-time + type: string + recoveryWindowInDays: + description: Number of days between the current and earliest point of recoverability covered by automatic backups and manual backups, but not long term backups. + type: integer + required: + - type + type: object + AutonomousContainerDatabaseBackupConfig: + description: | + Backup options for the Autonomous Container Database. + properties: + backupDestinationDetails: + description: Backup destination details. + items: + $ref: '#/components/schemas/BackupDestinationDetails' + type: array + recoveryWindowInDays: + description: | + Number of days between the current and the earliest point of recoverability covered by automatic backups. + This value applies to automatic backups. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. + When the value is updated, it is applied to all existing automatic backups. + If the number of specified days is 0 then there will be no backups. + maximum: 95 + minimum: 0 + type: integer + type: object + BackupDestinationProperties: + description: The properties of the backup destination associated with the Autonomous Container Database. + properties: + backupDestinationAttachHistory: + description: The timestamps at which this backup destination is used as the preferred destination to host the Autonomous Container Database backups. + items: + format: date-time + type: string + type: array + spaceUtilizedInGBs: + description: The total space utilized (in GBs) by this Autonomous Container Database on this backup destination, rounded to the nearest integer. + type: integer + timeAtWhichStorageDetailsAreUpdated: + description: The latest timestamp when the backup destination details, such as 'spaceUtilized,' are updated. + format: date-time + type: string + type: object + CustomerContact: + description: | + Customer contact information that will be used by Oracle to provide notifications needed by database and infrastructure administrators. + properties: + email: + description: The email address used by Oracle to send notifications regarding databases and infrastructure. + maxLength: 320 + minLength: 1 + type: string + type: object + AutonomousContainerDatabaseDataguard: + description: | + The properties that define Autonomous Container Databases Dataguard. + properties: + applyLag: + description: | + The lag time between updates to the primary Autonomous Container Database and application of the redo data on the standby Autonomous Container Database, + as computed by the reporting database. + Example: `9 seconds` + type: string + applyRate: + description: | + The rate at which redo logs are synchronized between the associated Autonomous Container Databases. + Example: `180 Mb per second` + type: string + automaticFailoverTarget: + description: | + Automatically selected by backend when observer is enabled. + maxLength: 255 + minLength: 1 + type: string + autonomousContainerDatabaseId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous Container Database that has a relationship with the peer Autonomous Container Database. Used only by Autonomous AI Database on Dedicated Exadata Infrastructure. + maxLength: 255 + minLength: 1 + type: string + availabilityDomain: + description: | + The domain of the Autonomous Container Database + maxLength: 255 + minLength: 1 + type: string + fastStartFailOverLagLimitInSeconds: + description: The lag time for my preference based on data loss tolerance in seconds. + maximum: 3600 + minimum: 5 + type: integer + isAutomaticFailoverEnabled: + description: | + Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association + type: boolean + lifecycleDetails: + description: | + Additional information about the current lifecycleState, if available. + type: string + lifecycleState: + description: The current state of Autonomous Data Guard. + enum: + - PROVISIONING + - AVAILABLE + - ROLE_CHANGE_IN_PROGRESS + - TERMINATING + - TERMINATED + - FAILED + - UNAVAILABLE + - UPDATING + type: string + protectionMode: + description: | + The protection mode of this Autonomous Data Guard association. For more information, see + [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) + in the Oracle Data Guard documentation. + enum: + - MAXIMUM_AVAILABILITY + - MAXIMUM_PERFORMANCE + type: string + redoTransportMode: + description: | + Automatically selected by backend based on the protection mode. + maxLength: 255 + minLength: 1 + type: string + role: + description: | + The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. + enum: + - PRIMARY + - STANDBY + - DISABLED_STANDBY + - BACKUP_COPY + - SNAPSHOT_STANDBY + type: string + timeCreated: + description: The date and time the Autonomous DataGuard association was created. + format: date-time + type: string + timeLagRefreshedOn: + description: Timestamp when the lags were last calculated for a standby. + format: date-time + type: string + timeLastRoleChanged: + description: The date and time when the last role change action happened. + format: date-time + type: string + timeLastSynced: + description: The date and time of the last update to the apply lag, apply rate, and transport lag values. + format: date-time + type: string + transportLag: + description: | + The approximate number of seconds of redo data not yet available on the standby Autonomous Container Database, + as computed by the reporting database. + Example: `7 seconds` + type: string + required: + - lifecycleState + - autonomousContainerDatabaseId + - role + type: object + AutonomousDatabaseKeyHistoryEntry: + description: | + The Autonomous AI Database [Vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. + properties: + id: + description: The id of the Autonomous AI Database [Vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. + type: string + kmsKeyVersionId: + description: | + The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. + maxLength: 255 + minLength: 1 + type: string + timeActivated: + description: The date and time the kms key activated. + format: date-time + type: string + vaultId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. + maxLength: 255 + minLength: 1 + type: string + required: + - id + type: object + MaintenanceWindow: + description: | + The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window. + properties: + customActionTimeoutInMins: + description: | + Determines the amount of time the system will wait before the start of each database server patching operation. + Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). + maximum: 120 + minimum: 15 + type: integer + daysOfWeek: + description: Days during the week when maintenance should be performed. + items: + $ref: '#/components/schemas/DayOfWeek' + type: array + uniqueItems: true + hoursOfDay: + description: The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC + items: + maximum: 20 + minimum: 0 + type: integer + type: array + uniqueItems: true + isCustomActionTimeoutEnabled: + description: If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. + type: boolean + leadTimeInWeeks: + description: | + Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. + maximum: 4 + minimum: 1 + type: integer + months: + description: Months during the year when maintenance should be performed. + items: + $ref: '#/components/schemas/Month' + type: array + uniqueItems: true + patchingMode: + description: | + Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. + + *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See [Oracle-Managed Infrastructure Maintenance Updates](/iaas/Content/Database/Concepts/examaintenance.htm#Oracle) for more information. + enum: + - ROLLING + - NONROLLING + type: string + preference: + default: NO_PREFERENCE + description: The maintenance window scheduling preference. + enum: + - NO_PREFERENCE + - CUSTOM_PREFERENCE + type: string + skipRu: + description: | + If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter. + items: + type: boolean + type: array + weeksOfMonth: + description: | + Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. + For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. + Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. + items: + maximum: 4 + minimum: 1 + type: integer + type: array + uniqueItems: true + type: object + RecoveryApplianceDetails: + description: Information about the recovery appliance configuration associated with the Autonomous Container Database. + properties: + allocatedStorageSizeInGBs: + description: The storage size of the backup destination allocated for an Autonomous Container Database to store backups on the recovery appliance, in GBs, rounded to the nearest integer. + type: integer + recoveryWindowInDays: + description: Number of days between the current and earliest point of recoverability covered by automatic backups. + type: integer + timeRecoveryApplianceDetailsUpdated: + description: The time when the recovery appliance details are updated. + format: date-time + type: string + type: object + PeerAutonomousContainerDatabaseBackupConfig: + description: | + Backup options for the standby Autonomous Container Database. + properties: + backupDestinationDetails: + description: Backup destination details. + items: + $ref: '#/components/schemas/BackupDestinationDetails' + type: array + recoveryWindowInDays: + description: | + Number of days between the current and the earliest point of recoverability covered by automatic backups. + This value applies to automatic backups. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. + When the value is updated, it is applied to all existing automatic backups. + If the number of specified days is 0 then there will be no backups. + maximum: 95 + minimum: 0 + type: integer + type: object + AcdAvmResourceStats: + description: Resource usage by autonomous container database in a particular VM. + properties: + displayName: + description: The user-friendly name for the Autonomous VM. The name does not need to be unique. + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous VM. + type: string + provisionedCpus: + description: CPUs/cores assigned to Autonomous AI Databases for the ACD instance in given Autonomus VM. + format: float + type: number + reclaimableCpus: + description: | + CPUs/cores that continue to be included in the count of OCPUs available to the + Autonomous Container Database in given Autonomous VM, even after one of its + Autonomous AI Database is terminated or scaled down. You can release them to the available + OCPUs at its parent AVMC level by restarting the Autonomous Container Database. + format: float + type: number + reservedCpus: + description: | + CPUs/cores reserved for scalability, resilliency and other overheads. + This includes failover, autoscaling and idle instance overhead. + format: float + type: number + usedCpus: + description: | + CPUs/cores assigned to the ACD instance in given Autonomous VM. Sum of provisioned, + reserved and reclaimable CPUs/ cores to the ACD instance. + format: float + type: number + type: object + BackupDestinationDetails: + description: Backup destination details + properties: + backupRetentionPolicyOnTerminate: + default: RETAIN_FOR_72_HOURS + description: | + Defines the automatic and manual backup retention policy for the Autonomous AI Database termination. + The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. + Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. + enum: + - RETAIN_PER_RETENTION_WINDOW + - RETAIN_FOR_72_HOURS + type: string + dbrsPolicyId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the backup destination. + maxLength: 255 + minLength: 1 + type: string + internetProxy: + description: Proxy URL to connect to object store. + type: string + isRemote: + default: false + description: Indicates whether the backup destination is cross-region or local. + type: boolean + isRetentionLockEnabled: + description: | + Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. + Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. + If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. + The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. + type: boolean + remoteRegion: + description: | + The name of the remote region where the remote automatic incremental backups will be stored. + For information about valid region names, see + [Regions and Availability Domains](/Content/General/Concepts/regions.htm). + maxLength: 50 + minLength: 1 + type: string + type: + description: Type of the database backup destination. + enum: + - NFS + - RECOVERY_APPLIANCE + - OBJECT_STORE + - LOCAL + - DBRS + - AWS + type: string + vpcPassword: + description: For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. + type: string + vpcUser: + description: For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. + type: string + required: + - type + type: object + SourceDatabaseDetails: + description: Source Autonomous AI Database details. + properties: + autonomousContainerDatabaseCustomerContacts: + description: | + Customer Contacts for the Autonomous Container Database. Setting this to an empty list removes all customer contacts. + items: + $ref: '#/components/schemas/CustomerContact' + type: array + autonomousContainerDatabaseDisplayName: + description: The user-provided name for the Autonomous Container Database. + maxLength: 255 + minLength: 1 + type: string + autonomousContainerDatabaseDstFileVersion: + description: DST Time-Zone File version of the Autonomous Container Database. + maxLength: 255 + minLength: 1 + type: string + autonomousContainerDatabaseName: + description: Autonomous Container Database name. + maxLength: 8 + minLength: 2 + type: string + autonomousDatabaseCustomerContacts: + description: Customer Contacts for the Autonomous AI Database. + items: + $ref: '#/components/schemas/CustomerContact' + type: array + autonomousDatabaseName: + description: Autonomous AI Database's name. + maxLength: 14 + minLength: 1 + type: string + autonomousVmClusterDisplayName: + description: Autonomous VM cluster's user-friendly name. + maxLength: 255 + minLength: 1 + type: string + dbWorkload: + description: | + The Autonomous AI Database workload type. The following values are valid: + - OLTP - indicates an Autonomous AI Transaction Processing database + - DW - indicates an Autonomous AI Lakehouse database + - AJD - indicates an Autonomous AI JSON Database + - APEX - indicates an Autonomous AI Database with the Oracle APEX AI Application Development workload type. + - LH - indicates an Oracle Autonomous AI Lakehouse database + + **Note** Starting December 2026, DW will not be supported as a valid value for this parameter. + When creating an Autonomous AI Database, if this parameter is not specified, the default value is `OLTP`. + + + This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. + enum: + - OLTP + - DW + - AJD + - APEX + - LH + type: string + type: object + AutonomousDatabaseSoftwareImageSummary: + description: | + The Database service supports the creation of Autonomous AI Database Software Images for use in creating Autonomous Container Database. + properties: + autonomousDsiOneOffPatches: + description: One-off patches included in the Autonomous AI Database Software Image + items: + type: string + type: array + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + databaseVersion: + description: The database version with which the Autonomous AI Database Software Image is to be built. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the Autonomous AI Database Software Image. The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database Software Image. + maxLength: 255 + minLength: 1 + type: string + imageShapeFamily: + description: To what shape the image is meant for. + type: string + x-obmcs-enumref: '#/definitions/AutonomousDatabaseSoftwareImage/imageShapeFamily' + lifecycleDetails: + description: Detailed message for the lifecycle state. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the Autonomous AI Database Software Image. + type: string + x-obmcs-enumref: '#/definitions/AutonomousDatabaseSoftwareImage/lifecycleState' + releaseUpdate: + description: The Release Updates. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the Autonomous AI Database Software Image was created. + format: date-time + type: string + required: + - id + - compartmentId + - lifecycleState + - displayName + - timeCreated + - releaseUpdate + - databaseVersion + - imageShapeFamily + type: object + AutonomousDatabaseApex: + description: | + Oracle APEX AI Application Development is a low-code development platform that enables you to build scalable, secure enterprise apps, with world-class features. Autonomous AI Database with the APEX workload type is optimized to support APEX development. + properties: + apexVersion: + description: The Oracle APEX AI Application Development version. + maxLength: 255 + minLength: 1 + type: string + ordsVersion: + description: The Oracle REST Data Services (ORDS) version. + maxLength: 255 + minLength: 1 + type: string + type: object + AutonomousDatabaseBackupConfig: + description: | + Autonomous AI Database configuration details for storing [manual backups](https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/backup-restore.html#GUID-9035DFB8-4702-4CEB-8281-C2A303820809) in the [Object Storage](/Content/Object/Concepts/objectstorageoverview.htm) service. + properties: + manualBackupBucketName: + description: Name of [Object Storage](/Content/Object/Concepts/objectstorageoverview.htm) bucket to use for storing manual backups. + type: string + manualBackupType: + description: The manual backup destination type. + enum: + - NONE + - OBJECT_STORE + type: string + type: object + AutonomousDatabaseConnectionStrings: + description: | + Connection strings to connect to an Oracle Autonomous AI Database. + + Example output for connection strings. See [DatabaseConnectionStringProfile](#/en/database/latest/datatypes/DatabaseConnectionStringProfile) for additional details: + + "connectionStrings": { + "allConnectionStrings": { + "HIGH": "adb.region.oraclecloud.com:1522/unique_id_databasename_high.adwc.oraclecloud.com", + "LOW": "adb.region.oraclecloud.com:1522/unique_id_databasename_low.adwc.oraclecloud.com", + "MEDIUM": "adb.region.oraclecloud.com:1522/unique_id_databasename_medium.adwc.oraclecloud.com" + }, + "profiles": [ + { + "displayName": "databasename_high", + "value": "(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.region.oraclecloud.com))(connect_data=(service_name=unique_id_databasename_high.adwc.oraclecloud.com))(security=(ssl_server_cert_dn="CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US")))", + "consumerGroup": "HIGH", + "protocol": "TCPS", + "tlsAuthentication": "MUTUAL", + "hostFormat": "FQDN", + "sessionMode": "DIRECT", + "syntaxFormat": "LONG" + }, + { + "displayName": "databasename_low", + "value": "(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.region.oraclecloud.com))(connect_data=(service_name=unique_id_databasename_low.adwc.oraclecloud.com))(security=(ssl_server_cert_dn="CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US")))", + "consumerGroup": "LOW", + "protocol": "TCPS", + "tlsAuthentication": "MUTUAL", + "hostFormat": "FQDN", + "sessionMode": "DIRECT", + "syntaxFormat": "LONG" + }, + { + "displayName": "databasename_medium", + "value": "(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.region.oraclecloud.com))(connect_data=(service_name=unique_id_databasename_medium.adwc.oraclecloud.com))(security=(ssl_server_cert_dn="CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US")))", + "consumerGroup": "MEDIUM", + "protocol": "TCPS", + "tlsAuthentication": "MUTUAL", + "hostFormat": "FQDN", + "sessionMode": "DIRECT", + "syntaxFormat": "LONG" + } + ], + "dedicated": null, + "high": "adb.region.oraclecloud.com:1522/unique_id_databasename_high.adwc.oraclecloud.com", + "low": "adb.region.oraclecloud.com:1522/unique_id_databasename_low.adwc.oraclecloud.com", + "medium": "adb.region.oraclecloud.com:1522/unique_id_databasename_medium.adwc.oraclecloud.com" + } + properties: + allConnectionStrings: + additionalProperties: + type: string + description: | + Returns all connection strings that can be used to connect to the Autonomous AI Database. + For more information, please see [Predefined Database Service Names for Autonomous AI Transaction Processing](https://docs.oracle.com/en/cloud/paas/atp-cloud/atpug/connect-predefined.html#GUID-9747539B-FD46-44F1-8FF8-F5AC650F15BE) + type: object + dedicated: + description: The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. + maxLength: 255 + minLength: 10 + type: string + high: + description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. + maxLength: 255 + minLength: 10 + type: string + low: + description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. + maxLength: 255 + minLength: 10 + type: string + medium: + description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. + maxLength: 255 + minLength: 10 + type: string + profiles: + description: | + A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata. + items: + $ref: '#/components/schemas/DatabaseConnectionStringProfile' + type: array + type: object + AutonomousDatabaseConnectionUrls: + description: | + The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. Note that these URLs are provided by the console only for databases on [dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html). + + Example: `{"sqlDevWebUrl": "https:///ords...", "apexUrl", "https:///ords..."}` + properties: + apexUrl: + description: Oracle Application Express (APEX) URL. + maxLength: 512 + minLength: 10 + type: string + databaseTransformsUrl: + description: The URL of the Database Transforms for the Autonomous AI Database. + maxLength: 512 + minLength: 10 + type: string + graphStudioUrl: + description: The URL of the Graph Studio for the Autonomous AI Database. + maxLength: 512 + minLength: 10 + type: string + machineLearningNotebookUrl: + description: The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous AI Database. + maxLength: 512 + minLength: 10 + type: string + machineLearningUserManagementUrl: + description: Oracle Machine Learning user management URL. + maxLength: 512 + minLength: 10 + type: string + mongoDbUrl: + description: The URL of the MongoDB API for the Autonomous AI Database. + maxLength: 512 + minLength: 10 + type: string + ordsUrl: + description: The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous AI Database. + maxLength: 512 + minLength: 10 + type: string + sqlDevWebUrl: + description: Oracle SQL Developer Web URL. + maxLength: 512 + minLength: 10 + type: string + type: object + DatabaseTool: + description: Summary of database tools of Autonomous AI Database. + properties: + isEnabled: + default: false + description: Indicates whether tool is enabled. + type: boolean + name: + description: Name of database tool. + enum: + - APEX + - DATABASE_ACTIONS + - GRAPH_STUDIO + - OML + - DATA_TRANSFORMS + - ORDS + - MONGODB_API + type: string + required: + - name + type: object + AutonomousDatabaseEncryptionKeyDetails: + description: Details of the Autonomous AI Database encryption key. + discriminator: + propertyName: provider + properties: + provider: + description: The provider for the Autonomous AI Database encryption key. + enum: + - AWS + - AZURE + - OCI + - ORACLE_MANAGED + - OKV + type: string + type: object + AutonomousDatabaseEncryptionKeyHistoryEntry: + description: The Autonomous AI Database encryption key history entry. + properties: + encryptionKey: + $ref: '#/components/schemas/AutonomousDatabaseEncryptionKeyDetails' + timeActivated: + description: The date and time the encryption key was activated. + format: date-time + type: string + type: object + AutonomousDatabaseStandbySummary: + description: | + Autonomous Data Guard standby database details. + properties: + availabilityDomain: + description: The availability domain of a local Autonomous Data Guard standby database of an Autonomous AI Database Serverless instance. + maxLength: 255 + minLength: 1 + type: string + lagTimeInSeconds: + description: The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. + type: integer + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the Autonomous AI Database. + enum: + - PROVISIONING + - AVAILABLE + - STOPPING + - STOPPED + - STARTING + - TERMINATING + - TERMINATED + - UNAVAILABLE + - RESTORE_IN_PROGRESS + - RESTORE_FAILED + - BACKUP_IN_PROGRESS + - SCALE_IN_PROGRESS + - AVAILABLE_NEEDS_ATTENTION + - UPDATING + - MAINTENANCE_IN_PROGRESS + - RESTARTING + - RECREATING + - ROLE_CHANGE_IN_PROGRESS + - UPGRADING + - INACCESSIBLE + - STANDBY + - TRANSPORTING + type: string + maintenanceTargetComponent: + description: The component chosen for maintenance. + type: string + timeDataGuardRoleChanged: + description: The date and time the Autonomous Data Guard role was switched for the standby Autonomous AI Database. + format: date-time + type: string + timeDisasterRecoveryRoleChanged: + description: The date and time the Disaster Recovery role was switched for the standby Autonomous AI Database. + format: date-time + type: string + timeMaintenanceBegin: + description: The date and time when maintenance will begin. + format: date-time + type: string + timeMaintenanceEnd: + description: The date and time when maintenance will end. + format: date-time + type: string + type: object + LongTermBackUpScheduleDetails: + description: Details for the long-term backup schedule. + properties: + isDisabled: + default: false + description: | + Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`. + type: boolean + repeatCadence: + description: The frequency of the long-term backup schedule + enum: + - ONE_TIME + - WEEKLY + - MONTHLY + - YEARLY + type: string + retentionPeriodInDays: + description: Retention period, in days, for long-term backups + maximum: 3650 + minimum: 90 + type: integer + timeOfBackup: + description: The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month. + format: date-time + type: string + type: object + DisasterRecoveryConfiguration: + description: Configurations of a Disaster Recovery. + properties: + disasterRecoveryType: + description: | + Indicates the disaster recovery (DR) type of the Autonomous AI Database Serverless instance. + Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. + Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. + enum: + - ADG + - BACKUP_BASED + type: string + isReplicateAutomaticBackups: + description: If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database. + type: boolean + isSnapshotStandby: + description: | + Indicates if user wants to convert to a snapshot standby. For example, true would set a standby database to snapshot standby database. False would set a snapshot standby database back to regular standby database. + type: boolean + timeSnapshotStandbyEnabledTill: + description: Time and date stored as an RFC 3339 formatted timestamp string. For example, 2022-01-01T12:00:00.000Z would set a limit for the snapshot standby to be converted back to a cross-region standby database. + format: date-time + type: string + type: object + ResourcePoolSummary: + description: The configuration details for resource pool + properties: + availableComputeCapacity: + description: Available capacity left for new elastic pool members provision + type: integer + isDisabled: + description: | + Indicates if the resource pool should be deleted for the Autonomous AI Database. + type: boolean + poolSize: + description: Resource pool size. + type: integer + totalComputeCapacity: + description: Resource Pool total capacity, it's currently 4x of pool size + type: integer + type: object + ScheduledOperationDetails: + description: | + Details of scheduled operation. + properties: + dayOfWeek: + $ref: '#/components/schemas/DayOfWeek' + scheduledStartTime: + description: auto start time. value must be of ISO-8601 format "HH:mm" + maxLength: 50 + minLength: 1 + type: string + scheduledStopTime: + description: auto stop time. value must be of ISO-8601 format "HH:mm" + maxLength: 50 + minLength: 1 + type: string + required: + - dayOfWeek + type: object + ResourcePoolShapeSummary: + description: | + An Autonomous AI Database Resource Pool. This object provides all the information related to the resource pool. + properties: + shape: + description: | + Predefined shape of the resource pool. + type: integer + required: + - shape + type: object + ChangeSubscriptionDetails: + description: | + The configuration details for associating the resource with a different subscription. + properties: + isDefault: + description: | + Indicates if the subscription is UCM or not. + type: boolean + subscriptionId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. + maxLength: 255 + minLength: 1 + type: string + type: object + EstimateCostSavingSummary: + description: Autonomous AI Database cost savings. + properties: + costSavingsWithElasticPool: + description: Estimated cost savings in percentage with elastic pool utilization. + format: double + type: number + estimatedUsageWithoutElasticPool: + description: CPU cost for a given time period under regular billing plan, in ECPU hours. + format: int64 + type: integer + isCpuAutoscale: + description: Indicates if CPU autoscaling is applied. + type: boolean + timeEnded: + description: The epoch time at which cost aggregation ends. + format: date-time + type: string + timeStarted: + description: The epoch time at which cost aggregation starts. + format: date-time + type: string + usageWithElasticPool: + description: CPU cost for a given time period under elastic pool billing plan, in ECPU hours. + format: int64 + type: integer + type: object + AutonomousDatabasePeerSummary: + description: | + The object holds details about a peer Autonomous AI Database for Oracle Autonomous AI Database. + properties: + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database. + maxLength: 255 + minLength: 1 + type: string + region: + description: The name of the region where this peer Autonomous AI Database clone exists. + type: string + required: + - id + type: object + RefreshableCloneSummary: + description: An Autonomous AI Database refreshable clone + properties: + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database. + maxLength: 255 + minLength: 1 + type: string + region: + description: The name of the region where the refreshable clone exists. + type: string + required: + - id + - region + type: object + ResourcePoolMemberSummary: + description: An Autonomous AI Database resource pool member summary. + properties: + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database. + maxLength: 255 + minLength: 1 + type: string + required: + - id + type: object + WorkloadType: + description: | + The number of consumed OCPUs, by database workload type. + properties: + adw: + description: The total number of OCPU cores in use for Autonomous AI Lakehouse databases in the infrastructure instance. + format: float + maximum: 92 + minimum: 0 + type: number + atp: + description: The total number of OCPU cores in use for Autonomous AI Transaction Processing databases in the infrastructure instance. + format: float + maximum: 92 + minimum: 0 + type: number + type: object + AutonomousVmResourceUsage: + description: Autonomous VM usage statistics. + properties: + autonomousContainerDatabaseUsage: + description: Associated Autonomous Container Database Usages. + items: + $ref: '#/components/schemas/AvmAcdResourceStats' + maxItems: 1024 + type: array + availableCpus: + description: The number of CPU cores available. + format: float + type: number + displayName: + description: The user-friendly name for the Autonomous VM cluster. The name does not need to be unique. + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous VM Cluster. + type: string + provisionedCpus: + description: The number of CPUs provisioned in an Autonomous VM Cluster. + format: float + type: number + reclaimableCpus: + description: | + CPU cores that continue to be included in the count of OCPUs available to the + Autonomous Container Database even after one of its Autonomous AI Database is + terminated or scaled down. You can release them to the available OCPUs at its + parent AVMC level by restarting the Autonomous Container Database. + format: float + type: number + reservedCpus: + description: The number of CPUs reserved in an Autonomous VM Cluster. + format: float + type: number + usedCpus: + description: | + The number of CPU cores alloted to the Autonomous Container Databases in an Cloud Autonomous VM cluster. + format: float + type: number + required: + - displayName + type: object + AssociatedDatabaseDetails: + description: Databases associated with a backup destination + properties: + dbName: + description: The display name of the database that is associated with the backup destination. + maxLength: 8 + minLength: 1 + type: string + id: + description: The database [OCID](/Content/General/Concepts/identifiers.htm). + maxLength: 255 + minLength: 1 + type: string + type: object + AssociatedLongTermBackup: + description: Long Term Backups associated with a backup destination + properties: + displayName: + description: The display name for the long term backup for the Autonomous AI Database. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup. + maxLength: 255 + minLength: 1 + type: string + type: object + DefinedFileSystemConfiguration: + description: Details of the file system configuration of the Exadata infrastructure. + properties: + isBackupPartition: + description: If true, the file system is used to create a backup prior to Exadata VM OS update. + type: boolean + isResizable: + description: If true, the file system resize is allowed for the Exadata Infrastructure cluster. If false, the file system resize is not allowed. + type: boolean + minSizeGb: + description: The minimum size of file system. + type: integer + mountPoint: + description: The mount point of file system. + type: string + type: object + ExascaleConfigDetails: + description: | + The exascale config response details for the Exadata Cloud@Customer infrastructure or cloud Exadata infrastructure . Applies to both Exadata Cloud@Customer instances and Exadata Cloud Service instances. + properties: + availableStorageInGBs: + description: Available storage size for Exascale in GBs. + type: integer + totalStorageInGBs: + description: Storage size needed for Exascale in GBs. + type: integer + required: + - totalStorageInGBs + type: object + MaintenanceVersionPreferenceDetails: + description: | + The preferences for target versions of future maintenance runs. + + Currently these preferences are only supported for Monthly maintenance runs created via scheduling plans + If no preferences are specified then the version will be set by default to "Latest". Changing preferences + will not change versions for an already existing maintenance run. + properties: + referenceResourceIdForImageUpdates: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the resource the maintenance run will refer to when trying to fetch target versions. + maxLength: 255 + minLength: 1 + type: string + type: object + CloudAutonomousVmClusterResourceDetails: + description: Unallocated resource details of the Cloud Autonomous VM Cluster. + properties: + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Cloud Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + unAllocatedAdbStorageInTBs: + description: Total unallocated autonomous data storage in the Cloud Autonomous VM Cluster in TBs. + format: double + type: number + required: + - id + - unAllocatedAdbStorageInTBs + type: object + DataCollectionOptions: + description: | + Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. + properties: + isDiagnosticsEventsEnabled: + description: | + Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` or `updateCloudVmCluster` API. + type: boolean + isHealthMonitoringEnabled: + description: | + Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. + Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster`, `UpdateCloudVmCluster` or `updateDbsystem` API. + type: boolean + isIncidentLogsEnabled: + description: | + Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. + Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster`, `updateCloudVmCluster` or `updateDbsystem` API. + type: boolean + type: object + FileSystemConfigurationDetail: + description: Details of the file system configuration of the VM cluster. + properties: + fileSystemSizeGb: + description: The file system size to be allocated in GBs. + type: integer + mountPoint: + description: The mount point of file system. + type: string + type: object + IdentityConnectorDetails: + description: Details of the identity connector + properties: + cloudProvider: + description: Cloud provider + enum: + - AZURE + type: string + x-default-description: 'null' + id: + description: The OCID of the identity connector + type: string + type: object + UpdateDetails: + description: | + Details specifying which maintenance update to apply to the cloud VM cluster and which actions are to be performed by the maintenance update. Applies to Exadata Cloud Service instances only. + properties: + giSoftwareImageId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of a grid infrastructure software image. This is a database software image of the type `GRID_IMAGE`. + maxLength: 255 + type: string + updateAction: + description: The update action. + enum: + - ROLLING_APPLY + - NON_ROLLING_APPLY + - PRECHECK + - ROLLBACK + type: string + updateId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. + maxLength: 255 + minLength: 1 + type: string + type: object + dbIormConfig: + description: | + The IORM configuration settings for the database. + properties: + dbName: + description: | + The database name. For the default `DbPlan`, the `dbName` is `default`. + type: string + flashCacheLimit: + description: | + The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. + type: string + share: + description: | + The relative priority of this database. + maximum: 32 + minimum: 1 + type: integer + type: object + ExadataIormConfigUpdateDetails: + description: | + IORM Setting details for this Exadata System to be updated + properties: + dbPlans: + description: | + Array of IORM Setting for all the database in + this Exadata DB System + items: + $ref: '#/components/schemas/dbIormConfigUpdateDetail' + type: array + objective: + description: | + Value for the IORM objective + Default is "Auto" + enum: + - LOW_LATENCY + - HIGH_THROUGHPUT + - BALANCED + - AUTO + - BASIC + type: string + type: object + CloudDbServerDetails: + description: | + Details of the ExaDB-D DB server. Applies to Exadata Cloud instances only. + properties: + dbServerId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of ExaDB-D DB server. + maxLength: 255 + minLength: 1 + type: string + required: + - dbServerId + type: object + DatabaseConnectionStrings: + description: | + Connection strings to connect to an Oracle Database. + properties: + allConnectionStrings: + additionalProperties: + type: string + description: All connection strings to use to connect to the Database. + type: object + cdbDefault: + description: Host name based CDB Connection String. + maxLength: 255 + minLength: 10 + type: string + cdbIpDefault: + description: IP based CDB Connection String. + maxLength: 255 + minLength: 10 + type: string + type: object + DataGuardGroup: + description: | + Details of Data Guard setup that the given database is part of. + Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration. + properties: + members: + description: List of Data Guard members, representing each database that is part of Data Guard. + items: + $ref: '#/components/schemas/DataGuardGroupMember' + type: array + protectionMode: + description: | + The protection mode of this Data Guard. For more information, see + [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) + in the Oracle Data Guard documentation. + enum: + - MAXIMUM_AVAILABILITY + - MAXIMUM_PERFORMANCE + - MAXIMUM_PROTECTION + type: string + type: object + CloudDatabaseManagementConfig: + description: The configuration of the Database Management service. + properties: + managementStatus: + description: The status of the Database Management service. + enum: + - ENABLING + - ENABLED + - DISABLING + - DISABLED + - UPDATING + - FAILED_ENABLING + - FAILED_DISABLING + - FAILED_UPDATING + type: string + managementType: + default: BASIC + description: The Database Management type. + enum: + - BASIC + - ADVANCED + type: string + required: + - managementStatus + - managementType + type: object + DbBackupConfig: + description: | + Backup Options + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + autoBackupEnabled: + description: If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work. + type: boolean + autoBackupWindow: + description: | + Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). + + Example: `SLOT_TWO` + enum: + - SLOT_ONE + - SLOT_TWO + - SLOT_THREE + - SLOT_FOUR + - SLOT_FIVE + - SLOT_SIX + - SLOT_SEVEN + - SLOT_EIGHT + - SLOT_NINE + - SLOT_TEN + - SLOT_ELEVEN + - SLOT_TWELVE + type: string + autoFullBackupDay: + default: SUNDAY + description: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday. + enum: + - SUNDAY + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + type: string + autoFullBackupWindow: + description: | + Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). + + Example: `SLOT_TWO` + enum: + - SLOT_ONE + - SLOT_TWO + - SLOT_THREE + - SLOT_FOUR + - SLOT_FIVE + - SLOT_SIX + - SLOT_SEVEN + - SLOT_EIGHT + - SLOT_NINE + - SLOT_TEN + - SLOT_ELEVEN + - SLOT_TWELVE + type: string + x-default-description: 'null' + backupDeletionPolicy: + description: This defines when the backups will be deleted. - DELETE_IMMEDIATELY option keep the backup for predefined time i.e 72 hours and then delete permanently... - DELETE_AFTER_RETENTION_PERIOD will keep the backups as per the policy defined for database backups. + enum: + - DELETE_IMMEDIATELY + - DELETE_AFTER_RETENTION_PERIOD + type: string + backupDestinationDetails: + description: Backup destination details. + items: + $ref: '#/components/schemas/BackupDestinationDetails' + type: array + recoveryWindowInDays: + description: | + Number of days between the current and the earliest point of recoverability covered by automatic backups. + This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. + When the value is updated, it is applied to all existing automatic backups. + maximum: 60 + minimum: 1 + type: integer + runImmediateFullBackup: + default: true + description: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately. + type: boolean + type: object + ManagedSoftwareUpdateDetails: + description: | + The database registered for Oracle Managed Database Software Updates. + properties: + isEnrolled: + description: | + If true, database is registered for Oracle Managed Database Software Updates otherwise database is not registered for Oracle Managed Database Software Updates + type: boolean + maintenanceDetails: + $ref: '#/components/schemas/ManagedSoftwareUpdateMaintenanceDetails' + preferenceDetails: + $ref: '#/components/schemas/ManagedSoftwareUpdatePreferenceDetails' + required: + - isEnrolled + type: object + DatabaseStorageSizeResponseDetails: + description: | + The database storage size details. This database option is supported for the Exadata VM cluster on Exascale Infrastructure. + properties: + dataStorageSizeInGBs: + description: | + The DATA storage size, in gigabytes, that is applicable for the database. + type: integer + recoStorageSizeInGBs: + description: | + The RECO storage size, in gigabytes, that is applicable for the database. + type: integer + redoLogStorageSizeInGBs: + description: | + The REDO Log storage size, in gigabytes, that is applicable for the database. + type: integer + required: + - dataStorageSizeInGBs + - recoStorageSizeInGBs + - redoLogStorageSizeInGBs + type: object + ManagedSoftwareUpdateInputDetails: + description: | + The database registered for Oracle Managed Database Software Updates. + properties: + isEnrolled: + description: | + If true, database is registered for Oracle Managed Database Software Updates otherwise database is not registered for Oracle Managed Database Software Updates + type: boolean + preferenceDetails: + $ref: '#/components/schemas/ManagedSoftwareUpdatePreferenceDetails' + required: + - isEnrolled + type: object + DatabaseStorageSizeDetails: + description: | + The database storage size details. This database option is supported for the Exadata VM cluster on Exascale Infrastructure. + properties: + dataStorageSizeInGBs: + description: | + The DATA storage size, in gigabytes, that is applicable for the database. + type: integer + recoStorageSizeInGBs: + description: | + The RECO storage size, in gigabytes, that is applicable for the database. + type: integer + required: + - dataStorageSizeInGBs + - recoStorageSizeInGBs + type: object + ConvertToPdbTargetBase: + description: | + Details of the container database in which the converted pluggable database will be located. + discriminator: + propertyName: target + properties: + target: + description: | + The target container database of the pluggable database created by the database conversion operation. Currently, the database conversion operation only supports creating the pluggable database in a new container database. + - Use `NEW_DATABASE` to specify that the pluggable database be created within a new container database in the same database home. + enum: + - NEW_DATABASE + type: string + type: object + DatabaseCredentialDetails: + description: | + Data for the credential used to connect to the database. + properties: + passwordSecretId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [secret](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). + maxLength: 255 + minLength: 1 + type: string + userName: + description: The name of the Oracle Database user that will be used to connect to the database. + maxLength: 255 + minLength: 1 + type: string + required: + - userName + - passwordSecretId + type: object + DatabaseUpgradeSourceBase: + description: | + Details for the database upgrade source. + discriminator: + propertyName: source + properties: + options: + description: | + Additional upgrade options supported by DBUA(Database Upgrade Assistant). + Example: "-upgradeTimezone false -keepEvents" + type: string + source: + description: | + The source of the Oracle Database software to be used for the upgrade. + - Use `DB_HOME` to specify an existing Database Home to upgrade the database. The database is moved to the target Database Home and makes use of the Oracle Database software version of the target Database Home. + - Use `DB_VERSION` to specify a generally-available Oracle Database software version to upgrade the database. + - Use `DB_SOFTWARE_IMAGE` to specify a [database software image](/iaas/Content/Database/Concepts/databasesoftwareimage.htm) to upgrade the database. + enum: + - DB_HOME + - DB_VERSION + - DB_SOFTWARE_IMAGE + type: string + type: object + AssociatedResourceDetails: + description: Details about the resources associated with the connection bundle. + properties: + resourceIds: + description: The OCIDs of the associated resources. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + required: + - resourceIds + type: object + PatchDetails: + description: | + The details about what actions to perform and using what patch to the specified target. + This is part of an update request that is applied to a version field on the target such + as DB system, Database Home, etc. + properties: + action: + description: The action to perform on the patch. + enum: + - APPLY + - PRECHECK + type: string + databaseSoftwareImageId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database software image. + maxLength: 255 + minLength: 1 + type: string + patchId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the patch. + maxLength: 255 + minLength: 1 + type: string + type: object + ConsoleHistorySummary: + description: | + The details of the Db Node console history. + properties: + compartmentId: + description: The OCID of the compartment containing the console history. + maxLength: 255 + minLength: 1 + type: string + dbNodeId: + description: The OCID of the database node. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the console history. The name does not need to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the console history. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the console history. + enum: + - REQUESTED + - GETTING_HISTORY + - SUCCEEDED + - FAILED + - DELETED + - DELETING + type: string + timeCreated: + description: The date and time the console history was created. + format: date-time + type: string + required: + - id + - compartmentId + - dbNodeId + - lifecycleState + - timeCreated + x-example: | + { + "id": "ocid1.consolehistory.oc1.iad.exampleunique_ID", + "displayName" : "console-history-20221202-1943", + "compartmentId": "ocid1.compartment.oc1.iad.exampleunique_ID", + "dbNodeId": "ocid1.dbnode.oc1.iad.exampleunique_ID", + "lifecycleState": "REQUESTED", + "definedTags" : {}, + "freeformTags" : {}, + "timeCreated" : "2022-12-03T03:43:24.342Z" + } + type: object + DbServerPatchingDetails: + description: | + The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window. + properties: + estimatedPatchDuration: + description: Estimated time, in minutes, to patch one database server. + maximum: 3000 + minimum: 1 + type: integer + patchingStatus: + description: The status of the patching operation. + enum: + - SCHEDULED + - MAINTENANCE_IN_PROGRESS + - FAILED + - COMPLETE + type: string + timePatchingEnded: + description: The time when the patching operation ended. + format: date-time + type: string + timePatchingStarted: + description: The time when the patching operation started. + format: date-time + type: string + type: object + ComputePerformanceSummary: + description: | + Parameters detailing the compute performance for a specified DB system shape. + properties: + cpuCoreCount: + description: The number of CPU cores available. + maximum: 64 + minimum: 1 + type: integer + memoryInGBs: + description: The amount of memory allocated for the VMDB System. + format: double + type: number + networkBandwidthInGbps: + description: The network bandwidth of the VMDB system in gbps. + format: float + type: number + networkIops: + description: IOPS for the VMDB System. + format: float + type: number + networkThroughputInMbps: + description: Network throughput for the VMDB System. + format: float + type: number + required: + - cpuCoreCount + - memoryInGBs + - networkBandwidthInGbps + - networkIops + - networkThroughputInMbps + type: object + FlexComponentSummary: + description: | + The Flex Components for a DB system. The Flex Component determines resources to allocate to the DB system - CPU cores, memory and storage for Flex shapes. + + For Exadata flexible shapes, detailed specifications can be found in https://docs.oracle.com/en/engineered-systems/exadata-cloud-service/ecscm/exa-service-desc.html#GUID-9E090174-5C57-4EB1-9243-B470F9F10D6B + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. + If you're an administrator who needs to write policies to give users access, + see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + availableCoreCount: + description: The maximum number of CPU cores that can ben enabled on the DB Server for this Flex Component. + format: int32 + type: integer + availableDbStorageInGBs: + description: The maximum storage that can be enabled on the Storage Server for this Flex Component. + format: int32 + type: integer + availableLocalStorageInGBs: + description: The maximum local storage that can be enabled on the DB Server for this Flex Component. + format: int32 + type: integer + availableMemoryInGBs: + description: The maximum memory size that can be enabled on the DB Server for this Flex Component. + type: integer + computeModel: + description: The compute model of the DB Server for this Flex Component. + maxLength: 255 + minLength: 1 + type: string + descriptionSummary: + description: The description summary for this Flex Component. + maxLength: 255 + minLength: 1 + type: string + hardwareType: + description: The hardware type of the DB (Compute) or Storage (Cell) Server for this Flex Component. + enum: + - COMPUTE + - CELL + type: string + minimumCoreCount: + description: The minimum number of CPU cores that can be enabled on the DB Server for this Flex Component. + format: int32 + type: integer + name: + description: The name of the Flex Component used for the DB system. + maxLength: 255 + minLength: 1 + type: string + runtimeMinimumCoreCount: + description: The runtime minimum number of CPU cores that can be enabled for this Flex Component. + format: int32 + type: integer + shape: + description: The name of the DB system shape for this Flex Component. + maxLength: 255 + minLength: 1 + type: string + required: + - name + type: object + StoragePerformanceDetails: + description: | + Representation of storage performance detail parameters. + properties: + balancedDiskPerformance: + $ref: '#/components/schemas/DiskPerformanceDetails' + highDiskPerformance: + $ref: '#/components/schemas/DiskPerformanceDetails' + sizeInGBs: + description: Size in GBs. + type: integer + required: + - sizeInGBs + - balancedDiskPerformance + - highDiskPerformance + type: object + DbSystemOptions: + description: The DB system options. + properties: + storageManagement: + default: ASM + description: | + The storage option used in DB system. + ASM - Automatic storage management + LVM - Logical Volume management + enum: + - ASM + - LVM + type: string + type: object + ExadataDbSystemMigrationSummary: + description: | + Information about the Exadata DB system migration. The migration is used to move the Exadata Cloud Service instance from the DB system resource model to the new cloud Exadata infrastructure resource model. + properties: + cloudExadataInfrastructureId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + cloudVmClusterId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud VM cluster. + maxLength: 255 + minLength: 1 + type: string + dbSystemId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. + maxLength: 255 + minLength: 1 + type: string + required: + - dbSystemId + - cloudVmClusterId + - cloudExadataInfrastructureId + type: object + DbSystemOsPatchHistoryEntrySummary: + description: The summary of an OS patch action history on a DB system. + properties: + action: + description: The action being performed or was completed. + enum: + - PRECHECK + - APPLY + type: string + dbSystemId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the OS patch history entry. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: | + A descriptive text associated with the lifecycleState. + Typically contains additional displayable text. + type: string + lifecycleState: + description: The current state of the action. + enum: + - IN_PROGRESS + - SUCCEEDED + - FAILED + type: string + osPatchDetails: + $ref: '#/components/schemas/DbSystemOsPatchDetailsCollection' + timeEnded: + description: The date and time when the patch action completed + format: date-time + type: string + timeStarted: + description: The date and time when the patch action started. + format: date-time + type: string + required: + - action + - dbSystemId + - id + - osPatchDetails + - lifecycleState + - timeStarted + type: object + MountPointDetails: + description: | + Details of the Mount Point. + properties: + dbNodeId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Node where snapshot was mounted. + maxLength: 255 + minLength: 1 + type: string + name: + description: Mount Point Name + maxLength: 255 + minLength: 1 + type: string + required: + - name + - dbNodeId + type: object + VolumeDetails: + description: | + Details of the volume. + properties: + name: + description: Volume Name + maxLength: 255 + minLength: 1 + type: string + size: + description: Volume Size + format: int32 + type: integer + required: + - name + type: object + ExadataInfrastructureContact: + description: Contact details for Exadata Infrastructure. + properties: + email: + description: The email for the Exadata Infrastructure contact. + maxLength: 255 + minLength: 1 + type: string + isContactMosValidated: + description: If `true`, this Exadata Infrastructure contact is a valid My Oracle Support (MOS) contact. If `false`, this Exadata Infrastructure contact is not a valid MOS contact. + type: boolean + isPrimary: + description: If `true`, this Exadata Infrastructure contact is a primary contact. If `false`, this Exadata Infrastructure is a secondary contact. + type: boolean + name: + description: The name of the Exadata Infrastructure contact. + maxLength: 255 + minLength: 1 + type: string + phoneNumber: + description: The phone number for the Exadata Infrastructure contact. + maxLength: 255 + type: string + required: + - name + - email + - isPrimary + type: object + NetworkBondingModeDetails: + description: | + Details of bonding mode for Client and Backup and DR networks of an Exadata infrastructure. + properties: + backupNetworkBondingMode: + default: + - ACTIVE_BACKUP + description: The network bonding mode for the Exadata infrastructure. + enum: + - ACTIVE_BACKUP + - LACP + type: string + clientNetworkBondingMode: + default: + - ACTIVE_BACKUP + description: The network bonding mode for the Exadata infrastructure. + enum: + - ACTIVE_BACKUP + - LACP + type: string + drNetworkBondingMode: + default: + - ACTIVE_BACKUP + description: The network bonding mode for the Exadata infrastructure. + enum: + - ACTIVE_BACKUP + - LACP + type: string + type: object + AutonomousVmClusterResourceDetails: + description: Unallocated resource details of the AVM + properties: + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. + maxLength: 255 + minLength: 1 + type: string + unAllocatedAdbStorageInTBs: + description: Total unallocated autonomous data storage in the AVM in TBs. + format: double + type: number + required: + - id + - unAllocatedAdbStorageInTBs + type: object + DrScanDetails: + description: | + The Single Client Access Name (SCAN) details for Disaster recovery network. + properties: + hostname: + description: The Disaster recovery SCAN hostname. + type: string + ips: + description: The list of Disaster recovery SCAN IP addresses. Three addresses should be provided. + items: + maxLength: 1024 + minLength: 1 + type: string + maxItems: 3 + type: array + scanListenerPortTcp: + description: The Disaster recovery SCAN TCPIP port. Default is 1521. + maximum: 8999 + minimum: 1024 + type: integer + required: + - hostname + - scanListenerPortTcp + - ips + type: object + ScanDetails: + description: | + The Single Client Access Name (SCAN) details. + properties: + hostname: + description: The SCAN hostname. + type: string + ips: + description: The list of SCAN IP addresses. Three addresses should be provided. + items: + maxLength: 1024 + minLength: 1 + type: string + maxItems: 3 + type: array + port: + description: | + **Deprecated.** This field is deprecated. You may use 'scanListenerPortTcp' to specify the port. + The SCAN TCPIP port. Default is 1521. + type: integer + required: + - hostname + - ips + type: object + VmNetworkDetails: + description: | + Details of the client or backup networks in an Exadata VM cluster network. Applies to Exadata Cloud@Customer instances only. + properties: + domainName: + description: The network domain name. + maxLength: 255 + minLength: 1 + type: string + gateway: + description: The network gateway. + maxLength: 255 + minLength: 1 + type: string + netmask: + description: The network netmask. + maxLength: 255 + minLength: 1 + type: string + networkType: + description: The network type. + enum: + - CLIENT + - BACKUP + - DISASTER_RECOVERY + type: string + nodes: + description: The list of node details. + items: + $ref: '#/components/schemas/NodeDetails' + type: array + vlanId: + description: The network VLAN ID. + maxLength: 255 + minLength: 1 + type: string + required: + - networkType + - nodes + type: object + InfoForNetworkGenDetails: + description: | + Parameters for generation of the client or backup network in a VM cluster network in an Exadata Cloud@Customer system. + properties: + cidr: + description: The cidr for the network. + maxLength: 255 + minLength: 1 + type: string + domain: + description: The network domain name. + maxLength: 255 + minLength: 1 + type: string + gateway: + description: The network gateway. + maxLength: 255 + minLength: 1 + type: string + netmask: + description: The network netmask. + maxLength: 255 + minLength: 1 + type: string + networkType: + description: The network type. + enum: + - CLIENT + - BACKUP + - DISASTER_RECOVERY + type: string + prefix: + description: The network domain name. + maxLength: 255 + minLength: 1 + type: string + vlanId: + description: The network VLAN ID. + maxLength: 255 + minLength: 1 + type: string + required: + - networkType + - vlanId + - cidr + - gateway + - netmask + - domain + - prefix + type: object + ExadbVmClusterStorageDetails: + description: | + Storage Details on the Exadata VM cluster. + properties: + totalSizeInGbs: + description: | + Total Capacity + format: int32 + type: integer + required: + - totalSizeInGbs + type: object + DbNodeDetails: + description: | + Details of the ExaCS Db node. Applies to Exadata Database Service on Exascale Infrastructure only. + properties: + dbNodeId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of ExaCS Db node. + maxLength: 255 + minLength: 1 + type: string + required: + - dbNodeId + type: object + ExascaleDbStorageDetails: + description: | + Exadata Database Storage Details + properties: + availableSizeInGbs: + description: | + Available Capacity + format: int32 + type: integer + totalSizeInGbs: + description: | + Total Capacity + format: int32 + type: integer + type: object + ExascaleDbStorageInputDetails: + description: | + Create exadata Database Storage Details + properties: + totalSizeInGbs: + description: | + Total Capacity + format: int32 + type: integer + required: + - totalSizeInGbs + type: object + ExecutionActionMember: + description: | + The action member details. + properties: + estimatedTimeInMins: + description: The estimated time of the execution action member in minutes. + minimum: 0 + type: integer + memberId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the parent resource the execution action belongs to. + maxLength: 255 + minLength: 1 + type: string + memberOrder: + description: The priority order of the execution action member. + minimum: 1 + type: integer + status: + description: | + The current status of the execution action member. Valid states are SCHEDULED, IN_PROGRESS, FAILED, CANCELED, DURATION_EXCEEDED, RESCHEDULED and COMPLETED. + enum: + - SCHEDULED + - IN_PROGRESS + - FAILED + - CANCELED + - DURATION_EXCEEDED + - RESCHEDULED + - SUCCEEDED + type: string + required: + - memberOrder + - memberId + type: object + ActionOrderDetails: + description: | + Describes the ordering list of action resources. + properties: + actionOrder: + description: The priority order of the action resource. + minimum: 1 + type: integer + actionResourceId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the action resource. + maxLength: 255 + minLength: 1 + type: string + type: object + ExternalDatabaseBase: + description: | + A resource that allows you to manage an Oracle Database located outside of Oracle Cloud using Oracle Cloud Infrastructure's Console and APIs. + properties: + characterSet: + description: The character set of the external database. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + databaseConfiguration: + description: The Oracle Database configuration + enum: + - RAC + - SINGLE_INSTANCE + type: string + databaseEdition: + description: | + The Oracle Database Edition that applies to all the databases on the DB system. + Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. + enum: + - STANDARD_EDITION + - ENTERPRISE_EDITION + - ENTERPRISE_EDITION_HIGH_PERFORMANCE + - ENTERPRISE_EDITION_EXTREME_PERFORMANCE + - ENTERPRISE_EDITION_DEVELOPER + type: string + databaseManagementConfig: + $ref: '#/components/schemas/DatabaseManagementConfig' + databaseVersion: + description: The Oracle Database version. + maxLength: 512 + minLength: 1 + type: string + dbId: + description: | + The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud. + maxLength: 512 + minLength: 1 + type: string + dbPacks: + description: The database packs licensed for the external Oracle Database. + maxLength: 512 + minLength: 1 + type: string + dbUniqueName: + description: The `DB_UNIQUE_NAME` of the external database. + maxLength: 32 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the external database. The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure external database resource. + maxLength: 255 + minLength: 1 + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: The current state of the Oracle Cloud Infrastructure external database resource. + enum: + - PROVISIONING + - NOT_CONNECTED + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + - FAILED + type: string + ncharacterSet: + description: The national character of the external database. + maxLength: 255 + minLength: 1 + type: string + stackMonitoringConfig: + $ref: '#/components/schemas/StackMonitoringConfig' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the database was created. + format: date-time + type: string + timeZone: + description: | + The time zone of the external database. + It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, + depending on how the time zone value was specified when the database was created / last altered. + maxLength: 512 + minLength: 1 + type: string + required: + - id + - compartmentId + - displayName + - lifecycleState + - timeCreated + type: object + CreateExternalDatabaseDetailsBase: + description: Details for creating an external database. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the external database. The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + required: + - compartmentId + - displayName + type: object + UpdateExternalDatabaseDetailsBase: + description: | + Details for updating an external database. This API is not currently supported. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The user-friendly name for the external database. The name does not have to be unique. + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + required: + - displayName + type: object + EnableExternalDatabaseManagementDetailsBase: + description: | + Details to enable Database Management on an external database. + properties: + externalDatabaseConnectorId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the + [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). + maxLength: 255 + minLength: 1 + type: string + required: + - externalDatabaseConnectorId + type: object + EnableExternalDatabaseStackMonitoringDetailsBase: + description: Details to enable Stack Monitoring on the external database. + properties: + externalDatabaseConnectorId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the + [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). + maxLength: 255 + minLength: 1 + type: string + required: + - externalDatabaseConnectorId + type: object + OperationsInsightsConfig: + description: The configuration of Operations Insights for the external database + properties: + operationsInsightsConnectorId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the + [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). + maxLength: 255 + minLength: 1 + type: string + operationsInsightsStatus: + description: The status of Operations Insights + enum: + - ENABLING + - ENABLED + - DISABLING + - NOT_ENABLED + - FAILED_ENABLING + - FAILED_DISABLING + type: string + required: + - operationsInsightsStatus + type: object + EnableExternalDatabaseOperationsInsightsDetailsBase: + description: Details to enable Operations Insights on the external database. + properties: + externalDatabaseConnectorId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the + [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). + maxLength: 255 + minLength: 1 + type: string + required: + - externalDatabaseConnectorId + type: object + KeyStoreAssociatedDatabaseDetails: + description: The databases associated with a key store + properties: + dbName: + description: The name of the database that is associated with the key store. + maxLength: 14 + minLength: 1 + type: string + dbUniqueName: + description: The unique name of the database that is associated with the key store. + maxLength: 30 + minLength: 1 + type: string + id: + description: The database [OCID](/Content/General/Concepts/identifiers.htm). + maxLength: 255 + minLength: 1 + type: string + type: object + KeyStoreTypeDetails: + description: Key store type details. + discriminator: + propertyName: type + properties: + type: + description: The type of key store. + enum: + - ORACLE_KEY_VAULT + type: string + required: + - type + type: object + DbServerHistorySummary: + description: Details of a database server maintenance history. + properties: + dbServerPatchingDetails: + $ref: '#/components/schemas/DbServerPatchingDetails' + displayName: + description: The user-friendly name for the database server. The name does not need to be unique. + maxLength: 255 + minLength: 1 + type: string + id: + description: The OCID of the database server. + maxLength: 255 + minLength: 1 + type: string + required: + - id + type: object + GranularMaintenanceHistoryDetails: + description: Details of a granular maintenance history. + properties: + executionActions: + description: The list of execution actions for this granular maintenance history. + items: + $ref: '#/components/schemas/ExecutionAction' + type: array + executionWindow: + $ref: '#/components/schemas/ExecutionWindow' + required: + - executionWindow + - executionActions + type: object + EstimatedPatchingTime: + description: | + The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching). + properties: + estimatedDbServerPatchingTime: + description: The estimated time required in minutes for database server patching. + maximum: 3000 + minimum: 1 + type: integer + estimatedNetworkSwitchesPatchingTime: + description: The estimated time required in minutes for network switch patching. + maximum: 3000 + minimum: 1 + type: integer + estimatedStorageServerPatchingTime: + description: The estimated time required in minutes for storage server patching. + maximum: 3000 + minimum: 1 + type: integer + totalEstimatedPatchingTime: + description: The estimated total time required in minutes for all patching operations. + maximum: 3000 + minimum: 1 + type: integer + type: object + PluggableDatabaseConnectionStrings: + description: | + Connection strings to connect to an Oracle Pluggable Database. + properties: + allConnectionStrings: + additionalProperties: + type: string + description: All connection strings to use to connect to the pluggable database. + type: object + pdbDefault: + description: A host name-based PDB connection string. + maxLength: 255 + minLength: 10 + type: string + pdbIpDefault: + description: An IP-based PDB connection string. + maxLength: 255 + minLength: 10 + type: string + type: object + PluggableDatabaseNodeLevelDetails: + description: Pluggable Database Node Level Details. + properties: + nodeName: + description: The Node name of the Database Instance. + maxLength: 255 + minLength: 1 + type: string + openMode: + description: | + The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software). + enum: + - READ_ONLY + - READ_WRITE + - MOUNTED + - MIGRATE + type: string + required: + - nodeName + - openMode + type: object + PluggableDatabaseRefreshableCloneConfig: + description: Pluggable Database Refreshable Clone Configuration. + properties: + isRefreshableClone: + description: Indicates whether the Pluggable Database is a refreshable clone. + type: boolean + type: object + CreatePluggableDatabaseCreationTypeDetails: + description: | + The Pluggable Database creation type. + Use `LOCAL_CLONE_PDB` for creating a new PDB using Local Clone on Source Pluggable Database. This will Clone and starts a + pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in the `READ_WRITE` openMode to + perform the clone operation. + sourcePluggableDatabaseSnapshotId and + isThinClone options are supported for Exadata VM cluster on Exascale Infrastructure, Exadata Cloud@Customer VM Cluster on Exadata Cloud@Customer infrastructure, and Exadata Cloud VM cluster on cloud Exadata infrastructure + Use `REMOTE_CLONE_PDB` for creating a new PDB using Remote Clone on Source Pluggable Database. This will Clone a pluggable + database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone + operation. The source PDB must be in the `READ_WRITE` openMode when performing the clone. + For Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructure as the + target container database (CDB) to create a remote clone. + sourcePluggableDatabaseSnapshotId and + isThinClone options are supported for Exadata VM cluster on Exascale Infrastructure, Exadata Cloud@Customer VM Cluster on Exadata Cloud@Customer infrastructure, and Exadata Cloud VM cluster on cloud Exadata infrastructure. + Use `RELOCATE_PDB` for relocating the Pluggable Database from Source CDB and creating it in target CDB. This will relocate a + pluggable database (PDB) to a different database from the source PDB. The source PDB must be in the `READ_WRITE` openMode when + performing the relocate. + discriminator: + propertyName: creationType + properties: + creationType: + description: The Pluggable Database creation type. + enum: + - LOCAL_CLONE_PDB + - REMOTE_CLONE_PDB + - RELOCATE_PDB + type: string + required: + - creationType + type: object + ActionParamValuesSummary: + description: | + Details of the action parameter and its possible values that is used in listParamsForActionType. + properties: + defaultValue: + description: The default value for this parameter. + maxLength: 255 + minLength: 1 + type: string + isRequired: + description: Whether this parameter is required or not for this action type.、 + type: boolean + parameterName: + description: The name of this parameter. + maxLength: 255 + minLength: 1 + type: string + parameterType: + default: STRING + description: The type of the parameter. + enum: + - BOOLEAN + - STRING + - INTEGER + type: string + parameterValues: + description: Possible values for this parameter. In case of integer it's min and max values. + items: + type: string + type: array + required: + - parameterName + - parameterType + - parameterValues + - isRequired + type: object + ScheduledActionSummary: + description: Details of a scheduled action. + properties: + actionMembers: + description: The list of action members in a scheduled action. + items: + $ref: '#/components/schemas/ActionMember' + maxItems: 200 + type: array + actionOrder: + description: The order of the scheduled action. + maximum: 300 + minimum: 1 + type: integer + actionParams: + additionalProperties: + type: string + description: | + Map where a key value pair describes the specific action parameter. + Example: `{"count": "3"}` + maxProperties: 100 + type: object + actionType: + default: DB_SERVER_FULL_SOFTWARE_UPDATE + description: The type of the scheduled action being performed + enum: + - DB_SERVER_FULL_SOFTWARE_UPDATE + - STORAGE_SERVER_FULL_SOFTWARE_UPDATE + - NETWORK_SWITCH_FULL_SOFTWARE_UPDATE + - DB_SERVER_ONLINE_SOFTWARE_UPDATE + type: string + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The display name of the Scheduled Action. + maxLength: 255 + minLength: 1 + type: string + estimatedTimeInMins: + description: The estimated patching time for the scheduled action. + maximum: 500000 + minimum: 0 + type: integer + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduled Action. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: | + The current state of the Scheduled Action. Valid states are CREATING, NEEDS_ATTENTION, AVAILABLE, UPDATING, FAILED, DELETING and DELETED. + enum: + - CREATING + - NEEDS_ATTENTION + - AVAILABLE + - UPDATING + - FAILED + - DELETING + - DELETED + type: string + schedulingPlanId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Plan. + maxLength: 255 + minLength: 1 + type: string + schedulingWindowId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Window. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the Scheduled Action Resource was created. + format: date-time + type: string + timeUpdated: + description: The date and time the Scheduled Action Resource was updated. + format: date-time + type: string + required: + - id + - actionOrder + - actionType + - schedulingPlanId + - timeCreated + - displayName + - compartmentId + - lifecycleState + type: object + ActionMember: + description: The details of an action member. + properties: + estimatedTimeInMins: + description: The estimated time for the intended action member. + maximum: 500000 + minimum: 0 + type: integer + memberId: + description: The ocid of the action member. + maxLength: 255 + minLength: 1 + type: string + memberOrder: + description: The order of the action member in a scheduled action. + maximum: 300 + minimum: 1 + type: integer + required: + - memberOrder + - memberId + type: object + SchedulingPlanSummary: + description: Details of a Scheduling Plan. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + type: object + displayName: + description: The display name of the Scheduling Plan. + maxLength: 255 + minLength: 1 + type: string + estimatedTimeInMins: + description: The estimated time for the Scheduling Plan. + maximum: 500000 + minimum: 0 + type: integer + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Plan. + maxLength: 255 + minLength: 1 + type: string + isUsingRecommendedScheduledActions: + description: If true, recommended scheduled actions will be generated for the scheduling plan. + type: boolean + lifecycleDetails: + description: Additional information about the current lifecycle state. + type: string + lifecycleState: + description: | + The current state of the Scheduling Plan. Valid states are CREATING, NEEDS_ATTENTION, AVAILABLE, UPDATING, FAILED, DELETING and DELETED. + enum: + - CREATING + - NEEDS_ATTENTION + - AVAILABLE + - UPDATING + - FAILED + - DELETING + - DELETED + type: string + planIntent: + default: EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE + description: The current intent of the Scheduling Plan. Valid states are EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE and EXADATA_INFRASTRUCTURE_SECURITY_UPDATE. + enum: + - EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE + - EXADATA_INFRASTRUCTURE_SECURITY_UPDATE + type: string + resourceId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the resource. + maxLength: 255 + minLength: 1 + type: string + schedulingPolicyId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Policy. + maxLength: 255 + minLength: 1 + type: string + serviceType: + description: The service type of the Scheduling Plan. + enum: + - EXACC + - EXACS + - FPPPCS + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + type: object + timeCreated: + description: The date and time the Scheduling Plan Resource was created. + format: date-time + type: string + timeUpdated: + description: The date and time the Scheduling Plan Resource was updated. + format: date-time + type: string + required: + - id + - schedulingPolicyId + - resourceId + - compartmentId + - serviceType + - lifecycleState + - timeCreated + type: object + Month: + description: Month of the year. + properties: + name: + description: Name of the month of the year. + enum: + - JANUARY + - FEBRUARY + - MARCH + - APRIL + - MAY + - JUNE + - JULY + - AUGUST + - SEPTEMBER + - OCTOBER + - NOVEMBER + - DECEMBER + type: string + required: + - name + type: object + RecommendedScheduledActionSummary: + description: | + Details of the scheduled action that is used in getRecommendedScheduledActions. + properties: + actionMembers: + description: The list of action members in a scheduled action. + items: + $ref: '#/components/schemas/ActionMember' + maxItems: 200 + type: array + actionOrder: + description: The order of the scheduled action. + maximum: 300 + minimum: 1 + type: integer + actionParams: + additionalProperties: + type: string + description: | + Map where a key value pair describes the specific action parameter. + Example: `{"count": "3"}` + maxProperties: 100 + type: object + actionType: + default: DB_SERVER_FULL_SOFTWARE_UPDATE + description: The type of the scheduled action being performed + enum: + - DB_SERVER_FULL_SOFTWARE_UPDATE + - STORAGE_SERVER_FULL_SOFTWARE_UPDATE + - NETWORK_SWITCH_FULL_SOFTWARE_UPDATE + - DB_SERVER_ONLINE_SOFTWARE_UPDATE + type: string + displayName: + description: Description of the scheduled action being performed, i.e. apply full update to DB Servers 1,2,3,4. + maxLength: 255 + minLength: 1 + type: string + estimatedTimeInMins: + description: The estimated patching time in minutes for the entire scheduled action. + maximum: 500000 + minimum: 0 + type: integer + schedulingWindowId: + description: The id of the scheduling window this scheduled action belongs to. + maxLength: 255 + minLength: 1 + type: string + required: + - actionOrder + - actionType + - schedulingWindowId + type: object + WindowPreferenceDetail: + description: | + The Single Scheduling Window details. + properties: + daysOfWeek: + description: Days during the week when scheduling window should be performed. + items: + $ref: '#/components/schemas/DayOfWeek' + type: array + uniqueItems: true + duration: + description: | + Duration window allows user to set a duration they plan to allocate for Scheduling window. The duration is in minutes. + minimum: 120 + type: integer + isEnforcedDuration: + default: false + description: Indicates if duration the user plans to allocate for scheduling window is strictly enforced. The default value is `FALSE`. + type: boolean + months: + description: Months during the year when scheduled window should be performed. + items: + $ref: '#/components/schemas/Month' + type: array + uniqueItems: true + startTime: + description: The scheduling window start time. The value must use the ISO-8601 format "hh:mm". + maxLength: 50 + minLength: 1 + type: string + weeksOfMonth: + description: | + Weeks during the month when scheduled window should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. + For example, to allow scheduling window during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Scheduling window cannot be scheduled for the fifth week of months that contain more than 28 days. + Note that this parameter works in conjunction with the daysOfWeek and startTime parameters to allow you to specify specific days of the week and hours that scheduled window will be performed. + items: + maximum: 4 + minimum: 1 + type: integer + type: array + uniqueItems: true + required: + - weeksOfMonth + - daysOfWeek + - startTime + - duration + - isEnforcedDuration + type: object + SystemVersionSummary: + description: List of compatible Exadata system versions for a given shape and GI version. + properties: + giVersion: + description: Grid Infrastructure version. + type: string + shape: + description: Exadata shape. + type: string + systemVersions: + description: Compatible Exadata system versions for a given shape and GI version. + items: + type: string + maxItems: 500 + type: array + required: + - shape + - giVersion + type: object + VmClusterUpdateDetails: + description: | + Details specifying which maintenance update to apply to the VM Cluster and which action is to be performed by the maintenance update. Applies to Exadata Cloud@Customer instances only. + properties: + giSoftwareImageId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of a grid infrastructure software image. This is a database software image of the type `GRID_IMAGE`. + maxLength: 255 + type: string + updateAction: + description: The update action to perform. + enum: + - ROLLING_APPLY + - PRECHECK + - ROLLBACK + type: string + updateId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. + maxLength: 255 + minLength: 1 + type: string + type: object + DbServerDetails: + description: | + Details of the Exacc Db server. Applies to Exadata Cloud@Customer instances only. + properties: + dbServerId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of Exacc Db server. + maxLength: 255 + minLength: 1 + type: string + required: + - dbServerId + type: object + AutonomousDatabaseInBackup: + description: | + Details of Autonomous AI Database in Autonomous Container Database + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: The user-friendly name for the Autonomous AI Database. The name does not have to be unique. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - displayName + type: object + BackupDestinationDetailsSummary: + description: Information about the backup destination associated with the Autonomous Container Database. + properties: + backupRetentionPolicyOnTerminate: + default: RETAIN_FOR_72_HOURS + description: | + Defines the automatic and manual backup retention policy for the Autonomous AI Database termination. + The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. + Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. + enum: + - RETAIN_PER_RETENTION_WINDOW + - RETAIN_FOR_72_HOURS + type: string + dbrsPolicyId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. + maxLength: 255 + minLength: 1 + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the backup destination. + maxLength: 255 + minLength: 1 + type: string + internetProxy: + description: Proxy URL to connect to object store. + type: string + isRemote: + default: false + description: Indicates whether the backup destination is cross-region or local. + type: boolean + isRetentionLockEnabled: + description: | + Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. + Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. + If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. + The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. + type: boolean + remoteRegion: + description: | + The name of the remote region where the remote automatic incremental backups will be stored. + For information about valid region names, see + [Regions and Availability Domains](/Content/General/Concepts/regions.htm). + maxLength: 50 + minLength: 1 + type: string + type: + description: Type of the database backup destination. + enum: + - NFS + - RECOVERY_APPLIANCE + - OBJECT_STORE + - LOCAL + - DBRS + - AWS + type: string + vpcPassword: + description: For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. + type: string + vpcUser: + description: For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. + type: string + backupDestinationAttachHistory: + description: The timestamps at which this backup destination is used as the preferred destination to host the Autonomous Container Database backups. + items: + format: date-time + type: string + type: array + spaceUtilizedInGBs: + description: The total space utilized (in GBs) by this Autonomous Container Database on this backup destination, rounded to the nearest integer. + type: integer + timeAtWhichStorageDetailsAreUpdated: + description: The latest timestamp when the backup destination details, such as 'spaceUtilized,' are updated. + format: date-time + type: string + required: + - type + type: object + DayOfWeek: + description: Day of the week. + properties: + name: + description: Name of the day of the week. + enum: + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY + type: string + required: + - name + type: object + DatabaseConnectionStringProfile: + description: | + The connection string profile to allow clients to group, filter and select connection string values based on structured metadata. + properties: + consumerGroup: + description: Consumer group used by the connection. + enum: + - HIGH + - MEDIUM + - LOW + - TP + - TPURGENT + type: string + displayName: + description: A user-friendly name for the connection. + maxLength: 255 + minLength: 1 + type: string + hostFormat: + description: Host format used in connection string. + enum: + - FQDN + - IP + type: string + isRegional: + description: True for a regional connection string, applicable to cross-region DG only. + type: boolean + protocol: + description: Protocol used by the connection. + enum: + - TCP + - TCPS + type: string + sessionMode: + description: Specifies whether the listener performs a direct hand-off of the session, or redirects the session. In RAC deployments where SCAN is used, sessions are redirected to a Node VIP. Use `DIRECT` for direct hand-offs. Use `REDIRECT` to redirect the session. + enum: + - DIRECT + - REDIRECT + type: string + syntaxFormat: + description: | + Specifies whether the connection string is using the long (`LONG`), Easy Connect (`EZCONNECT`), or Easy Connect Plus (`EZCONNECTPLUS`) format. + Autonomous AI Database Serverless instances always use the long format. + enum: + - LONG + - EZCONNECT + - EZCONNECTPLUS + type: string + tlsAuthentication: + description: Specifies whether the TLS handshake is using one-way (`SERVER`) or mutual (`MUTUAL`) authentication. + enum: + - SERVER + - MUTUAL + type: string + value: + description: Connection string value. + type: string + required: + - displayName + - value + - protocol + - hostFormat + - sessionMode + - syntaxFormat + type: object + AvmAcdResourceStats: + description: Associated autonomous container databases usages. + properties: + availableCpus: + description: The number of CPU cores available. + format: float + type: number + displayName: + description: The user-friendly name for the Autonomous Container Database. The name does not need to be unique. + type: string + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous Container Database. + type: string + provisionedCpus: + description: CPUs/cores assigned to Autonomous AI Databases in the ACD instances. + format: float + type: number + reclaimableCpus: + description: | + CPUs/cores that continue to be included in the count of OCPUs available to the + Autonomous Container Database even after one of its Autonomous AI Database is terminated + or scaled down. You can release them to the available OCPUs at its parent AVMC level by + restarting the Autonomous Container Database. + format: float + type: number + reservedCpus: + description: | + CPUs/cores reserved for scalability, resilliency and other overheads. This includes failover, + autoscaling and idle instance overhead. + format: float + type: number + usedCpus: + description: | + CPUs/cores assigned to the ACD instance. Sum of provisioned, reserved and reclaimable CPUs/ cores + to the ACD instance. + format: float + type: number + required: + - displayName + type: object + dbIormConfigUpdateDetail: + description: | + Details of the IORM configuration settings update request. + properties: + dbName: + description: | + The database name. For the default `DbPlan`, the `dbName` is `default`. + type: string + share: + description: | + The relative priority of this database. + maximum: 32 + minimum: 1 + type: integer + type: object + DataGuardGroupMember: + description: The member of a Data Guard group. Represents either a PRIMARY or a STANDBY Data Guard instance. + properties: + applyLag: + description: | + The lag time between updates to the primary database and application of the redo data on the standby database, + as computed by the reporting database. + + Example: `1 second` + type: string + applyRate: + description: | + The rate at which redo logs are synced between the associated databases. + + Example: `102.96 MByte/s` + type: string + databaseId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database. + type: string + dbSystemId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system, Cloud VM cluster or VM cluster. + type: string + isActiveDataGuardEnabled: + description: True if active Data Guard is enabled. + type: boolean + role: + description: The role of the reporting database in this Data Guard association. + enum: + - PRIMARY + - STANDBY + - DISABLED_STANDBY + type: string + transportLag: + description: | + The rate at which redo logs are transported between the associated databases. + + Example: `1 second` + type: string + transportLagRefresh: + description: The date and time when last redo transport has been done. + type: string + transportType: + description: | + The redo transport type to use for this Data Guard association. Valid values depend on the specified `protectionMode`: + + * MAXIMUM_AVAILABILITY - SYNC or FASTSYNC + * MAXIMUM_PERFORMANCE - ASYNC + * MAXIMUM_PROTECTION - SYNC + + For more information, see + [Redo Transport Services](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-redo-transport-services.htm#SBYDB00400) + in the Oracle Data Guard documentation. + + **IMPORTANT** - The only transport type currently supported by the Database service is ASYNC. + enum: + - SYNC + - ASYNC + - FASTSYNC + type: string + required: + - dbSystemId + - databaseId + - role + type: object + ManagedSoftwareUpdateMaintenanceDetails: + description: | + Provides details about actual Oracle Managed Database Software Updates scheduled time and version. + properties: + timeOfLastReadinessCheck: + description: The date and time of the last readiness check. + format: date-time + type: string + timeOfStatusUpdate: + description: The date and time of when the status was updated. + format: date-time + type: string + timeScheduled: + description: The date and time of the database was scheduled for update. + format: date-time + type: string + updateMode: + description: | + Oracle Managed Database Software update method, either "ROLLING" or "NONROLLING" + enum: + - ROLLING + - NONROLLING + type: string + updateReadinessStatus: + description: The managed software update readiness status + enum: + - SCHEDULED + - SUCCEEDED + - READY_FOR_MANAGED_UPDATE + - NOT_READY_FOR_MANAGED_UPDATE + - IN_PROGRESS + - NEEDS_ATTENTION + - AWAITING_RESOLUTION + type: string + updateReadinessStatusDetails: + description: This field will contain actual cause of update readiness state. + type: string + version: + description: The version of the database was scheduled for update. + type: string + required: + - timeScheduled + - version + type: object + ManagedSoftwareUpdatePreferenceDetails: + description: | + Oracle Managed Database Software Updates schedule will be created based on the provided update preferences + properties: + daysOfWeek: + description: | + The update should be applied on the database for the selected days of the week. + items: + $ref: '#/components/schemas/ManagedSoftwareUpdateDayOfWeek' + maxItems: 1 + minItems: 1 + type: array + uniqueItems: true + hourOfDay: + description: | + The update should be applied on the database for the selected hour of the day. + maximum: 23 + minimum: 0 + type: integer + updateMode: + description: | + Oracle Managed Database Software update method, either "ROLLING" or "NONROLLING". Default value is ROLLING. + *IMPORTANT*: Non-rolling Database Software update update involves system down time. + enum: + - ROLLING + - NONROLLING + type: string + versionSchemeDetails: + $ref: '#/components/schemas/VersionSchemeDetails' + required: + - daysOfWeek + - hourOfDay + - versionSchemeDetails + type: object + DiskPerformanceDetails: + description: | + Representation of disk performance detail parameters. + properties: + diskIops: + description: Disk IOPS in thousands. + format: float + type: number + diskThroughputInMbps: + description: Disk Throughput in Mbps. + format: float + type: number + required: + - diskIops + - diskThroughputInMbps + type: object + DbSystemOsPatchDetailsCollection: + description: Results of OS patch details for a DB System. + properties: + items: + description: Array of OS patch details for a DB System. + items: + $ref: '#/components/schemas/DbSystemOsPatchDetailsSummary' + type: array + required: + - items + type: object + NodeDetails: + description: Node details associated with a network. + properties: + dbServerId: + description: The Db server associated with the node. + maxLength: 255 + minLength: 1 + type: string + hostname: + description: The node host name. + maxLength: 255 + minLength: 1 + type: string + ip: + description: The node IP address. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: | + The current state of the VM cluster network nodes. + CREATING - The resource is being created + REQUIRES_VALIDATION - The resource is created and may not be usable until it is validated. + VALIDATING - The resource is being validated and not available to use. + VALIDATED - The resource is validated and is available for consumption by VM cluster. + VALIDATION_FAILED - The resource validation has failed and might require user input to be corrected. + UPDATING - The resource is being updated and not available to use. + ALLOCATED - The resource is currently being used by VM cluster. + TERMINATING - The resource is being deleted and not available to use. + TERMINATED - The resource is deleted and unavailable. + FAILED - The resource is in a failed state due to validation or other errors. + enum: + - CREATING + - REQUIRES_VALIDATION + - VALIDATING + - VALIDATED + - VALIDATION_FAILED + - UPDATING + - ALLOCATED + - TERMINATING + - TERMINATED + - FAILED + type: string + vip: + description: The node virtual IP (VIP) address. + maxLength: 255 + minLength: 1 + type: string + vipHostname: + description: The node virtual IP (VIP) host name. + maxLength: 255 + minLength: 1 + type: string + required: + - hostname + - ip + type: object + DatabaseManagementConfig: + description: The configuration of the Database Management service. + properties: + databaseManagementConnectionId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the + [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). + maxLength: 255 + minLength: 1 + type: string + databaseManagementStatus: + description: The status of the Database Management service. + enum: + - ENABLING + - ENABLED + - DISABLING + - NOT_ENABLED + - FAILED_ENABLING + - FAILED_DISABLING + type: string + licenseModel: + description: | + The Oracle license model that applies to the external database. + enum: + - LICENSE_INCLUDED + - BRING_YOUR_OWN_LICENSE + type: string + required: + - databaseManagementStatus + type: object + StackMonitoringConfig: + description: The configuration of Stack Monitoring for the external database. + properties: + stackMonitoringConnectorId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the + [external database connector](#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). + maxLength: 255 + minLength: 1 + type: string + stackMonitoringStatus: + description: The status of Stack Monitoring. + enum: + - ENABLING + - ENABLED + - DISABLING + - NOT_ENABLED + - FAILED_ENABLING + - FAILED_DISABLING + type: string + required: + - stackMonitoringStatus + type: object + ManagedSoftwareUpdateDayOfWeek: + description: | + Day of the week. + properties: + dayOfWeek: + description: | + Day of the week. + enum: + - SUNDAY + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + type: string + required: + - dayOfWeek + type: string + VersionSchemeDetails: + description: | + The update should be applied on the database for the selected version scheme. + discriminator: + propertyName: source + properties: + source: + description: | + The update should be applied on the database for the selected version scheme. + enum: + - VERSION_SERIES + type: string + required: + - source + type: object + DbSystemOsPatchDetailsSummary: + description: The details of available/applied OS patch on a DB Node. + properties: + dbNodeId: + description: The OCID of the DB node targeted for this patch action. + maxLength: 255 + minLength: 1 + type: string + isRebootRequired: + description: Indicates whether a reboot is required after applying the patch. + type: boolean + rpms: + description: List of OS package identifiers (e.g., RPM strings). + items: + type: string + maxItems: 2048 + type: array + required: + - rpms + - isRebootRequired + - dbNodeId + type: object + ListApplicationVipsResponse: + type: object + properties: + application_vips: + type: array + items: + $ref: '#/components/schemas/ApplicationVipSummary' + ListAutonomousContainerDatabaseVersionsResponse: + type: object + properties: + autonomous_container_database_versions: + type: array + items: + $ref: '#/components/schemas/AutonomousContainerDatabaseVersionSummary' + ListAutonomousContainerDatabasesResponse: + type: object + properties: + autonomous_container_databases: + type: array + items: + $ref: '#/components/schemas/AutonomousContainerDatabaseSummary' + ListAutonomousContainerDatabaseDataguardAssociationsResponse: + type: object + properties: + autonomous_container_database_dataguard_associations: + type: array + items: + $ref: '#/components/schemas/AutonomousContainerDatabaseDataguardAssociation' + ListContainerDatabasePatchesResponse: + type: object + properties: + container_database_patches: + type: array + items: + $ref: '#/components/schemas/AutonomousPatchSummary' + ListAutonomousDatabaseBackupsResponse: + type: object + properties: + autonomous_database_backups: + type: array + items: + $ref: '#/components/schemas/AutonomousDatabaseBackupSummary' + ListAutonomousDatabaseCharacterSetsResponse: + type: object + properties: + autonomous_database_character_sets: + type: array + items: + $ref: '#/components/schemas/AutonomousDatabaseCharacterSets' + ListAutonomousDatabasesResponse: + type: object + properties: + autonomous_databases: + type: array + items: + $ref: '#/components/schemas/AutonomousDatabaseSummary' + ListAutonomousDatabaseDataguardAssociationsResponse: + type: object + properties: + autonomous_database_dataguard_associations: + type: array + items: + $ref: '#/components/schemas/AutonomousDatabaseDataguardAssociation' + ListAutonomousDatabaseClonesResponse: + type: object + properties: + autonomous_database_clones: + type: array + items: + $ref: '#/components/schemas/AutonomousDatabaseSummary' + ListAutonomousDbPreviewVersionsResponse: + type: object + properties: + autonomous_db_preview_versions: + type: array + items: + $ref: '#/components/schemas/AutonomousDbPreviewVersionSummary' + ListAutonomousDbVersionsResponse: + type: object + properties: + autonomous_db_versions: + type: array + items: + $ref: '#/components/schemas/AutonomousDbVersionSummary' + ListAutonomousExadataInfrastructureShapesResponse: + type: object + properties: + autonomous_exadata_infrastructure_shapes: + type: array + items: + $ref: '#/components/schemas/AutonomousExadataInfrastructureShapeSummary' + ListAutonomousExadataInfrastructuresResponse: + type: object + properties: + autonomous_exadata_infrastructures: + type: array + items: + $ref: '#/components/schemas/AutonomousExadataInfrastructureSummary' + ListAutonomousVirtualMachinesResponse: + type: object + properties: + autonomous_virtual_machines: + type: array + items: + $ref: '#/components/schemas/AutonomousVirtualMachineSummary' + ListAutonomousVmClustersResponse: + type: object + properties: + autonomous_vm_clusters: + type: array + items: + $ref: '#/components/schemas/AutonomousVmClusterSummary' + ListAutonomousVmClusterAcdResourceUsageResponse: + type: object + properties: + autonomous_vm_cluster_acd_resource_usage: + type: array + items: + $ref: '#/components/schemas/AutonomousContainerDatabaseResourceUsage' + ListBackupDestinationResponse: + type: object + properties: + backup_destination: + type: array + items: + $ref: '#/components/schemas/BackupDestinationSummary' + ListBackupsResponse: + type: object + properties: + backups: + type: array + items: + $ref: '#/components/schemas/BackupSummary' + ListCloudAutonomousVmClustersResponse: + type: object + properties: + cloud_autonomous_vm_clusters: + type: array + items: + $ref: '#/components/schemas/CloudAutonomousVmClusterSummary' + ListCloudAutonomousVmClusterAcdResourceUsageResponse: + type: object + properties: + cloud_autonomous_vm_cluster_acd_resource_usage: + type: array + items: + $ref: '#/components/schemas/AutonomousContainerDatabaseResourceUsage' + ListCloudExadataInfrastructuresResponse: + type: object + properties: + cloud_exadata_infrastructures: + type: array + items: + $ref: '#/components/schemas/CloudExadataInfrastructureSummary' + ListCloudVmClustersResponse: + type: object + properties: + cloud_vm_clusters: + type: array + items: + $ref: '#/components/schemas/CloudVmClusterSummary' + ListCloudVmClusterUpdateHistoryEntriesResponse: + type: object + properties: + cloud_vm_cluster_update_history_entries: + type: array + items: + $ref: '#/components/schemas/UpdateHistoryEntrySummary' + ListCloudVmClusterUpdatesResponse: + type: object + properties: + cloud_vm_cluster_updates: + type: array + items: + $ref: '#/components/schemas/UpdateSummary' + ListDatabaseSoftwareImagesResponse: + type: object + properties: + database_software_images: + type: array + items: + $ref: '#/components/schemas/DatabaseSoftwareImageSummary' + ListDatabasesResponse: + type: object + properties: + databases: + type: array + items: + $ref: '#/components/schemas/DatabaseSummary' + ListDataGuardAssociationsResponse: + type: object + properties: + data_guard_associations: + type: array + items: + $ref: '#/components/schemas/DataGuardAssociationSummary' + ListPdbConversionHistoryEntriesResponse: + type: object + properties: + pdb_conversion_history_entries: + type: array + items: + $ref: '#/components/schemas/PdbConversionHistoryEntrySummary' + ListDatabaseUpgradeHistoryEntriesResponse: + type: object + properties: + database_upgrade_history_entries: + type: array + items: + $ref: '#/components/schemas/DatabaseUpgradeHistoryEntrySummary' + ListDbConnectionBundlesResponse: + type: object + properties: + db_connection_bundles: + type: array + items: + $ref: '#/components/schemas/DbConnectionBundleSummary' + ListDbHomesResponse: + type: object + properties: + db_homes: + type: array + items: + $ref: '#/components/schemas/DbHomeSummary' + ListDbHomePatchHistoryEntriesResponse: + type: object + properties: + db_home_patch_history_entries: + type: array + items: + $ref: '#/components/schemas/PatchHistoryEntrySummary' + ListDbHomePatchesResponse: + type: object + properties: + db_home_patches: + type: array + items: + $ref: '#/components/schemas/PatchSummary' + ListDbNodesResponse: + type: object + properties: + db_nodes: + type: array + items: + $ref: '#/components/schemas/DbNodeSummary' + ListConsoleConnectionsResponse: + type: object + properties: + console_connections: + type: array + items: + $ref: '#/components/schemas/ConsoleConnectionSummary' + ListDbServersResponse: + type: object + properties: + db_servers: + type: array + items: + $ref: '#/components/schemas/DbServerSummary' + ListDbSystemComputePerformancesResponse: + type: object + properties: + db_system_compute_performances: + type: array + items: + $ref: '#/components/schemas/DbSystemComputePerformanceSummary' + ListDbSystemShapesResponse: + type: object + properties: + db_system_shapes: + type: array + items: + $ref: '#/components/schemas/DbSystemShapeSummary' + ListDbSystemStoragePerformancesResponse: + type: object + properties: + db_system_storage_performances: + type: array + items: + $ref: '#/components/schemas/DbSystemStoragePerformanceSummary' + ListDbSystemsResponse: + type: object + properties: + db_systems: + type: array + items: + $ref: '#/components/schemas/DbSystemSummary' + ListDbSystemUpgradesResponse: + type: object + properties: + db_system_upgrades: + type: array + items: + $ref: '#/components/schemas/DbSystemUpgradeSummary' + ListDbSystemPatchHistoryEntriesResponse: + type: object + properties: + db_system_patch_history_entries: + type: array + items: + $ref: '#/components/schemas/PatchHistoryEntrySummary' + ListDbSystemPatchesResponse: + type: object + properties: + db_system_patches: + type: array + items: + $ref: '#/components/schemas/PatchSummary' + ListDbSystemUpgradeHistoryEntriesResponse: + type: object + properties: + db_system_upgrade_history_entries: + type: array + items: + $ref: '#/components/schemas/DbSystemUpgradeHistoryEntrySummary' + ListDbVersionsResponse: + type: object + properties: + db_versions: + type: array + items: + $ref: '#/components/schemas/DbVersionSummary' + ListDbnodeSnapshotsResponse: + type: object + properties: + dbnode_snapshots: + type: array + items: + $ref: '#/components/schemas/DbnodeSnapshotSummary' + ListExadataInfrastructuresResponse: + type: object + properties: + exadata_infrastructures: + type: array + items: + $ref: '#/components/schemas/ExadataInfrastructureSummary' + ListVmClusterNetworksResponse: + type: object + properties: + vm_cluster_networks: + type: array + items: + $ref: '#/components/schemas/VmClusterNetworkSummary' + ListExadbVmClustersResponse: + type: object + properties: + exadb_vm_clusters: + type: array + items: + $ref: '#/components/schemas/ExadbVmClusterSummary' + ListExadbVmClusterUpdateHistoryEntriesResponse: + type: object + properties: + exadb_vm_cluster_update_history_entries: + type: array + items: + $ref: '#/components/schemas/ExadbVmClusterUpdateHistoryEntrySummary' + ListExadbVmClusterUpdatesResponse: + type: object + properties: + exadb_vm_cluster_updates: + type: array + items: + $ref: '#/components/schemas/ExadbVmClusterUpdateSummary' + ListExascaleDbStorageVaultsResponse: + type: object + properties: + exascale_db_storage_vaults: + type: array + items: + $ref: '#/components/schemas/ExascaleDbStorageVaultSummary' + ListExecutionActionsResponse: + type: object + properties: + execution_actions: + type: array + items: + $ref: '#/components/schemas/ExecutionActionSummary' + ListExecutionWindowsResponse: + type: object + properties: + execution_windows: + type: array + items: + $ref: '#/components/schemas/ExecutionWindowSummary' + ListExternalContainerDatabasesResponse: + type: object + properties: + external_container_databases: + type: array + items: + $ref: '#/components/schemas/ExternalContainerDatabaseSummary' + ListExternalDatabaseConnectorsResponse: + type: object + properties: + external_database_connectors: + type: array + items: + $ref: '#/components/schemas/ExternalDatabaseConnectorSummary' + ListExternalNonContainerDatabasesResponse: + type: object + properties: + external_non_container_databases: + type: array + items: + $ref: '#/components/schemas/ExternalNonContainerDatabaseSummary' + ListExternalPluggableDatabasesResponse: + type: object + properties: + external_pluggable_databases: + type: array + items: + $ref: '#/components/schemas/ExternalPluggableDatabaseSummary' + ListGiVersionsResponse: + type: object + properties: + gi_versions: + type: array + items: + $ref: '#/components/schemas/GiVersionSummary' + ListGiVersionMinorVersionsResponse: + type: object + properties: + gi_version_minor_versions: + type: array + items: + $ref: '#/components/schemas/GiMinorVersionSummary' + ListKeyStoresResponse: + type: object + properties: + key_stores: + type: array + items: + $ref: '#/components/schemas/KeyStoreSummary' + ListMaintenanceRunHistoryResponse: + type: object + properties: + maintenance_run_history: + type: array + items: + $ref: '#/components/schemas/MaintenanceRunHistorySummary' + ListMaintenanceRunsResponse: + type: object + properties: + maintenance_runs: + type: array + items: + $ref: '#/components/schemas/MaintenanceRunSummary' + ListOneoffPatchesResponse: + type: object + properties: + oneoff_patches: + type: array + items: + $ref: '#/components/schemas/OneoffPatchSummary' + ListPluggableDatabaseSnapshotsResponse: + type: object + properties: + pluggable_database_snapshots: + type: array + items: + $ref: '#/components/schemas/PluggableDatabaseSnapshotSummary' + ListPluggableDatabasesResponse: + type: object + properties: + pluggable_databases: + type: array + items: + $ref: '#/components/schemas/PluggableDatabaseSummary' + ListSchedulingPoliciesResponse: + type: object + properties: + scheduling_policies: + type: array + items: + $ref: '#/components/schemas/SchedulingPolicySummary' + ListSchedulingWindowsResponse: + type: object + properties: + scheduling_windows: + type: array + items: + $ref: '#/components/schemas/SchedulingWindowSummary' + ListVmClustersResponse: + type: object + properties: + vm_clusters: + type: array + items: + $ref: '#/components/schemas/VmClusterSummary' + ListVmClusterPatchHistoryEntriesResponse: + type: object + properties: + vm_cluster_patch_history_entries: + type: array + items: + $ref: '#/components/schemas/PatchHistoryEntrySummary' + ListVmClusterPatchesResponse: + type: object + properties: + vm_cluster_patches: + type: array + items: + $ref: '#/components/schemas/PatchSummary' + ListVmClusterUpdateHistoryEntriesResponse: + type: object + properties: + vm_cluster_update_history_entries: + type: array + items: + $ref: '#/components/schemas/VmClusterUpdateHistoryEntrySummary' + ListVmClusterUpdatesResponse: + type: object + properties: + vm_cluster_updates: + type: array + items: + $ref: '#/components/schemas/VmClusterUpdateSummary' + responses: + '400': + description: Bad Request + 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' + '401': + description: Unauthorized + 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' + '403': + description: Forbidden + 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' + '404': + description: Not Found + 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' + '409': + description: Conflict + 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' + '412': + description: Precondition Failed + 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' + '429': + description: Too Many Requests + 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' + '500': + description: Internal Server 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' + DefaultError: + description: An error has occurred. + 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' + parameters: + CompartmentId: + description: The compartment [OCID](/Content/General/Concepts/identifiers.htm). + in: query + name: compartmentId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + PaginationLimitParam: + description: The maximum number of items to return per page. + in: query + name: limit + required: false + schema: + type: integer + minimum: 1 + maximum: 1000 + default: 10 + PaginationToken: + description: The pagination token to continue listing from. + in: query + name: page + required: false + schema: + type: string + minLength: 1 + maxLength: 256 + CloudVmClusterIdQueryParam: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud VM cluster associated with the application virtual IP (VIP) address. + in: query + name: cloudVmClusterId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + OptionalRequestId: + description: | + Unique identifier for the request. + in: header + name: opc-request-id + required: false + schema: + type: string + SortOrderQueryParam: + description: The sort order to use, either ascending (`ASC`) or descending (`DESC`). + in: query + name: sortOrder + required: false + schema: + type: string + enum: + - ASC + - DESC + default: ASC + ListApplicationVipsSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). + Default order for TIMECREATED is descending. + Default order for DISPLAYNAME is ascending. + The DISPLAYNAME sort order is case sensitive. + in: query + name: sortBy + required: false + x-default-description: 'null' + schema: + type: string + enum: + - DISPLAYNAME + - TIMECREATED + ListApplicationVipsFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/ApplicationVipSummary/lifecycleState' + schema: + type: string + RetryTokenHeader: + description: | + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + may be rejected). + in: header + name: opc-retry-token + schema: + type: string + minLength: 1 + maxLength: 64 + ApplicationVipIdPathParam: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the application virtual IP (VIP) address. + in: path + name: applicationVipId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + 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 + schema: + type: string + OptionalCompartmentIdQueryParam: + description: The compartment [OCID](/Content/General/Concepts/identifiers.htm). + in: query + name: compartmentId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + optionalAutonomousContainerDatabaseIdQueryParam: + description: The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm). + in: query + name: autonomousContainerDatabaseId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + OptionalIsRemoteQueryParam: + description: call for all remote backups + in: query + name: isRemote + required: false + schema: + type: boolean + default: false + ListAutonomousContainerDatabaseBackupsFilterByInfrastructureTypeQueryParam: + description: A filter to return only resources that match the given Infrastructure Type. + in: query + name: infrastructureType + required: false + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/AutonomousContainerDatabaseBackupSummary/infrastructureType' + schema: + type: string + default: null + listAutonomousContainerDatabaseBackupsFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/AutonomousContainerDatabaseBackupSummary/lifecycleState' + schema: + type: string + listAutonomousContainerDatabaseBackupsSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + + **Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. + in: query + name: sortBy + required: false + x-default-description: 'null' + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + FilterByDisplayNameQueryParam: + description: A filter to return only resources that match the entire display name given. The match is not case sensitive. + in: query + name: displayName + required: false + schema: + type: string + ServiceComponentQueryParam: + description: The service component to use, either ADBD or EXACC. + in: query + name: serviceComponent + required: true + schema: + type: string + enum: + - ADBD + - EXACC + optionalAutonomousExadataInfrastructureIdQueryParam: + description: The Autonomous Exadata Infrastructure [OCID](/Content/General/Concepts/identifiers.htm). + in: query + name: autonomousExadataInfrastructureId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + OptionalAutonomousVmClusterIdQueryParam: + description: The Autonomous VM Cluster [OCID](/Content/General/Concepts/identifiers.htm). + in: query + name: autonomousVmClusterId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + ListAutonomousContainerDatabasesFilterByInfrastructureTypeQueryParam: + description: A filter to return only resources that match the given Infrastructure Type. + in: query + name: infrastructureType + required: false + x-obmcs-enumref: '#/definitions/AutonomousContainerDatabaseSummary/infrastructureType' + schema: + type: string + ListAutonomousContainerDatabasesSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + + **Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + ListAutonomousContainerDatabasesFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/AutonomousContainerDatabaseSummary/lifecycleState' + schema: + type: string + FilterByAvailabilityDomainQueryParam: + description: A filter to return only resources that match the given availability domain exactly. + in: query + name: availabilityDomain + required: false + schema: + type: string + FilterByServiceLevelAgreementTypeQueryParam: + description: A filter to return only resources that match the given service-level agreement type exactly. + in: query + name: serviceLevelAgreementType + required: false + x-default-description: 'null' + schema: + type: string + OptionalCloudAutonomousVmClusterIdQueryParam: + description: The cloud Autonomous VM Cluster [OCID](/Content/General/Concepts/identifiers.htm). + in: query + name: cloudAutonomousVmClusterId + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + AutonomousContainerDatabaseIdPathParam: + description: The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: autonomousContainerDatabaseId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + AutonomousContainerDatabaseDataguardAssociationIdPathParam: + description: The Autonomous Container Database-Autonomous Data Guard association [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: autonomousContainerDatabaseDataguardAssociationId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + AutonomousPatchTypeQueryParam: + description: | + Autonomous patch type, either "QUARTERLY" or "TIMEZONE". + in: query + name: autonomousPatchType + schema: + type: string + enum: + - QUARTERLY + - TIMEZONE + default: QUARTERLY + optionalautonomousDatabaseIdQueryParam: + description: The database [OCID](/Content/General/Concepts/identifiers.htm). + in: query + name: autonomousDatabaseId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + listAutonomousDatabaseBackupsSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + + **Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + listAutonomousDatabaseBackupsFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/AutonomousDatabaseBackupSummary/lifecycleState' + schema: + type: string + FilterByBackupTypeQueryParam: + description: A filter to return only backups that matches with the given type of Backup. + in: query + name: type + required: false + x-default-description: 'null' + schema: + type: string + FilterByBackupDestinationIdQueryParam: + description: A filter to return only resources that have the given backup destination id. + in: query + name: backupDestinationId + required: false + x-default-description: 'null' + schema: + type: string + FilterByKeyStoreIdQueryParam: + description: A filter to return only resources that have the given key store id. + in: query + name: keyStoreId + required: false + x-default-description: 'null' + schema: + type: string + FilterByInfrastructureTypeQueryParam: + description: A filter to return only resources that match the given Infrastructure Type. + in: query + name: infrastructureType + required: false + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/AutonomousDatabaseBackupSummary/infrastructureType' + schema: + type: string + autonomousDatabaseBackupIdPathParam: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup. + in: path + name: autonomousDatabaseBackupId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + isSharedQueryParam: + description: | + Specifies whether this request is for an Autonomous AI Database Serverless instance. By default, this request will be for Autonomous AI Database on Dedicated Exadata Infrastructure. + in: query + name: isShared + x-default-description: 'null' + schema: + type: boolean + default: null + isDedicatedQueryParam: + description: | + Specifies if the request is for an Autonomous AI Database Dedicated instance. The default request is for an Autonomous AI Database Dedicated instance. + in: query + name: isDedicated + x-default-description: 'null' + schema: + type: boolean + characterSetTypeQueryParam: + description: | + Specifies whether this request pertains to database character sets or national character sets. + in: query + name: characterSetType + schema: + type: string + enum: + - DATABASE + - NATIONAL + default: DATABASE + ListAutonomousDatabaseSoftwareImagesSortByQueryParam: + description: | + parameter according to which Autonomous AI Database Software Images will be sorted. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + default: TIMECREATED + ListAutonomousDatabaseSoftwareImagesFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/AutonomousDatabaseSoftwareImage/lifecycleState' + schema: + type: string + ListAutonomousDatabaseSoftwareImagesFilterByImageShapeFamilyQueryParam: + description: A filter to return only resources that match the given image shape family exactly. + in: query + name: imageShapeFamily + required: true + x-obmcs-enumref: '#/definitions/AutonomousDatabaseSoftwareImage/imageShapeFamily' + schema: + type: string + AutonomousDatabaseSoftwareImageIdPathParam: + description: The Autonomous AI Database Software Image [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: autonomousDatabaseSoftwareImageId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + listAutonomousDatabasesSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + + **Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + ListAutonomousDatabasesFilterByInfrastructureTypeQueryParam: + description: A filter to return only resources that match the given Infrastructure Type. + in: query + name: infrastructureType + required: false + x-obmcs-enumref: '#/definitions/AutonomousDatabaseSummary/infrastructureType' + schema: + type: string + listAutonomousDatabasesFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/AutonomousDatabaseSummary/lifecycleState' + schema: + type: string + listAutonomousDatabasesFilterByLifecycleStateNotEqualToQueryParam: + description: A filter to return only resources that not match the given lifecycle state. + in: query + name: lifecycleStateNotEqualTo + required: false + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/AutonomousDatabaseSummary/lifecycleState' + schema: + type: string + default: null + listAutonomousDatabasesFilterByDbWorkloadQueryParam: + description: A filter to return only Autonomous AI Database resources that match the specified workload type. + in: query + name: dbWorkload + required: false + x-obmcs-enumref: '#/definitions/AutonomousDatabaseSummary/dbWorkload' + schema: + type: string + listAutonomousDatabasesFilterByDbVersionQueryParam: + description: A filter to return only Autonomous AI Database resources that match the specified dbVersion. + in: query + name: dbVersion + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + isFreeTierQueryParam: + description: | + Filter on the value of the resource's 'isFreeTier' property. A value of `true` returns only Always Free resources. + A value of `false` excludes Always Free resources from the returned results. Omitting this parameter returns both Always Free and paid resources. + in: query + name: isFreeTier + schema: + type: boolean + refreshableCloneQueryParam: + description: | + Filter on the value of the resource's 'isRefreshableClone' property. A value of `true` returns only refreshable clones. + A value of `false` excludes refreshable clones from the returned results. Omitting this parameter returns both refreshable clones and databases that are not refreshable clones. + in: query + name: isRefreshableClone + schema: + type: boolean + isDataGuardEnabledQueryParam: + description: A filter to return only resources that have Data Guard enabled. + in: query + name: isDataGuardEnabled + required: false + schema: + type: boolean + isResourcePoolLeaderParam: + description: | + Filter if the resource is the resource pool leader. A value of `true` returns only resource pool leader. + in: query + name: isResourcePoolLeader + required: false + x-default-description: 'null' + schema: + type: boolean + resourcePoolLeaderIdParam: + description: The database [OCID](/Content/General/Concepts/identifiers.htm) of the resourcepool Leader Autonomous AI Database. + in: query + name: resourcePoolLeaderId + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + autonomousDatabaseIdPathParam: + description: The database [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: autonomousDatabaseId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + mustDeleteAssociatedLongTermBackupsQueryParam: + description: If set to true, terminating the Autonomous AI Database also deletes its associated long-term backups if the retention lock is not enabled. + in: query + name: mustDeleteAssociatedLongTermBackups + required: false + x-default-description: 'false' + schema: + type: boolean + default: false + OptionalPeerAutonomousDatabaseIdQueryParam: + description: The database OCID(/Content/General/Concepts/identifiers.htm) of the Disaster Recovery peer (source Primary) database, which is located in a different (remote) region from the current peer database. + in: query + name: peerDbId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + OptionalIsOnlineRestartQueryParam: + description: If provided, an online restart will be triggered. + in: query + name: isOnlineRestart + required: false + schema: + type: boolean + default: false + AutonomousDatabaseDataguardAssociationIdPathParam: + description: The Autonomous Container Database-Autonomous Data Guard association [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: autonomousDatabaseDataguardAssociationId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + listAutonomousDatabasesRefreshableClonesSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + + **Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - NONE + - TIMECREATED + - DISPLAYNAME + default: NONE + listAutonomousDatabasesFilterByCloneTypeQueryParam: + description: A filter to return only resources that match the given clone type exactly. + in: query + name: cloneType + required: false + schema: + type: string + enum: + - REFRESHABLE_CLONE + IsCpuAutoScaleQueryParam: + description: If provided as true, cost estimate with cpu autoscaling. + in: query + name: isCpuAutoscale + required: true + schema: + type: boolean + default: false + listAutonomousDbPreviewVersionSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for DBWORKLOAD is ascending. + + **Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - DBWORKLOAD + AvailabilityDomainQueryParam: + description: The name of the Availability Domain. + in: query + name: availabilityDomain + required: true + schema: + type: string + ListAutonomousExadataInfrastructuresSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + + **Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + ListAutonomousExadataInfrastructuresFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/AutonomousExadataInfrastructureSummary/lifecycleState' + schema: + type: string + AutonomousExadataInfrastructureIdPathParam: + description: The Autonomous Exadata Infrastructure [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: autonomousExadataInfrastructureId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + AutonomousPatchIdPathParam: + description: The autonomous patch [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: autonomousPatchId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + AutonomousVmClusterIdQueryParam: + description: The Autonomous Virtual machine [OCID](/Content/General/Concepts/identifiers.htm). + in: query + name: autonomousVmClusterId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListAutonomousVirtualMachinesFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/AutonomousVirtualMachineSummary/lifecycleState' + schema: + type: string + AutonomousVirtualMachineIdPathParam: + description: The Autonomous Virtual machine [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: autonomousVirtualMachineId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + OptionalExadataInfrastructureIdQueryParam: + description: If provided, filters the results for the given Exadata Infrastructure. + in: query + name: exadataInfrastructureId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + default: default + ListAutonomousVmClustersSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + ListAutonomousVmClustersFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/AutonomousVmClusterSummary/lifecycleState' + schema: + type: string + AutonomousVmClusterIdPathParam: + description: The autonomous VM cluster [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: autonomousVmClusterId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + FilterByDestinationTypeQueryParam: + description: A filter to return only resources that match the given type of the Backup Destination. + in: query + name: type + required: false + schema: + type: string + BackupDestinationIdPathParam: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the backup destination. + in: path + name: backupDestinationId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + OptionalDatabaseIdQueryParam: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database. + in: query + name: databaseId + required: false + schema: + type: string + OptionalShapeFamilyQueryParam: + description: If provided, filters the results to the set of database versions which are supported for the given shape family. + in: query + name: shapeFamily + required: false + x-default-description: 'null' + schema: + type: string + enum: + - SINGLENODE + - YODA + - VIRTUALMACHINE + - EXADATA + - EXACC + - EXADB_XS + FilterByDatabaseVersionQueryParam: + description: A filter to return only resources that match the given database version. + in: query + name: version + required: false + x-default-description: 'null' + schema: + type: string + ListBackupsFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/BackupSummary/lifecycleState' + schema: + type: string + TimeExpiryScheduledGreaterThanOrEqualTo: + description: The start of date-time range of expiration for the long term backups to be fetched. + in: query + name: timeExpiryScheduledGreaterThanOrEqualTo + required: false + x-default-description: 'null' + schema: + type: string + format: date-time + TimeExpiryScheduledLessThan: + description: The end of date-time range of expiration for the long term backups to be fetched. + in: query + name: timeExpiryScheduledLessThan + required: false + x-default-description: 'null' + schema: + type: string + format: date-time + FilterByBackupDestinationType: + description: A filter to return only resources that match the given backup destination type. + in: query + name: backupDestinationType + required: false + x-default-description: 'null' + schema: + type: string + BackupIdPathParam: + description: The backup [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: backupId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + OptionalCloudExadataInfrastructureIdQueryParam: + description: If provided, filters the results for the specified cloud Exadata infrastructure. + in: query + name: cloudExadataInfrastructureId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + ListCloudAutonomousVmClustersSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + default: TIMECREATED + ListCloudAutonomousVmClustersFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/CloudAutonomousVmClusterSummary/lifecycleState' + schema: + type: string + CloudAutonomousVmClusterIdPathParam: + description: The Cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: cloudAutonomousVmClusterId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListCloudExadataInfrastructuresSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + ListCloudExadataInfrastructuresFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/CloudExadataInfrastructureSummary/lifecycleState' + schema: + type: string + ListCloudExadataInfrastructuresFilterByClusterPlacementGroupIdQueryParam: + description: A filter to return only resources that match the given cluster placement group ID exactly. + in: query + name: clusterPlacementGroupId + required: false + schema: + type: string + CloudExadataInfrastructureIdPathParam: + description: The cloud Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: cloudExadataInfrastructureId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + isDeleteVmClustersQueryParam: + description: | + If `true`, forces the deletion the specified cloud Exadata infrastructure resource as well as all associated VM clusters. If `false`, the cloud Exadata infrastructure resource can be deleted only if it has no associated VM clusters. Default value is `false`. + in: query + name: isDeleteVmClusters + schema: + type: boolean + default: false + OptionalDbServersQueryParam: + description: The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Db servers. + in: query + name: dbServers + required: false + x-default-description: 'null' + explode: true + schema: + type: array + items: + maxLength: 255 + minLength: 1 + type: string + ListCloudVmClustersSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + ListCloudVmClustersFilterByLifecycleStateQueryParam: + description: A filter to return only cloud VM clusters that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/CloudVmClusterSummary/lifecycleState' + schema: + type: string + CloudVmClusterIdPathParam: + description: The cloud VM cluster [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: cloudVmClusterId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + FilterByCloudVmClusterUpdateTypeQueryParam: + description: A filter to return only resources that match the given update type exactly. + in: query + name: updateType + required: false + schema: + type: string + enum: + - GI_UPGRADE + - GI_PATCH + - OS_UPDATE + UpdateHistoryEntryIdPathParam: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update history entry. + in: path + name: updateHistoryEntryId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + UpdateIdPathParam: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance update. + in: path + name: updateId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListDatabaseSoftwareImagesSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + Default order for PATCHSET is descending. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + - PATCHSET + default: TIMECREATED + ListDatabaseSoftwareImagesFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/DatabaseSoftwareImageSummary/lifecycleState' + schema: + type: string + ListDatabaseSoftwareImagesFilterByImageTypeQueryParam: + description: A filter to return only resources that match the given image type exactly. + in: query + name: imageType + required: false + x-obmcs-enumref: '#/definitions/DatabaseSoftwareImageSummary/imageType' + schema: + type: string + ListDatabaseSoftwareImagesFilterByImageShapeFamilyQueryParam: + description: A filter to return only resources that match the given image shape family exactly. + in: query + name: imageShapeFamily + required: false + x-obmcs-enumref: '#/definitions/DatabaseSoftwareImageSummary/imageShapeFamily' + schema: + type: string + PatchSetGreaterThanOrEqualToQueryParam: + description: A filter to return only resources with `patchSet` greater than or equal to given value. + in: query + name: patchSetGreaterThanOrEqualTo + required: false + schema: + type: string + OptionalDatabaseUpgradeSupportedQueryParam: + description: If provided, filters the results to the set of database versions which are supported for Upgrade. + in: query + name: isUpgradeSupported + required: false + x-default-description: 'null' + schema: + type: boolean + DatabaseSoftwareImageIdPathParam: + description: The DB system [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: databaseSoftwareImageId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + DbHomeIdQueryParam: + description: A Database Home [OCID](/Content/General/Concepts/identifiers.htm). + in: query + name: dbHomeId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + SystemIdQueryParam: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata DB system that you want to filter the database results by. Applies only to Exadata DB systems. + in: query + name: systemId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + ListDatabasesSortByQueryParam: + description: The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DBNAME is ascending. The DBNAME sort order is case sensitive. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - DBNAME + - TIMECREATED + ListDatabasesFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/DatabaseSummary/lifecycleState' + schema: + type: string + FilterByDbNameQueryParam: + description: A filter to return only resources that match the entire database name given. The match is not case sensitive. + in: query + name: dbName + required: false + schema: + type: string + DatabaseIdPathParam: + description: The database [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: databaseId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + PerformFinalBackupParam: + description: | + Whether to perform a final backup of the database or not. Default is false. + + If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work. + + This parameter is used in multiple APIs. Refer to the API description for details on how the operation uses it. + in: query + name: performFinalBackup + required: false + schema: + type: boolean + default: false + DataGuardAssociationIdPathParam: + description: The Data Guard association's [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: dataGuardAssociationId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + FilterByPdbConversionActionQueryParam: + description: A filter to return only the pluggable database conversion history entries that match the specified conversion action. For example, you can use this filter to return only entries for the precheck operation. + in: query + name: pdbConversionAction + required: false + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/PdbConversionHistoryEntrySummary/action' + schema: + type: string + FilterByPdbConversionLifecycleStateQueryParam: + description: A filter to return only the pluggable database conversion history entries that match the specified lifecycle state. For example, you can use this filter to return only entries in the "failed" lifecycle state. + in: query + name: lifecycleState + required: false + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/PdbConversionHistoryEntrySummary/lifecycleState' + schema: + type: string + ListPdbConversionHistoryEntriesSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). The default order for `TIMECREATED` is ascending. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMESTARTED + default: TIMESTARTED + PdbConversionHistoryEntryIdPathParam: + description: The database conversion history [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: pdbConversionHistoryEntryId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + FilterByUpgradeActionQueryParam: + description: A filter to return only upgradeHistoryEntries that match the specified Upgrade Action. + in: query + name: upgradeAction + required: false + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/DatabaseUpgradeHistoryEntrySummary/action' + schema: + type: string + FilterByUpgradeLifecycleStateQueryParam: + description: A filter to return only upgradeHistoryEntries that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/DatabaseUpgradeHistoryEntrySummary/lifecycleState' + schema: + type: string + ListUpgradeHistoryEntriesSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is ascending. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMESTARTED + default: TIMESTARTED + UpgradeHistoryEntryIdPathParam: + description: The database/db system upgrade History [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: upgradeHistoryEntryId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListDbConnectionBundlesSortByQueryParam: + description: | + The field to sort by. You can specify only one sort order. The default + order for `TIMECREATED` is descending. The default order for `TIMEREFRESHED` + is descending. + in: query + name: sortBy + required: false + x-default-description: The default value is `TIMECREATED`. + schema: + type: string + enum: + - TIMECREATED + - TIMEREFRESHED + ListDbConnectionBundlesFilterByLifecycleStateQueryParam: + description: A filter that returns only resources that match the given lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-default-description: The default value is null. + schema: + type: string + enum: + - CREATING + - ACTIVE + - INACTIVE + - UPDATING + - DELETING + - DELETED + - FAILED + ListDbConnectionBundlesFilterByTypeQueryParam: + description: A filter that returns only resources that match the specified database connection bundle type. + in: query + name: dbConnectionBundleType + required: false + x-default-description: The default value is null. + schema: + type: string + enum: + - TLS + - MTLS + OptionalAssociatedResourceIdQueryParam: + description: The OCID of the VM cluster associated with the connection bundle. If the parameter is set to null, all bundles are returned. + in: query + name: associatedResourceId + required: false + x-default-description: The default value is null. + schema: + type: string + minLength: 1 + maxLength: 255 + DbConnectionBundleIdPathParam: + description: The OCID of the database connection bundle. + in: path + name: dbConnectionBundleId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + OptionalDbSystemIdQueryParam: + description: The DB system [OCID](/Content/General/Concepts/identifiers.htm). If provided, filters the results to the set of database versions which are supported for the DB system. + in: query + name: dbSystemId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + OptionalVmClusterIdQueryParam: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster. + in: query + name: vmClusterId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + BackupIdQueryParam: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment. + in: query + name: backupId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + DbVersionQueryParam: + description: A filter to return only DB Homes that match the specified dbVersion. + in: query + name: dbVersion + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + default: NONE + ListDbHomesSortByQueryParam: + description: The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + ListDbHomesFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/DbHomeSummary/lifecycleState' + schema: + type: string + DbHomeIdPathParam: + description: The Database Home [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: dbHomeId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + PatchHistoryEntryIdPathParam: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the patch history entry. + in: path + name: patchHistoryEntryId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + PatchIdPathParam: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the patch. + in: path + name: patchId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListDbNodesSortByQueryParam: + description: Sort by TIMECREATED. Default order for TIMECREATED is descending. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + ListDbNodesFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/DbNodeSummary/lifecycleState' + schema: + type: string + OptionalDbServerIdQueryParam: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exacc Db server. + in: query + name: dbServerId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + DbNodeIdPathParam: + description: The database node [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: dbNodeId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + DbNodeActionQueryParam: + description: The action to perform on the DB Node. + in: query + name: action + required: true + x-obmcs-inline-enum: false + schema: + type: string + enum: + - STOP + - FORCESTOP + - FORCERESET + - START + - SOFTRESET + - RESET + ConsoleConnectionIdPathParam: + description: The OCID of the console connection. + in: path + name: consoleConnectionId + required: true + schema: + type: string + ListConsoleHistoriesSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + in: query + name: sortBy + required: false + x-default-description: 'null' + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + ListConsoleHistoriesFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/ConsoleHistorySummary/lifecycleState' + schema: + type: string + ConsoleHistoryIdPathParam: + description: The OCID of the console history. + in: path + name: consoleHistoryId + required: true + schema: + type: string + ExadataInfrastructureIdQueryParam: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the ExadataInfrastructure. + in: query + name: exadataInfrastructureId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListDbServersSortByQueryParam: + description: Sort by TIMECREATED. Default order for TIMECREATED is descending. + in: query + name: sortBy + required: false + x-default-description: 'null' + schema: + type: string + enum: + - TIMECREATED + ListDbServersFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/DbServerSummary/lifecycleState' + schema: + type: string + DbServerIdPathParam: + description: The DB server [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: dbServerId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + DbSystemShapeParam: + description: If provided, filters the results to the set of database versions which are supported for the given shape. + in: query + name: dbSystemShape + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + OptionalAvailabilityDomainQueryParam: + description: The name of the Availability Domain. + in: query + name: availabilityDomain + required: false + schema: + type: string + ShapeAttributeQueryParam: + description: If provided and applicable, return DB System shape parameters based on the shapeAttribute provided + in: query + name: shapeAttribute + required: false + x-default-description: 'null' + schema: + type: string + FilterByNameQueryParam: + description: A filter to return only resources that match the entire name given. The match is not case sensitive. + in: query + name: name + required: false + schema: + type: string + FilterByShapeQueryParam: + description: A filter to return only resources that belong to the entire shape name given. The match is not case sensitive. + in: query + name: shape + required: false + x-default-description: 'null' + schema: + type: string + ListFlexComponentsSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for NAME is ascending. The NAME sort order is case sensitive. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - NAME + StorageManagementQueryParam: + description: | + The DB system storage management option. Used to list database versions available for that storage manager. Valid values are `ASM` and `LVM`. + * ASM specifies Oracle Automatic Storage Management + * LVM specifies logical volume manager, sometimes called logical disk manager. + in: query + name: storageManagement + required: true + x-obmcs-enumref: '#/definitions/DbSystemOptions/storageManagement' + schema: + type: string + default: ASM + ShapeTypeParam: + description: Optional. Filters the performance results by shape type. + in: query + name: shapeType + required: false + x-default-description: 'null' + schema: + type: string + DatabaseEditionQueryParam: + description: The database edition of quota (STANDARD_EDITION/ENTERPRISE_EDITION/ENTERPRISE_EDITION_HIGH_PERFORMANCE/ENTERPRISE_EDITION_EXTREME_PERFORMANCE/ENTERPRISE_EDITION_DEVELOPER) + in: query + name: databaseEdition + required: false + x-default-description: 'null' + schema: + type: string + enum: + - STANDARD_EDITION + - ENTERPRISE_EDITION + - ENTERPRISE_EDITION_HIGH_PERFORMANCE + - ENTERPRISE_EDITION_EXTREME_PERFORMANCE + - ENTERPRISE_EDITION_DEVELOPER + ListDbSystemsSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + + **Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + ListDbSystemsFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/DbSystemSummary/lifecycleState' + schema: + type: string + DbSystemIdPathParam: + description: The DB system [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: dbSystemId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListDbSystemOsPatchHistoryEntriesSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMESTARTED is descending. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMESTARTED + - ACTION + default: TIMESTARTED + ListDbSystemOsPatchHistoryEntriesFilterByLifecycleStateQueryParam: + description: A filter to return only OS patch history entries that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/DbSystemOsPatchHistoryEntrySummary/lifecycleState' + schema: + type: string + ListDbSystemOsPatchHistoryEntriesFilterByActionQueryParam: + description: A filter to return only OS patch history entries that match the specified OS patch action. + in: query + name: action + required: false + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/DbSystemOsPatchHistoryEntrySummary/action' + schema: + type: string + DbSystemOsPatchHistoryEntryIdParam: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the patch history entry. + in: path + name: osPatchHistoryEntryId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + FilterByDbSystemUpgradeActionQueryParam: + description: A filter to return only upgradeHistoryEntries that match the specified Upgrade Action. + in: query + name: upgradeAction + required: false + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/DbSystemUpgradeHistoryEntrySummary/action' + schema: + type: string + FilterByUpgradeDbSystemLifecycleStateQueryParam: + description: A filter to return only upgrade history entries that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/DbSystemUpgradeHistoryEntrySummary/lifecycleState' + schema: + type: string + OptionalStorageManagementQueryParam: + description: | + The DB system storage management option. Used to list database versions available for that storage manager. Valid values are `ASM` and `LVM`. + * ASM specifies Oracle Automatic Storage Management + * LVM specifies logical volume manager, sometimes called logical disk manager. + in: query + name: storageManagement + required: false + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/DbSystemOptions/storageManagement' + schema: + type: string + OptionalDatabaseSoftwareImageSupportedQueryParam: + description: If true, filters the results to the set of Oracle Database versions that are supported for OCI database software images. + in: query + name: isDatabaseSoftwareImageSupported + required: false + x-default-description: 'null' + schema: + type: boolean + ListDbnodeSnapshotsSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - NAME + default: TIMECREATED + ListDbnodeSnapshotsFilterByLifecycleStateQueryParam: + description: A filter to return only Exadata Database Snapshots that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/DbnodeSnapshot/lifecycleState' + schema: + type: string + ListDbnodeSnapshotsFilterByClusterQueryParam: + description: A filter to return only Exadata Database Node Snapshots that match the given VM cluster. + in: query + name: clusterId + required: false + schema: + type: string + ListDbnodeSnapshotsFilterByDbNodeQueryParam: + description: A filter to return only Exadata Database Snapshots that match the given database node. + in: query + name: sourceDbnodeId + required: false + schema: + type: string + DbnodeSnapshotIdPathParam: + description: The Exadata Database Node Snapshot [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: dbnodeSnapshotId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListExadataInfrastructuresSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + ListExadataInfrastructuresFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/ExadataInfrastructureSummary/lifecycleState' + schema: + type: string + OptionalExcludedFieldsQueryParam: + description: If provided, the specified fields will be excluded in the response. + in: query + name: excludedFields + x-default-description: 'null' + explode: true + schema: + type: array + items: + enum: + - multiRackConfigurationFile + type: string + ExadataInfrastructureIdPathParam: + description: The Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: exadataInfrastructureId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListVmClusterNetworksSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + ListVmClusterNetworksFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/VmClusterNetworkSummary/lifecycleState' + schema: + type: string + VmClusterNetworkIdPathParam: + description: The VM cluster network [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: vmClusterNetworkId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListExadbVmClustersSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + default: TIMECREATED + ListExadbVmClustersFilterByLifecycleStateQueryParam: + description: | + A filter to return only Exadata VM clusters on Exascale Infrastructure that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/ExadbVmClusterSummary/lifecycleState' + schema: + type: string + ListExadbVmClustersFilterByExascaleDbStorageVaultIdQueryParam: + description: | + A filter to return only Exadata VM clusters on Exascale Infrastructure that match the given Exascale Database Storage Vault ID. + in: query + name: exascaleDbStorageVaultId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + ListExadbVmClustersFilterByClusterPlacementGroupIdQueryParam: + description: A filter to return only resources that match the given cluster placement group ID exactly. + in: query + name: clusterPlacementGroupId + required: false + schema: + type: string + ExadbVmClusterIdPathParam: + description: The Exadata VM cluster [OCID](/Content/General/Concepts/identifiers.htm) on Exascale Infrastructure. + in: path + name: exadbVmClusterId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + FilterByExadbVmClusterUpdateTypeQueryParam: + description: A filter to return only resources that match the given update type exactly. + in: query + name: updateType + required: false + schema: + type: string + enum: + - GI_UPGRADE + - GI_PATCH + - OS_UPDATE + default: GI_UPGRADE + FilterByUpdateTypeVersionQueryParam: + description: A filter to return only resources that match the given update version exactly. + in: query + name: version + required: false + x-default-description: Return resources with all the available update versions if not specified + schema: + type: string + ListExascaleDbStorageVaultsSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + default: TIMECREATED + ListExascaleDbStorageVaultsFilterByLifecycleStateQueryParam: + description: A filter to return only Exadata Database Storage Vaults that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/ExascaleDbStorageVault/lifecycleState' + schema: + type: string + ListExascaleDbStorageVaultsFilterByClusterPlacementGroupIdQueryParam: + description: A filter to return only resources that match the given cluster placement group ID exactly. + in: query + name: clusterPlacementGroupId + required: false + schema: + type: string + AttachedShapeAttributesNotEqualToQueryParam: + description: A filter to return only Exadata Database Storage Vaults which do not match the given attachedShapeAttributes + in: query + name: attachedShapeAttributesNotEqualTo + required: false + x-default-description: 'null' + schema: + type: string + AttachedShapeAttributesQueryParam: + description: A filter to return only Exadata Database Storage Vaults which match the given attachedShapeAttributes or has null attachedShapeAttributes + in: query + name: attachedShapeAttributes + required: false + x-default-description: 'null' + schema: + type: string + VmClusterCountLessThanOrEqualToQueryParam: + description: A filter to return only Exadata Database Storage Vaults with associated Exadata VM Clusters less than or equal to the given count + in: query + name: vmClusterCountLessThanOrEqualTo + required: false + schema: + type: integer + minimum: 0 + VmClusterCountGreaterThanOrEqualToQueryParam: + description: A filter to return only Exadata Database Storage Vaults with associated Exadata VM Clusters greater than or equal to the given count + in: query + name: vmClusterCountGreaterThanOrEqualTo + required: false + schema: + type: integer + minimum: 0 + ListExascaleDbStorageVaultsFilterByExadataInfrastructureIdQueryParam: + description: A filter to return only list of Vaults that are linked to the exadata infrastructure Id. + in: query + name: exadataInfrastructureId + required: false + schema: + type: string + ExascaleDbStorageVaultIdPathParam: + description: The Exadata Database Storage Vault [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: exascaleDbStorageVaultId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListExecutionActionsSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + default: TIMECREATED + ListExecutionActionsFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/ExecutionActionSummary/lifecycleState' + schema: + type: string + ListExecutionActionsFilterByExecutionWindowIdQueryParam: + description: A filter to return only resources that match the given execution wondow id. + in: query + name: executionWindowId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + ExecutionActionIdPathParam: + description: The execution action [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: executionActionId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListExecutionWindowsSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + default: TIMECREATED + ListExecutionWindowsByResourceIdQueryParam: + description: A filter to return only resources that match the given resource id exactly. + in: query + name: executionResourceId + required: false + x-default-description: Return only resources that match the given resource id exactly. + schema: + type: string + minLength: 1 + maxLength: 255 + ListExecutionWindowsFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/ExecutionWindowSummary/lifecycleState' + schema: + type: string + ExecutionWindowIdPathParam: + description: The execution window [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: executionWindowId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListExternalContainerDatabasesSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). + Default order for TIMECREATED is descending. + Default order for DISPLAYNAME is ascending. + The DISPLAYNAME sort order is case sensitive. + in: query + name: sortBy + required: false + x-default-description: 'null' + schema: + type: string + enum: + - DISPLAYNAME + - TIMECREATED + ListExternalContainerDatabasesFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the specified lifecycle state. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/ExternalDatabaseBase/lifecycleState' + schema: + type: string + ExternalContainerDatabaseIdPathParam: + description: The ExternalContainerDatabase [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: externalContainerDatabaseId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ExternalDatabaseConnectorIdQueryParam: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the + external database connector resource (`ExternalDatabaseConnectorId`). + in: query + name: externalDatabaseConnectorId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListExternalDatabaseConnectorsExternalDatabaseIdQueryParam: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the external database whose connectors will be listed. + in: query + name: externalDatabaseId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListExternalDatabaseConnectorsSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). + Default order for TIMECREATED is descending. + Default order for DISPLAYNAME is ascending. + The DISPLAYNAME sort order is case sensitive. + in: query + name: sortBy + required: false + x-default-description: 'null' + schema: + type: string + enum: + - DISPLAYNAME + - TIMECREATED + ListExternalDatabaseConnectorsFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the specified lifecycle state. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/ExternalDatabaseConnector/lifecycleState' + schema: + type: string + ExternalDatabaseConnectorIdPathParam: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the + external database connector resource (`ExternalDatabaseConnectorId`). + in: path + name: externalDatabaseConnectorId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListExternalNonContainerDatabasesSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). + Default order for TIMECREATED is descending. + Default order for DISPLAYNAME is ascending. + The DISPLAYNAME sort order is case sensitive. + in: query + name: sortBy + required: false + x-default-description: 'null' + schema: + type: string + enum: + - DISPLAYNAME + - TIMECREATED + ListExternalNonContainerDatabasesFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the specified lifecycle state. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/ExternalDatabaseBase/lifecycleState' + schema: + type: string + ExternalNonContainerDatabaseIdPathParam: + description: The external non-container database [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: externalNonContainerDatabaseId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ExternalContainerDatabaseIdQueryParam: + description: The ExternalContainerDatabase [OCID](/Content/General/Concepts/identifiers.htm). + in: query + name: externalContainerDatabaseId + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + ListExternalPluggableDatabasesSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). + Default order for TIMECREATED is descending. + Default order for DISPLAYNAME is ascending. + The DISPLAYNAME sort order is case sensitive. + in: query + name: sortBy + required: false + x-default-description: | + The field to sort by. You can provide one sort order (`sortOrder`). + Default order for TIMECREATED is descending. + Default order for DISPLAYNAME is ascending. + The DISPLAYNAME sort order is case sensitive. + schema: + type: string + enum: + - DISPLAYNAME + - TIMECREATED + ListExternalPluggableDatabasesFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the specified lifecycle state. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/ExternalDatabaseBase/lifecycleState' + schema: + type: string + ExternalPluggableDatabaseIdPathParam: + description: The ExternalPluggableDatabaseId [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: externalPluggableDatabaseId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + OptionalShapeQueryParam: + description: If provided, filters the results for the given shape. + in: query + name: shape + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + default: default + ExadbxsAvailabilityDomainParam: + description: The target availability domain. Only passed if the limit is AD-specific. + in: query + name: availabilityDomain + required: false + schema: + type: string + GiMajorVersionPathParam: + description: The Oracle Grid Infrastructure major version. + in: path + name: version + required: true + schema: + type: string + minLength: 1 + maxLength: 30 + IsGiVersionForProvisioningQueryParam: + description: If true, returns the Grid Infrastructure versions that can be used for provisioning a cluster + in: query + name: isGiVersionForProvisioning + schema: + type: boolean + default: false + ListGiMinorVersionsSortByQueryParam: + description: Sort by VERSION. Default order for VERSION is descending. + in: query + name: sortBy + required: false + x-default-description: 'null' + schema: + type: string + enum: + - VERSION + KeyStoreIdPathParam: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the key store. + in: path + name: keyStoreId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + optionalTargetResourceIdQueryParam: + description: The target resource ID. + in: query + name: targetResourceId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + optionalTargetResourceTypeQueryParam: + description: The type of the target resource. + in: query + name: targetResourceType + required: false + x-obmcs-enumref: '#/definitions/MaintenanceRunSummary/targetResourceType' + schema: + type: string + optionalMaintenanceTypeQueryParam: + description: The maintenance type. + in: query + name: maintenanceType + required: false + x-obmcs-enumref: '#/definitions/MaintenanceRunSummary/maintenanceType' + schema: + type: string + listMaintenanceRunsSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIME_SCHEDULED and TIME_ENDED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + + **Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIME_SCHEDULED + - TIME_ENDED + - DISPLAYNAME + listMaintenanceRunHistoryFilterByStateQueryParam: + description: The state of the maintenance run history. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/MaintenanceRunSummary/lifecycleState' + schema: + type: string + OptionalMaintenanceSubtypeQueryParam: + description: The sub-type of the maintenance run. + in: query + name: maintenanceSubtype + required: false + x-obmcs-enumref: '#/definitions/MaintenanceRunSummary/maintenanceSubtype' + schema: + type: string + maintenanceRunHistoryIdPathParam: + description: The maintenance run history OCID. + in: path + name: maintenanceRunHistoryId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + listMaintenanceRunsFilterByLocalAdgQueryParam: + description: A filter to return the maintenance history results for the local standby Autonomous AI Database Serverless only. + in: query + name: isLocalAdg + required: false + schema: + type: boolean + default: false + listMaintenanceRunsFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/MaintenanceRunSummary/lifecycleState' + schema: + type: string + maintenanceRunIdPathParam: + description: The maintenance run OCID. + in: path + name: maintenanceRunId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListOneoffPatchesSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + ListOneoffPatchesFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/OneoffPatchSummary/lifecycleState' + schema: + type: string + OneoffPatchIdPathParam: + description: The one-off patch [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: oneoffPatchId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListPluggableDatabaseSnapshotsSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - NAME + default: TIMECREATED + ListPluggableDatabaseSnapshotsFilterByLifecycleStateQueryParam: + description: A filter to return only Exadata Pluggable Database Snapshots that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/PluggableDatabaseSnapshot/lifecycleState' + schema: + type: string + ListPluggableDatabaseSnapshotsFilterByClusterQueryParam: + description: A filter to return only Exadata Database Node Snapshots that match the given VM cluster. + in: query + name: clusterId + required: false + schema: + type: string + ListPluggableDatabaseSnapshotsFilterByDatabaseQueryParam: + description: A filter to return only Exadata Pluggable Database Snapshots that match the given database [OCID](/Content/General/Concepts/identifiers.htm). + in: query + name: pluggableDatabaseId + required: false + schema: + type: string + PluggableDatabaseSnapshotIdPathParam: + description: The Exadata Pluggable Database Snapshot [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: pluggableDatabaseSnapshotId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListPluggableDatabasesSortByQueryParam: + description: The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for PDBNAME is ascending. The PDBNAME sort order is case sensitive. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - PDBNAME + - TIMECREATED + default: TIMECREATED + ListPluggableDatabasesFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/PluggableDatabaseSummary/lifecycleState' + schema: + type: string + ListPluggableDatabasesFilterByPdbNameQueryParam: + description: A filter to return only pluggable databases that match the entire name given. The match is not case sensitive. + in: query + name: pdbName + required: false + x-default-description: 'null' + schema: + type: string + PluggableDatabaseIdPathParam: + description: The database [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: pluggableDatabaseId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + InstanceIdPathParam: + description: The Compute Instance [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: instanceId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListParamsActionTypeQueryParam: + description: The type of the scheduled action + in: query + name: type + required: true + x-obmcs-enumref: '#/definitions/RecommendedScheduledActionSummary/actionType' + schema: + type: string + ListParamsPlanIntentQueryParam: + description: The plan intent the action will be used for. Relevant to action type that can be used in multiple plans + in: query + name: planIntent + required: false + x-default-description: Return relevant to action type that can be used in multiple plans + schema: + type: string + enum: + - EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE + - EXADATA_INFRASTRUCTURE_SECURITY_UPDATE + ListScheduledActionsFilterByServiceTypeQueryParam: + description: A filter to return only resources that match the given service type exactly. + in: query + name: serviceType + required: false + x-default-description: Return only resources that match the given service type exactly. + schema: + type: string + minLength: 1 + maxLength: 255 + ListScheduledActionsFilterBySchedulingPlanIdQueryParam: + description: A filter to return only resources that match the given scheduling policy id exactly. + in: query + name: schedulingPlanId + required: false + x-default-description: Return only resources that match the given scheduling policy id exactly. + schema: + type: string + minLength: 1 + maxLength: 255 + ListScheduledActionsSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + default: TIMECREATED + ScheduledActionIdQueryParam: + description: A filter to return only resources that match the given Scheduled Action id exactly. + in: query + name: id + required: false + x-default-description: Return only resources that match the given Scheduled Action id exactly. + schema: + type: string + minLength: 1 + maxLength: 255 + ListScheduledActionsFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-default-description: Return only resources that match the given lifecycle state exactly. + x-obmcs-enumref: '#/definitions/ScheduledActionSummary/lifecycleState' + schema: + type: string + ScheduledActionIdPathParam: + description: The Scheduled Action [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: scheduledActionId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListSchedulingPlansSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + default: TIMECREATED + ListSchedulingPlansFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-default-description: Return only resources that match the given lifecycle state exactly. + x-obmcs-enumref: '#/definitions/SchedulingPlanSummary/lifecycleState' + schema: + type: string + ListSchedulingPlanByResourceIdQueryParam: + description: A filter to return only resources that match the given resource id exactly. + in: query + name: resourceId + required: false + x-default-description: Return only resources that match the given resource id exactly. + schema: + type: string + minLength: 1 + maxLength: 255 + SchedulingPlanIdQueryParam: + description: A filter to return only resources that match the given Schedule Plan id exactly. + in: query + name: id + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + ListSchedulingPlansFilterByPlanIntentQueryParam: + description: A filter to return only resources that match the given plan intent exactly. + in: query + name: planIntent + required: false + x-default-description: Return only resources that match the given plan intent exactly. + schema: + type: string + enum: + - EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE + - EXADATA_INFRASTRUCTURE_SECURITY_UPDATE + SchedulingPlanIdPathParam: + description: The Schedule Plan [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: schedulingPlanId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListSchedulingPoliciesSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + ListSchedulingPoliciesFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/SchedulingPolicySummary/lifecycleState' + schema: + type: string + ListSchedulingPoliciesFilterByCadenceQueryParam: + description: A filter to return only resources that match the given cadence period exactly. + in: query + name: cadence + required: false + x-default-description: returns only resources that match the given cadence period exactly. + x-obmcs-enumref: '#/definitions/SchedulingPolicySummary/cadence' + schema: + type: string + SchedulingPolicyIdPathParam: + description: The Scheduling Policy [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: schedulingPolicyId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + SchedulingPolicyTargetResourceIdQueryParam: + description: The target resource [OCID](/Content/General/Concepts/identifiers.htm) the scheduled actions will be for. + in: query + name: schedulingPolicyTargetResourceId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + PlanIntentQueryParam: + description: The scheduling plan intent the scheduled actions will be for. + in: query + name: planIntent + required: true + schema: + type: string + enum: + - EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE + - EXADATA_INFRASTRUCTURE_SECURITY_UPDATE + ListSchedulingWindowsSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + ListSchedulingWindowsFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/SchedulingWindowSummary/lifecycleState' + schema: + type: string + SchedulingWindowIdPathParam: + description: The Scheduling Window [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: schedulingWindowId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ShapeQueryParam: + description: Specifies shape query parameter. + in: query + name: shape + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + GridInfrastructureVersionQueryParam: + description: Specifies gi version query parameter. + in: query + name: giVersion + required: true + schema: + type: string + minLength: 1 + maxLength: 30 + ListVmClustersSortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + ListVmClustersFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/VmClusterSummary/lifecycleState' + schema: + type: string + VmClusterIdPathParam: + description: The VM cluster [OCID](/Content/General/Concepts/identifiers.htm). + in: path + name: vmClusterId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + FilterByVmClusterUpdateTypeQueryParam: + description: A filter to return only resources that match the given update type exactly. + in: query + name: updateType + required: false + schema: + type: string + enum: + - GI_UPGRADE + - GI_PATCH + - OS_UPDATE + ListVmClusterUpdateHistoryEntriesFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/VmClusterUpdateHistoryEntrySummary/lifecycleState' + schema: + type: string + ListVmClusterUpdatesFilterByLifecycleStateQueryParam: + description: A filter to return only resources that match the given lifecycle state exactly. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/VmClusterUpdateSummary/lifecycleState' + schema: + type: string + requestBodies: + ExadataIormConfigUpdateDetails: + content: + application/json: + schema: + $ref: '#/components/schemas/ExadataIormConfigUpdateDetails' + description: Request to perform database update. + required: true + x-stackQL-resources: + application_vips: + id: oci.database.application_vips + name: application_vips + title: Application Vips + methods: + list: + operation: + $ref: '#/paths/~1applicationVip/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.application_vips + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListApplicationVipsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"application_vips\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1applicationVip/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1applicationVip~1{applicationVipId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1applicationVip~1{applicationVipId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/application_vips/methods/get' + - $ref: '#/components/x-stackQL-resources/application_vips/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/application_vips/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/application_vips/methods/delete' + replace: [] + autonomous_container_database_backups: + id: oci.database.autonomous_container_database_backups + name: autonomous_container_database_backups + title: Autonomous Container Database Backups + methods: + list: + operation: + $ref: '#/paths/~1autonomousContainerDatabaseBackups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_container_database_backups/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + autonomous_container_database_versions: + id: oci.database.autonomous_container_database_versions + name: autonomous_container_database_versions + title: Autonomous Container Database Versions + methods: + list: + operation: + $ref: '#/paths/~1autonomousContainerDatabaseVersions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.autonomous_container_database_versions + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAutonomousContainerDatabaseVersionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"autonomous_container_database_versions\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_container_database_versions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + autonomous_container_databases: + id: oci.database.autonomous_container_databases + name: autonomous_container_databases + title: Autonomous Container Databases + methods: + list: + operation: + $ref: '#/paths/~1autonomousContainerDatabases/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.autonomous_container_databases + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAutonomousContainerDatabasesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"autonomous_container_databases\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousContainerDatabases/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + terminate: + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + add_standby_autonomous_container_database: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}~1actions~1addStandby/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_dataguard_role: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}~1actions~1changeDataguardRole/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + edit_autonomous_container_database_dataguard: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}~1actions~1editDataguard/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + failover_autonomous_container_database_dataguard: + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}~1actions~1failover/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + reinstate_autonomous_container_database_dataguard: + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}~1actions~1reinstate/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + restart_autonomous_container_database: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}~1actions~1restart/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + rotate_autonomous_container_database_encryption_key: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}~1actions~1rotateKey/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + convert_standby_autonomous_container_database: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}~1actions~1snapshotStandby/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + switchover_autonomous_container_database_dataguard: + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}~1actions~1switchover/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_container_databases/methods/get' + - $ref: '#/components/x-stackQL-resources/autonomous_container_databases/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/autonomous_container_databases/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/autonomous_container_databases/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/autonomous_container_databases/methods/terminate' + replace: [] + autonomous_container_database_dataguard_associations: + id: oci.database.autonomous_container_database_dataguard_associations + name: autonomous_container_database_dataguard_associations + title: Autonomous Container Database Dataguard Associations + methods: + list: + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}~1autonomousContainerDatabaseDataguardAssociations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.autonomous_container_database_dataguard_associations + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAutonomousContainerDatabaseDataguardAssociationsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"autonomous_container_database_dataguard_associations\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}~1autonomousContainerDatabaseDataguardAssociations/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}~1autonomousContainerDatabaseDataguardAssociations~1{autonomousContainerDatabaseDataguardAssociationId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}~1autonomousContainerDatabaseDataguardAssociations~1{autonomousContainerDatabaseDataguardAssociationId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + failover_autonomous_container_database_dataguard_association: + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}~1autonomousContainerDatabaseDataguardAssociations~1{autonomousContainerDatabaseDataguardAssociationId}~1actions~1failover/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + migrate_autonomous_container_database_dataguard_association: + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}~1autonomousContainerDatabaseDataguardAssociations~1{autonomousContainerDatabaseDataguardAssociationId}~1actions~1migrate/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + reinstate_autonomous_container_database_dataguard_association: + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}~1autonomousContainerDatabaseDataguardAssociations~1{autonomousContainerDatabaseDataguardAssociationId}~1actions~1reinstate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + switchover_autonomous_container_database_dataguard_association: + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}~1autonomousContainerDatabaseDataguardAssociations~1{autonomousContainerDatabaseDataguardAssociationId}~1actions~1switchover/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_container_database_dataguard_associations/methods/get' + - $ref: '#/components/x-stackQL-resources/autonomous_container_database_dataguard_associations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/autonomous_container_database_dataguard_associations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/autonomous_container_database_dataguard_associations/methods/update' + delete: [] + replace: [] + container_database_patches: + id: oci.database.container_database_patches + name: container_database_patches + title: Container Database Patches + methods: + list: + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}~1patches/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.container_database_patches + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListContainerDatabasePatchesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"container_database_patches\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/container_database_patches/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + autonomous_container_database_resource_usages: + id: oci.database.autonomous_container_database_resource_usages + name: autonomous_container_database_resource_usages + title: Autonomous Container Database Resource Usages + methods: + get: + operation: + $ref: '#/paths/~1autonomousContainerDatabases~1{autonomousContainerDatabaseId}~1resourceUsage/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_container_database_resource_usages/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + autonomous_database_backups: + id: oci.database.autonomous_database_backups + name: autonomous_database_backups + title: Autonomous Database Backups + methods: + list: + operation: + $ref: '#/paths/~1autonomousDatabaseBackups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.autonomous_database_backups + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAutonomousDatabaseBackupsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"autonomous_database_backups\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabaseBackups/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1autonomousDatabaseBackups~1{autonomousDatabaseBackupId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1autonomousDatabaseBackups~1{autonomousDatabaseBackupId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabaseBackups~1{autonomousDatabaseBackupId}/put' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_database_backups/methods/get' + - $ref: '#/components/x-stackQL-resources/autonomous_database_backups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/autonomous_database_backups/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/autonomous_database_backups/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/autonomous_database_backups/methods/delete' + replace: [] + autonomous_database_character_sets: + id: oci.database.autonomous_database_character_sets + name: autonomous_database_character_sets + title: Autonomous Database Character Sets + methods: + list: + operation: + $ref: '#/paths/~1autonomousDatabaseCharacterSets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.autonomous_database_character_sets + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAutonomousDatabaseCharacterSetsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"autonomous_database_character_sets\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_database_character_sets/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + autonomous_database_software_images: + id: oci.database.autonomous_database_software_images + name: autonomous_database_software_images + title: Autonomous Database Software Images + methods: + list: + operation: + $ref: '#/paths/~1autonomousDatabaseSoftwareImages/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabaseSoftwareImages/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1autonomousDatabaseSoftwareImages~1{autonomousDatabaseSoftwareImageId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1autonomousDatabaseSoftwareImages~1{autonomousDatabaseSoftwareImageId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabaseSoftwareImages~1{autonomousDatabaseSoftwareImageId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabaseSoftwareImages~1{autonomousDatabaseSoftwareImageId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_database_software_images/methods/get' + - $ref: '#/components/x-stackQL-resources/autonomous_database_software_images/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/autonomous_database_software_images/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/autonomous_database_software_images/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/autonomous_database_software_images/methods/delete' + replace: [] + autonomous_databases: + id: oci.database.autonomous_databases + name: autonomous_databases + title: Autonomous Databases + methods: + list: + operation: + $ref: '#/paths/~1autonomousDatabases/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.autonomous_databases + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAutonomousDatabasesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"autonomous_databases\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabases/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + resource_pool_shapes: + operation: + $ref: '#/paths/~1autonomousDatabases~1actions~1listResourcePoolShapes/post' + response: + mediaType: application/json + openAPIDocKey: '200' + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_disaster_recovery_configuration: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1changeDisasterRecoveryConfiguration/put' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_autonomous_database_subscription: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1changeSubscription/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + configure_autonomous_database_vault_key: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1configureAutonomousDatabaseVaultKey/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + configure_saas_admin_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1configureSaasAdminUser/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + deregister_autonomous_database_data_safe: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1deregisterDataSafe/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + disable_autonomous_database_management: + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1disableDatabaseManagement/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + disable_autonomous_database_operations_insights: + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1disableOperationsInsights/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + enable_autonomous_database_management: + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1enableDatabaseManagement/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + enable_autonomous_database_operations_insights: + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1enableOperationsInsights/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + fail_over_autonomous_database: + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1failover/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + generate_autonomous_database_wallet: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1generateWallet/post' + response: + mediaType: application/octet-stream + openAPIDocKey: '200' + request: + nativeCasing: camel + saas_admin_user_status: + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1getSaasAdminUserStatus/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + import_transportable_tablespace: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1importTransportableTablespace/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + autonomous_database_manual_refresh: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1refresh/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + register_autonomous_database_data_safe: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1registerDataSafe/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + restart_autonomous_database: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1restart/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + restore_autonomous_database: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1restore/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + rotate_autonomous_database_encryption_key: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1rotateKey/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + shrink_autonomous_database: + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1shrink/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + start_autonomous_database: + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1start/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + stop_autonomous_database: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1stop/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + switchover_autonomous_database: + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1actions~1switchover/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_databases/methods/get' + - $ref: '#/components/x-stackQL-resources/autonomous_databases/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/autonomous_databases/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/autonomous_databases/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/autonomous_databases/methods/delete' + replace: [] + autonomous_database_regional_wallets: + id: oci.database.autonomous_database_regional_wallets + name: autonomous_database_regional_wallets + title: Autonomous Database Regional Wallets + methods: + get: + operation: + $ref: '#/paths/~1autonomousDatabases~1wallet/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabases~1wallet/put' + response: + mediaType: application-json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_database_regional_wallets/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/autonomous_database_regional_wallets/methods/update' + delete: [] + replace: [] + autonomous_database_dataguard_associations: + id: oci.database.autonomous_database_dataguard_associations + name: autonomous_database_dataguard_associations + title: Autonomous Database Dataguard Associations + methods: + list: + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1autonomousDatabaseDataguardAssociations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.autonomous_database_dataguard_associations + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAutonomousDatabaseDataguardAssociationsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"autonomous_database_dataguard_associations\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1autonomousDatabaseDataguardAssociations~1{autonomousDatabaseDataguardAssociationId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_database_dataguard_associations/methods/get' + - $ref: '#/components/x-stackQL-resources/autonomous_database_dataguard_associations/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + autonomous_database_clones: + id: oci.database.autonomous_database_clones + name: autonomous_database_clones + title: Autonomous Database Clones + methods: + list: + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1clones/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.autonomous_database_clones + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAutonomousDatabaseClonesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"autonomous_database_clones\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_database_clones/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + estimate_cost_savings: + id: oci.database.estimate_cost_savings + name: estimate_cost_savings + title: Estimate Cost Savings + methods: + list: + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1estimateCostSavings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/estimate_cost_savings/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + autonomous_database_peers: + id: oci.database.autonomous_database_peers + name: autonomous_database_peers + title: Autonomous Database Peers + methods: + list: + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1peers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_database_peers/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + autonomous_database_refreshable_clones: + id: oci.database.autonomous_database_refreshable_clones + name: autonomous_database_refreshable_clones + title: Autonomous Database Refreshable Clones + methods: + list: + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1refreshableClones/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_database_refreshable_clones/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + resource_pool_members: + id: oci.database.resource_pool_members + name: resource_pool_members + title: Resource Pool Members + methods: + list: + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1resourcePoolMembers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/resource_pool_members/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + autonomous_database_wallets: + id: oci.database.autonomous_database_wallets + name: autonomous_database_wallets + title: Autonomous Database Wallets + methods: + get: + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1wallet/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousDatabases~1{autonomousDatabaseId}~1wallet/put' + response: + mediaType: application-json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_database_wallets/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/autonomous_database_wallets/methods/update' + delete: [] + replace: [] + autonomous_db_preview_versions: + id: oci.database.autonomous_db_preview_versions + name: autonomous_db_preview_versions + title: Autonomous Db Preview Versions + methods: + list: + operation: + $ref: '#/paths/~1autonomousDbPreviewVersions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.autonomous_db_preview_versions + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAutonomousDbPreviewVersionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"autonomous_db_preview_versions\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_db_preview_versions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + autonomous_db_versions: + id: oci.database.autonomous_db_versions + name: autonomous_db_versions + title: Autonomous Db Versions + methods: + list: + operation: + $ref: '#/paths/~1autonomousDbVersions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.autonomous_db_versions + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAutonomousDbVersionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"autonomous_db_versions\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_db_versions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + autonomous_exadata_infrastructure_shapes: + id: oci.database.autonomous_exadata_infrastructure_shapes + name: autonomous_exadata_infrastructure_shapes + title: Autonomous Exadata Infrastructure Shapes + methods: + list: + operation: + $ref: '#/paths/~1autonomousExadataInfrastructureShapes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.autonomous_exadata_infrastructure_shapes + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAutonomousExadataInfrastructureShapesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"autonomous_exadata_infrastructure_shapes\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_exadata_infrastructure_shapes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + autonomous_exadata_infrastructures: + id: oci.database.autonomous_exadata_infrastructures + name: autonomous_exadata_infrastructures + title: Autonomous Exadata Infrastructures + methods: + list: + operation: + $ref: '#/paths/~1autonomousExadataInfrastructures/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.autonomous_exadata_infrastructures + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAutonomousExadataInfrastructuresResponse' + transform: + body: |- + {{- $wrapped := printf "{\"autonomous_exadata_infrastructures\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + launch: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousExadataInfrastructures/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + terminate: + operation: + $ref: '#/paths/~1autonomousExadataInfrastructures~1{autonomousExadataInfrastructureId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1autonomousExadataInfrastructures~1{autonomousExadataInfrastructureId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousExadataInfrastructures~1{autonomousExadataInfrastructureId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousExadataInfrastructures~1{autonomousExadataInfrastructureId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + rotate_ords_certs: + operation: + $ref: '#/paths/~1autonomousExadataInfrastructures~1{autonomousExadataInfrastructureId}~1actions~1rotateOrdsCerts/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + rotate_ssl_certs: + operation: + $ref: '#/paths/~1autonomousExadataInfrastructures~1{autonomousExadataInfrastructureId}~1actions~1rotateSslCerts/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_exadata_infrastructures/methods/get' + - $ref: '#/components/x-stackQL-resources/autonomous_exadata_infrastructures/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/autonomous_exadata_infrastructures/methods/launch' + update: + - $ref: '#/components/x-stackQL-resources/autonomous_exadata_infrastructures/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/autonomous_exadata_infrastructures/methods/terminate' + replace: [] + exadata_infrastructure_ocpus: + id: oci.database.exadata_infrastructure_ocpus + name: exadata_infrastructure_ocpus + title: Exadata Infrastructure Ocpus + methods: + get: + operation: + $ref: '#/paths/~1autonomousExadataInfrastructures~1{autonomousExadataInfrastructureId}~1ocpus/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/exadata_infrastructure_ocpus/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + autonomous_patches: + id: oci.database.autonomous_patches + name: autonomous_patches + title: Autonomous Patches + methods: + get: + operation: + $ref: '#/paths/~1autonomousPatches~1{autonomousPatchId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_patches/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + autonomous_virtual_machines: + id: oci.database.autonomous_virtual_machines + name: autonomous_virtual_machines + title: Autonomous Virtual Machines + methods: + list: + operation: + $ref: '#/paths/~1autonomousVirtualMachines/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.autonomous_virtual_machines + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAutonomousVirtualMachinesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"autonomous_virtual_machines\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1autonomousVirtualMachines~1{autonomousVirtualMachineId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_virtual_machines/methods/get' + - $ref: '#/components/x-stackQL-resources/autonomous_virtual_machines/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + autonomous_vm_clusters: + id: oci.database.autonomous_vm_clusters + name: autonomous_vm_clusters + title: Autonomous Vm Clusters + methods: + list: + operation: + $ref: '#/paths/~1autonomousVmClusters/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.autonomous_vm_clusters + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAutonomousVmClustersResponse' + transform: + body: |- + {{- $wrapped := printf "{\"autonomous_vm_clusters\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousVmClusters/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1autonomousVmClusters~1{autonomousVmClusterId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1autonomousVmClusters~1{autonomousVmClusterId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousVmClusters~1{autonomousVmClusterId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousVmClusters~1{autonomousVmClusterId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + restart_autonomous_vm_cluster_ords: + operation: + $ref: '#/paths/~1autonomousVmClusters~1{autonomousVmClusterId}~1actions~1restartOrds/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + rotate_autonomous_vm_cluster_ords_certs: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousVmClusters~1{autonomousVmClusterId}~1actions~1rotateOrdsCerts/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + rotate_autonomous_vm_cluster_ssl_certs: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1autonomousVmClusters~1{autonomousVmClusterId}~1actions~1rotateSslCerts/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_vm_clusters/methods/get' + - $ref: '#/components/x-stackQL-resources/autonomous_vm_clusters/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/autonomous_vm_clusters/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/autonomous_vm_clusters/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/autonomous_vm_clusters/methods/delete' + replace: [] + autonomous_vm_cluster_acd_resource_usage: + id: oci.database.autonomous_vm_cluster_acd_resource_usage + name: autonomous_vm_cluster_acd_resource_usage + title: Autonomous Vm Cluster Acd Resource Usage + methods: + list: + operation: + $ref: '#/paths/~1autonomousVmClusters~1{autonomousVmClusterId}~1acdResourceUsage/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.autonomous_vm_cluster_acd_resource_usage + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAutonomousVmClusterAcdResourceUsageResponse' + transform: + body: |- + {{- $wrapped := printf "{\"autonomous_vm_cluster_acd_resource_usage\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_vm_cluster_acd_resource_usage/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + autonomous_vm_cluster_resource_usages: + id: oci.database.autonomous_vm_cluster_resource_usages + name: autonomous_vm_cluster_resource_usages + title: Autonomous Vm Cluster Resource Usages + methods: + get: + operation: + $ref: '#/paths/~1autonomousVmClusters~1{autonomousVmClusterId}~1resourceUsage/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autonomous_vm_cluster_resource_usages/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + backup_destination: + id: oci.database.backup_destination + name: backup_destination + title: Backup Destination + methods: + list: + operation: + $ref: '#/paths/~1backupDestinations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.backup_destination + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListBackupDestinationResponse' + transform: + body: |- + {{- $wrapped := printf "{\"backup_destination\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/backup_destination/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + backup_destinations: + id: oci.database.backup_destinations + name: backup_destinations + title: Backup Destinations + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1backupDestinations/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1backupDestinations~1{backupDestinationId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1backupDestinations~1{backupDestinationId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1backupDestinations~1{backupDestinationId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1backupDestinations~1{backupDestinationId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/backup_destinations/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/backup_destinations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/backup_destinations/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/backup_destinations/methods/delete' + replace: [] + backups: + id: oci.database.backups + name: backups + title: Backups + methods: + list: + operation: + $ref: '#/paths/~1backups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.backups + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListBackupsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"backups\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1backups/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1backups~1{backupId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1backups~1{backupId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1backups~1{backupId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/backups/methods/get' + - $ref: '#/components/x-stackQL-resources/backups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/backups/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/backups/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/backups/methods/delete' + replace: [] + cloud_autonomous_vm_clusters: + id: oci.database.cloud_autonomous_vm_clusters + name: cloud_autonomous_vm_clusters + title: Cloud Autonomous Vm Clusters + methods: + list: + operation: + $ref: '#/paths/~1cloudAutonomousVmClusters/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.cloud_autonomous_vm_clusters + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListCloudAutonomousVmClustersResponse' + transform: + body: |- + {{- $wrapped := printf "{\"cloud_autonomous_vm_clusters\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cloudAutonomousVmClusters/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1cloudAutonomousVmClusters~1{cloudAutonomousVmClusterId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1cloudAutonomousVmClusters~1{cloudAutonomousVmClusterId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cloudAutonomousVmClusters~1{cloudAutonomousVmClusterId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cloudAutonomousVmClusters~1{cloudAutonomousVmClusterId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + restart_cloud_autonomous_vm_cluster_ords: + operation: + $ref: '#/paths/~1cloudAutonomousVmClusters~1{cloudAutonomousVmClusterId}~1actions~1restartOrds/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + rotate_cloud_autonomous_vm_cluster_ords_certs: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cloudAutonomousVmClusters~1{cloudAutonomousVmClusterId}~1actions~1rotateOrdsCerts/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + rotate_cloud_autonomous_vm_cluster_ssl_certs: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cloudAutonomousVmClusters~1{cloudAutonomousVmClusterId}~1actions~1rotateSslCerts/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cloud_autonomous_vm_clusters/methods/get' + - $ref: '#/components/x-stackQL-resources/cloud_autonomous_vm_clusters/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/cloud_autonomous_vm_clusters/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/cloud_autonomous_vm_clusters/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/cloud_autonomous_vm_clusters/methods/delete' + replace: [] + cloud_autonomous_vm_cluster_acd_resource_usage: + id: oci.database.cloud_autonomous_vm_cluster_acd_resource_usage + name: cloud_autonomous_vm_cluster_acd_resource_usage + title: Cloud Autonomous Vm Cluster Acd Resource Usage + methods: + list: + operation: + $ref: '#/paths/~1cloudAutonomousVmClusters~1{cloudAutonomousVmClusterId}~1acdResourceUsage/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.cloud_autonomous_vm_cluster_acd_resource_usage + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListCloudAutonomousVmClusterAcdResourceUsageResponse' + transform: + body: |- + {{- $wrapped := printf "{\"cloud_autonomous_vm_cluster_acd_resource_usage\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cloud_autonomous_vm_cluster_acd_resource_usage/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + cloud_autonomous_vm_cluster_resource_usages: + id: oci.database.cloud_autonomous_vm_cluster_resource_usages + name: cloud_autonomous_vm_cluster_resource_usages + title: Cloud Autonomous Vm Cluster Resource Usages + methods: + get: + operation: + $ref: '#/paths/~1cloudAutonomousVmClusters~1{cloudAutonomousVmClusterId}~1resourceUsage/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cloud_autonomous_vm_cluster_resource_usages/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + cloud_exadata_infrastructures: + id: oci.database.cloud_exadata_infrastructures + name: cloud_exadata_infrastructures + title: Cloud Exadata Infrastructures + methods: + list: + operation: + $ref: '#/paths/~1cloudExadataInfrastructures/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.cloud_exadata_infrastructures + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListCloudExadataInfrastructuresResponse' + transform: + body: |- + {{- $wrapped := printf "{\"cloud_exadata_infrastructures\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cloudExadataInfrastructures/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1cloudExadataInfrastructures~1{cloudExadataInfrastructureId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1cloudExadataInfrastructures~1{cloudExadataInfrastructureId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cloudExadataInfrastructures~1{cloudExadataInfrastructureId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + add_storage_capacity_cloud_exadata_infrastructure: + operation: + $ref: '#/paths/~1cloudExadataInfrastructures~1{cloudExadataInfrastructureId}~1actions~1addStorageCapacity/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cloudExadataInfrastructures~1{cloudExadataInfrastructureId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_cloud_exadata_infrastructure_subscription: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cloudExadataInfrastructures~1{cloudExadataInfrastructureId}~1actions~1changeSubscription/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + configure_exascale_cloud_exadata_infrastructure: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cloudExadataInfrastructures~1{cloudExadataInfrastructureId}~1actions~1configureExascale/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cloud_exadata_infrastructures/methods/get' + - $ref: '#/components/x-stackQL-resources/cloud_exadata_infrastructures/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/cloud_exadata_infrastructures/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/cloud_exadata_infrastructures/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/cloud_exadata_infrastructures/methods/delete' + replace: [] + cloud_exadata_infrastructure_unallocated_resources: + id: oci.database.cloud_exadata_infrastructure_unallocated_resources + name: cloud_exadata_infrastructure_unallocated_resources + title: Cloud Exadata Infrastructure Unallocated Resources + methods: + get: + operation: + $ref: '#/paths/~1cloudExadataInfrastructures~1{cloudExadataInfrastructureId}~1unAllocatedResources/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cloud_exadata_infrastructure_unallocated_resources/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + cloud_vm_clusters: + id: oci.database.cloud_vm_clusters + name: cloud_vm_clusters + title: Cloud Vm Clusters + methods: + list: + operation: + $ref: '#/paths/~1cloudVmClusters/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.cloud_vm_clusters + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListCloudVmClustersResponse' + transform: + body: |- + {{- $wrapped := printf "{\"cloud_vm_clusters\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cloudVmClusters/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1cloudVmClusters~1{cloudVmClusterId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1cloudVmClusters~1{cloudVmClusterId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cloudVmClusters~1{cloudVmClusterId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + add_virtual_machine_to_cloud_vm_cluster: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cloudVmClusters~1{cloudVmClusterId}~1actions~1addVirtualMachine/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cloudVmClusters~1{cloudVmClusterId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_cloud_vm_cluster_subscription: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cloudVmClusters~1{cloudVmClusterId}~1actions~1changeSubscription/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + register_cloud_vm_cluster_pkcs: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cloudVmClusters~1{cloudVmClusterId}~1actions~1registerPkcs/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + remove_virtual_machine_from_cloud_vm_cluster: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cloudVmClusters~1{cloudVmClusterId}~1actions~1removeVirtualMachine/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + unregister_cloud_vm_cluster_pkcs: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cloudVmClusters~1{cloudVmClusterId}~1actions~1unregisterPkcs/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cloud_vm_clusters/methods/get' + - $ref: '#/components/x-stackQL-resources/cloud_vm_clusters/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/cloud_vm_clusters/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/cloud_vm_clusters/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/cloud_vm_clusters/methods/delete' + replace: [] + cloud_vm_cluster_iorm_configs: + id: oci.database.cloud_vm_cluster_iorm_configs + name: cloud_vm_cluster_iorm_configs + title: Cloud Vm Cluster Iorm Configs + methods: + get: + operation: + $ref: '#/paths/~1cloudVmClusters~1{cloudVmClusterId}~1CloudVmClusterIormConfig/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cloudVmClusters~1{cloudVmClusterId}~1CloudVmClusterIormConfig/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cloud_vm_cluster_iorm_configs/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/cloud_vm_cluster_iorm_configs/methods/update' + delete: [] + replace: [] + cloud_vm_cluster_update_history_entries: + id: oci.database.cloud_vm_cluster_update_history_entries + name: cloud_vm_cluster_update_history_entries + title: Cloud Vm Cluster Update History Entries + methods: + list: + operation: + $ref: '#/paths/~1cloudVmClusters~1{cloudVmClusterId}~1updateHistoryEntries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.cloud_vm_cluster_update_history_entries + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListCloudVmClusterUpdateHistoryEntriesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"cloud_vm_cluster_update_history_entries\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1cloudVmClusters~1{cloudVmClusterId}~1updateHistoryEntries~1{updateHistoryEntryId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cloud_vm_cluster_update_history_entries/methods/get' + - $ref: '#/components/x-stackQL-resources/cloud_vm_cluster_update_history_entries/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + cloud_vm_cluster_updates: + id: oci.database.cloud_vm_cluster_updates + name: cloud_vm_cluster_updates + title: Cloud Vm Cluster Updates + methods: + list: + operation: + $ref: '#/paths/~1cloudVmClusters~1{cloudVmClusterId}~1updates/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.cloud_vm_cluster_updates + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListCloudVmClusterUpdatesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"cloud_vm_cluster_updates\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1cloudVmClusters~1{cloudVmClusterId}~1updates~1{updateId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cloud_vm_cluster_updates/methods/get' + - $ref: '#/components/x-stackQL-resources/cloud_vm_cluster_updates/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + database_software_images: + id: oci.database.database_software_images + name: database_software_images + title: Database Software Images + methods: + list: + operation: + $ref: '#/paths/~1databaseSoftwareImages/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.database_software_images + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDatabaseSoftwareImagesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"database_software_images\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1databaseSoftwareImages/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1databaseSoftwareImages~1{databaseSoftwareImageId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1databaseSoftwareImages~1{databaseSoftwareImageId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1databaseSoftwareImages~1{databaseSoftwareImageId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1databaseSoftwareImages~1{databaseSoftwareImageId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/database_software_images/methods/get' + - $ref: '#/components/x-stackQL-resources/database_software_images/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/database_software_images/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/database_software_images/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/database_software_images/methods/delete' + replace: [] + databases: + id: oci.database.databases + name: databases + title: Databases + methods: + list: + operation: + $ref: '#/paths/~1databases/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.databases + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDatabasesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"databases\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1databases/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1databases~1{databaseId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1databases~1{databaseId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1databases~1{databaseId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_encryption_key_location: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1databases~1{databaseId}~1actions~1changeEncryptionKeyLocation/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + convert_to_pdb: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1databases~1{databaseId}~1actions~1convertToPdb/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + disable_database_management: + operation: + $ref: '#/paths/~1databases~1{databaseId}~1actions~1disableDatabaseManagement/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + enable_database_management: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1databases~1{databaseId}~1actions~1enableDatabaseManagement/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + migrate_vault_key: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1databases~1{databaseId}~1actions~1migrateKey/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + modify_database_management: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1databases~1{databaseId}~1actions~1modifyDatabaseManagement/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + reschedule_managed_db_software_update: + operation: + $ref: '#/paths/~1databases~1{databaseId}~1actions~1rescheduleManagedDbSoftwareUpdate/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + restore_database: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1databases~1{databaseId}~1actions~1restore/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + rotate_vault_key: + operation: + $ref: '#/paths/~1databases~1{databaseId}~1actions~1rotateKey/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + upgrade_database: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1databases~1{databaseId}~1actions~1upgrade/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/databases/methods/get' + - $ref: '#/components/x-stackQL-resources/databases/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/databases/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/databases/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/databases/methods/delete' + replace: [] + data_guards: + id: oci.database.data_guards + name: data_guards + title: Data Guards + methods: + convert_to_standalone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1databases~1{databaseId}~1dataGuard~1actions~1convertToStandalone/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + failover_data_guard: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1databases~1{databaseId}~1dataGuard~1actions~1failover/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + reinstate_data_guard: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1databases~1{databaseId}~1dataGuard~1actions~1reinstate/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + switch_over_data_guard: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1databases~1{databaseId}~1dataGuard~1actions~1switchover/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1databases~1{databaseId}~1dataGuard~1actions~1updateDataGuard/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/data_guards/methods/update' + delete: [] + replace: [] + data_guard_associations: + id: oci.database.data_guard_associations + name: data_guard_associations + title: Data Guard Associations + methods: + list: + operation: + $ref: '#/paths/~1databases~1{databaseId}~1dataGuardAssociations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.data_guard_associations + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDataGuardAssociationsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"data_guard_associations\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1databases~1{databaseId}~1dataGuardAssociations/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1databases~1{databaseId}~1dataGuardAssociations~1{dataGuardAssociationId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1databases~1{databaseId}~1dataGuardAssociations~1{dataGuardAssociationId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + failover_data_guard_association: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1databases~1{databaseId}~1dataGuardAssociations~1{dataGuardAssociationId}~1actions~1failover/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + migrate_data_guard_association_to_multi_data_guards: + operation: + $ref: '#/paths/~1databases~1{databaseId}~1dataGuardAssociations~1{dataGuardAssociationId}~1actions~1migrate/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + reinstate_data_guard_association: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1databases~1{databaseId}~1dataGuardAssociations~1{dataGuardAssociationId}~1actions~1reinstate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + switchover_data_guard_association: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1databases~1{databaseId}~1dataGuardAssociations~1{dataGuardAssociationId}~1actions~1switchover/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/data_guard_associations/methods/get' + - $ref: '#/components/x-stackQL-resources/data_guard_associations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/data_guard_associations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/data_guard_associations/methods/update' + delete: [] + replace: [] + pdb_conversion_history_entries: + id: oci.database.pdb_conversion_history_entries + name: pdb_conversion_history_entries + title: Pdb Conversion History Entries + methods: + list: + operation: + $ref: '#/paths/~1databases~1{databaseId}~1pdbConversionHistoryEntries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.pdb_conversion_history_entries + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListPdbConversionHistoryEntriesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"pdb_conversion_history_entries\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1databases~1{databaseId}~1pdbConversionHistoryEntries~1{pdbConversionHistoryEntryId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pdb_conversion_history_entries/methods/get' + - $ref: '#/components/x-stackQL-resources/pdb_conversion_history_entries/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + database_upgrade_history_entries: + id: oci.database.database_upgrade_history_entries + name: database_upgrade_history_entries + title: Database Upgrade History Entries + methods: + list: + operation: + $ref: '#/paths/~1databases~1{databaseId}~1upgradeHistoryEntries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.database_upgrade_history_entries + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDatabaseUpgradeHistoryEntriesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"database_upgrade_history_entries\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1databases~1{databaseId}~1upgradeHistoryEntries~1{upgradeHistoryEntryId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/database_upgrade_history_entries/methods/get' + - $ref: '#/components/x-stackQL-resources/database_upgrade_history_entries/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + db_connection_bundles: + id: oci.database.db_connection_bundles + name: db_connection_bundles + title: Db Connection Bundles + methods: + list: + operation: + $ref: '#/paths/~1dbConnectionBundles/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.db_connection_bundles + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDbConnectionBundlesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"db_connection_bundles\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1dbConnectionBundles~1{dbConnectionBundleId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + download_db_connection_bundle: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dbConnectionBundles~1{dbConnectionBundleId}~1actions~1download/post' + response: + mediaType: application/octet-stream + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/db_connection_bundles/methods/get' + - $ref: '#/components/x-stackQL-resources/db_connection_bundles/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + db_homes: + id: oci.database.db_homes + name: db_homes + title: Db Homes + methods: + list: + operation: + $ref: '#/paths/~1dbHomes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.db_homes + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDbHomesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"db_homes\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dbHomes/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1dbHomes~1{dbHomeId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1dbHomes~1{dbHomeId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dbHomes~1{dbHomeId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/db_homes/methods/get' + - $ref: '#/components/x-stackQL-resources/db_homes/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/db_homes/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/db_homes/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/db_homes/methods/delete' + replace: [] + db_home_patch_history_entries: + id: oci.database.db_home_patch_history_entries + name: db_home_patch_history_entries + title: Db Home Patch History Entries + methods: + list: + operation: + $ref: '#/paths/~1dbHomes~1{dbHomeId}~1patchHistoryEntries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.db_home_patch_history_entries + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDbHomePatchHistoryEntriesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"db_home_patch_history_entries\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1dbHomes~1{dbHomeId}~1patchHistoryEntries~1{patchHistoryEntryId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/db_home_patch_history_entries/methods/get' + - $ref: '#/components/x-stackQL-resources/db_home_patch_history_entries/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + db_home_patches: + id: oci.database.db_home_patches + name: db_home_patches + title: Db Home Patches + methods: + list: + operation: + $ref: '#/paths/~1dbHomes~1{dbHomeId}~1patches/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.db_home_patches + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDbHomePatchesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"db_home_patches\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1dbHomes~1{dbHomeId}~1patches~1{patchId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/db_home_patches/methods/get' + - $ref: '#/components/x-stackQL-resources/db_home_patches/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + db_nodes: + id: oci.database.db_nodes + name: db_nodes + title: Db Nodes + methods: + list: + operation: + $ref: '#/paths/~1dbNodes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.db_nodes + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDbNodesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"db_nodes\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1dbNodes~1{dbNodeId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + db_node_action: + operation: + $ref: '#/paths/~1dbNodes~1{dbNodeId}/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/db_nodes/methods/get' + - $ref: '#/components/x-stackQL-resources/db_nodes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + console_connections: + id: oci.database.console_connections + name: console_connections + title: Console Connections + methods: + list: + operation: + $ref: '#/paths/~1dbNodes~1{dbNodeId}~1consoleConnections/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.console_connections + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListConsoleConnectionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"console_connections\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dbNodes~1{dbNodeId}~1consoleConnections/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1dbNodes~1{dbNodeId}~1consoleConnections~1{consoleConnectionId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1dbNodes~1{dbNodeId}~1consoleConnections~1{consoleConnectionId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/console_connections/methods/get' + - $ref: '#/components/x-stackQL-resources/console_connections/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/console_connections/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/console_connections/methods/delete' + replace: [] + console_histories: + id: oci.database.console_histories + name: console_histories + title: Console Histories + methods: + list: + operation: + $ref: '#/paths/~1dbNodes~1{dbNodeId}~1consoleHistories/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dbNodes~1{dbNodeId}~1consoleHistories/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1dbNodes~1{dbNodeId}~1consoleHistories~1{consoleHistoryId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1dbNodes~1{dbNodeId}~1consoleHistories~1{consoleHistoryId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dbNodes~1{dbNodeId}~1consoleHistories~1{consoleHistoryId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/console_histories/methods/get' + - $ref: '#/components/x-stackQL-resources/console_histories/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/console_histories/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/console_histories/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/console_histories/methods/delete' + replace: [] + console_history_contents: + id: oci.database.console_history_contents + name: console_history_contents + title: Console History Contents + methods: + get: + operation: + $ref: '#/paths/~1dbNodes~1{dbNodeId}~1consoleHistories~1{consoleHistoryId}~1content/get' + response: + mediaType: application/octet-stream + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/console_history_contents/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + db_servers: + id: oci.database.db_servers + name: db_servers + title: Db Servers + methods: + list: + operation: + $ref: '#/paths/~1dbServers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.db_servers + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDbServersResponse' + transform: + body: |- + {{- $wrapped := printf "{\"db_servers\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1dbServers~1{dbServerId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/db_servers/methods/get' + - $ref: '#/components/x-stackQL-resources/db_servers/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + db_system_compute_performances: + id: oci.database.db_system_compute_performances + name: db_system_compute_performances + title: Db System Compute Performances + methods: + list: + operation: + $ref: '#/paths/~1dbSystemComputePerformance/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.db_system_compute_performances + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDbSystemComputePerformancesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"db_system_compute_performances\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/db_system_compute_performances/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + db_system_shapes: + id: oci.database.db_system_shapes + name: db_system_shapes + title: Db System Shapes + methods: + list: + operation: + $ref: '#/paths/~1dbSystemShapes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.db_system_shapes + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDbSystemShapesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"db_system_shapes\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/db_system_shapes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + flex_components: + id: oci.database.flex_components + name: flex_components + title: Flex Components + methods: + list: + operation: + $ref: '#/paths/~1dbSystemShapes~1flexComponents/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/flex_components/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + db_system_storage_performances: + id: oci.database.db_system_storage_performances + name: db_system_storage_performances + title: Db System Storage Performances + methods: + list: + operation: + $ref: '#/paths/~1dbSystemStoragePerformance/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.db_system_storage_performances + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDbSystemStoragePerformancesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"db_system_storage_performances\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/db_system_storage_performances/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + db_systems: + id: oci.database.db_systems + name: db_systems + title: Db Systems + methods: + list: + operation: + $ref: '#/paths/~1dbSystems/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.db_systems + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDbSystemsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"db_systems\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + launch: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dbSystems/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + terminate: + operation: + $ref: '#/paths/~1dbSystems~1{dbSystemId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1dbSystems~1{dbSystemId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dbSystems~1{dbSystemId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dbSystems~1{dbSystemId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + migrate_exadata_db_system_resource_model: + operation: + $ref: '#/paths/~1dbSystems~1{dbSystemId}~1actions~1migration/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + execute_db_system_os_patch: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dbSystems~1{dbSystemId}~1actions~1osPatch/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + upgrade_db_system: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dbSystems~1{dbSystemId}~1actions~1upgrade/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/db_systems/methods/get' + - $ref: '#/components/x-stackQL-resources/db_systems/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/db_systems/methods/launch' + update: + - $ref: '#/components/x-stackQL-resources/db_systems/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/db_systems/methods/terminate' + replace: [] + exadata_iorm_configs: + id: oci.database.exadata_iorm_configs + name: exadata_iorm_configs + title: Exadata Iorm Configs + methods: + get: + operation: + $ref: '#/paths/~1dbSystems~1{dbSystemId}~1ExadataIormConfig/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dbSystems~1{dbSystemId}~1ExadataIormConfig/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/exadata_iorm_configs/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/exadata_iorm_configs/methods/update' + delete: [] + replace: [] + db_system_upgrades: + id: oci.database.db_system_upgrades + name: db_system_upgrades + title: Db System Upgrades + methods: + list: + operation: + $ref: '#/paths/~1dbSystems~1{dbSystemId}~1dbSystemUpgrades/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.db_system_upgrades + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDbSystemUpgradesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"db_system_upgrades\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/db_system_upgrades/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + db_system_os_patch_history_entries: + id: oci.database.db_system_os_patch_history_entries + name: db_system_os_patch_history_entries + title: Db System Os Patch History Entries + methods: + list: + operation: + $ref: '#/paths/~1dbSystems~1{dbSystemId}~1osPatchHistoryEntries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1dbSystems~1{dbSystemId}~1osPatchHistoryEntries~1{osPatchHistoryEntryId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/db_system_os_patch_history_entries/methods/get' + - $ref: '#/components/x-stackQL-resources/db_system_os_patch_history_entries/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + db_system_patch_history_entries: + id: oci.database.db_system_patch_history_entries + name: db_system_patch_history_entries + title: Db System Patch History Entries + methods: + list: + operation: + $ref: '#/paths/~1dbSystems~1{dbSystemId}~1patchHistoryEntries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.db_system_patch_history_entries + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDbSystemPatchHistoryEntriesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"db_system_patch_history_entries\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1dbSystems~1{dbSystemId}~1patchHistoryEntries~1{patchHistoryEntryId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/db_system_patch_history_entries/methods/get' + - $ref: '#/components/x-stackQL-resources/db_system_patch_history_entries/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + db_system_patches: + id: oci.database.db_system_patches + name: db_system_patches + title: Db System Patches + methods: + list: + operation: + $ref: '#/paths/~1dbSystems~1{dbSystemId}~1patches/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.db_system_patches + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDbSystemPatchesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"db_system_patches\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1dbSystems~1{dbSystemId}~1patches~1{patchId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/db_system_patches/methods/get' + - $ref: '#/components/x-stackQL-resources/db_system_patches/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + db_system_upgrade_history_entries: + id: oci.database.db_system_upgrade_history_entries + name: db_system_upgrade_history_entries + title: Db System Upgrade History Entries + methods: + list: + operation: + $ref: '#/paths/~1dbSystems~1{dbSystemId}~1upgradeHistoryEntries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.db_system_upgrade_history_entries + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDbSystemUpgradeHistoryEntriesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"db_system_upgrade_history_entries\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1dbSystems~1{dbSystemId}~1upgradeHistoryEntries~1{upgradeHistoryEntryId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/db_system_upgrade_history_entries/methods/get' + - $ref: '#/components/x-stackQL-resources/db_system_upgrade_history_entries/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + db_versions: + id: oci.database.db_versions + name: db_versions + title: Db Versions + methods: + list: + operation: + $ref: '#/paths/~1dbVersions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.db_versions + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDbVersionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"db_versions\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/db_versions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + dbnode_snapshots: + id: oci.database.dbnode_snapshots + name: dbnode_snapshots + title: Dbnode Snapshots + methods: + list: + operation: + $ref: '#/paths/~1dbnodeSnapshots/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.dbnode_snapshots + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDbnodeSnapshotsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"dbnode_snapshots\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1dbnodeSnapshots~1{dbnodeSnapshotId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1dbnodeSnapshots~1{dbnodeSnapshotId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + mount_dbnode_snapshot: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dbnodeSnapshots~1{dbnodeSnapshotId}~1actions~1mount/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + unmount_dbnode_snapshot: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dbnodeSnapshots~1{dbnodeSnapshotId}~1actions~1unmount/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dbnode_snapshots/methods/get' + - $ref: '#/components/x-stackQL-resources/dbnode_snapshots/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/dbnode_snapshots/methods/delete' + replace: [] + exadata_infrastructures: + id: oci.database.exadata_infrastructures + name: exadata_infrastructures + title: Exadata Infrastructures + methods: + list: + operation: + $ref: '#/paths/~1exadataInfrastructures/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.exadata_infrastructures + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListExadataInfrastructuresResponse' + transform: + body: |- + {{- $wrapped := printf "{\"exadata_infrastructures\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1exadataInfrastructures/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1exadataInfrastructures~1{exadataInfrastructureId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1exadataInfrastructures~1{exadataInfrastructureId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1exadataInfrastructures~1{exadataInfrastructureId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + activate_exadata_infrastructure: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1exadataInfrastructures~1{exadataInfrastructureId}~1actions~1activate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + add_storage_capacity_exadata_infrastructure: + operation: + $ref: '#/paths/~1exadataInfrastructures~1{exadataInfrastructureId}~1actions~1addStorageCapacity/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1exadataInfrastructures~1{exadataInfrastructureId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + download_exadata_infrastructure_config_file: + operation: + $ref: '#/paths/~1exadataInfrastructures~1{exadataInfrastructureId}~1actions~1downloadConfigFile/post' + response: + mediaType: application/octet-stream + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/exadata_infrastructures/methods/get' + - $ref: '#/components/x-stackQL-resources/exadata_infrastructures/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/exadata_infrastructures/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/exadata_infrastructures/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/exadata_infrastructures/methods/delete' + replace: [] + exadata_infrastructure_un_allocated_resources: + id: oci.database.exadata_infrastructure_un_allocated_resources + name: exadata_infrastructure_un_allocated_resources + title: Exadata Infrastructure Un Allocated Resources + methods: + get: + operation: + $ref: '#/paths/~1exadataInfrastructures~1{exadataInfrastructureId}~1unAllocatedResources/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/exadata_infrastructure_un_allocated_resources/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + vm_cluster_networks: + id: oci.database.vm_cluster_networks + name: vm_cluster_networks + title: Vm Cluster Networks + methods: + list: + operation: + $ref: '#/paths/~1exadataInfrastructures~1{exadataInfrastructureId}~1vmClusterNetworks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.vm_cluster_networks + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVmClusterNetworksResponse' + transform: + body: |- + {{- $wrapped := printf "{\"vm_cluster_networks\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1exadataInfrastructures~1{exadataInfrastructureId}~1vmClusterNetworks/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + generate_recommended_vm_cluster_network: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1exadataInfrastructures~1{exadataInfrastructureId}~1vmClusterNetworks~1actions~1generateRecommendedNetwork/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1exadataInfrastructures~1{exadataInfrastructureId}~1vmClusterNetworks~1{vmClusterNetworkId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1exadataInfrastructures~1{exadataInfrastructureId}~1vmClusterNetworks~1{vmClusterNetworkId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1exadataInfrastructures~1{exadataInfrastructureId}~1vmClusterNetworks~1{vmClusterNetworkId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + download_vm_cluster_network_config_file: + operation: + $ref: '#/paths/~1exadataInfrastructures~1{exadataInfrastructureId}~1vmClusterNetworks~1{vmClusterNetworkId}~1actions~1downloadConfigFile/post' + response: + mediaType: application/octet-stream + openAPIDocKey: '200' + request: + nativeCasing: camel + resize_vm_cluster_network: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1exadataInfrastructures~1{exadataInfrastructureId}~1vmClusterNetworks~1{vmClusterNetworkId}~1actions~1resize/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + validate_vm_cluster_network: + operation: + $ref: '#/paths/~1exadataInfrastructures~1{exadataInfrastructureId}~1vmClusterNetworks~1{vmClusterNetworkId}~1actions~1validate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/vm_cluster_networks/methods/get' + - $ref: '#/components/x-stackQL-resources/vm_cluster_networks/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/vm_cluster_networks/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/vm_cluster_networks/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/vm_cluster_networks/methods/delete' + replace: [] + exadb_vm_clusters: + id: oci.database.exadb_vm_clusters + name: exadb_vm_clusters + title: Exadb Vm Clusters + methods: + list: + operation: + $ref: '#/paths/~1exadbVmClusters/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.exadb_vm_clusters + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListExadbVmClustersResponse' + transform: + body: |- + {{- $wrapped := printf "{\"exadb_vm_clusters\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1exadbVmClusters/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1exadbVmClusters~1{exadbVmClusterId}/delete' + response: + mediaType: application-json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1exadbVmClusters~1{exadbVmClusterId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1exadbVmClusters~1{exadbVmClusterId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + add_dbnode_snapshots_for_exadb_vm_cluster: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1exadbVmClusters~1{exadbVmClusterId}~1actions~1addDbNodeSnapshots/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1exadbVmClusters~1{exadbVmClusterId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_exadb_vm_cluster_subscription: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1exadbVmClusters~1{exadbVmClusterId}~1actions~1changeSubscription/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + remove_virtual_machine_from_exadb_vm_cluster: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1exadbVmClusters~1{exadbVmClusterId}~1actions~1removeVirtualMachine/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/exadb_vm_clusters/methods/get' + - $ref: '#/components/x-stackQL-resources/exadb_vm_clusters/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/exadb_vm_clusters/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/exadb_vm_clusters/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/exadb_vm_clusters/methods/delete' + replace: [] + exadb_vm_cluster_update_history_entries: + id: oci.database.exadb_vm_cluster_update_history_entries + name: exadb_vm_cluster_update_history_entries + title: Exadb Vm Cluster Update History Entries + methods: + list: + operation: + $ref: '#/paths/~1exadbVmClusters~1{exadbVmClusterId}~1updateHistoryEntries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.exadb_vm_cluster_update_history_entries + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListExadbVmClusterUpdateHistoryEntriesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"exadb_vm_cluster_update_history_entries\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1exadbVmClusters~1{exadbVmClusterId}~1updateHistoryEntries~1{updateHistoryEntryId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/exadb_vm_cluster_update_history_entries/methods/get' + - $ref: '#/components/x-stackQL-resources/exadb_vm_cluster_update_history_entries/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + exadb_vm_cluster_updates: + id: oci.database.exadb_vm_cluster_updates + name: exadb_vm_cluster_updates + title: Exadb Vm Cluster Updates + methods: + list: + operation: + $ref: '#/paths/~1exadbVmClusters~1{exadbVmClusterId}~1updates/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.exadb_vm_cluster_updates + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListExadbVmClusterUpdatesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"exadb_vm_cluster_updates\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1exadbVmClusters~1{exadbVmClusterId}~1updates~1{updateId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/exadb_vm_cluster_updates/methods/get' + - $ref: '#/components/x-stackQL-resources/exadb_vm_cluster_updates/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + exascale_db_storage_vaults: + id: oci.database.exascale_db_storage_vaults + name: exascale_db_storage_vaults + title: Exascale Db Storage Vaults + methods: + list: + operation: + $ref: '#/paths/~1exascaleDbStorageVaults/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.exascale_db_storage_vaults + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListExascaleDbStorageVaultsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"exascale_db_storage_vaults\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1exascaleDbStorageVaults/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1exascaleDbStorageVaults~1{exascaleDbStorageVaultId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1exascaleDbStorageVaults~1{exascaleDbStorageVaultId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1exascaleDbStorageVaults~1{exascaleDbStorageVaultId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1exascaleDbStorageVaults~1{exascaleDbStorageVaultId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_exascale_db_storage_vault_subscription: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1exascaleDbStorageVaults~1{exascaleDbStorageVaultId}~1actions~1changeSubscription/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/exascale_db_storage_vaults/methods/get' + - $ref: '#/components/x-stackQL-resources/exascale_db_storage_vaults/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/exascale_db_storage_vaults/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/exascale_db_storage_vaults/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/exascale_db_storage_vaults/methods/delete' + replace: [] + execution_actions: + id: oci.database.execution_actions + name: execution_actions + title: Execution Actions + methods: + list: + operation: + $ref: '#/paths/~1executionActions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.execution_actions + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListExecutionActionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"execution_actions\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1executionActions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1executionActions~1{executionActionId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1executionActions~1{executionActionId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1executionActions~1{executionActionId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + move_execution_action_member: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1executionActions~1{executionActionId}~1actions~1moveActionMember/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/execution_actions/methods/get' + - $ref: '#/components/x-stackQL-resources/execution_actions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/execution_actions/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/execution_actions/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/execution_actions/methods/delete' + replace: [] + execution_windows: + id: oci.database.execution_windows + name: execution_windows + title: Execution Windows + methods: + list: + operation: + $ref: '#/paths/~1executionWindows/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.execution_windows + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListExecutionWindowsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"execution_windows\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1executionWindows/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1executionWindows~1{executionWindowId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1executionWindows~1{executionWindowId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1executionWindows~1{executionWindowId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + reorder_execution_actions: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1executionWindows~1{executionWindowId}~1actions~1reorder/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/execution_windows/methods/get' + - $ref: '#/components/x-stackQL-resources/execution_windows/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/execution_windows/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/execution_windows/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/execution_windows/methods/delete' + replace: [] + external_backup_jobs: + id: oci.database.external_backup_jobs + name: external_backup_jobs + title: External Backup Jobs + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1externalBackupJobs/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1externalBackupJobs~1{backupId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + complete_external_backup_job: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1externalBackupJobs~1{backupId}~1actions~1complete/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/external_backup_jobs/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/external_backup_jobs/methods/create' + update: [] + delete: [] + replace: [] + external_container_databases: + id: oci.database.external_container_databases + name: external_container_databases + title: External Container Databases + methods: + list: + operation: + $ref: '#/paths/~1externalcontainerdatabases/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.external_container_databases + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListExternalContainerDatabasesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"external_container_databases\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1externalcontainerdatabases/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1externalcontainerdatabases~1{externalContainerDatabaseId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1externalcontainerdatabases~1{externalContainerDatabaseId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1externalcontainerdatabases~1{externalContainerDatabaseId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1externalcontainerdatabases~1{externalContainerDatabaseId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/external_container_databases/methods/get' + - $ref: '#/components/x-stackQL-resources/external_container_databases/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/external_container_databases/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/external_container_databases/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/external_container_databases/methods/delete' + replace: [] + externalcontainerdatabases: + id: oci.database.externalcontainerdatabases + name: externalcontainerdatabases + title: Externalcontainerdatabases + methods: + disable_external_container_database_database_management: + operation: + $ref: '#/paths/~1externalcontainerdatabases~1{externalContainerDatabaseId}~1actions~1disableDatabaseManagement/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + disable_external_container_database_stack_monitoring: + operation: + $ref: '#/paths/~1externalcontainerdatabases~1{externalContainerDatabaseId}~1actions~1disableStackMonitoring/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + enable_external_container_database_database_management: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1externalcontainerdatabases~1{externalContainerDatabaseId}~1actions~1enableDatabaseManagement/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + enable_external_container_database_stack_monitoring: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1externalcontainerdatabases~1{externalContainerDatabaseId}~1actions~1enableStackMonitoring/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + scan_external_container_database_pluggable_databases: + operation: + $ref: '#/paths/~1externalcontainerdatabases~1{externalContainerDatabaseId}~1actions~1scanPluggableDatabases/post' + response: + mediaType: application-json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + external_database_connectors: + id: oci.database.external_database_connectors + name: external_database_connectors + title: External Database Connectors + methods: + list: + operation: + $ref: '#/paths/~1externaldatabaseconnectors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.external_database_connectors + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListExternalDatabaseConnectorsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"external_database_connectors\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1externaldatabaseconnectors/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1externaldatabaseconnectors~1{externalDatabaseConnectorId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1externaldatabaseconnectors~1{externalDatabaseConnectorId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1externaldatabaseconnectors~1{externalDatabaseConnectorId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/external_database_connectors/methods/get' + - $ref: '#/components/x-stackQL-resources/external_database_connectors/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/external_database_connectors/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/external_database_connectors/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/external_database_connectors/methods/delete' + replace: [] + externaldatabaseconnectors: + id: oci.database.externaldatabaseconnectors + name: externaldatabaseconnectors + title: Externaldatabaseconnectors + methods: + check_external_database_connector_connection_status: + operation: + $ref: '#/paths/~1externaldatabaseconnectors~1{externalDatabaseConnectorId}~1actions~1checkConnectionStatus/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + external_non_container_databases: + id: oci.database.external_non_container_databases + name: external_non_container_databases + title: External Non Container Databases + methods: + list: + operation: + $ref: '#/paths/~1externalnoncontainerdatabases/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.external_non_container_databases + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListExternalNonContainerDatabasesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"external_non_container_databases\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1externalnoncontainerdatabases/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1externalnoncontainerdatabases~1{externalNonContainerDatabaseId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1externalnoncontainerdatabases~1{externalNonContainerDatabaseId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1externalnoncontainerdatabases~1{externalNonContainerDatabaseId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1externalnoncontainerdatabases~1{externalNonContainerDatabaseId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/external_non_container_databases/methods/get' + - $ref: '#/components/x-stackQL-resources/external_non_container_databases/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/external_non_container_databases/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/external_non_container_databases/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/external_non_container_databases/methods/delete' + replace: [] + externalnoncontainerdatabases: + id: oci.database.externalnoncontainerdatabases + name: externalnoncontainerdatabases + title: Externalnoncontainerdatabases + methods: + disable_external_non_container_database_database_management: + operation: + $ref: '#/paths/~1externalnoncontainerdatabases~1{externalNonContainerDatabaseId}~1actions~1disableDatabaseManagement/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + disable_external_non_container_database_operations_insights: + operation: + $ref: '#/paths/~1externalnoncontainerdatabases~1{externalNonContainerDatabaseId}~1actions~1disableOperationsInsights/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + disable_external_non_container_database_stack_monitoring: + operation: + $ref: '#/paths/~1externalnoncontainerdatabases~1{externalNonContainerDatabaseId}~1actions~1disableStackMonitoring/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + enable_external_non_container_database_database_management: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1externalnoncontainerdatabases~1{externalNonContainerDatabaseId}~1actions~1enableDatabaseManagement/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + enable_external_non_container_database_operations_insights: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1externalnoncontainerdatabases~1{externalNonContainerDatabaseId}~1actions~1enableOperationsInsights/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + enable_external_non_container_database_stack_monitoring: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1externalnoncontainerdatabases~1{externalNonContainerDatabaseId}~1actions~1enableStackMonitoring/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + external_pluggable_databases: + id: oci.database.external_pluggable_databases + name: external_pluggable_databases + title: External Pluggable Databases + methods: + list: + operation: + $ref: '#/paths/~1externalpluggabledatabases/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.external_pluggable_databases + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListExternalPluggableDatabasesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"external_pluggable_databases\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1externalpluggabledatabases/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1externalpluggabledatabases~1{externalPluggableDatabaseId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1externalpluggabledatabases~1{externalPluggableDatabaseId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1externalpluggabledatabases~1{externalPluggableDatabaseId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1externalpluggabledatabases~1{externalPluggableDatabaseId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/external_pluggable_databases/methods/get' + - $ref: '#/components/x-stackQL-resources/external_pluggable_databases/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/external_pluggable_databases/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/external_pluggable_databases/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/external_pluggable_databases/methods/delete' + replace: [] + externalpluggabledatabases: + id: oci.database.externalpluggabledatabases + name: externalpluggabledatabases + title: Externalpluggabledatabases + methods: + disable_external_pluggable_database_database_management: + operation: + $ref: '#/paths/~1externalpluggabledatabases~1{externalPluggableDatabaseId}~1actions~1disableDatabaseManagement/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + disable_external_pluggable_database_operations_insights: + operation: + $ref: '#/paths/~1externalpluggabledatabases~1{externalPluggableDatabaseId}~1actions~1disableOperationsInsights/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + disable_external_pluggable_database_stack_monitoring: + operation: + $ref: '#/paths/~1externalpluggabledatabases~1{externalPluggableDatabaseId}~1actions~1disableStackMonitoring/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + enable_external_pluggable_database_database_management: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1externalpluggabledatabases~1{externalPluggableDatabaseId}~1actions~1enableDatabaseManagement/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + enable_external_pluggable_database_operations_insights: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1externalpluggabledatabases~1{externalPluggableDatabaseId}~1actions~1enableOperationsInsights/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + enable_external_pluggable_database_stack_monitoring: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1externalpluggabledatabases~1{externalPluggableDatabaseId}~1actions~1enableStackMonitoring/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + gi_versions: + id: oci.database.gi_versions + name: gi_versions + title: Gi Versions + methods: + list: + operation: + $ref: '#/paths/~1giVersions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.gi_versions + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListGiVersionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"gi_versions\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/gi_versions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + gi_version_minor_versions: + id: oci.database.gi_version_minor_versions + name: gi_version_minor_versions + title: Gi Version Minor Versions + methods: + list: + operation: + $ref: '#/paths/~1giVersions~1{version}~1minorVersions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.gi_version_minor_versions + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListGiVersionMinorVersionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"gi_version_minor_versions\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/gi_version_minor_versions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + key_stores: + id: oci.database.key_stores + name: key_stores + title: Key Stores + methods: + list: + operation: + $ref: '#/paths/~1keyStores/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.key_stores + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListKeyStoresResponse' + transform: + body: |- + {{- $wrapped := printf "{\"key_stores\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1keyStores/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1keyStores~1{keyStoreId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1keyStores~1{keyStoreId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1keyStores~1{keyStoreId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1keyStores~1{keyStoreId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/key_stores/methods/get' + - $ref: '#/components/x-stackQL-resources/key_stores/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/key_stores/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/key_stores/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/key_stores/methods/delete' + replace: [] + maintenance_run_history: + id: oci.database.maintenance_run_history + name: maintenance_run_history + title: Maintenance Run History + methods: + list: + operation: + $ref: '#/paths/~1maintenanceRunHistory/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.maintenance_run_history + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListMaintenanceRunHistoryResponse' + transform: + body: |- + {{- $wrapped := printf "{\"maintenance_run_history\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/maintenance_run_history/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + maintenance_run_histories: + id: oci.database.maintenance_run_histories + name: maintenance_run_histories + title: Maintenance Run Histories + methods: + get: + operation: + $ref: '#/paths/~1maintenanceRunHistory~1{maintenanceRunHistoryId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/maintenance_run_histories/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + maintenance_runs: + id: oci.database.maintenance_runs + name: maintenance_runs + title: Maintenance Runs + methods: + list: + operation: + $ref: '#/paths/~1maintenanceRuns/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.maintenance_runs + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListMaintenanceRunsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"maintenance_runs\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1maintenanceRuns/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1maintenanceRuns~1{maintenanceRunId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1maintenanceRuns~1{maintenanceRunId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/maintenance_runs/methods/get' + - $ref: '#/components/x-stackQL-resources/maintenance_runs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/maintenance_runs/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/maintenance_runs/methods/update' + delete: [] + replace: [] + oneoff_patches: + id: oci.database.oneoff_patches + name: oneoff_patches + title: Oneoff Patches + methods: + list: + operation: + $ref: '#/paths/~1oneoffPatches/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.oneoff_patches + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListOneoffPatchesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"oneoff_patches\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1oneoffPatches/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1oneoffPatches~1{oneoffPatchId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1oneoffPatches~1{oneoffPatchId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1oneoffPatches~1{oneoffPatchId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1oneoffPatches~1{oneoffPatchId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + download_oneoff_patch: + operation: + $ref: '#/paths/~1oneoffPatches~1{oneoffPatchId}~1actions~1downloadOneoffPatch/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/oneoff_patches/methods/get' + - $ref: '#/components/x-stackQL-resources/oneoff_patches/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/oneoff_patches/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/oneoff_patches/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/oneoff_patches/methods/delete' + replace: [] + pluggable_database_snapshots: + id: oci.database.pluggable_database_snapshots + name: pluggable_database_snapshots + title: Pluggable Database Snapshots + methods: + list: + operation: + $ref: '#/paths/~1pluggableDatabaseSnapshots/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.pluggable_database_snapshots + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListPluggableDatabaseSnapshotsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"pluggable_database_snapshots\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1pluggableDatabaseSnapshots/post' + response: + mediaType: application/json + openAPIDocKey: '201' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1pluggableDatabaseSnapshots~1{pluggableDatabaseSnapshotId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1pluggableDatabaseSnapshots~1{pluggableDatabaseSnapshotId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pluggable_database_snapshots/methods/get' + - $ref: '#/components/x-stackQL-resources/pluggable_database_snapshots/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/pluggable_database_snapshots/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/pluggable_database_snapshots/methods/delete' + replace: [] + pluggable_databases: + id: oci.database.pluggable_databases + name: pluggable_databases + title: Pluggable Databases + methods: + list: + operation: + $ref: '#/paths/~1pluggableDatabases/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.pluggable_databases + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListPluggableDatabasesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"pluggable_databases\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1pluggableDatabases/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1pluggableDatabases~1{pluggableDatabaseId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1pluggableDatabases~1{pluggableDatabaseId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1pluggableDatabases~1{pluggableDatabaseId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + convert_to_regular_pluggable_database: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1pluggableDatabases~1{pluggableDatabaseId}~1actions~1convertToRegular/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + local_clone_pluggable_database: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1pluggableDatabases~1{pluggableDatabaseId}~1actions~1localClone/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + refresh_pluggable_database: + operation: + $ref: '#/paths/~1pluggableDatabases~1{pluggableDatabaseId}~1actions~1refresh/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + remote_clone_pluggable_database: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1pluggableDatabases~1{pluggableDatabaseId}~1actions~1remoteClone/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + start_pluggable_database: + operation: + $ref: '#/paths/~1pluggableDatabases~1{pluggableDatabaseId}~1actions~1start/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + stop_pluggable_database: + operation: + $ref: '#/paths/~1pluggableDatabases~1{pluggableDatabaseId}~1actions~1stop/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pluggable_databases/methods/get' + - $ref: '#/components/x-stackQL-resources/pluggable_databases/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/pluggable_databases/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/pluggable_databases/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/pluggable_databases/methods/delete' + replace: [] + resource_principal_tokens: + id: oci.database.resource_principal_tokens + name: resource_principal_tokens + title: Resource Principal Tokens + methods: + get: + operation: + $ref: '#/paths/~1resourcePrincipalToken~1{instanceId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/resource_principal_tokens/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + params_for_action_type: + id: oci.database.params_for_action_type + name: params_for_action_type + title: Params For Action Type + methods: + list: + operation: + $ref: '#/paths/~1scheduledActionParams/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/params_for_action_type/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + scheduled_actions: + id: oci.database.scheduled_actions + name: scheduled_actions + title: Scheduled Actions + methods: + list: + operation: + $ref: '#/paths/~1scheduledActions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1scheduledActions/post' + response: + mediaType: application/json + openAPIDocKey: '201' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1scheduledActions~1{scheduledActionId}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1scheduledActions~1{scheduledActionId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1scheduledActions~1{scheduledActionId}/put' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/scheduled_actions/methods/get' + - $ref: '#/components/x-stackQL-resources/scheduled_actions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/scheduled_actions/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/scheduled_actions/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/scheduled_actions/methods/delete' + replace: [] + scheduling_plans: + id: oci.database.scheduling_plans + name: scheduling_plans + title: Scheduling Plans + methods: + list: + operation: + $ref: '#/paths/~1schedulingPlans/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1schedulingPlans/post' + response: + mediaType: application/json + openAPIDocKey: '201' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1schedulingPlans~1{schedulingPlanId}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1schedulingPlans~1{schedulingPlanId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1schedulingPlans~1{schedulingPlanId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + reorder_scheduled_actions: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1schedulingPlans~1{schedulingPlanId}~1actions~1reorder/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/scheduling_plans/methods/get' + - $ref: '#/components/x-stackQL-resources/scheduling_plans/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/scheduling_plans/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/scheduling_plans/methods/delete' + replace: [] + scheduling_policies: + id: oci.database.scheduling_policies + name: scheduling_policies + title: Scheduling Policies + methods: + list: + operation: + $ref: '#/paths/~1schedulingPolicies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.scheduling_policies + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListSchedulingPoliciesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"scheduling_policies\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1schedulingPolicies/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1schedulingPolicies~1{schedulingPolicyId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1schedulingPolicies~1{schedulingPolicyId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1schedulingPolicies~1{schedulingPolicyId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1schedulingPolicies~1{schedulingPolicyId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/scheduling_policies/methods/get' + - $ref: '#/components/x-stackQL-resources/scheduling_policies/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/scheduling_policies/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/scheduling_policies/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/scheduling_policies/methods/delete' + replace: [] + recommended_scheduled_actions: + id: oci.database.recommended_scheduled_actions + name: recommended_scheduled_actions + title: Recommended Scheduled Actions + methods: + list: + operation: + $ref: '#/paths/~1schedulingPolicies~1{schedulingPolicyId}~1recommendedScheduledActions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/recommended_scheduled_actions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + scheduling_windows: + id: oci.database.scheduling_windows + name: scheduling_windows + title: Scheduling Windows + methods: + list: + operation: + $ref: '#/paths/~1schedulingPolicies~1{schedulingPolicyId}~1schedulingWindows/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.scheduling_windows + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListSchedulingWindowsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"scheduling_windows\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1schedulingPolicies~1{schedulingPolicyId}~1schedulingWindows/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1schedulingPolicies~1{schedulingPolicyId}~1schedulingWindows~1{schedulingWindowId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1schedulingPolicies~1{schedulingPolicyId}~1schedulingWindows~1{schedulingWindowId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1schedulingPolicies~1{schedulingPolicyId}~1schedulingWindows~1{schedulingWindowId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/scheduling_windows/methods/get' + - $ref: '#/components/x-stackQL-resources/scheduling_windows/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/scheduling_windows/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/scheduling_windows/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/scheduling_windows/methods/delete' + replace: [] + system_versions: + id: oci.database.system_versions + name: system_versions + title: System Versions + methods: + list: + operation: + $ref: '#/paths/~1systemVersions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/system_versions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + vm_clusters: + id: oci.database.vm_clusters + name: vm_clusters + title: Vm Clusters + methods: + list: + operation: + $ref: '#/paths/~1vmClusters/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.vm_clusters + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVmClustersResponse' + transform: + body: |- + {{- $wrapped := printf "{\"vm_clusters\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1vmClusters/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1vmClusters~1{vmClusterId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1vmClusters~1{vmClusterId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1vmClusters~1{vmClusterId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + add_virtual_machine_to_vm_cluster: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1vmClusters~1{vmClusterId}~1actions~1addVirtualMachine/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1vmClusters~1{vmClusterId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + remove_virtual_machine_from_vm_cluster: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1vmClusters~1{vmClusterId}~1actions~1removeVirtualMachine/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/vm_clusters/methods/get' + - $ref: '#/components/x-stackQL-resources/vm_clusters/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/vm_clusters/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/vm_clusters/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/vm_clusters/methods/delete' + replace: [] + vm_cluster_patch_history_entries: + id: oci.database.vm_cluster_patch_history_entries + name: vm_cluster_patch_history_entries + title: Vm Cluster Patch History Entries + methods: + list: + operation: + $ref: '#/paths/~1vmClusters~1{vmClusterId}~1patchHistoryEntries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.vm_cluster_patch_history_entries + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVmClusterPatchHistoryEntriesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"vm_cluster_patch_history_entries\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1vmClusters~1{vmClusterId}~1patchHistoryEntries~1{patchHistoryEntryId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/vm_cluster_patch_history_entries/methods/get' + - $ref: '#/components/x-stackQL-resources/vm_cluster_patch_history_entries/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + vm_cluster_patches: + id: oci.database.vm_cluster_patches + name: vm_cluster_patches + title: Vm Cluster Patches + methods: + list: + operation: + $ref: '#/paths/~1vmClusters~1{vmClusterId}~1patches/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.vm_cluster_patches + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVmClusterPatchesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"vm_cluster_patches\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1vmClusters~1{vmClusterId}~1patches~1{patchId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/vm_cluster_patches/methods/get' + - $ref: '#/components/x-stackQL-resources/vm_cluster_patches/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + vm_cluster_update_history_entries: + id: oci.database.vm_cluster_update_history_entries + name: vm_cluster_update_history_entries + title: Vm Cluster Update History Entries + methods: + list: + operation: + $ref: '#/paths/~1vmClusters~1{vmClusterId}~1updateHistoryEntries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.vm_cluster_update_history_entries + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVmClusterUpdateHistoryEntriesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"vm_cluster_update_history_entries\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1vmClusters~1{vmClusterId}~1updateHistoryEntries~1{updateHistoryEntryId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/vm_cluster_update_history_entries/methods/get' + - $ref: '#/components/x-stackQL-resources/vm_cluster_update_history_entries/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + vm_cluster_updates: + id: oci.database.vm_cluster_updates + name: vm_cluster_updates + title: Vm Cluster Updates + methods: + list: + operation: + $ref: '#/paths/~1vmClusters~1{vmClusterId}~1updates/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.vm_cluster_updates + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVmClusterUpdatesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"vm_cluster_updates\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1vmClusters~1{vmClusterId}~1updates~1{updateId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/vm_cluster_updates/methods/get' + - $ref: '#/components/x-stackQL-resources/vm_cluster_updates/methods/list' + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://database.{region}.oraclecloud.com/20160918 + variables: + region: + default: us-ashburn-1 + description: OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. + x-stackQL-envVar: OCI_REGION +x-stackQL-config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: opc-next-page + location: header diff --git a/providers/src/oci/v00.00.00000/services/dns.yaml b/providers/src/oci/v00.00.00000/services/dns.yaml new file mode 100644 index 00000000..84c2d43f --- /dev/null +++ b/providers/src/oci/v00.00.00000/services/dns.yaml @@ -0,0 +1,8247 @@ +openapi: 3.0.0 +info: + title: dns API + description: oci dns API + version: '20180115' +paths: + /actions/createZoneFromZoneFile: + post: + description: | + Creates a new zone from a zone file in the specified compartment. Not supported for private zones. + operationId: CreateZoneFromZoneFile + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/OpcRetryTokenHeader' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/ViewIdQueryParam' + requestBody: + content: + text/dns: + schema: + format: binary + type: string + description: The zone file contents. + required: true + responses: + '201': + description: A response containing a single zone object. + headers: + Location: + description: | + The full URI of the resource related to the request. + schema: + type: string + etag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. + You can use this to query status of the asynchronous operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Zone' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '409': + $ref: '#/components/responses/409' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + x-example: | + POST /20180115/actions/createZoneFromZoneFile?compartmentId=ocid1.. HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + Content-Type: text/dns + <Zone file contents> + x-related-resource: '#/definitions/Zone' + /resolvers: + get: + description: | + Gets a list of all resolvers within a compartment. + + The collection can be filtered by display name, id, or lifecycle state. It can be sorted + on creation time or displayName both in ASC or DESC order. Note that when no lifecycleState + query parameter is provided, the collection does not include resolvers in the DELETED + lifecycleState to be consistent with other operations of the API. + operationId: ListResolvers + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/DisplayNameQueryParam' + - $ref: '#/components/parameters/IdQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ResolversSortByQueryParam' + - $ref: '#/components/parameters/ResolverLifecycleStateQueryParam' + - $ref: '#/components/parameters/ScopeQueryParam' + responses: + '200': + description: A Response containing a list of resolver objects. + 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/ListResolversResponse' + '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/DefaultError' + tags: + - dns + x-related-resource: '#/definitions/Resolver' + /resolvers/{resolverId}: + get: + description: | + Gets information about a specific resolver. + + Note that attempting to get a resolver in the DELETED lifecycleState will result in a `404` + response to be consistent with other operations of the API. + operationId: GetResolver + parameters: + - $ref: '#/components/parameters/IfModifiedSinceHeader' + - $ref: '#/components/parameters/IfNoneMatchHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ResolverIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + responses: + '200': + description: A Response containing a single resolver object. + headers: + etag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + 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/Resolver' + '304': + $ref: '#/components/responses/304' + '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/DefaultError' + tags: + - dns + x-related-resource: '#/definitions/Resolver' + put: + description: | + Updates the specified resolver with your new information. + operationId: UpdateResolver + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ResolverIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateResolverDetails' + description: New data for the resolver. + required: true + responses: + '200': + description: A Response containing a single resolver object. + headers: + etag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. + You can use this to query status of the asynchronous operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Resolver' + '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' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + /resolvers/{resolverId}/actions/changeCompartment: + post: + description: | + Moves a resolver into a different compartment along with its protected default view and any endpoints. + + Zones in the default view are not moved. VCN-dedicated resolvers are initially created in the same compartment + as their corresponding VCN, but can then be moved to a different compartment. + operationId: ChangeResolverCompartment + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OpcRetryTokenHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ResolverIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeResolverCompartmentDetails' + description: | + Details for moving a resolver, along with its protected default view and endpoints, into a + different compartment. + required: true + responses: + '202': + $ref: '#/components/responses/EmptyResponseWithWorkRequest' + '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' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + x-related-resource: '#/definitions/Resolver' + /resolvers/{resolverId}/endpoints: + get: + description: | + Gets a list of all endpoints within a resolver. The collection can be filtered by name or lifecycle state. + It can be sorted on creation time or name both in ASC or DESC order. Note that when no lifecycleState + query parameter is provided, the collection does not include resolver endpoints in the DELETED + lifecycle state to be consistent with other operations of the API. + operationId: ListResolverEndpoints + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ResolverIdPathParam' + - $ref: '#/components/parameters/NameQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ResolverEndpointsSortByQueryParam' + - $ref: '#/components/parameters/ResolverEndpointLifecycleStateQueryParam' + - $ref: '#/components/parameters/ScopeQueryParam' + responses: + '200': + description: A Response containing a list of resolver endpoint objects. + 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/ListResolverEndpointsResponse' + '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/DefaultError' + tags: + - dns + x-related-resource: '#/definitions/ResolverEndpoint' + post: + description: | + Creates a new resolver endpoint in the same compartment as the resolver. + operationId: CreateResolverEndpoint + parameters: + - $ref: '#/components/parameters/OpcRetryTokenHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ResolverIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateResolverEndpointDetails' + description: Details for creating a new resolver endpoint. + required: true + responses: + '201': + description: A Response containing a single resolver endpoint object. + headers: + Location: + description: | + The full URI of the resource related to the request. + schema: + type: string + etag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. + You can use this to query status of the asynchronous operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ResolverEndpoint' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '409': + $ref: '#/components/responses/409' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + /resolvers/{resolverId}/endpoints/{resolverEndpointName}: + delete: + description: | + Deletes the specified resolver endpoint. + + Note that attempting to delete a resolver endpoint in the DELETED lifecycle state will result in + a `404` response to be consistent with other operations of the API. Resolver endpoints may not + be deleted if they are referenced by a resolver rule. + operationId: DeleteResolverEndpoint + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ResolverIdPathParam' + - $ref: '#/components/parameters/ResolverEndpointNamePathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + responses: + '202': + $ref: '#/components/responses/EmptyResponseWithWorkRequest' + '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/DefaultError' + tags: + - dns + x-obmcs-client-retries-enabled: false + x-related-resource: '#/definitions/ResolverEndpoint' + get: + description: | + Gets information about a specific resolver endpoint. + + Note that attempting to get a resolver endpoint in the DELETED lifecycle state will result + in a `404` response to be consistent with other operations of the API. + operationId: GetResolverEndpoint + parameters: + - $ref: '#/components/parameters/IfModifiedSinceHeader' + - $ref: '#/components/parameters/IfNoneMatchHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ResolverIdPathParam' + - $ref: '#/components/parameters/ResolverEndpointNamePathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + responses: + '200': + description: A Response containing a single resolver endpoint object. + headers: + etag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + 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/ResolverEndpoint' + '304': + $ref: '#/components/responses/304' + '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/DefaultError' + tags: + - dns + x-related-resource: '#/definitions/ResolverEndpoint' + put: + description: | + Updates the specified resolver endpoint with your new information. + operationId: UpdateResolverEndpoint + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ResolverIdPathParam' + - $ref: '#/components/parameters/ResolverEndpointNamePathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateResolverEndpointDetails' + description: New data for the resolver endpoint. + required: true + responses: + '200': + description: A Response containing a single resolver endpoint object. + headers: + etag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. + You can use this to query status of the asynchronous operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ResolverEndpoint' + '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' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + /steeringPolicies: + get: + description: | + Gets a list of all steering policies in the specified compartment. + operationId: ListSteeringPolicies + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/IdQueryParam' + - $ref: '#/components/parameters/DisplayNameQueryParam' + - $ref: '#/components/parameters/DisplayNameContainsQueryParam' + - $ref: '#/components/parameters/HealthCheckMonitorIdQueryParam' + - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' + - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' + - $ref: '#/components/parameters/TemplateQueryParam' + - $ref: '#/components/parameters/SteeringPoliciesLifecycleStateQueryParam' + - $ref: '#/components/parameters/SteeringPoliciesSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ScopeQueryParam' + responses: + '200': + description: A response containing a list of steering policy objects. + 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 + opc-total-items: + description: The total number of items that match the query. + schema: + type: integer + content: + application/json: + schema: + $ref: '#/components/schemas/ListSteeringPoliciesResponse' + '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/DefaultError' + tags: + - dns + x-example: | + GET /20180115/steeringPolicies?compartmentId=ocid1..HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/SteeringPolicy' + post: + description: | + Creates a new steering policy in the specified compartment. For more information on + creating policies with templates, see [Traffic Management API Guide](/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm). + operationId: CreateSteeringPolicy + parameters: + - $ref: '#/components/parameters/OpcRetryTokenHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ScopeQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateSteeringPolicyDetails' + description: Details for creating a new steering policy. + required: true + responses: + '201': + description: A response containing a single steering policy object. + headers: + ETag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + schema: + type: string + Location: + description: | + The full URI of the resource related to the request. + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. + You can use this to query status of the asynchronous operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SteeringPolicy' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '409': + $ref: '#/components/responses/409' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + x-example: | + POST /20180115/steeringPolicies HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..", + "displayName": "failover between endpoints", + "ttl": 30, + "healthCheckMonitorId": "ocid1.httpmonitor.oc1..", + "template": "FAILOVER", + "answers": [ + { + "name": "server-primary", + "rtype": "A", + "rdata": "192.0.2.0", + "pool": "primary" + }, + { + "name": "server-secondary", + "rtype": "A", + "rdata": "192.0.4.6", + "pool": "secondary" + } + ], + "rules": [ + { + "ruleType": "FILTER", + "defaultAnswerData": [ + { + "answerCondition": "answer.isDisabled != true", + "shouldKeep": true + } + ] + }, + { + "ruleType": "HEALTH" + }, + { + "ruleType": "PRIORITY", + "defaultAnswerData": [ + { + "answerCondition": "answer.pool == 'primary'", + "value": 1 + }, + { + "answerCondition": "answer.pool == 'secondary'", + "value": 99 + } + ] + }, + { + "ruleType": "LIMIT", + "defaultCount": 1 + } + ] + } + /steeringPolicies/{steeringPolicyId}: + delete: + description: | + Deletes the specified steering policy. + + A `204` response indicates that the delete has been successful. + Deletion will fail if the policy is attached to any zones. To detach a + policy from a zone, see `DeleteSteeringPolicyAttachment`. + operationId: DeleteSteeringPolicy + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/PolicyIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + responses: + '204': + $ref: '#/components/responses/EmptyResponseWithWorkRequest' + '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/DefaultError' + tags: + - dns + x-example: | + DELETE /20180115/steeringPolicies/ocid1.dnspolicy.oc1.. HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-client-retries-enabled: false + get: + description: | + Gets information about the specified steering policy. + operationId: GetSteeringPolicy + parameters: + - $ref: '#/components/parameters/IfNoneMatchHeader' + - $ref: '#/components/parameters/IfModifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/PolicyIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + responses: + '200': + description: A response containing a single steering policy object. + headers: + ETag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + 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/SteeringPolicy' + '304': + $ref: '#/components/responses/304' + '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/DefaultError' + tags: + - dns + x-example: | + GET /20180115/steeringPolicies/ocid1.dnspolicy.oc1..HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/SteeringPolicy' + put: + description: | + Updates the configuration of the specified steering policy. + operationId: UpdateSteeringPolicy + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/PolicyIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSteeringPolicyDetails' + description: New data for the steering policy. + required: true + responses: + '200': + description: A response containing a single steering policy object. + headers: + ETag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. + You can use this to query status of the asynchronous operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SteeringPolicy' + '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' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + x-example: | + PUT /20180115/steeringPolicies/ocid1.dnspolicy.oc1.. HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + { + "compartmentId": "ocid1.compartment.oc1..", + "displayName": "LA data center failover", + "ttl": 30, + "healthCheckMonitorId": "ocid1.httpmonitor.oc1..", + "template": "FAILOVER", + "answers": [ + { + "name": "server-primary", + "rtype": "A", + "rdata": "192.0.2.0", + "pool": "primary" + }, + { + "name": "server-secondary", + "rtype": "A", + "rdata": "192.0.4.1", + "pool": "secondary" + } + ], + "rules": [ + { + "ruleType": "FILTER", + "defaultAnswerData": [ + { + "answerCondition": "answer.isDisabled != true", + "shouldKeep": true + } + ] + }, + { + "ruleType": "HEALTH" + }, + { + "ruleType": "PRIORITY", + "defaultAnswerData": [ + { + "answerCondition": "answer.pool == 'primary'", + "value": 1 + }, + { + "answerCondition": "answer.pool == 'secondary'", + "value": 99 + } + ] + }, + { + "ruleType": "LIMIT", + "defaultCount": 1 + } + ] + } + /steeringPolicies/{steeringPolicyId}/actions/changeCompartment: + post: + description: | + Moves a steering policy into a different compartment. + operationId: ChangeSteeringPolicyCompartment + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OpcRetryTokenHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/PolicyIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeSteeringPolicyCompartmentDetails' + description: Details for moving a steering policy into a different compartment. + required: true + responses: + '204': + $ref: '#/components/responses/EmptyResponseWithWorkRequest' + '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' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + x-related-resource: '#/definitions/SteeringPolicy' + /steeringPolicyAttachments: + get: + description: | + Lists the steering policy attachments in the specified compartment. + operationId: ListSteeringPolicyAttachments + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/IdQueryParam' + - $ref: '#/components/parameters/DisplayNameQueryParam' + - $ref: '#/components/parameters/SteeringPolicyIdQueryParam' + - $ref: '#/components/parameters/ZoneIdQueryParam' + - $ref: '#/components/parameters/DomainNameQueryParam' + - $ref: '#/components/parameters/DomainNameContainsQueryParam' + - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' + - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' + - $ref: '#/components/parameters/AttachmentLifecycleStateQueryParam' + - $ref: '#/components/parameters/SteeringPolicyAttachmentsSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ScopeQueryParam' + responses: + '200': + description: A response containing a list of steering policy attachments. + 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 + opc-total-items: + description: The total number of items that match the query. + schema: + type: integer + content: + application/json: + schema: + $ref: '#/components/schemas/ListSteeringPolicyAttachmentsResponse' + '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/DefaultError' + tags: + - dns + x-related-resource: '#/definitions/SteeringPolicyAttachment' + post: + description: | + Creates a new attachment between a steering policy and a domain, giving the + policy permission to answer queries for the specified domain. A steering policy must + be attached to a domain for the policy to answer DNS queries for that domain. + + For the purposes of access control, the attachment is automatically placed + into the same compartment as the domain's zone. + + Attachments cannot be created for private zones. + operationId: CreateSteeringPolicyAttachment + parameters: + - $ref: '#/components/parameters/OpcRetryTokenHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ScopeQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateSteeringPolicyAttachmentDetails' + description: Details for creating a new steering policy attachment. + required: true + responses: + '201': + description: A response containing a single steering policy attachment object. + headers: + ETag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + schema: + type: string + Location: + description: | + The full URI of the resource related to the request. + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. + You can use this to query status of the asynchronous operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SteeringPolicyAttachment' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '409': + $ref: '#/components/responses/409' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + x-example: | + POST /20180115/steeringPolicyAttachments HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "steeringPolicyId": "ocid1.dnspolicy.oc1..", + "zoneId": "ocid1.dns-zone.oc1..", + "domainName": "example.com", + "displayName": "attached to example" + } + /steeringPolicyAttachments/{steeringPolicyAttachmentId}: + delete: + description: | + Deletes the specified steering policy attachment. + A `204` response indicates that the delete has been successful. + operationId: DeleteSteeringPolicyAttachment + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/SteeringPolicyAttachmentIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + responses: + '204': + $ref: '#/components/responses/EmptyResponseWithWorkRequest' + '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/DefaultError' + tags: + - dns + x-example: | + DELETE /20180115/steeringPolicyAttachments/ocid1.dnsattachment.oc1.. HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-client-retries-enabled: false + get: + description: | + Gets information about the specified steering policy attachment. + operationId: GetSteeringPolicyAttachment + parameters: + - $ref: '#/components/parameters/IfNoneMatchHeader' + - $ref: '#/components/parameters/IfModifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/SteeringPolicyAttachmentIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + responses: + '200': + description: A response containing a single steering policy attachment object. + headers: + ETag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + 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/SteeringPolicyAttachment' + '304': + $ref: '#/components/responses/304' + '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/DefaultError' + tags: + - dns + x-example: | + GET /20180115/steeringPolicyAttachments/ocid1.dnsattachment.oc1.. HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/SteeringPolicyAttachment' + put: + description: | + Updates the specified steering policy attachment with your new information. + operationId: UpdateSteeringPolicyAttachment + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/SteeringPolicyAttachmentIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSteeringPolicyAttachmentDetails' + description: New data for the steering policy attachment. + required: true + responses: + '200': + description: A response containing a single steering policy attachment object. + headers: + ETag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. + You can use this to query status of the asynchronous operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SteeringPolicyAttachment' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + x-example: | + PUT /20180115/steeringPolicyAttachments/ocid1.dnsattachment.oc1.. HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName": "IP prefix steering" + } + /tsigKeys: + get: + description: | + Gets a list of all TSIG keys in the specified compartment. + operationId: ListTsigKeys + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/IdQueryParam' + - $ref: '#/components/parameters/NameQueryParam' + - $ref: '#/components/parameters/TsigKeysLifecycleStateQueryParam' + - $ref: '#/components/parameters/TsigKeysSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ScopeQueryParam' + responses: + '200': + description: A response containing a list of TSIG keys. + 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/ListTsigKeysResponse' + '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/DefaultError' + tags: + - dns + x-related-resource: '#/definitions/TsigKey' + post: + description: | + Creates a new TSIG key in the specified compartment. There is no + `opc-retry-token` header since TSIG key names must be globally unique. + operationId: CreateTsigKey + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ScopeQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTsigKeyDetails' + description: Details for creating a new TSIG key. + required: true + responses: + '201': + description: A response containing a single TSIG key object. + headers: + ETag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + schema: + type: string + Location: + description: | + The full URI of the resource related to the request. + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. + You can use this to query status of the asynchronous operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/TsigKey' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '409': + $ref: '#/components/responses/409' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + /tsigKeys/{tsigKeyId}: + delete: + description: | + Deletes the specified TSIG key. + operationId: DeleteTsigKey + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/TsigKeyIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + responses: + '204': + $ref: '#/components/responses/EmptyResponseWithWorkRequest' + '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/DefaultError' + tags: + - dns + x-obmcs-client-retries-enabled: false + get: + description: | + Gets information about the specified TSIG key. + operationId: GetTsigKey + parameters: + - $ref: '#/components/parameters/IfNoneMatchHeader' + - $ref: '#/components/parameters/IfModifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/TsigKeyIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + responses: + '200': + description: A response containing a single TSIG key object. + headers: + ETag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + 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/TsigKey' + '304': + $ref: '#/components/responses/304' + '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/DefaultError' + tags: + - dns + x-related-resource: '#/definitions/TsigKey' + put: + description: | + Updates the specified TSIG key. + operationId: UpdateTsigKey + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/TsigKeyIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateTsigKeyDetails' + description: New data for the TSIG key. + required: true + responses: + '200': + description: A response containing a single TSIG key object. + headers: + ETag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. + You can use this to query status of the asynchronous operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/TsigKey' + '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' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + /tsigKeys/{tsigKeyId}/actions/changeCompartment: + post: + description: | + Moves a TSIG key into a different compartment. + operationId: ChangeTsigKeyCompartment + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OpcRetryTokenHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/TsigKeyIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeTsigKeyCompartmentDetails' + description: Details for moving a TSIG key into a different compartment. + required: true + responses: + '204': + $ref: '#/components/responses/EmptyResponse' + '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' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + x-related-resource: '#/definitions/TsigKey' + /views: + get: + description: | + Gets a list of all views within a compartment. + + The collection can be filtered by display name, id, or lifecycle state. It can be sorted + on creation time or displayName both in ASC or DESC order. Note that when no lifecycleState + query parameter is provided, the collection does not include views in the DELETED + lifecycleState to be consistent with other operations of the API. + operationId: ListViews + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/DisplayNameQueryParam' + - $ref: '#/components/parameters/IdQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ViewsSortByQueryParam' + - $ref: '#/components/parameters/ViewLifecycleStateQueryParam' + - $ref: '#/components/parameters/ScopeQueryParam' + responses: + '200': + description: A Response containing a list of view objects. + 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/ListViewsResponse' + '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/DefaultError' + tags: + - dns + x-related-resource: '#/definitions/View' + post: + description: | + Creates a new view in the specified compartment. + operationId: CreateView + parameters: + - $ref: '#/components/parameters/OpcRetryTokenHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ScopeQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateViewDetails' + description: Details for creating a new view. + required: true + responses: + '201': + description: A Response containing a single view object. + headers: + Location: + description: | + The full URI of the resource related to the request. + schema: + type: string + etag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. + You can use this to query status of the asynchronous operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/View' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '409': + $ref: '#/components/responses/409' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + /views/{viewId}: + delete: + description: | + Deletes the specified view. + + Note that attempting to delete a view in the DELETED lifecycleState will result in a `404` + response to be consistent with other operations of the API. Views cannot be + deleted if they are referenced by non-deleted zones or resolvers. + Protected views cannot be deleted. + operationId: DeleteView + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ViewIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + responses: + '202': + $ref: '#/components/responses/EmptyResponseWithWorkRequest' + '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/DefaultError' + tags: + - dns + x-obmcs-client-retries-enabled: false + x-related-resource: '#/definitions/View' + get: + description: | + Gets information about a specific view. + + Note that attempting to get a + view in the DELETED lifecycleState will result in a `404` response to be + consistent with other operations of the API. + operationId: GetView + parameters: + - $ref: '#/components/parameters/IfModifiedSinceHeader' + - $ref: '#/components/parameters/IfNoneMatchHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ViewIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + responses: + '200': + description: A Response containing a single view object. + headers: + etag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + 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/View' + '304': + $ref: '#/components/responses/304' + '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/DefaultError' + tags: + - dns + x-related-resource: '#/definitions/View' + put: + description: | + Updates the specified view with your new information. + operationId: UpdateView + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ViewIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateViewDetails' + description: New data for the view. + required: true + responses: + '200': + description: A Response containing a single view object. + headers: + etag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. + You can use this to query status of the asynchronous operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/View' + '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' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + /views/{viewId}/actions/changeCompartment: + post: + description: | + Moves a view into a different compartment. + + To change the compartment of a protected view, change the compartment of its corresponding resolver. + operationId: ChangeViewCompartment + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OpcRetryTokenHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ViewIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeViewCompartmentDetails' + description: Details for moving a view into a different compartment. + required: true + responses: + '202': + $ref: '#/components/responses/EmptyResponseWithWorkRequest' + '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' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + x-related-resource: '#/definitions/View' + /zoneTransferServers: + get: + description: | + Gets a list of IP addresses of OCI nameservers for inbound and outbound transfer of zones in the specified + compartment (which must be the root compartment of a tenancy) that transfer zone data with external master or + downstream nameservers. + operationId: ListZoneTransferServers + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: A response containing a list of zone transfer server objects. + 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/ListZoneTransferServersResponse' + '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/DefaultError' + tags: + - dns + x-example: | + GET /20180115/zoneTransferServers?compartmentId=ocid1.. HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ZoneTransferServer' + /zones: + get: + description: | + Gets a list of all zones in the specified compartment. + + The collection can be filtered by name, time created, scope, associated view, and zone type. + Filtering by view is only supported for private zones. + operationId: ListZones + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/ZoneNameQueryParam' + - $ref: '#/components/parameters/ZoneNameContainsQueryParam' + - $ref: '#/components/parameters/ZoneTypeQueryParam' + - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' + - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' + - $ref: '#/components/parameters/LifecycleStateQueryParam' + - $ref: '#/components/parameters/ZonesSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/ViewIdQueryParam' + - $ref: '#/components/parameters/TsigKeyIdQueryParam' + - $ref: '#/components/parameters/DnssecStateQueryParam' + responses: + '200': + description: A response containing a list of zone objects. + 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 + opc-total-items: + description: The total number of items that match the query. + schema: + type: integer + content: + application/json: + schema: + $ref: '#/components/schemas/ListZonesResponse' + '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/DefaultError' + tags: + - dns + x-example: | + GET /20180115/zones?compartmentId=ocid1.compartment.oc1.. HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Zone' + post: + description: | + Creates a new zone in the specified compartment. + + Private zones must have a zone type of `PRIMARY`. Creating a private zone at or under `oraclevcn.com` + within the default protected view of a VCN-dedicated resolver is not permitted. + operationId: CreateZone + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/OpcRetryTokenHeader' + - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/ViewIdQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateZoneBaseDetails' + description: Details for creating a new zone. + required: true + responses: + '201': + description: A response containing a single zone object. + headers: + ETag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + schema: + type: string + Location: + description: | + The full URI of the resource related to the request. + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. + You can use this to query status of the asynchronous operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Zone' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '409': + $ref: '#/components/responses/409' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + x-example: | + POST /20180115/zones HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" :"ocid1.compartment.oc1..", + "name" :"example.com", + "zoneType" : "PRIMARY" + } + /zones/{zoneId}/actions/changeCompartment: + post: + description: | + Moves a zone into a different compartment. + + Protected zones cannot have their compartment changed. When the zone name is provided as a path + parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is + required. + + **Note:** All SteeringPolicyAttachment objects associated with this zone will also be moved into + the provided compartment. + operationId: ChangeZoneCompartment + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OpcRetryTokenHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/ZoneIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeZoneCompartmentDetails' + description: Details for moving a zone into a different compartment. + required: true + responses: + '204': + $ref: '#/components/responses/EmptyResponseWithWorkRequest' + '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' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + x-example: | + POST /20180115/zones/ocid1.dns-zone.oc1../actions/changeCompartment HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1.." + } + x-related-resource: '#/definitions/Zone' + /zones/{zoneId}/actions/promoteDnssecKeyVersion: + post: + description: | + Promotes a specified `DnssecKeyVersion` on the zone. + + If the `DnssecKeyVersion` identified in the request body is a key signing key (KSK) that is replacing + another `DnssecKeyVersion`, then the old `DnssecKeyVersion` is scheduled for removal from the zone. + + For key signing keys (KSKs), you must create the DS record with the new key information **before** promoting + the new key to establish a chain of trust. To avoid a service disruption, remove the old DS record as soon + as its TTL (time to live) expires. + + For more information, see [DNSSEC](/iaas/Content/DNS/Concepts/dnssec.htm). + operationId: PromoteZoneDnssecKeyVersion + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRetryTokenHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/ZoneIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PromoteZoneDnssecKeyVersionDetails' + description: Details for promoting a `DnssecKeyVersion`. + required: true + responses: + '202': + $ref: '#/components/responses/EmptyResponseWithWorkRequest' + '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' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + x-example: | + POST /20180115/zones/ocid1.dns-zone.oc1../actions/promoteZoneDnssecKeyVersion HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "dnssecKeyVersionUuid": "123e4567-e89b-12d3-a456-426614174009", + } + x-related-resource: '#/definitions/Zone' + /zones/{zoneId}/actions/stageDnssecKeyVersion: + post: + description: | + Stages a new `DnssecKeyVersion` on the zone. Staging is a process that generates a new "successor" key version + that replaces an existing "predecessor" key version. + **Note:** A new key-signing key (KSK) version is inert until you update the parent zone DS records. + + For more information, see the [DNSSEC](/iaas/Content/DNS/Concepts/dnssec.htm) documentation. + operationId: StageZoneDnssecKeyVersion + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRetryTokenHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/ZoneIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StageZoneDnssecKeyVersionDetails' + description: Details for staging a DnssecKeyVersion. + required: true + responses: + '202': + $ref: '#/components/responses/EmptyResponseWithWorkRequest' + '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' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + x-example: | + POST /20180115/zones/ocid1.dns-zone.oc1../actions/stageDnssecKeyVersion HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "predecessorDnssecKeyVersionUuid": "123e4567-e89b-12d3-a456-426614174009" + } + x-related-resource: '#/definitions/Zone' + /zones/{zoneNameOrId}: + delete: + description: | + Deletes the specified zone and all its steering policy attachments. + + A `204` response indicates that the zone has been successfully deleted. Protected zones cannot be deleted. + When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter + then the viewId query parameter is required. + operationId: DeleteZone + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ZoneNameOrIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/ZoneViewIdQueryParam' + - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' + responses: + '204': + $ref: '#/components/responses/EmptyResponseWithWorkRequest' + '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/DefaultError' + tags: + - dns + x-example: | + DELETE /20180115/zones/ocid1.dns-zone.oc1.. HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-client-retries-enabled: false + get: + description: | + Gets information about the specified zone, including its creation date, zone type, and serial. + + When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query + parameter then the viewId query parameter is required. + operationId: GetZone + parameters: + - $ref: '#/components/parameters/IfNoneMatchHeader' + - $ref: '#/components/parameters/IfModifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ZoneNameOrIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/ZoneViewIdQueryParam' + - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' + responses: + '200': + description: A response containing a single zone object. + headers: + ETag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + 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/Zone' + '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/DefaultError' + tags: + - dns + x-example: | + GET /20180115/zones/ocid1.dns-zone.oc1.. HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Zone' + put: + description: | + Updates the zone with the specified information. + + Global secondary zones may have their external masters updated. For more information about secondary + zones, see [Manage DNS Service Zone](/iaas/Content/DNS/Tasks/managingdnszones.htm). When the zone name + is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId + query parameter is required. + operationId: UpdateZone + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ZoneNameOrIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/ZoneViewIdQueryParam' + - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateZoneDetails' + description: New data for the zone. + required: true + responses: + '200': + description: A response containing a single zone object. + headers: + ETag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. + You can use this to query status of the asynchronous operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Zone' + '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' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + x-example: | + PUT /20180115/zones/ocid1.dns-zone.oc1.. HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "freeformTags": { + "Department": "Finance" + } + } + /zones/{zoneNameOrId}/content: + get: + description: | + Gets the requested zone's zone file. + operationId: GetZoneContent + parameters: + - $ref: '#/components/parameters/IfNoneMatchHeader' + - $ref: '#/components/parameters/IfModifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ZoneNameOrIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/ZoneViewIdQueryParam' + responses: + '200': + description: A response containing a binary zone file. + headers: + etag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + 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: + text/dns: + schema: + format: binary + 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/DefaultError' + tags: + - dns + x-example: | + GET /20180115/zones/ocid1.dns-zone.oc1../content HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Zone' + /zones/{zoneNameOrId}/records: + get: + description: | + Gets all records in the specified zone. + + The results are sorted by `domain` in alphabetical order by default. For more information about records, + see [Resource Record (RR) TYPEs](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4). + When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter + then the viewId query parameter is required. + operationId: GetZoneRecords + parameters: + - $ref: '#/components/parameters/IfNoneMatchHeader' + - $ref: '#/components/parameters/IfModifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ZoneNameOrIdPathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/ZoneVersionQueryParam' + - $ref: '#/components/parameters/DomainNameQueryParam' + - $ref: '#/components/parameters/DomainNameContainsQueryParam' + - $ref: '#/components/parameters/RTypeQueryParam' + - $ref: '#/components/parameters/ZoneRecordsSortByQueryParam' + - $ref: '#/components/parameters/RecordSortOrderQueryParam' + - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/ZoneViewIdQueryParam' + responses: + '200': + $ref: '#/components/responses/RecordsResponse' + '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/DefaultError' + tags: + - dns + x-example: | + GET /20180115/zones/ocid1.dns-zone.oc1../records HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Records' + patch: + description: | + Updates a collection of records in the specified zone. + + You can update one record or all records for the specified zone depending on the changes provided in the + request body. You can also add or remove records using this function. When the zone name is provided as + a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is + required. + operationId: PatchZoneRecords + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ZoneNameOrIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/ZoneViewIdQueryParam' + - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchZoneRecordsDetails' + description: | + The operations describing how to modify the collection of records. + required: true + responses: + '200': + $ref: '#/components/responses/RecordsResponse' + '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' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + x-example: | + PATCH /20180115/zones/ocid1.dns-zone.oc1../records HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "items": [ + { + "domain": "example.com", + "recordHash": "8f356bd7e9c2007c5c898f441fb663e9", + "isProtected": false, + "rdata": "v=spf1 include:example.net -all", + "rrsetVersion": "9", + "rtype": "TXT", + "ttl": 30, + "operation": "ADD" + } + ] + } + x-related-resource: '#/definitions/Records' + put: + description: | + Replaces records in the specified zone with the records specified in the request body. + + If a specified record does not exist, it will be created. If the record exists, then it will be updated + to represent the record in the body of the request. If a record in the zone does not exist in the + request body, the record will be removed from the zone. When the zone name is provided as a path + parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is + required. + operationId: UpdateZoneRecords + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ZoneNameOrIdPathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/ZoneViewIdQueryParam' + - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateZoneRecordsDetails' + description: A full list of records for the zone. + required: true + responses: + '200': + $ref: '#/components/responses/RecordsResponse' + '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' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + x-example: | + PUT /20180115/zones/ocid1.dns-zone.oc1../records HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "items": [ + { + "domain": "example.com", + "recordHash": "261c84e3c11c3f2808fc4f18528f236e", + "isProtected": true, + "rdata": "ns1.p68.dns.oraclecloud.net.", + "rrsetVersion": "1", + "rtype": "NS", + "ttl": 86400 + }, + { + "domain": "example.com", + "recordHash": "90c6eaebe9f434417091ec5dbd547df4", + "isProtected": true, + "rdata": "ns3.p68.dns.oraclecloud.net.", + "rrsetVersion": "1", + "rtype": "NS", + "ttl": 86400 + }, + { + "domain": "example.com", + "recordHash": "d896912a210edd8e9c7a25814c3546e5", + "isProtected": true, + "rdata": "ns2.p68.dns.oraclecloud.net.", + "rrsetVersion": "1", + "rtype": "NS", + "ttl": 86400 + }, + { + "domain": "example.com", + "recordHash": "ef56ea8e43967513ea90250df1769b3a", + "isProtected": true, + "rdata": "ns4.p68.dns.oraclecloud.net.", + "rrsetVersion": "1", + "rtype": "NS", + "ttl": 86400 + }, + { + "domain": "www.example.com", + "recordHash": "136d3f26e66156a0727dda2552ab306f", + "isProtected": false, + "rdata": "v=spf1 include:example.net -all", + "rrsetVersion": "14", + "rtype": "TXT", + "ttl": 300 + } + ] + } + x-related-resource: '#/definitions/Records' + /zones/{zoneNameOrId}/records/{domain}: + delete: + description: | + Deletes all records at the specified zone and domain. + + When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter + then the viewId query parameter is required. + operationId: DeleteDomainRecords + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ZoneNameOrIdPathParam' + - $ref: '#/components/parameters/DomainNamePathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/ZoneViewIdQueryParam' + - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' + responses: + '204': + $ref: '#/components/responses/EmptyResponse' + '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/DefaultError' + tags: + - dns + x-example: | + DELETE /20180115/zones/ocid1.dns-zone.oc1../records/example.com HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Records' + get: + description: | + Gets a list of all records at the specified zone and domain. + + The results are sorted by `rtype` in alphabetical order by default. You can optionally filter and/or sort + the results using the listed parameters. When the zone name is provided as a path parameter and `PRIVATE` + is used for the scope query parameter then the viewId query parameter is required. + operationId: GetDomainRecords + parameters: + - $ref: '#/components/parameters/IfNoneMatchHeader' + - $ref: '#/components/parameters/IfModifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ZoneNameOrIdPathParam' + - $ref: '#/components/parameters/DomainNamePathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/ZoneVersionQueryParam' + - $ref: '#/components/parameters/RTypeQueryParam' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/ZoneViewIdQueryParam' + - $ref: '#/components/parameters/DomainRecordsSortByQueryParam' + - $ref: '#/components/parameters/RecordSortOrderQueryParam' + - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' + responses: + '200': + $ref: '#/components/responses/RecordsResponse' + '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/DefaultError' + tags: + - dns + x-example: | + GET /20180115/zones/ocid1.dns-zone.oc1../records/example.com HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Records' + patch: + description: | + Updates records in the specified zone at a domain. + + You can update one record or all records for the specified zone depending on the changes provided in the + request body. You can also add or remove records using this function. When the zone name is provided as + a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is + required. + operationId: PatchDomainRecords + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ZoneNameOrIdPathParam' + - $ref: '#/components/parameters/DomainNamePathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/ZoneViewIdQueryParam' + - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchDomainRecordsDetails' + description: Operations describing how to modify the collection of records. + required: true + responses: + '200': + $ref: '#/components/responses/RecordsResponse' + '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' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + x-related-resource: '#/definitions/Records' + put: + description: | + Replaces records in the specified zone at a domain with the records specified in the request body. + + If a specified record does not exist, it will be created. If the record exists, then it will be updated to + represent the record in the body of the request. If a record in the zone does not exist in the request body, + the record will be removed from the zone. When the zone name is provided as a path parameter and `PRIVATE` + is used for the scope query parameter then the viewId query parameter is required. + operationId: UpdateDomainRecords + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ZoneNameOrIdPathParam' + - $ref: '#/components/parameters/DomainNamePathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/ZoneViewIdQueryParam' + - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateDomainRecordsDetails' + description: A full list of records for the domain. + required: true + responses: + '200': + $ref: '#/components/responses/RecordsResponse' + '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' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + x-example: | + PUT /20180115/zones/ocid1.dns-zone.oc1../records/www.example.com HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "items": [ + { + "domain": "www.example.com", + "recordHash": "8f356bd7e9c2007c5c898f441fb663e9", + "isProtected": false, + "rdata": "v=spf1 include:example.net -all", + "rrsetVersion": "9", + "rtype": "TXT", + "ttl": 30 + } + ] + } + x-related-resource: '#/definitions/Records' + /zones/{zoneNameOrId}/records/{domain}/{rtype}: + delete: + description: | + Deletes all records in the specified RRSet. + + When the zone name is provided as a path parameter and `PRIVATE` is used for the scope + query parameter then the viewId query parameter is required. + operationId: DeleteRRSet + parameters: + - $ref: '#/components/parameters/ZoneNameOrIdPathParam' + - $ref: '#/components/parameters/DomainNamePathParam' + - $ref: '#/components/parameters/RTypePathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/ZoneViewIdQueryParam' + responses: + '204': + $ref: '#/components/responses/EmptyResponse' + '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/DefaultError' + tags: + - dns + x-example: | + DELETE /20180115/zones/ocid1.dns-zone.oc1../records/example.com/TXT HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + get: + description: | + Gets a list of all records in the specified RRSet. + + The results are sorted by `recordHash` by default. When the zone name is provided as a path parameter + and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required. + operationId: GetRRSet + parameters: + - $ref: '#/components/parameters/IfNoneMatchHeader' + - $ref: '#/components/parameters/IfModifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ZoneNameOrIdPathParam' + - $ref: '#/components/parameters/DomainNamePathParam' + - $ref: '#/components/parameters/RTypePathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/ZoneVersionQueryParam' + - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/ZoneViewIdQueryParam' + responses: + '200': + description: A collection of DNS resource record objects in a single RRSet. + headers: + ETag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + schema: + 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). + 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 + opc-total-items: + description: The total number of items that match the query. + schema: + type: integer + content: + application/json: + schema: + $ref: '#/components/schemas/RRSet' + '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/DefaultError' + tags: + - dns + x-example: | + GET /20180115/zones/ocid1.dns-zone.oc1../records/www.example.com/TXT HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/RRSet' + patch: + description: | + Updates records in the specified RRSet. + + When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query + parameter then the viewId query parameter is required. + operationId: PatchRRSet + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ZoneNameOrIdPathParam' + - $ref: '#/components/parameters/DomainNamePathParam' + - $ref: '#/components/parameters/RTypePathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/ZoneViewIdQueryParam' + - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchRRSetDetails' + description: Operations describing how to modify the collection of records. + required: true + responses: + '200': + $ref: '#/components/responses/RecordsResponse' + '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' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + x-related-resource: '#/definitions/RRSet' + put: + description: | + Replaces records in the specified RRSet. + + When the zone name is provided as a path parameter and `PRIVATE` is used for the scope + query parameter then the viewId query parameter is required. + operationId: UpdateRRSet + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' + - $ref: '#/components/parameters/OpcRequestIdHeader' + - $ref: '#/components/parameters/ZoneNameOrIdPathParam' + - $ref: '#/components/parameters/DomainNamePathParam' + - $ref: '#/components/parameters/RTypePathParam' + - $ref: '#/components/parameters/ScopeQueryParam' + - $ref: '#/components/parameters/ZoneViewIdQueryParam' + - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateRRSetDetails' + description: A full list of records for the RRSet. + required: true + responses: + '200': + $ref: '#/components/responses/RecordsResponse' + '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' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + tags: + - dns + x-example: | + PUT /20180115/zones/ocid1.dns-zone.oc1../records/www.example.com/TXT HTTP/1.1 + Host: dns.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "items": [ + { + "domain": "www.example.com", + "recordHash": "e86155f805706f45b4820db76f0dd71f", + "isProtected": false, + "rdata": "v=spf1 include:example.net -all", + "rrsetVersion": "10", + "rtype": "TXT", + "ttl": 60 + } + ] + } + x-related-resource: '#/definitions/RRSet' +components: + schemas: + Zone: + description: | + A DNS zone. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + compartmentId: + description: The OCID of the compartment containing the zone. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Operations": {"CostCenter": "42"}}` + type: object + dnssecConfig: + $ref: '#/components/schemas/DnssecConfig' + dnssecState: + default: DISABLED + description: | + The state of DNSSEC on the zone. + + For DNSSEC to function, every parent zone in the DNS tree up to the top-level domain (or an independent + trust anchor) must also have DNSSEC correctly set up. + After enabling DNSSEC, you must add a DS record to the zone's parent zone containing the + `KskDnssecKeyVersion` data. You can find the DS data in the `dsData` attribute of the `KskDnssecKeyVersion`. + Then, use the `PromoteZoneDnssecKeyVersion` operation to promote the `KskDnssecKeyVersion`. + + New `KskDnssecKeyVersion`s are generated annually, a week before the existing `KskDnssecKeyVersion`'s expiration. + To rollover a `KskDnssecKeyVersion`, you must replace the parent zone's DS record containing the old + `KskDnssecKeyVersion` data with the data from the new `KskDnssecKeyVersion`. + + To remove the old DS record without causing service disruption, wait until the old DS record's TTL has + expired, and the new DS record has propagated. After the DS replacement has been completed, then the + `PromoteZoneDnssecKeyVersion` operation must be called. + + Metrics are emitted in the `oci_dns` namespace daily for each `KskDnssecKeyVersion` indicating how many + days are left until expiration. + We recommend that you set up alarms and notifications for KskDnssecKeyVersion expiration so that the + necessary parent zone updates can be made and the `PromoteZoneDnssecKeyVersion` operation can be called. + + Enabling DNSSEC results in additional records in DNS responses which increases their size and can + cause higher response latency. + + For more information, see [DNSSEC](/iaas/Content/DNS/Concepts/dnssec.htm). + enum: + - ENABLED + - DISABLED + type: string + x-obmcs-top-level-enum: '#/definitions/ZoneDnssecState' + externalDownstreams: + description: | + External secondary servers for the zone. + This field is currently not supported when `zoneType` is `SECONDARY` or `scope` is `PRIVATE`. + items: + $ref: '#/components/schemas/ExternalDownstream' + type: array + externalMasters: + description: | + External master servers for the zone. `externalMasters` becomes a + required parameter when the `zoneType` value is `SECONDARY`. + items: + $ref: '#/components/schemas/ExternalMaster' + type: array + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Department": "Finance"}` + type: object + id: + description: The OCID of the zone. + maxLength: 255 + minLength: 1 + type: string + isProtected: + description: | + A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. + type: boolean + lifecycleState: + description: The current state of the zone resource. + enum: + - ACTIVE + - CREATING + - DELETED + - DELETING + - FAILED + - UPDATING + type: string + name: + description: The name of the zone. + maxLength: 254 + minLength: 1 + type: string + nameservers: + description: The authoritative nameservers for the zone. + items: + $ref: '#/components/schemas/Nameserver' + type: array + resolutionMode: + default: STATIC + description: | + The resolution mode of a zone defines behavior related to how query responses can be handled. See [Private DNS Zone Transparency](/Content/DNS/Tasks/privatedns.htm#use-cases__resolution) for more information. + enum: + - STATIC + - TRANSPARENT + - RTYPE_TRANSPARENT + type: string + x-obmcs-top-level-enum: '#/definitions/ZoneResolutionMode' + scope: + description: The scope of the zone. + enum: + - GLOBAL + - PRIVATE + type: string + x-obmcs-top-level-enum: '#/definitions/Scope' + self: + description: The canonical absolute URL of the resource. + format: url + type: string + serial: + description: | + The current serial of the zone. As seen in the zone's SOA record. + format: int64 + type: integer + timeCreated: + description: | + The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format + with a Z offset, as defined by RFC 3339. + + **Example:** `2016-07-22T17:23:59:60Z` + format: date-time + type: string + version: + description: | + Version is the never-repeating, totally-orderable, version of the + zone, from which the serial field of the zone's SOA record is + derived. + type: string + viewId: + description: | + The OCID of the private view containing the zone. This value will + be null for zones in the global DNS, which are publicly resolvable and + not part of a private view. + maxLength: 255 + minLength: 1 + type: string + zoneTransferServers: + description: | + The OCI nameservers that transfer the zone data with external nameservers. + items: + $ref: '#/components/schemas/ZoneTransferServer' + type: array + zoneType: + description: | + The type of the zone. Must be either `PRIMARY` or `SECONDARY`. `SECONDARY` is only supported for GLOBAL zones. + enum: + - PRIMARY + - SECONDARY + type: string + required: + - name + - zoneType + - compartmentId + - freeformTags + - definedTags + - externalMasters + - externalDownstreams + - id + - version + - serial + - lifecycleState + - self + - scope + - isProtected + - timeCreated + - nameservers + - dnssecState + - resolutionMode + type: object + ResolverSummary: + description: | + An OCI DNS resolver. If the resolver has an attached VCN, the VCN will attempt to answer queries based on the + attached views in priority order. If the query does not match any of the attached views, the query will be + evaluated against the default view. If the default view does not match, the rules will be evaluated in + priority order. If no rules match the query, answers come from Internet DNS. A resolver may have a maximum of 10 + resolver endpoints. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + attachedVcnId: + description: | + The OCID of the attached VCN. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The OCID of the owning compartment. + maxLength: 255 + minLength: 1 + type: string + defaultViewId: + description: | + The OCID of the default view. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + The display name of the resolver. + maxLength: 255 + minLength: 1 + type: string + x-default-description: | + This field will be set to a value in the format "dnsresolver" where currentTimestampUTC + is in ISO 8601 basic format "yyyyMMddHHmmss". + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Department": "Finance"}` + type: object + id: + description: The OCID of the resolver. + maxLength: 255 + minLength: 1 + type: string + isProtected: + description: | + A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. + type: boolean + lifecycleState: + description: The current state of the resource. + enum: + - ACTIVE + - CREATING + - DELETED + - DELETING + - FAILED + - UPDATING + type: string + self: + description: The canonical absolute URL of the resource. + format: url + type: string + timeCreated: + description: | + The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format + with a Z offset, as defined by RFC 3339. + + **Example:** `2016-07-22T17:23:59:60Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" + format with a Z offset, as defined by RFC 3339. + + **Example:** `2016-07-22T17:23:59:60Z` + format: date-time + type: string + required: + - compartmentId + - displayName + - freeformTags + - definedTags + - id + - timeCreated + - timeUpdated + - lifecycleState + - self + - isProtected + type: object + Resolver: + description: | + An OCI DNS resolver. If the resolver has an attached VCN, the VCN will attempt to answer queries based on the + attached views in priority order. If the query does not match any of the attached views, the query will be + evaluated against the default view. If the default view does not match, the rules will be evaluated in + priority order. If no rules match the query, answers come from Internet DNS. A resolver may have a maximum of 10 + resolver endpoints. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + attachedVcnId: + description: | + The OCID of the attached VCN. + maxLength: 255 + minLength: 1 + type: string + attachedViews: + description: The attached views. Views are evaluated in order. + items: + $ref: '#/components/schemas/AttachedView' + maxItems: 50 + type: array + compartmentId: + description: The OCID of the owning compartment. + maxLength: 255 + minLength: 1 + type: string + defaultViewId: + description: | + The OCID of the default view. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + The display name of the resolver. + maxLength: 255 + minLength: 1 + type: string + x-default-description: | + This field will be set to a value in the format "dnsresolver" where currentTimestampUTC + is in ISO 8601 basic format "yyyyMMddHHmmss". + endpoints: + description: | + Read-only array of endpoints for the resolver. + items: + $ref: '#/components/schemas/ResolverEndpointSummary' + type: array + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Department": "Finance"}` + type: object + id: + description: The OCID of the resolver. + maxLength: 255 + minLength: 1 + type: string + isProtected: + description: | + A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. + type: boolean + lifecycleState: + description: The current state of the resource. + enum: + - ACTIVE + - CREATING + - DELETED + - DELETING + - FAILED + - UPDATING + type: string + rules: + description: | + Rules for the resolver. Rules are evaluated in order, and only the first matching rule will have its action + applied. + items: + $ref: '#/components/schemas/ResolverRule' + maxItems: 50 + type: array + self: + description: The canonical absolute URL of the resource. + format: url + type: string + timeCreated: + description: | + The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format + with a Z offset, as defined by RFC 3339. + + **Example:** `2016-07-22T17:23:59:60Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" + format with a Z offset, as defined by RFC 3339. + + **Example:** `2016-07-22T17:23:59:60Z` + format: date-time + type: string + required: + - compartmentId + - displayName + - freeformTags + - definedTags + - attachedViews + - id + - timeCreated + - timeUpdated + - lifecycleState + - endpoints + - self + - isProtected + type: object + UpdateResolverDetails: + description: | + The body for updating an existing resolver. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + attachedViews: + description: The attached views. Views are evaluated in order. + items: + $ref: '#/components/schemas/AttachedViewDetails' + maxItems: 50 + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + The display name of the resolver. + maxLength: 255 + minLength: 1 + type: string + x-default-description: | + This field will be set to a value in the format "dnsresolver" where currentTimestampUTC + is in ISO 8601 basic format "yyyyMMddHHmmss". + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Department": "Finance"}` + type: object + rules: + description: | + Rules for the resolver. Rules are evaluated in order, and only the first matching rule will have its action + applied. + items: + $ref: '#/components/schemas/ResolverRuleDetails' + maxItems: 50 + type: array + type: object + ChangeResolverCompartmentDetails: + properties: + compartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resolver, along with + its protected default view and resolver endpoints, should be moved. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ResolverEndpointSummary: + description: | + An OCI DNS resolver endpoint. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + discriminator: + propertyName: endpointType + properties: + compartmentId: + description: | + The OCID of the owning compartment. This will match the resolver that the resolver endpoint is under + and will be updated if the resolver's compartment is changed. + maxLength: 255 + minLength: 1 + type: string + endpointType: + default: VNIC + description: | + The type of resolver endpoint. VNIC is currently the only supported type. + enum: + - VNIC + type: string + forwardingAddress: + description: | + An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part + of the subnet and will be assigned by the system if unspecified when isForwarding is true. + type: string + isForwarding: + description: | + A Boolean flag indicating whether or not the resolver endpoint is for forwarding. + type: boolean + isListening: + description: | + A Boolean flag indicating whether or not the resolver endpoint is for listening. + type: boolean + lifecycleState: + description: The current state of the resource. + enum: + - ACTIVE + - CREATING + - DELETED + - DELETING + - FAILED + - UPDATING + type: string + listeningAddress: + description: | + An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the + subnet and will be assigned by the system if unspecified when isListening is true. + type: string + name: + description: | + The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver. + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ + type: string + self: + description: The canonical absolute URL of the resource. + format: url + type: string + timeCreated: + description: | + The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format + with a Z offset, as defined by RFC 3339. + + **Example:** `2016-07-22T17:23:59:60Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" + format with a Z offset, as defined by RFC 3339. + + **Example:** `2016-07-22T17:23:59:60Z` + format: date-time + type: string + required: + - compartmentId + - isForwarding + - isListening + - lifecycleState + - name + - self + - timeCreated + - timeUpdated + type: object + CreateResolverEndpointDetails: + description: | + The body for defining a new resolver endpoint. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + discriminator: + propertyName: endpointType + properties: + endpointType: + default: VNIC + description: | + The type of resolver endpoint. VNIC is currently the only supported type. + enum: + - VNIC + type: string + forwardingAddress: + description: | + An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part + of the subnet and will be assigned by the system if unspecified when isForwarding is true. + type: string + isForwarding: + description: | + A Boolean flag indicating whether or not the resolver endpoint is for forwarding. + type: boolean + isListening: + description: | + A Boolean flag indicating whether or not the resolver endpoint is for listening. + type: boolean + listeningAddress: + description: | + An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the + subnet and will be assigned by the system if unspecified when isListening is true. + type: string + name: + description: | + The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver. + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ + type: string + required: + - name + - isForwarding + - isListening + type: object + ResolverEndpoint: + description: | + An OCI DNS resolver endpoint. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + discriminator: + propertyName: endpointType + properties: + compartmentId: + description: | + The OCID of the owning compartment. This will match the resolver that the resolver endpoint is under + and will be updated if the resolver's compartment is changed. + maxLength: 255 + minLength: 1 + type: string + endpointType: + default: VNIC + description: | + The type of resolver endpoint. VNIC is currently the only supported type. + enum: + - VNIC + type: string + forwardingAddress: + description: | + An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part + of the subnet and will be assigned by the system if unspecified when isForwarding is true. + type: string + isForwarding: + description: | + A Boolean flag indicating whether or not the resolver endpoint is for forwarding. + type: boolean + isListening: + description: | + A Boolean flag indicating whether or not the resolver endpoint is for listening. + type: boolean + lifecycleState: + description: The current state of the resource. + enum: + - ACTIVE + - CREATING + - DELETED + - DELETING + - FAILED + - UPDATING + type: string + listeningAddress: + description: | + An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the + subnet and will be assigned by the system if unspecified when isListening is true. + type: string + name: + description: | + The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver. + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ + type: string + self: + description: The canonical absolute URL of the resource. + format: url + type: string + timeCreated: + description: | + The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format + with a Z offset, as defined by RFC 3339. + + **Example:** `2016-07-22T17:23:59:60Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" + format with a Z offset, as defined by RFC 3339. + + **Example:** `2016-07-22T17:23:59:60Z` + format: date-time + type: string + required: + - compartmentId + - isForwarding + - isListening + - lifecycleState + - name + - self + - timeCreated + - timeUpdated + type: object + UpdateResolverEndpointDetails: + description: | + The body for updating an existing resolver endpoint. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + discriminator: + propertyName: endpointType + properties: + endpointType: + default: VNIC + description: | + The type of resolver endpoint. VNIC is currently the only supported type. + enum: + - VNIC + type: string + type: object + SteeringPolicySummary: + description: | + A DNS steering policy. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + compartmentId: + description: The OCID of the compartment containing the steering policy. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + A user-friendly name for the steering policy. Does not have to be unique and can be changed. + Avoid entering confidential information. + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Department": "Finance"}` + type: object + healthCheckMonitorId: + description: | + The OCID of the health check monitor providing health data about the answers of the + steering policy. A steering policy answer with `rdata` matching a monitored endpoint + will use the health data of that endpoint. A steering policy answer with `rdata` not + matching any monitored endpoint will be assumed healthy. + + + **Note:** To use the Health Check monitoring feature in a steering policy, a monitor + must be created using the Health Checks service first. For more information on how to + create a monitor, please see [Managing Health Checks](/iaas/Content/HealthChecks/Tasks/managinghealthchecks.htm). + maxLength: 255 + minLength: 1 + type: string + id: + description: The OCID of the resource. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the resource. + enum: + - ACTIVE + - CREATING + - DELETED + - DELETING + type: string + self: + description: The canonical absolute URL of the resource. + format: url + type: string + template: + description: | + A set of predefined rules based on the desired purpose of the steering policy. Each + template utilizes Traffic Management's rules in a different order to produce the desired + results when answering DNS queries. + + + **Example:** The `FAILOVER` template determines answers by filtering the policy's answers + using the `FILTER` rule first, then the following rules in succession: `HEALTH`, `PRIORITY`, + and `LIMIT`. This gives the domain dynamic failover capability. + + + It is **strongly recommended** to use a template other than `CUSTOM` when creating + a steering policy. + + + All templates require the rule order to begin with an unconditional `FILTER` rule that keeps + answers contingent upon `answer.isDisabled != true`, except for `CUSTOM`. A defined + `HEALTH` rule must follow the `FILTER` rule if the policy references a `healthCheckMonitorId`. + The last rule of a template must must be a `LIMIT` rule. For more information about templates + and code examples, see [Traffic Management API Guide](/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm). + + **Template Types** + + * `FAILOVER` - Uses health check information on your endpoints to determine which DNS answers + to serve. If an endpoint fails a health check, the answer for that endpoint will be removed + from the list of available answers until the endpoint is detected as healthy. + + + * `LOAD_BALANCE` - Distributes web traffic to specified endpoints based on defined weights. + + + * `ROUTE_BY_GEO` - Answers DNS queries based on the query's geographic location. For a list of geographic + locations to route by, see [Traffic Management Geographic Locations](/iaas/Content/TrafficManagement/Reference/trafficmanagementgeo.htm). + + + * `ROUTE_BY_ASN` - Answers DNS queries based on the query's originating ASN. + + + * `ROUTE_BY_IP` - Answers DNS queries based on the query's IP address. + + + * `CUSTOM` - Allows a customized configuration of rules. + enum: + - FAILOVER + - LOAD_BALANCE + - ROUTE_BY_GEO + - ROUTE_BY_ASN + - ROUTE_BY_IP + - CUSTOM + type: string + timeCreated: + description: | + The date and time the resource was created, expressed in RFC 3339 timestamp format. + + **Example:** `2016-07-22T17:23:59:60Z` + format: date-time + type: string + ttl: + description: | + The Time To Live (TTL) for responses from the steering policy, in seconds. + If not specified during creation, a value of 30 seconds will be used. + format: int32 + maximum: 604800 + minimum: 1 + type: integer + required: + - compartmentId + - displayName + - ttl + - template + - freeformTags + - definedTags + - self + - id + - timeCreated + - lifecycleState + type: object + CreateSteeringPolicyDetails: + description: | + The body for defining a new steering policy. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + answers: + description: | + The set of all answers that can potentially issue from the steering policy. + items: + $ref: '#/components/schemas/SteeringPolicyAnswer' + type: array + compartmentId: + description: The OCID of the compartment containing the steering policy. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + A user-friendly name for the steering policy. Does not have to be unique and can be changed. + Avoid entering confidential information. + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Department": "Finance"}` + type: object + healthCheckMonitorId: + description: | + The OCID of the health check monitor providing health data about the answers of the + steering policy. A steering policy answer with `rdata` matching a monitored endpoint + will use the health data of that endpoint. A steering policy answer with `rdata` not + matching any monitored endpoint will be assumed healthy. + + + **Note:** To use the Health Check monitoring feature in a steering policy, a monitor + must be created using the Health Checks service first. For more information on how to + create a monitor, please see [Managing Health Checks](/iaas/Content/HealthChecks/Tasks/managinghealthchecks.htm). + maxLength: 255 + minLength: 1 + type: string + rules: + description: | + The series of rules that will be processed in sequence to reduce the pool of answers + to a response for any given request. + + + The first rule receives a shuffled list of all answers, and every other rule receives + the list of answers emitted by the one preceding it. The last rule populates the + response. + items: + $ref: '#/components/schemas/SteeringPolicyRule' + maxItems: 10 + type: array + template: + description: | + A set of predefined rules based on the desired purpose of the steering policy. Each + template utilizes Traffic Management's rules in a different order to produce the desired + results when answering DNS queries. + + + **Example:** The `FAILOVER` template determines answers by filtering the policy's answers + using the `FILTER` rule first, then the following rules in succession: `HEALTH`, `PRIORITY`, + and `LIMIT`. This gives the domain dynamic failover capability. + + + It is **strongly recommended** to use a template other than `CUSTOM` when creating + a steering policy. + + + All templates require the rule order to begin with an unconditional `FILTER` rule that keeps + answers contingent upon `answer.isDisabled != true`, except for `CUSTOM`. A defined + `HEALTH` rule must follow the `FILTER` rule if the policy references a `healthCheckMonitorId`. + The last rule of a template must must be a `LIMIT` rule. For more information about templates + and code examples, see [Traffic Management API Guide](/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm). + + **Template Types** + + * `FAILOVER` - Uses health check information on your endpoints to determine which DNS answers + to serve. If an endpoint fails a health check, the answer for that endpoint will be removed + from the list of available answers until the endpoint is detected as healthy. + + + * `LOAD_BALANCE` - Distributes web traffic to specified endpoints based on defined weights. + + + * `ROUTE_BY_GEO` - Answers DNS queries based on the query's geographic location. For a list of geographic + locations to route by, see [Traffic Management Geographic Locations](/iaas/Content/TrafficManagement/Reference/trafficmanagementgeo.htm). + + + * `ROUTE_BY_ASN` - Answers DNS queries based on the query's originating ASN. + + + * `ROUTE_BY_IP` - Answers DNS queries based on the query's IP address. + + + * `CUSTOM` - Allows a customized configuration of rules. + enum: + - FAILOVER + - LOAD_BALANCE + - ROUTE_BY_GEO + - ROUTE_BY_ASN + - ROUTE_BY_IP + - CUSTOM + type: string + ttl: + default: 30 + description: | + The Time To Live (TTL) for responses from the steering policy, in seconds. + If not specified during creation, a value of 30 seconds will be used. + format: int32 + maximum: 604800 + minimum: 1 + type: integer + required: + - compartmentId + - displayName + - template + type: object + SteeringPolicy: + description: | + A DNS steering policy. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + answers: + description: | + The set of all answers that can potentially issue from the steering policy. + items: + $ref: '#/components/schemas/SteeringPolicyAnswer' + type: array + compartmentId: + description: The OCID of the compartment containing the steering policy. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + A user-friendly name for the steering policy. Does not have to be unique and can be changed. + Avoid entering confidential information. + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Department": "Finance"}` + type: object + healthCheckMonitorId: + description: | + The OCID of the health check monitor providing health data about the answers of the + steering policy. A steering policy answer with `rdata` matching a monitored endpoint + will use the health data of that endpoint. A steering policy answer with `rdata` not + matching any monitored endpoint will be assumed healthy. + + + **Note:** To use the Health Check monitoring feature in a steering policy, a monitor + must be created using the Health Checks service first. For more information on how to + create a monitor, please see [Managing Health Checks](/iaas/Content/HealthChecks/Tasks/managinghealthchecks.htm). + maxLength: 255 + minLength: 1 + type: string + id: + description: The OCID of the resource. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the resource. + enum: + - ACTIVE + - CREATING + - DELETED + - DELETING + type: string + rules: + description: | + The series of rules that will be processed in sequence to reduce the pool of answers + to a response for any given request. + + + The first rule receives a shuffled list of all answers, and every other rule receives + the list of answers emitted by the one preceding it. The last rule populates the + response. + items: + $ref: '#/components/schemas/SteeringPolicyRule' + maxItems: 10 + type: array + self: + description: The canonical absolute URL of the resource. + format: url + type: string + template: + description: | + A set of predefined rules based on the desired purpose of the steering policy. Each + template utilizes Traffic Management's rules in a different order to produce the desired + results when answering DNS queries. + + + **Example:** The `FAILOVER` template determines answers by filtering the policy's answers + using the `FILTER` rule first, then the following rules in succession: `HEALTH`, `PRIORITY`, + and `LIMIT`. This gives the domain dynamic failover capability. + + + It is **strongly recommended** to use a template other than `CUSTOM` when creating + a steering policy. + + + All templates require the rule order to begin with an unconditional `FILTER` rule that keeps + answers contingent upon `answer.isDisabled != true`, except for `CUSTOM`. A defined + `HEALTH` rule must follow the `FILTER` rule if the policy references a `healthCheckMonitorId`. + The last rule of a template must must be a `LIMIT` rule. For more information about templates + and code examples, see [Traffic Management API Guide](/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm). + + **Template Types** + + * `FAILOVER` - Uses health check information on your endpoints to determine which DNS answers + to serve. If an endpoint fails a health check, the answer for that endpoint will be removed + from the list of available answers until the endpoint is detected as healthy. + + + * `LOAD_BALANCE` - Distributes web traffic to specified endpoints based on defined weights. + + + * `ROUTE_BY_GEO` - Answers DNS queries based on the query's geographic location. For a list of geographic + locations to route by, see [Traffic Management Geographic Locations](/iaas/Content/TrafficManagement/Reference/trafficmanagementgeo.htm). + + + * `ROUTE_BY_ASN` - Answers DNS queries based on the query's originating ASN. + + + * `ROUTE_BY_IP` - Answers DNS queries based on the query's IP address. + + + * `CUSTOM` - Allows a customized configuration of rules. + enum: + - FAILOVER + - LOAD_BALANCE + - ROUTE_BY_GEO + - ROUTE_BY_ASN + - ROUTE_BY_IP + - CUSTOM + type: string + timeCreated: + description: | + The date and time the resource was created, expressed in RFC 3339 timestamp format. + + **Example:** `2016-07-22T17:23:59:60Z` + format: date-time + type: string + ttl: + description: | + The Time To Live (TTL) for responses from the steering policy, in seconds. + If not specified during creation, a value of 30 seconds will be used. + format: int32 + maximum: 604800 + minimum: 1 + type: integer + required: + - compartmentId + - displayName + - ttl + - template + - freeformTags + - definedTags + - answers + - rules + - self + - id + - timeCreated + - lifecycleState + type: object + UpdateSteeringPolicyDetails: + description: | + The body for updating a steering policy. New rules and answers provided in the request will + replace the existing rules and answers in the policy. + + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + answers: + description: | + The set of all answers that can potentially issue from the steering policy. + items: + $ref: '#/components/schemas/SteeringPolicyAnswer' + type: array + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + A user-friendly name for the steering policy. Does not have to be unique and can be changed. + Avoid entering confidential information. + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Department": "Finance"}` + type: object + healthCheckMonitorId: + description: | + The OCID of the health check monitor providing health data about the answers of the + steering policy. A steering policy answer with `rdata` matching a monitored endpoint + will use the health data of that endpoint. A steering policy answer with `rdata` not + matching any monitored endpoint will be assumed healthy. + + + **Note:** To use the Health Check monitoring feature in a steering policy, a monitor + must be created using the Health Checks service first. For more information on how to + create a monitor, please see [Managing Health Checks](/iaas/Content/HealthChecks/Tasks/managinghealthchecks.htm). + maxLength: 255 + minLength: 1 + type: string + rules: + description: | + The series of rules that will be processed in sequence to reduce the pool of answers + to a response for any given request. + + + The first rule receives a shuffled list of all answers, and every other rule receives + the list of answers emitted by the one preceding it. The last rule populates the + response. + items: + $ref: '#/components/schemas/SteeringPolicyRule' + maxItems: 10 + type: array + template: + description: | + A set of predefined rules based on the desired purpose of the steering policy. Each + template utilizes Traffic Management's rules in a different order to produce the desired + results when answering DNS queries. + + + **Example:** The `FAILOVER` template determines answers by filtering the policy's answers + using the `FILTER` rule first, then the following rules in succession: `HEALTH`, `PRIORITY`, + and `LIMIT`. This gives the domain dynamic failover capability. + + + It is **strongly recommended** to use a template other than `CUSTOM` when creating + a steering policy. + + + All templates require the rule order to begin with an unconditional `FILTER` rule that keeps + answers contingent upon `answer.isDisabled != true`, except for `CUSTOM`. A defined + `HEALTH` rule must follow the `FILTER` rule if the policy references a `healthCheckMonitorId`. + The last rule of a template must must be a `LIMIT` rule. For more information about templates + and code examples, see [Traffic Management API Guide](/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm). + + **Template Types** + + * `FAILOVER` - Uses health check information on your endpoints to determine which DNS answers + to serve. If an endpoint fails a health check, the answer for that endpoint will be removed + from the list of available answers until the endpoint is detected as healthy. + + + * `LOAD_BALANCE` - Distributes web traffic to specified endpoints based on defined weights. + + + * `ROUTE_BY_GEO` - Answers DNS queries based on the query's geographic location. For a list of geographic + locations to route by, see [Traffic Management Geographic Locations](/iaas/Content/TrafficManagement/Reference/trafficmanagementgeo.htm). + + + * `ROUTE_BY_ASN` - Answers DNS queries based on the query's originating ASN. + + + * `ROUTE_BY_IP` - Answers DNS queries based on the query's IP address. + + + * `CUSTOM` - Allows a customized configuration of rules. + enum: + - FAILOVER + - LOAD_BALANCE + - ROUTE_BY_GEO + - ROUTE_BY_ASN + - ROUTE_BY_IP + - CUSTOM + type: string + ttl: + description: | + The Time To Live (TTL) for responses from the steering policy, in seconds. + If not specified during creation, a value of 30 seconds will be used. + format: int32 + maximum: 604800 + minimum: 1 + type: integer + type: object + ChangeSteeringPolicyCompartmentDetails: + properties: + compartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment + into which the steering policy should be moved. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + SteeringPolicyAttachmentSummary: + description: An attachment between a steering policy and a domain. + properties: + compartmentId: + description: The OCID of the compartment containing the steering policy attachment. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name for the steering policy attachment. + Does not have to be unique and can be changed. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + domainName: + description: The attached domain within the attached zone. + type: string + id: + description: The OCID of the resource. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the resource. + enum: + - CREATING + - ACTIVE + - DELETING + type: string + rtypes: + description: | + The record types covered by the attachment at the domain. The set of record types is + determined by aggregating the record types from the answers defined in the steering + policy. + items: + type: string + type: array + self: + description: The canonical absolute URL of the resource. + format: url + type: string + steeringPolicyId: + description: The OCID of the attached steering policy. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the resource was created, expressed in RFC 3339 timestamp format. + + **Example:** `2016-07-22T17:23:59:60Z` + format: date-time + type: string + zoneId: + description: The OCID of the attached zone. Must be a public zone. + maxLength: 255 + minLength: 1 + type: string + required: + - steeringPolicyId + - zoneId + - domainName + - displayName + - rtypes + - compartmentId + - self + - id + - timeCreated + - lifecycleState + type: object + CreateSteeringPolicyAttachmentDetails: + description: | + The body for defining an attachment between a steering policy and a domain. + + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + displayName: + description: | + A user-friendly name for the steering policy attachment. + Does not have to be unique and can be changed. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + domainName: + description: The attached domain within the attached zone. + type: string + steeringPolicyId: + description: The OCID of the attached steering policy. + maxLength: 255 + minLength: 1 + type: string + zoneId: + description: The OCID of the attached zone. Must be a public zone. + maxLength: 255 + minLength: 1 + type: string + required: + - steeringPolicyId + - zoneId + - domainName + type: object + SteeringPolicyAttachment: + description: | + An attachment between a steering policy and a domain. An attachment constructs + DNS responses using its steering policy instead of the records at its defined domain. + Only records of the policy's covered rtype are blocked at the domain. + A domain can have a maximum of one attachment covering any given rtype. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + compartmentId: + description: The OCID of the compartment containing the steering policy attachment. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name for the steering policy attachment. + Does not have to be unique and can be changed. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + domainName: + description: The attached domain within the attached zone. + type: string + id: + description: The OCID of the resource. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the resource. + enum: + - CREATING + - ACTIVE + - DELETING + type: string + rtypes: + description: | + The record types covered by the attachment at the domain. The set of record types is + determined by aggregating the record types from the answers defined in the steering + policy. + items: + type: string + type: array + self: + description: The canonical absolute URL of the resource. + format: url + type: string + steeringPolicyId: + description: The OCID of the attached steering policy. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the resource was created, expressed in RFC 3339 timestamp format. + + **Example:** `2016-07-22T17:23:59:60Z` + format: date-time + type: string + zoneId: + description: The OCID of the attached zone. Must be a public zone. + maxLength: 255 + minLength: 1 + type: string + required: + - steeringPolicyId + - zoneId + - domainName + - displayName + - rtypes + - compartmentId + - self + - id + - timeCreated + - lifecycleState + type: object + UpdateSteeringPolicyAttachmentDetails: + description: | + The body for updating a steering policy attachment. + + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + displayName: + description: | + A user-friendly name for the steering policy attachment. + Does not have to be unique and can be changed. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + type: object + TsigKeySummary: + description: A TSIG key. + properties: + algorithm: + description: | + TSIG key algorithms are encoded as domain names, but most consist of only one + non-empty label, which is not required to be explicitly absolute. + Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, + hmac-sha512. For more information on these algorithms, see [RFC 4635](https://tools.ietf.org/html/rfc4635#section-2). + maxLength: 63 + minLength: 1 + pattern: ^\.$|^(?=([^\\]|\\([^0-9]|[0-9]{3})){1,253}\.?$)(?=.*[^\\0-9.])(([a-zA-Z0-9_-]|\\([\x21-\x2F\x3A-\x7E]|[01][0-9][0-9]|2[0-4][0-9]|25[0-5])){1,63}(\.|$))+$ + type: string + compartmentId: + description: The OCID of the compartment containing the TSIG key. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + 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](/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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Department": "Finance"}` + type: object + id: + description: The OCID of the resource. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the resource. + enum: + - ACTIVE + - CREATING + - DELETED + - DELETING + - FAILED + - UPDATING + type: string + name: + description: A globally unique domain name identifying the key for a given pair of hosts. + maxLength: 63 + minLength: 1 + pattern: ^\.$|^(?=([^\\]|\\([^0-9]|[0-9]{3})){1,253}\.?$)(?=.*[^\\0-9.])(?=.*\.)(([a-zA-Z0-9_-]|\\([\x21-\x2F\x3A-\x7E]|[01][0-9][0-9]|2[0-4][0-9]|25[0-5])){1,63}(\.|$))+$ + type: string + self: + description: The canonical absolute URL of the resource. + format: url + type: string + timeCreated: + description: | + The date and time the resource was created, expressed in RFC 3339 timestamp format. + + **Example:** `2016-07-22T17:23:59:60Z` + format: date-time + type: string + required: + - algorithm + - name + - compartmentId + - freeformTags + - definedTags + - id + - self + - timeCreated + - lifecycleState + type: object + CreateTsigKeyDetails: + description: | + The body for defining a TSIG key. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + algorithm: + description: | + TSIG key algorithms are encoded as domain names, but most consist of only one + non-empty label, which is not required to be explicitly absolute. + Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, + hmac-sha512. For more information on these algorithms, see [RFC 4635](https://tools.ietf.org/html/rfc4635#section-2). + maxLength: 63 + minLength: 1 + pattern: ^\.$|^(?=([^\\]|\\([^0-9]|[0-9]{3})){1,253}\.?$)(?=.*[^\\0-9.])(([a-zA-Z0-9_-]|\\([\x21-\x2F\x3A-\x7E]|[01][0-9][0-9]|2[0-4][0-9]|25[0-5])){1,63}(\.|$))+$ + type: string + compartmentId: + description: The OCID of the compartment containing the TSIG key. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + 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](/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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Department": "Finance"}` + type: object + name: + description: A globally unique domain name identifying the key for a given pair of hosts. + maxLength: 63 + minLength: 1 + pattern: ^\.$|^(?=([^\\]|\\([^0-9]|[0-9]{3})){1,253}\.?$)(?=.*[^\\0-9.])(?=.*\.)(([a-zA-Z0-9_-]|\\([\x21-\x2F\x3A-\x7E]|[01][0-9][0-9]|2[0-4][0-9]|25[0-5])){1,63}(\.|$))+$ + type: string + secret: + description: A base64 string encoding the binary shared secret. + maxLength: 255 + minLength: 1 + pattern: ^(([\x20\t\r\n\f]*[A-Za-z0-9+/]){4})*(([\x20\t\r\n\f]*[A-Za-z0-9+/])([\x20\t\r\n\f]*[AQgw])==|([\x20\t\r\n\f]*[A-Za-z0-9+/]){2}([\x20\t\r\n\f]*[AEIMQUYcgkosw048])=)?[\x20\t\r\n\f]*$ + type: string + required: + - algorithm + - compartmentId + - name + - secret + type: object + TsigKey: + description: | + A TSIG key. + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + algorithm: + description: | + TSIG key algorithms are encoded as domain names, but most consist of only one + non-empty label, which is not required to be explicitly absolute. + Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, + hmac-sha512. For more information on these algorithms, see [RFC 4635](https://tools.ietf.org/html/rfc4635#section-2). + maxLength: 63 + minLength: 1 + pattern: ^\.$|^(?=([^\\]|\\([^0-9]|[0-9]{3})){1,253}\.?$)(?=.*[^\\0-9.])(([a-zA-Z0-9_-]|\\([\x21-\x2F\x3A-\x7E]|[01][0-9][0-9]|2[0-4][0-9]|25[0-5])){1,63}(\.|$))+$ + type: string + compartmentId: + description: The OCID of the compartment containing the TSIG key. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + 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](/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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Department": "Finance"}` + type: object + id: + description: The OCID of the resource. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the resource. + enum: + - ACTIVE + - CREATING + - DELETED + - DELETING + - FAILED + - UPDATING + type: string + name: + description: A globally unique domain name identifying the key for a given pair of hosts. + maxLength: 63 + minLength: 1 + pattern: ^\.$|^(?=([^\\]|\\([^0-9]|[0-9]{3})){1,253}\.?$)(?=.*[^\\0-9.])(?=.*\.)(([a-zA-Z0-9_-]|\\([\x21-\x2F\x3A-\x7E]|[01][0-9][0-9]|2[0-4][0-9]|25[0-5])){1,63}(\.|$))+$ + type: string + secret: + description: A base64 string encoding the binary shared secret. + maxLength: 255 + minLength: 1 + pattern: ^(([\x20\t\r\n\f]*[A-Za-z0-9+/]){4})*(([\x20\t\r\n\f]*[A-Za-z0-9+/])([\x20\t\r\n\f]*[AQgw])==|([\x20\t\r\n\f]*[A-Za-z0-9+/]){2}([\x20\t\r\n\f]*[AEIMQUYcgkosw048])=)?[\x20\t\r\n\f]*$ + type: string + self: + description: The canonical absolute URL of the resource. + format: url + type: string + timeCreated: + description: | + The date and time the resource was created, expressed in RFC 3339 timestamp format. + + **Example:** `2016-07-22T17:23:59:60Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time the resource was last updated, expressed in RFC 3339 timestamp format. + + **Example:** `2016-07-22T17:23:59:60Z` + format: date-time + type: string + required: + - algorithm + - name + - compartmentId + - secret + - freeformTags + - definedTags + - id + - self + - timeCreated + - lifecycleState + type: object + UpdateTsigKeyDetails: + description: | + The body for updating a TSIG key. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + 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](/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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Department": "Finance"}` + type: object + type: object + ChangeTsigKeyCompartmentDetails: + properties: + compartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment + into which the TSIG key should be moved. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ViewSummary: + description: | + An OCI DNS view. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + compartmentId: + description: The OCID of the owning compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + The display name of the view. + maxLength: 255 + minLength: 1 + type: string + x-default-description: | + This field will be set to a value in the format "dnsview" where currentTimestampUTC + is in ISO 8601 basic format "yyyyMMddHHmmss". + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Department": "Finance"}` + type: object + id: + description: The OCID of the view. + maxLength: 255 + minLength: 1 + type: string + isProtected: + description: | + A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. + type: boolean + lifecycleState: + description: The current state of the resource. + enum: + - ACTIVE + - DELETED + - DELETING + - UPDATING + type: string + self: + description: The canonical absolute URL of the resource. + format: url + type: string + timeCreated: + description: | + The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format + with a Z offset, as defined by RFC 3339. + + **Example:** `2016-07-22T17:23:59:60Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" + format with a Z offset, as defined by RFC 3339. + + **Example:** `2016-07-22T17:23:59:60Z` + format: date-time + type: string + required: + - compartmentId + - displayName + - freeformTags + - definedTags + - id + - self + - timeCreated + - timeUpdated + - lifecycleState + - isProtected + type: object + CreateViewDetails: + description: | + The body for defining a new view. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + compartmentId: + description: The OCID of the owning compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + The display name of the view. + maxLength: 255 + minLength: 1 + type: string + x-default-description: | + This field will be set to a value in the format "dnsview" where currentTimestampUTC + is in ISO 8601 basic format "yyyyMMddHHmmss". + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Department": "Finance"}` + type: object + required: + - compartmentId + type: object + View: + description: | + An OCI DNS view. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + compartmentId: + description: The OCID of the owning compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + The display name of the view. + maxLength: 255 + minLength: 1 + type: string + x-default-description: | + This field will be set to a value in the format "dnsview" where currentTimestampUTC + is in ISO 8601 basic format "yyyyMMddHHmmss". + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Department": "Finance"}` + type: object + id: + description: The OCID of the view. + maxLength: 255 + minLength: 1 + type: string + isProtected: + description: | + A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. + type: boolean + lifecycleState: + description: The current state of the resource. + enum: + - ACTIVE + - DELETED + - DELETING + - UPDATING + type: string + self: + description: The canonical absolute URL of the resource. + format: url + type: string + timeCreated: + description: | + The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format + with a Z offset, as defined by RFC 3339. + + **Example:** `2016-07-22T17:23:59:60Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" + format with a Z offset, as defined by RFC 3339. + + **Example:** `2016-07-22T17:23:59:60Z` + format: date-time + type: string + required: + - compartmentId + - displayName + - freeformTags + - definedTags + - id + - self + - timeCreated + - timeUpdated + - lifecycleState + - isProtected + type: object + UpdateViewDetails: + description: | + The body for updating an existing view. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + The display name of the view. + maxLength: 255 + minLength: 1 + type: string + x-default-description: | + This field will be set to a value in the format "dnsview" where currentTimestampUTC + is in ISO 8601 basic format "yyyyMMddHHmmss". + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Department": "Finance"}` + type: object + type: object + ChangeViewCompartmentDetails: + properties: + compartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment + into which the view should be moved. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ZoneTransferServer: + description: | + An OCI nameserver that transfers zone data with external nameservers. + properties: + address: + description: The server's IP address (IPv4 or IPv6). + type: string + isTransferDestination: + description: | + A Boolean flag indicating whether or not the server is a zone data transfer destination. + type: boolean + isTransferSource: + description: | + A Boolean flag indicating whether or not the server is a zone data transfer source. + type: boolean + port: + default: 53 + description: | + The server's port. + type: integer + required: + - address + type: object + ZoneSummary: + description: | + A DNS zone. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + compartmentId: + description: The OCID of the compartment containing the zone. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Operations": {"CostCenter": "42"}}` + type: object + dnssecConfig: + $ref: '#/components/schemas/DnssecConfig' + dnssecState: + default: DISABLED + description: | + The state of DNSSEC on the zone. + + For DNSSEC to function, every parent zone in the DNS tree up to the top-level domain (or an independent + trust anchor) must also have DNSSEC correctly set up. + After enabling DNSSEC, you must add a DS record to the zone's parent zone containing the + `KskDnssecKeyVersion` data. You can find the DS data in the `dsData` attribute of the `KskDnssecKeyVersion`. + Then, use the `PromoteZoneDnssecKeyVersion` operation to promote the `KskDnssecKeyVersion`. + + New `KskDnssecKeyVersion`s are generated annually, a week before the existing `KskDnssecKeyVersion`'s expiration. + To rollover a `KskDnssecKeyVersion`, you must replace the parent zone's DS record containing the old + `KskDnssecKeyVersion` data with the data from the new `KskDnssecKeyVersion`. + + To remove the old DS record without causing service disruption, wait until the old DS record's TTL has + expired, and the new DS record has propagated. After the DS replacement has been completed, then the + `PromoteZoneDnssecKeyVersion` operation must be called. + + Metrics are emitted in the `oci_dns` namespace daily for each `KskDnssecKeyVersion` indicating how many + days are left until expiration. + We recommend that you set up alarms and notifications for KskDnssecKeyVersion expiration so that the + necessary parent zone updates can be made and the `PromoteZoneDnssecKeyVersion` operation can be called. + + Enabling DNSSEC results in additional records in DNS responses which increases their size and can + cause higher response latency. + + For more information, see [DNSSEC](/iaas/Content/DNS/Concepts/dnssec.htm). + enum: + - ENABLED + - DISABLED + type: string + x-obmcs-top-level-enum: '#/definitions/ZoneDnssecState' + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Department": "Finance"}` + type: object + id: + description: The OCID of the zone. + maxLength: 255 + minLength: 1 + type: string + isProtected: + description: | + A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. + type: boolean + lifecycleState: + description: The current state of the zone resource. + enum: + - ACTIVE + - CREATING + - DELETED + - DELETING + - FAILED + - UPDATING + type: string + name: + description: The name of the zone. + maxLength: 254 + minLength: 1 + type: string + resolutionMode: + default: STATIC + description: | + The resolution mode of a zone defines behavior related to how query responses can be handled. See [Private DNS Zone Transparency](/Content/DNS/Tasks/privatedns.htm#use-cases__resolution) for more information. + enum: + - STATIC + - TRANSPARENT + - RTYPE_TRANSPARENT + type: string + x-obmcs-top-level-enum: '#/definitions/ZoneResolutionMode' + scope: + description: The scope of the zone. + enum: + - GLOBAL + - PRIVATE + type: string + x-obmcs-top-level-enum: '#/definitions/Scope' + self: + description: The canonical absolute URL of the resource. + format: url + type: string + serial: + description: | + The current serial of the zone. As seen in the zone's SOA record. + format: int64 + type: integer + timeCreated: + description: | + The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format + with a Z offset, as defined by RFC 3339. + + **Example:** `2016-07-22T17:23:59:60Z` + format: date-time + type: string + version: + description: | + Version is the never-repeating, totally-orderable, version of the + zone, from which the serial field of the zone's SOA record is + derived. + type: string + viewId: + description: | + The OCID of the private view containing the zone. This value will + be null for zones in the global DNS, which are publicly resolvable and + not part of a private view. + maxLength: 255 + minLength: 1 + type: string + zoneType: + description: | + The type of the zone. Must be either `PRIMARY` or `SECONDARY`. `SECONDARY` is only supported for GLOBAL zones. + enum: + - PRIMARY + - SECONDARY + type: string + required: + - name + - zoneType + - compartmentId + - freeformTags + - definedTags + - id + - version + - serial + - lifecycleState + - self + - scope + - isProtected + - timeCreated + - dnssecState + - resolutionMode + type: object + CreateZoneBaseDetails: + description: | + The body for either defining a new zone or migrating a zone from migrationSource. This is determined by the migrationSource discriminator. + NONE indicates creation of a new zone (default). DYNECT indicates migration from a DynECT zone. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + discriminator: + propertyName: migrationSource + properties: + compartmentId: + description: The OCID of the compartment containing the zone. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + 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](/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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Department": "Finance"}` + type: object + migrationSource: + default: NONE + description: | + Discriminator that is used to determine whether to create a new zone (NONE) or to migrate an existing DynECT zone (DYNECT). + enum: + - NONE + - DYNECT + type: string + name: + description: | + The name of the zone. + + Global zone names must be unique across all other zones within the realm. Private zone names must be unique + within their view. + + Unicode characters will be converted into punycode, see [RFC 3492](https://tools.ietf.org/html/rfc3492). + maxLength: 254 + minLength: 1 + type: string + required: + - name + - compartmentId + type: object + ChangeZoneCompartmentDetails: + properties: + compartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment + into which the zone should be moved. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + PromoteZoneDnssecKeyVersionDetails: + description: | + Details for promoting a `DnssecKeyVersion` on a zone. + properties: + dnssecKeyVersionUuid: + description: | + The UUID of the `DnssecKeyVersion` that is being promoted. + maxLength: 36 + minLength: 36 + type: string + required: + - dnssecKeyVersionUuid + type: object + StageZoneDnssecKeyVersionDetails: + description: | + Details for staging a `DnssecKeyVersion` on a zone. + properties: + predecessorDnssecKeyVersionUuid: + description: | + The UUID of the `DnssecKeyVersion` for which a new successor should be generated. + maxLength: 36 + minLength: 36 + type: string + required: + - predecessorDnssecKeyVersionUuid + type: object + UpdateZoneDetails: + description: | + The body for updating a zone. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Operations": {"CostCenter": "42"}}` + type: object + dnssecState: + default: DISABLED + description: | + The state of DNSSEC on the zone. + + For DNSSEC to function, every parent zone in the DNS tree up to the top-level domain (or an independent + trust anchor) must also have DNSSEC correctly set up. + After enabling DNSSEC, you must add a DS record to the zone's parent zone containing the + `KskDnssecKeyVersion` data. You can find the DS data in the `dsData` attribute of the `KskDnssecKeyVersion`. + Then, use the `PromoteZoneDnssecKeyVersion` operation to promote the `KskDnssecKeyVersion`. + + New `KskDnssecKeyVersion`s are generated annually, a week before the existing `KskDnssecKeyVersion`'s expiration. + To rollover a `KskDnssecKeyVersion`, you must replace the parent zone's DS record containing the old + `KskDnssecKeyVersion` data with the data from the new `KskDnssecKeyVersion`. + + To remove the old DS record without causing service disruption, wait until the old DS record's TTL has + expired, and the new DS record has propagated. After the DS replacement has been completed, then the + `PromoteZoneDnssecKeyVersion` operation must be called. + + Metrics are emitted in the `oci_dns` namespace daily for each `KskDnssecKeyVersion` indicating how many + days are left until expiration. + We recommend that you set up alarms and notifications for KskDnssecKeyVersion expiration so that the + necessary parent zone updates can be made and the `PromoteZoneDnssecKeyVersion` operation can be called. + + Enabling DNSSEC results in additional records in DNS responses which increases their size and can + cause higher response latency. + + For more information, see [DNSSEC](/iaas/Content/DNS/Concepts/dnssec.htm). + enum: + - ENABLED + - DISABLED + type: string + x-obmcs-top-level-enum: '#/definitions/ZoneDnssecState' + externalDownstreams: + description: | + External secondary servers for the zone. + This field is currently not supported when `zoneType` is `SECONDARY` or `scope` is `PRIVATE`. + items: + $ref: '#/components/schemas/ExternalDownstream' + type: array + externalMasters: + description: | + External master servers for the zone. `externalMasters` becomes a + required parameter when the `zoneType` value is `SECONDARY`. + items: + $ref: '#/components/schemas/ExternalMaster' + type: array + 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](/Content/General/Concepts/resourcetags.htm). + + + **Example:** `{"Department": "Finance"}` + type: object + resolutionMode: + default: STATIC + description: | + The resolution mode of a zone defines behavior related to how query responses can be handled. See [Private DNS Zone Transparency](/Content/DNS/Tasks/privatedns.htm#use-cases__resolution) for more information. + enum: + - STATIC + - TRANSPARENT + - RTYPE_TRANSPARENT + type: string + x-obmcs-top-level-enum: '#/definitions/ZoneResolutionMode' + type: object + PatchZoneRecordsDetails: + properties: + items: + items: + $ref: '#/components/schemas/RecordOperation' + type: array + type: object + UpdateZoneRecordsDetails: + properties: + items: + items: + $ref: '#/components/schemas/RecordDetails' + type: array + type: object + PatchDomainRecordsDetails: + properties: + items: + items: + $ref: '#/components/schemas/RecordOperation' + type: array + type: object + UpdateDomainRecordsDetails: + properties: + items: + items: + $ref: '#/components/schemas/RecordDetails' + type: array + type: object + RRSet: + description: | + A collection of DNS records of the same domain and type. For more + information about record types, see [Resource Record (RR) TYPEs](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4). + properties: + items: + items: + $ref: '#/components/schemas/Record' + type: array + required: + - items + type: object + PatchRRSetDetails: + properties: + items: + items: + $ref: '#/components/schemas/RecordOperation' + type: array + type: object + UpdateRRSetDetails: + properties: + items: + items: + $ref: '#/components/schemas/RecordDetails' + type: array + type: object + DnssecConfig: + description: | + DNSSEC configuration data. + + A zone may have a maximum of 10 `DnssecKeyVersions`, regardless of signing key type. + properties: + kskDnssecKeyVersions: + description: | + A read-only array of key signing key (KSK) versions. + items: + $ref: '#/components/schemas/KskDnssecKeyVersion' + type: array + zskDnssecKeyVersions: + description: | + A read-only array of zone signing key (ZSK) versions. + items: + $ref: '#/components/schemas/ZskDnssecKeyVersion' + type: array + type: object + ExternalDownstream: + description: | + External downstream nameserver for the zone. + This field is currently not supported when `zoneType` is `SECONDARY` or `scope` is `PRIVATE`. + properties: + address: + description: The server's IP address (IPv4 or IPv6). + type: string + port: + default: 53 + description: | + The server's port. Port value must be a value of 53, otherwise omit + the port value. + type: integer + tsigKeyId: + description: | + The OCID of the TSIG key. + A TSIG key is used to secure DNS messages (in this case, zone transfers) between two systems that both have the (shared) secret. + maxLength: 255 + minLength: 1 + type: string + required: + - address + type: object + ExternalMaster: + description: | + An external master name server used as the source of zone data. + properties: + address: + description: The server's IP address (IPv4 or IPv6). + type: string + port: + default: 53 + description: | + The server's port. Port value must be a value of 53, otherwise omit + the port value. + type: integer + tsigKeyId: + description: The OCID of the TSIG key. + maxLength: 255 + minLength: 1 + type: string + required: + - address + type: object + Nameserver: + description: A server that has been set up to answer DNS queries for a zone. + properties: + hostname: + description: The hostname of the nameserver. + type: string + required: + - hostname + type: object + Error: + properties: + code: + description: | + A short error code that defines the error, meant for programmatic parsing. See + [API Errors](/Content/API/References/apierrors.htm). + type: string + message: + description: A human-readable error string. + type: string + required: + - code + - message + type: object + AttachedView: + description: | + Properties of an attached view. + properties: + viewId: + description: The OCID of the view. + maxLength: 255 + minLength: 1 + type: string + required: + - viewId + type: object + ResolverRule: + description: | + A rule for a resolver. Specifying both qnameCoverConditions and clientAddressConditions is not allowed. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + discriminator: + propertyName: action + properties: + action: + description: | + The action determines the behavior of the rule. If a query matches a supplied condition, the action will + apply. If there are no conditions on the rule, all queries are subject to the specified action. + * `FORWARD` - Matching requests will be forwarded from the source interface to the destination address. + enum: + - FORWARD + type: string + clientAddressConditions: + description: | + A list of CIDR blocks. In order for the rule action to apply, the query must come from a client within one of + the CIDR blocks. + example: + - 198.51.100.0/24 + items: + type: string + maxItems: 10 + type: array + qnameCoverConditions: + description: | + A list of domain names. In order for the rule action to apply, the query must either match or be a subdomain + of one of the listed domains. + example: + - internal.example.com + items: + format: hostname + type: string + maxItems: 10 + type: array + required: + - action + - clientAddressConditions + - qnameCoverConditions + type: object + AttachedViewDetails: + description: | + Properties for defining an attached view. + properties: + viewId: + description: The OCID of the view. + maxLength: 255 + minLength: 1 + type: string + required: + - viewId + type: object + ResolverRuleDetails: + description: | + A rule for a resolver. Specifying both qnameCoverConditions and clientAddressConditions is not allowed. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + discriminator: + propertyName: action + properties: + action: + description: | + The action determines the behavior of the rule. If a query matches a supplied condition, the action will + apply. If there are no conditions on the rule, all queries are subject to the specified action. + * `FORWARD` - Matching requests will be forwarded from the source interface to the destination address. + enum: + - FORWARD + type: string + clientAddressConditions: + description: | + A list of CIDR blocks. In order for the rule action to apply, the query must come from a client within one of + the CIDR blocks. + example: + - 198.51.100.0/24 + items: + type: string + maxItems: 10 + type: array + qnameCoverConditions: + description: | + A list of domain names. In order for the rule action to apply, the query must either match or be a subdomain + of one of the listed domains. + example: + - internal.example.com + items: + format: hostname + type: string + maxItems: 10 + type: array + required: + - action + type: object + SteeringPolicyAnswer: + description: | + DNS record data with metadata for processing in a steering policy. + + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + example: + isDisabled: false + name: Phoenix LB 1 + pool: na-west + rdata: 192.0.2.1 + rtype: A + properties: + isDisabled: + description: | + Set this property to `true` to indicate that the answer is administratively disabled, + such as when the corresponding server is down for maintenance. An answer's `isDisabled` + property can be referenced in `answerCondition` properties in rules using `answer.isDisabled`. + + **Example:** + "rules": [ + { + "ruleType": "FILTER", + "defaultAnswerData": [ + { + "answerCondition": "answer.isDisabled != true", + "shouldKeep": true + } + ] + }, + type: boolean + name: + description: | + A user-friendly name for the answer, unique within the steering policy. + An answer's `name` property can be referenced in `answerCondition` properties + of rules using `answer.name`. + + **Example:** + + "rules": [ + { + "ruleType": "FILTER", + "defaultAnswerData": [ + { + "answerCondition": "answer.name == 'server 1'", + "shouldKeep": true + } + ] + } + ] + maxLength: 255 + minLength: 1 + type: string + pool: + description: | + The freeform name of a group of one or more records in which this record is included, + such as "LAX data center". An answer's `pool` property can be referenced in `answerCondition` + properties of rules using `answer.pool`. + + **Example:** + + "rules": [ + { + "ruleType": "FILTER", + "defaultAnswerData": [ + { + "answerCondition": "answer.pool == 'US East Servers'", + "shouldKeep": true + } + ] + } + ] + maxLength: 255 + minLength: 1 + type: string + rdata: + description: | + The record's data, as whitespace-delimited tokens in + type-specific presentation format. All RDATA is normalized and the + returned presentation of your RDATA may differ from its initial input. + For more information about RDATA, see [Supported DNS Resource Record Types](/iaas/Content/DNS/Reference/supporteddnsresource.htm). + type: string + rtype: + description: | + The type of DNS record, such as A or CNAME. Only A, AAAA, and CNAME are supported. For more + information, see [Supported DNS Resource Record Types](/iaas/Content/DNS/Reference/supporteddnsresource.htm). + type: string + required: + - name + - rtype + - rdata + type: object + SteeringPolicyRule: + description: | + The configuration of the sorting and filtering behaviors in a steering policy. Rules can + filter and sort answers based on weight, priority, endpoint health, and other data. + + + A rule may optionally include a sequence of cases, each with an optional `caseCondition` + expression. Cases allow a sequence of conditions to be defined that will apply different + parameters to the rule when the conditions are met. For more information about cases, + see [Traffic Management API Guide](/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm). + + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + discriminator: + propertyName: ruleType + properties: + description: + description: A user-defined description of the rule's purpose or behavior. + maxLength: 400 + type: string + ruleType: + description: | + The type of a rule determines its sorting/filtering behavior. + * `FILTER` - Filters the list of answers based on their defined boolean data. Answers remain + only if their `shouldKeep` value is `true`. + + + * `HEALTH` - Removes answers from the list if their `rdata` matches a target in the + health check monitor referenced by the steering policy and the target is reported down. + + + * `WEIGHTED` - Uses a number between 0 and 255 to determine how often an answer will be served + in relation to other answers. Anwers with a higher weight will be served more frequently. + + + * `PRIORITY` - Uses a defined rank value of answers to determine which answer to serve, + moving those with the lowest values to the beginning of the list without changing the + relative order of those with the same value. Answers can be given a value between `0` and `255`. + + + * `LIMIT` - Filters answers that are too far down the list. Parameter `defaultCount` + specifies how many answers to keep. **Example:** If `defaultCount` has a value of `2` and + there are five answers left, when the `LIMIT` rule is processed, only the first two answers + will remain in the list. + enum: + - FILTER + - HEALTH + - WEIGHTED + - PRIORITY + - LIMIT + type: string + required: + - ruleType + type: object + RecordCollection: + description: A collection of DNS resource records. + properties: + items: + items: + $ref: '#/components/schemas/Record' + type: array + required: + - items + type: object + RecordOperation: + description: | + An extension of the existing record resource, describing either a + precondition, an add, or a remove. Preconditions check all fields, + including read-only data like `recordHash` and `rrsetVersion`. + properties: + domain: + description: | + The fully qualified domain name where the record can be located. + maxLength: 254 + minLength: 1 + type: string + isProtected: + description: | + A Boolean flag indicating whether or not parts of the record + are unable to be explicitly managed. + type: boolean + operation: + default: ADD + description: | + A description of how a record relates to a PATCH operation. + + + - `REQUIRE` indicates a precondition that record data **must** already exist. + - `PROHIBIT` indicates a precondition that record data **must not** already exist. + - `ADD` indicates that record data **must** exist after successful application. + - `REMOVE` indicates that record data **must not** exist after successful application. + + + **Note:** `ADD` and `REMOVE` operations can succeed even if + they require no changes when applied, such as when the described + records are already present or absent. + + + **Note:** `ADD` and `REMOVE` operations can describe changes for + more than one record. + + + **Example:** `{ "domain": "www.example.com", "rtype": "AAAA", "ttl": 60 }` + specifies a new TTL for every record in the www.example.com AAAA RRSet. + enum: + - REQUIRE + - PROHIBIT + - ADD + - REMOVE + type: string + rdata: + description: | + The record's data, as whitespace-delimited tokens in + type-specific presentation format. All RDATA is normalized and the + returned presentation of your RDATA may differ from its initial input. + For more information about RDATA, see [Supported DNS Resource Record Types](/iaas/Content/DNS/Reference/supporteddnsresource.htm) + type: string + recordHash: + description: | + A unique identifier for the record within its zone. + type: string + rrsetVersion: + description: | + The latest version of the record's zone in which its RRSet differs + from the preceding version. + type: string + rtype: + description: | + The type of DNS record, such as A or CNAME. For more information, see [Resource Record (RR) TYPEs](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4). + type: string + ttl: + description: | + The Time To Live for the record, in seconds. Using a TTL lower than 30 seconds is not recommended. + format: int32 + maximum: 604800 + minimum: 0 + type: integer + type: object + RecordDetails: + description: A DNS resource record. For more information about records, see [RFC 1034](https://tools.ietf.org/html/rfc1034#section-3.6). + properties: + domain: + description: | + The fully qualified domain name where the record can be located. + maxLength: 254 + minLength: 1 + type: string + isProtected: + description: | + A Boolean flag indicating whether or not parts of the record + are unable to be explicitly managed. + type: boolean + rdata: + description: | + The record's data, as whitespace-delimited tokens in + type-specific presentation format. All RDATA is normalized and the + returned presentation of your RDATA may differ from its initial input. + For more information about RDATA, see [Supported DNS Resource Record Types](/iaas/Content/DNS/Reference/supporteddnsresource.htm) + type: string + recordHash: + description: | + A unique identifier for the record within its zone. + type: string + rrsetVersion: + description: | + The latest version of the record's zone in which its RRSet differs + from the preceding version. + type: string + rtype: + description: | + The type of DNS record, such as A or CNAME. For more information, see [Resource Record (RR) TYPEs](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4). + type: string + ttl: + description: | + The Time To Live for the record, in seconds. Using a TTL lower than 30 seconds is not recommended. + format: int32 + maximum: 604800 + minimum: 0 + type: integer + required: + - domain + - ttl + - rtype + - rdata + type: object + Record: + description: | + A DNS resource record. For more information, see + [Supported DNS Resource Record Types](/iaas/Content/DNS/Reference/supporteddnsresource.htm). + properties: + domain: + description: | + The fully qualified domain name where the record can be located. + maxLength: 254 + minLength: 1 + type: string + isProtected: + description: | + A Boolean flag indicating whether or not parts of the record + are unable to be explicitly managed. + type: boolean + rdata: + description: | + The record's data, as whitespace-delimited tokens in + type-specific presentation format. All RDATA is normalized and the + returned presentation of your RDATA may differ from its initial input. + For more information about RDATA, see [Supported DNS Resource Record Types](/iaas/Content/DNS/Reference/supporteddnsresource.htm) + type: string + recordHash: + description: | + A unique identifier for the record within its zone. + type: string + rrsetVersion: + description: | + The latest version of the record's zone in which its RRSet differs + from the preceding version. + type: string + rtype: + description: | + The type of DNS record, such as A or CNAME. For more information, see [Resource Record (RR) TYPEs](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4). + type: string + ttl: + description: | + The Time To Live for the record, in seconds. Using a TTL lower than 30 seconds is not recommended. + format: int32 + maximum: 604800 + minimum: 0 + type: integer + type: object + KskDnssecKeyVersion: + description: | + A key signing key (KSK) version. The version information contains timing and configuration data corresponding to the KSK that is used to + apply DNSSEC on the zone. + properties: + algorithm: + description: | + The signing algorithm used for the key. + enum: + - RSASHA256 + type: string + x-obmcs-top-level-enum: '#/definitions/DnssecSigningAlgorithm' + dsData: + description: | + An array of data for DS records corresponding with this key version. An entry will exist for each + supported DS digest algorithm. + items: + $ref: '#/components/schemas/DnssecKeyVersionDsData' + minLength: 1 + type: array + keyTag: + description: | + The key tag associated with the `DnssecKeyVersion`. This key tag will be present in the RRSIG and DS records + associated with the key material for this `DnssecKeyVersion`. For more information about key tags, see + [RFC 4034](https://tools.ietf.org/html/rfc4034). + maximum: 65535 + minimum: 0 + type: integer + lengthInBytes: + description: | + The length of the corresponding private key in bytes, expressed as an integer. + format: int32 + type: integer + predecessorDnssecKeyVersionUuid: + description: | + When populated, this is the UUID of the `DnssecKeyVersion` that this `DnssecKeyVersion` will replace or has + replaced. + maxLength: 36 + minLength: 36 + type: string + successorDnssecKeyVersionUuid: + description: | + When populated, this is the UUID of the `DnssecKeyVersion` that will replace, or has replaced, this + `DnssecKeyVersion`. + maxLength: 36 + minLength: 36 + type: string + timeActivated: + description: | + The date and time the key version went, or will go, active, expressed in RFC 3339 timestamp format. This is + when the key material will be used to generate RRSIGs. + + **Example:** `2016-07-22T17:23:59:00Z` + format: date-time + type: string + timeCreated: + description: | + The date and time the key version was created, expressed in RFC 3339 timestamp format. + + **Example:** `2016-07-22T17:23:59:00Z` + format: date-time + type: string + timeExpired: + description: | + The date and time at which the recommended key version publication/activation lifetime ends, expressed in RFC + 3339 timestamp format. This is when the corresponding DNSKEY should no longer exist in zone contents and no + longer be used to generate RRSIGs. For a key sigining key (KSK), if `PromoteZoneDnssecKeyVersion` has not been called on this + `DnssecKeyVersion`'s successor then it will remain active for arbitrarily long past its recommended lifetime. + This prevents service disruption at the potential increased risk of key compromise. + + **Example:** `2016-07-22T17:23:59:00Z` + format: date-time + type: string + timeInactivated: + description: | + The date and time the key version went, or will go, inactive, expressed in RFC 3339 timestamp format. This + is when the key material will no longer be used to generate RRSIGs. For a key signing key (KSK) `DnssecKeyVersion`, this is + populated after `PromoteZoneDnssecKeyVersion` has been called on its successor `DnssecKeyVersion`. + + **Example:** `2016-07-22T17:23:59:00Z` + format: date-time + type: string + timePromoted: + description: | + The date and time the key version was promoted expressed in RFC 3339 timestamp format. + + **Example:** `2016-07-22T17:23:59:00Z` + format: date-time + type: string + timePublished: + description: | + The date and time the key version was, or will be, published, expressed in RFC 3339 timestamp format. This is + when the zone contents will include a DNSKEY record corresponding to the key material. + + **Example:** `2016-07-22T17:23:59:00Z` + format: date-time + type: string + timeUnpublished: + description: | + The date and time the key version was, or will be, unpublished, expressed in RFC 3339 timestamp format. This + is when the corresponding DNSKEY will be removed from zone contents. For a key signing key (KSK) `DnssecKeyVersion`, this is + populated after `PromoteZoneDnssecKeyVersion` has been called on its successor `DnssecKeyVersion`. + + **Example:** `2016-07-22T17:23:59:00Z` + format: date-time + type: string + uuid: + description: | + The UUID of the `DnssecKeyVersion`. + maxLength: 36 + minLength: 36 + type: string + type: object + ZskDnssecKeyVersion: + description: | + A zone signing key (ZSK) version. The version information contains timing and configuration data for the ZSK that is used to + apply DNSSEC on the zone. + properties: + algorithm: + description: | + The signing algorithm used for the key. + enum: + - RSASHA256 + type: string + x-obmcs-top-level-enum: '#/definitions/DnssecSigningAlgorithm' + keyTag: + description: | + The key tag associated with the `DnssecKeyVersion`. This key tag will be present in the RRSIG and DS records + associated with the key material for this `DnssecKeyVersion`. For more information about key tags, see + [RFC 4034](https://tools.ietf.org/html/rfc4034). + maximum: 65535 + minimum: 0 + type: integer + lengthInBytes: + description: | + The length of the corresponding private key in bytes, expressed as an integer. + format: int32 + type: integer + predecessorDnssecKeyVersionUuid: + description: | + When populated, this is the UUID of the `DnssecKeyVersion` that this `DnssecKeyVersion` will replace or has + replaced. + maxLength: 36 + minLength: 36 + type: string + successorDnssecKeyVersionUuid: + description: | + When populated, this is the UUID of the `DnssecKeyVersion` that will replace, or has replaced, this + `DnssecKeyVersion`. + maxLength: 36 + minLength: 36 + type: string + timeActivated: + description: | + The date and time the key version went, or will go, active, expressed in RFC 3339 timestamp format. This is + when the key material will be used to generate RRSIGs. + + **Example:** `2016-07-22T17:23:59:00Z` + format: date-time + type: string + timeCreated: + description: | + The date and time the key version was created, expressed in RFC 3339 timestamp format. + + **Example:** `2016-07-22T17:23:59:00Z` + format: date-time + type: string + timeExpired: + description: | + The date and time at which the recommended key version publication/activation lifetime ends, expressed in RFC + 3339 timestamp format. This is when the corresponding DNSKEY should no longer exist in zone contents and no + longer be used to generate RRSIGs. For a key sigining key (KSK), if `PromoteZoneDnssecKeyVersion` has not been called on this + `DnssecKeyVersion`'s successor then it will remain active for arbitrarily long past its recommended lifetime. + This prevents service disruption at the potential increased risk of key compromise. + + **Example:** `2016-07-22T17:23:59:00Z` + format: date-time + type: string + timeInactivated: + description: | + The date and time the key version went, or will go, inactive, expressed in RFC 3339 timestamp format. This + is when the key material will no longer be used to generate RRSIGs. For a key signing key (KSK) `DnssecKeyVersion`, this is + populated after `PromoteZoneDnssecKeyVersion` has been called on its successor `DnssecKeyVersion`. + + **Example:** `2016-07-22T17:23:59:00Z` + format: date-time + type: string + timePromoted: + description: | + The date and time the key version was promoted expressed in RFC 3339 timestamp format. + + **Example:** `2016-07-22T17:23:59:00Z` + format: date-time + type: string + timePublished: + description: | + The date and time the key version was, or will be, published, expressed in RFC 3339 timestamp format. This is + when the zone contents will include a DNSKEY record corresponding to the key material. + + **Example:** `2016-07-22T17:23:59:00Z` + format: date-time + type: string + timeUnpublished: + description: | + The date and time the key version was, or will be, unpublished, expressed in RFC 3339 timestamp format. This + is when the corresponding DNSKEY will be removed from zone contents. For a key signing key (KSK) `DnssecKeyVersion`, this is + populated after `PromoteZoneDnssecKeyVersion` has been called on its successor `DnssecKeyVersion`. + + **Example:** `2016-07-22T17:23:59:00Z` + format: date-time + type: string + uuid: + description: | + The UUID of the `DnssecKeyVersion`. + maxLength: 36 + minLength: 36 + type: string + type: object + DnssecKeyVersionDsData: + description: | + Data for a parent zone DS record corresponding to this key-signing key (KSK). + properties: + digestType: + description: | + The type of the digest associated with the rdata. + enum: + - SHA_256 + type: string + x-obmcs-top-level-enum: '#/definitions/DnssecDigestType' + rdata: + description: | + Presentation-format DS record data that must be added to the parent zone. For more information about RDATA, + see [Supported DNS Resource Record Types](/iaas/Content/DNS/Reference/supporteddnsresource.htm) + example: 60485 5 1 2BB183AF5F22588179A53B0A98631FAD1A292118 + type: string + type: object + ListResolversResponse: + type: object + properties: + resolvers: + type: array + items: + $ref: '#/components/schemas/ResolverSummary' + ListResolverEndpointsResponse: + type: object + properties: + resolver_endpoints: + type: array + items: + $ref: '#/components/schemas/ResolverEndpointSummary' + ListSteeringPoliciesResponse: + type: object + properties: + steering_policies: + type: array + items: + $ref: '#/components/schemas/SteeringPolicySummary' + ListSteeringPolicyAttachmentsResponse: + type: object + properties: + steering_policy_attachments: + type: array + items: + $ref: '#/components/schemas/SteeringPolicyAttachmentSummary' + ListTsigKeysResponse: + type: object + properties: + tsig_keys: + type: array + items: + $ref: '#/components/schemas/TsigKeySummary' + ListViewsResponse: + type: object + properties: + views: + type: array + items: + $ref: '#/components/schemas/ViewSummary' + ListZoneTransferServersResponse: + type: object + properties: + zone_transfer_servers: + type: array + items: + $ref: '#/components/schemas/ZoneTransferServer' + ListZonesResponse: + type: object + properties: + zones: + type: array + items: + $ref: '#/components/schemas/ZoneSummary' + responses: + '304': + description: Not Modified + 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 + '400': + description: Bad Request + 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' + '401': + description: Unauthorized + 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' + '404': + description: Forbidden or Not Found + 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' + '409': + description: Conflict + 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' + '412': + description: Precondition Failed + 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' + '422': + description: Unprocessable Entity + 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' + '429': + description: Too Many Requests + 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' + '500': + description: Internal Server 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' + DefaultError: + description: | + An error has occurred. + 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' + EmptyResponseWithWorkRequest: + description: An empty HTTP response. + 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: | + Unique Oracle-assigned identifier for the asynchronous request. + You can use this to query status of the asynchronous operation. + schema: + type: string + EmptyResponse: + description: An empty HTTP response. + 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 + RecordsResponse: + description: A collection of DNS resource record objects. + headers: + ETag: + description: | + The current version of the resource, ending with a + representation-specific suffix. This value may be used in If-Match + and If-None-Match headers for later requests of the same resource. + schema: + 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). + 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 + opc-total-items: + description: The total number of items that match the query. + schema: + type: integer + content: + application/json: + schema: + $ref: '#/components/schemas/RecordCollection' + parameters: + OpcRequestIdHeader: + description: | + Unique Oracle-assigned identifier for the request. If you need + to contact Oracle about a particular request, please provide + the request ID. + in: header + name: opc-request-id + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 98 + OpcRetryTokenHeader: + description: | + A token that uniquely identifies a request so it can be retried in case + of a timeout or server error without risk of executing that same action + again. Retry tokens expire after 24 hours, but can be invalidated before + then due to conflicting operations (for example, if a resource has been + deleted and purged from the system, then a retry of the original creation + request may be rejected). + in: header + name: opc-retry-token + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 64 + CompartmentIdQueryParam: + description: The OCID of the compartment the resource belongs to. + in: query + name: compartmentId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ScopeQueryParam: + description: | + Specifies to operate only on resources that have a matching DNS scope. + in: query + name: scope + x-default-description: 'null' + x-obmcs-top-level-enum: '#/definitions/Scope' + schema: + type: string + enum: + - GLOBAL + - PRIVATE + ViewIdQueryParam: + description: The OCID of the view the resource is associated with. + in: query + name: viewId + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + DisplayNameQueryParam: + description: The displayName of a resource. + in: query + name: displayName + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + IdQueryParam: + description: The OCID of a resource. + in: query + name: id + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + PaginationTokenQueryParam: + description: | + The value of the `opc-next-page` response header from the previous "List" call. + in: query + name: page + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 512 + PaginationLimitQueryParam: + description: | + The maximum number of items to return in a page of the collection. + in: query + name: limit + schema: + type: integer + format: int64 + minimum: 1 + maximum: 100 + default: 50 + SortOrderQueryParam: + description: | + The order to sort the resources. + in: query + name: sortOrder + x-obmcs-top-level-enum: '#/definitions/SortOrder' + schema: + type: string + enum: + - ASC + - DESC + default: DESC + ResolversSortByQueryParam: + description: The field by which to sort resolvers. + in: query + name: sortBy + schema: + type: string + enum: + - displayName + - timeCreated + default: timeCreated + ResolverLifecycleStateQueryParam: + description: The state of a resource. + in: query + name: lifecycleState + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/ResolverSummary/lifecycleState' + schema: + type: string + IfModifiedSinceHeader: + description: | + The `If-Modified-Since` header field makes a GET or HEAD request method + conditional on the selected representation's modification date being more + recent than the date provided in the field-value. Transfer of the + selected representation's data is avoided if that data has not changed. + in: header + name: If-Modified-Since + x-default-description: 'null' + schema: + type: string + IfNoneMatchHeader: + description: | + The `If-None-Match` header field makes the request method conditional on + the absence of any current representation of the target resource, when + the field-value is `*`, or having a selected representation with an + entity-tag that does not match any of those listed in the field-value. + in: header + name: If-None-Match + x-default-description: 'null' + schema: + type: string + ResolverIdPathParam: + description: The OCID of the target resolver. + in: path + name: resolverId + required: true + schema: + type: string + IfMatchHeader: + description: | + The `If-Match` header field makes the request method conditional on the + existence of at least one current representation of the target resource, + when the field-value is `*`, or having a current representation of the + target resource that has an entity-tag matching a member of the list of + entity-tags provided in the field-value. + in: header + name: If-Match + x-default-description: 'null' + schema: + type: string + IfUnmodifiedSinceHeader: + description: | + The `If-Unmodified-Since` header field makes the request method + conditional on the selected representation's last modification date being + earlier than or equal to the date provided in the field-value. This + field accomplishes the same purpose as If-Match for cases where the user + agent does not have an entity-tag for the representation. + in: header + name: If-Unmodified-Since + x-default-description: 'null' + schema: + type: string + NameQueryParam: + description: The name of a resource. + in: query + name: name + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + ResolverEndpointsSortByQueryParam: + description: The field by which to sort resolver endpoints. + in: query + name: sortBy + schema: + type: string + enum: + - name + - timeCreated + default: timeCreated + ResolverEndpointLifecycleStateQueryParam: + description: The state of a resource. + in: query + name: lifecycleState + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/ResolverEndpointSummary/lifecycleState' + schema: + type: string + ResolverEndpointNamePathParam: + description: The name of the target resolver endpoint. + in: path + name: resolverEndpointName + required: true + schema: + type: string + DisplayNameContainsQueryParam: + description: | + The partial displayName of a resource. Will match any resource whose name + (case-insensitive) contains the provided value. + in: query + name: displayNameContains + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + HealthCheckMonitorIdQueryParam: + description: | + Search by health check monitor OCID. + Will match any resource whose health check monitor ID matches the provided value. + in: query + name: healthCheckMonitorId + x-default-description: 'null' + schema: + type: string + TimeCreatedGreaterThanOrEqualToQueryParam: + description: | + An [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp that states + all returned resources were created on or after the indicated time. + in: query + name: timeCreatedGreaterThanOrEqualTo + x-default-description: 'null' + schema: + type: string + format: date-time + TimeCreatedLessThanQueryParam: + description: | + An [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp that states + all returned resources were created before the indicated time. + in: query + name: timeCreatedLessThan + x-default-description: 'null' + schema: + type: string + format: date-time + TemplateQueryParam: + description: | + Search by steering template type. + Will match any resource whose template type matches the provided value. + in: query + name: template + x-default-description: 'null' + schema: + type: string + SteeringPoliciesLifecycleStateQueryParam: + description: The state of a resource. + in: query + name: lifecycleState + x-obmcs-enumref: '#/definitions/SteeringPolicySummary/lifecycleState' + schema: + type: string + default: ACTIVE + SteeringPoliciesSortByQueryParam: + description: The field by which to sort steering policies. If unspecified, defaults to `timeCreated`. + in: query + name: sortBy + schema: + type: string + enum: + - displayName + - timeCreated + - template + default: timeCreated + PolicyIdPathParam: + description: The OCID of the target steering policy. + in: path + name: steeringPolicyId + required: true + schema: + type: string + SteeringPolicyIdQueryParam: + description: | + Search by steering policy OCID. + Will match any resource whose steering policy ID matches the provided value. + in: query + name: steeringPolicyId + x-default-description: 'null' + schema: + type: string + ZoneIdQueryParam: + description: | + Search by zone OCID. + Will match any resource whose zone ID matches the provided value. + in: query + name: zoneId + x-default-description: 'null' + schema: + type: string + DomainNameQueryParam: + description: | + Search by domain. + Will match any record whose domain (case-insensitive) equals the provided value. + in: query + name: domain + x-default-description: 'null' + schema: + type: string + DomainNameContainsQueryParam: + description: | + Search by domain. + Will match any record whose domain (case-insensitive) contains the provided value. + in: query + name: domainContains + x-default-description: 'null' + schema: + type: string + AttachmentLifecycleStateQueryParam: + description: The state of a resource. + in: query + name: lifecycleState + x-obmcs-enumref: '#/definitions/SteeringPolicyAttachmentSummary/lifecycleState' + schema: + type: string + default: ACTIVE + SteeringPolicyAttachmentsSortByQueryParam: + description: The field by which to sort steering policy attachments. If unspecified, defaults to `timeCreated`. + in: query + name: sortBy + schema: + type: string + enum: + - displayName + - timeCreated + - domainName + default: timeCreated + SteeringPolicyAttachmentIdPathParam: + description: The OCID of the target steering policy attachment. + in: path + name: steeringPolicyAttachmentId + required: true + schema: + type: string + TsigKeysLifecycleStateQueryParam: + description: The state of a resource. + in: query + name: lifecycleState + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/TsigKeySummary/lifecycleState' + schema: + type: string + TsigKeysSortByQueryParam: + description: The field by which to sort TSIG keys. If unspecified, defaults to `timeCreated`. + in: query + name: sortBy + schema: + type: string + enum: + - name + - timeCreated + default: timeCreated + TsigKeyIdPathParam: + description: The OCID of the target TSIG key. + in: path + name: tsigKeyId + required: true + schema: + type: string + ViewsSortByQueryParam: + description: The field by which to sort views. + in: query + name: sortBy + schema: + type: string + enum: + - displayName + - timeCreated + default: timeCreated + ViewLifecycleStateQueryParam: + description: The state of a resource. + in: query + name: lifecycleState + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/ViewSummary/lifecycleState' + schema: + type: string + ViewIdPathParam: + description: The OCID of the target view. + in: path + name: viewId + required: true + schema: + type: string + ZoneNameQueryParam: + description: | + A case-sensitive filter for zone names. + Will match any zone with a name that equals the provided value. + in: query + name: name + x-default-description: 'null' + schema: + type: string + ZoneNameContainsQueryParam: + description: | + Search by zone name. + Will match any zone whose name (case-insensitive) contains the provided value. + in: query + name: nameContains + x-default-description: 'null' + schema: + type: string + ZoneTypeQueryParam: + description: | + Search by zone type, `PRIMARY` or `SECONDARY`. + Will match any zone whose type equals the provided value. + in: query + name: zoneType + x-default-description: 'null' + schema: + type: string + enum: + - PRIMARY + - SECONDARY + LifecycleStateQueryParam: + description: The state of a resource. + in: query + name: lifecycleState + schema: + type: string + enum: + - ACTIVE + - CREATING + - DELETED + - DELETING + - FAILED + - UPDATING + default: ACTIVE + ZonesSortByQueryParam: + description: The field by which to sort zones. + in: query + name: sortBy + schema: + type: string + enum: + - name + - zoneType + - timeCreated + default: timeCreated + TsigKeyIdQueryParam: + description: | + Search for zones that are associated with a TSIG key. + in: query + name: tsigKeyId + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + DnssecStateQueryParam: + description: | + Search for zones that have the given `DnssecState`. + in: query + name: dnssecState + x-default-description: 'null' + x-obmcs-top-level-enum: '#/definitions/ZoneDnssecState' + schema: + type: string + enum: + - ENABLED + - DISABLED + CompartmentIdDeprecatedQueryParam: + description: | + The OCID of the compartment the zone belongs to. + + This parameter is deprecated and should be omitted. + in: query + name: compartmentId + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + ZoneIdPathParam: + description: The OCID of the target zone. + in: path + name: zoneId + required: true + schema: + type: string + ZoneNameOrIdPathParam: + description: The name or OCID of the target zone. + in: path + name: zoneNameOrId + required: true + schema: + type: string + ZoneViewIdQueryParam: + description: The OCID of the view the zone is associated with. Required when accessing a private zone by name. + in: query + name: viewId + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + ZoneVersionQueryParam: + description: | + The version of the zone for which data is requested. + in: query + name: zoneVersion + x-default-description: 'null' + schema: + type: string + RTypeQueryParam: + description: | + Search by record type. + Will match any record whose [type](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4) (case-insensitive) equals the provided value. + in: query + name: rtype + x-default-description: 'null' + schema: + type: string + ZoneRecordsSortByQueryParam: + description: The field by which to sort records. + in: query + name: sortBy + schema: + type: string + enum: + - domain + - rtype + - ttl + default: domain + RecordSortOrderQueryParam: + description: | + The order to sort the resources. + in: query + name: sortOrder + x-obmcs-top-level-enum: '#/definitions/SortOrder' + schema: + type: string + enum: + - ASC + - DESC + default: ASC + DomainNamePathParam: + description: The target fully-qualified domain name (FQDN) within the target zone. + in: path + name: domain + required: true + schema: + type: string + DomainRecordsSortByQueryParam: + description: The field by which to sort records. + in: query + name: sortBy + schema: + type: string + enum: + - rtype + - ttl + default: rtype + RTypePathParam: + description: The type of the target RRSet within the target zone. + in: path + name: rtype + required: true + schema: + type: string + x-stackQL-resources: + zone_from_zone_files: + id: oci.dns.zone_from_zone_files + name: zone_from_zone_files + title: Zone From Zone Files + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1actions~1createZoneFromZoneFile/post' + response: + mediaType: application/json + openAPIDocKey: '201' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/zone_from_zone_files/methods/create' + update: [] + delete: [] + replace: [] + resolvers: + id: oci.dns.resolvers + name: resolvers + title: Resolvers + methods: + list: + operation: + $ref: '#/paths/~1resolvers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.resolvers + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListResolversResponse' + transform: + body: |- + {{- $wrapped := printf "{\"resolvers\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1resolvers~1{resolverId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1resolvers~1{resolverId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1resolvers~1{resolverId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/resolvers/methods/get' + - $ref: '#/components/x-stackQL-resources/resolvers/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/resolvers/methods/update' + delete: [] + replace: [] + resolver_endpoints: + id: oci.dns.resolver_endpoints + name: resolver_endpoints + title: Resolver Endpoints + methods: + list: + operation: + $ref: '#/paths/~1resolvers~1{resolverId}~1endpoints/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.resolver_endpoints + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListResolverEndpointsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"resolver_endpoints\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1resolvers~1{resolverId}~1endpoints/post' + response: + mediaType: application/json + openAPIDocKey: '201' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1resolvers~1{resolverId}~1endpoints~1{resolverEndpointName}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1resolvers~1{resolverId}~1endpoints~1{resolverEndpointName}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1resolvers~1{resolverId}~1endpoints~1{resolverEndpointName}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/resolver_endpoints/methods/get' + - $ref: '#/components/x-stackQL-resources/resolver_endpoints/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/resolver_endpoints/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/resolver_endpoints/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/resolver_endpoints/methods/delete' + replace: [] + steering_policies: + id: oci.dns.steering_policies + name: steering_policies + title: Steering Policies + methods: + list: + operation: + $ref: '#/paths/~1steeringPolicies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.steering_policies + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListSteeringPoliciesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"steering_policies\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1steeringPolicies/post' + response: + mediaType: application/json + openAPIDocKey: '201' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1steeringPolicies~1{steeringPolicyId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1steeringPolicies~1{steeringPolicyId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1steeringPolicies~1{steeringPolicyId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1steeringPolicies~1{steeringPolicyId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/steering_policies/methods/get' + - $ref: '#/components/x-stackQL-resources/steering_policies/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/steering_policies/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/steering_policies/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/steering_policies/methods/delete' + replace: [] + steering_policy_attachments: + id: oci.dns.steering_policy_attachments + name: steering_policy_attachments + title: Steering Policy Attachments + methods: + list: + operation: + $ref: '#/paths/~1steeringPolicyAttachments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.steering_policy_attachments + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListSteeringPolicyAttachmentsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"steering_policy_attachments\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1steeringPolicyAttachments/post' + response: + mediaType: application/json + openAPIDocKey: '201' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1steeringPolicyAttachments~1{steeringPolicyAttachmentId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1steeringPolicyAttachments~1{steeringPolicyAttachmentId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1steeringPolicyAttachments~1{steeringPolicyAttachmentId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/steering_policy_attachments/methods/get' + - $ref: '#/components/x-stackQL-resources/steering_policy_attachments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/steering_policy_attachments/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/steering_policy_attachments/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/steering_policy_attachments/methods/delete' + replace: [] + tsig_keys: + id: oci.dns.tsig_keys + name: tsig_keys + title: Tsig Keys + methods: + list: + operation: + $ref: '#/paths/~1tsigKeys/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tsig_keys + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListTsigKeysResponse' + transform: + body: |- + {{- $wrapped := printf "{\"tsig_keys\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1tsigKeys/post' + response: + mediaType: application/json + openAPIDocKey: '201' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1tsigKeys~1{tsigKeyId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1tsigKeys~1{tsigKeyId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1tsigKeys~1{tsigKeyId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1tsigKeys~1{tsigKeyId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tsig_keys/methods/get' + - $ref: '#/components/x-stackQL-resources/tsig_keys/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/tsig_keys/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/tsig_keys/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/tsig_keys/methods/delete' + replace: [] + views: + id: oci.dns.views + name: views + title: Views + methods: + list: + operation: + $ref: '#/paths/~1views/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.views + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListViewsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"views\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1views/post' + response: + mediaType: application/json + openAPIDocKey: '201' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1views~1{viewId}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1views~1{viewId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1views~1{viewId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1views~1{viewId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/views/methods/get' + - $ref: '#/components/x-stackQL-resources/views/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/views/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/views/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/views/methods/delete' + replace: [] + zone_transfer_servers: + id: oci.dns.zone_transfer_servers + name: zone_transfer_servers + title: Zone Transfer Servers + methods: + list: + operation: + $ref: '#/paths/~1zoneTransferServers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.zone_transfer_servers + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListZoneTransferServersResponse' + transform: + body: |- + {{- $wrapped := printf "{\"zone_transfer_servers\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/zone_transfer_servers/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + zones: + id: oci.dns.zones + name: zones + title: Zones + methods: + list: + operation: + $ref: '#/paths/~1zones/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.zones + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListZonesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"zones\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones/post' + response: + mediaType: application/json + openAPIDocKey: '201' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zoneId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + promote_zone_dnssec_key_version: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zoneId}~1actions~1promoteDnssecKeyVersion/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + stage_zone_dnssec_key_version: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zoneId}~1actions~1stageDnssecKeyVersion/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1zones~1{zoneNameOrId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1zones~1{zoneNameOrId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zoneNameOrId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/zones/methods/get' + - $ref: '#/components/x-stackQL-resources/zones/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/zones/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/zones/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/zones/methods/delete' + replace: [] + zone_contents: + id: oci.dns.zone_contents + name: zone_contents + title: Zone Contents + methods: + get: + operation: + $ref: '#/paths/~1zones~1{zoneNameOrId}~1content/get' + response: + mediaType: text/dns + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/zone_contents/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + zone_records: + id: oci.dns.zone_records + name: zone_records + title: Zone Records + methods: + get: + operation: + $ref: '#/paths/~1zones~1{zoneNameOrId}~1records/get' + response: + mediaType: application/json + openAPIDocKey: '200' + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zoneNameOrId}~1records/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/zone_records/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/zone_records/methods/update' + delete: [] + replace: [] + records: + id: oci.dns.records + name: records + title: Records + methods: + patch_zone_records: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zoneNameOrId}~1records/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + patch_domain_records: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zoneNameOrId}~1records~1{domain}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + patch_rr_set: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zoneNameOrId}~1records~1{domain}~1{rtype}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + domain_records: + id: oci.dns.domain_records + name: domain_records + title: Domain Records + methods: + delete: + operation: + $ref: '#/paths/~1zones~1{zoneNameOrId}~1records~1{domain}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1zones~1{zoneNameOrId}~1records~1{domain}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zoneNameOrId}~1records~1{domain}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/domain_records/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/domain_records/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/domain_records/methods/delete' + replace: [] + rr_sets: + id: oci.dns.rr_sets + name: rr_sets + title: Rr Sets + methods: + delete: + operation: + $ref: '#/paths/~1zones~1{zoneNameOrId}~1records~1{domain}~1{rtype}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1zones~1{zoneNameOrId}~1records~1{domain}~1{rtype}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1zones~1{zoneNameOrId}~1records~1{domain}~1{rtype}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rr_sets/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/rr_sets/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/rr_sets/methods/delete' + replace: [] +servers: + - url: https://dns.{region}.oci.oraclecloud.com/20180115 + variables: + region: + default: us-ashburn-1 + description: OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. + x-stackQL-envVar: OCI_REGION +x-stackQL-config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: opc-next-page + location: header diff --git a/providers/src/oci/v00.00.00000/services/events.yaml b/providers/src/oci/v00.00.00000/services/events.yaml new file mode 100644 index 00000000..7d06b4e9 --- /dev/null +++ b/providers/src/oci/v00.00.00000/services/events.yaml @@ -0,0 +1,1411 @@ +openapi: 3.0.0 +info: + title: events API + description: oci events API + version: '20181201' +paths: + /rules: + get: + description: | + Lists rules for this compartment. + operationId: ListRules + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/ListRulesFilterByLifecycleStateQueryParam' + - description: | + A filter to return only rules with descriptions that match the displayName string + in this parameter. + + Example: `"This rule sends a notification upon completion of DbaaS backup."` + in: query + name: displayName + required: false + schema: + type: string + minLength: 1 + maxLength: 1024 + - description: | + Specifies the attribute with which to sort the rules. + + Default: `timeCreated` + + * **TIME_CREATED:** Sorts by timeCreated. + * **DISPLAY_NAME:** Sorts by displayName. + * **ID:** Sorts by id. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIME_CREATED + - ID + - DISPLAY_NAME + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: Succesfully retrieved summary of rules. + 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/ListRulesResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Lists rules for this compartment. + tags: + - events + x-example: | + GET /20181201/rules?compartmentId=<compartment_OCID> + Host: events.us-phoenix-1.oraclecloud.com + <authorization and other headers> + post: + description: | + Creates a new rule. + operationId: CreateRule + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateRuleDetails' + description: Specification of the rule to create + required: true + responses: + '200': + description: Succesfully created rule. + headers: + etag: + description: | + For optimistic concurrency control. Add this value to the `if-match` parameter + in a PUT or DELETE operation. The resource will be updated only if the value you + provide matches the `etag` on the resource. + 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/Rule' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Creates a new rule + tags: + - events + x-example: | + POST /20181201/rules + Host: events.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + { + "displayName": "This rule sends a notification upon completion of DbaaS backup", + "condition": "{ + \"eventType\": \"com.oraclecloud.databaseservice.autonomous.database.backup.end\" + }", + "compartmentId": "ocid.compartment.oc1..<unique_ID>", + "isEnabled": true, + "freeformTags": { + "Department": "Finance" + }, + "definedTags": { + Operations": { + "CostCenter": "42" + }, + "actions": { + "actions": [ + { + "actionType": "ONS", + "id": "ocid.action.oc1..<unique_ID>", + "lifecycleMessage":null, + "lifecycleState": "CREATING" + } + ] + } + } + /rules/{ruleId}: + delete: + description: Deletes a rule. + operationId: DeleteRule + parameters: + - $ref: '#/components/parameters/RuleIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '204': + description: Rule deleted successfully. + 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Deletes a rule + tags: + - events + x-example: | + DELETE /20181201/rules/<rule_OCID> + Host: events.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Rule' + get: + description: Retrieves a rule. + operationId: GetRule + parameters: + - $ref: '#/components/parameters/RuleIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: Succesfully retrieved rule. + headers: + etag: + description: | + For optimistic concurrency control. Add this value to the `if-match` parameter + in a PUT or DELETE operation. The resource will be updated only if the value you + provide matches the `etag` on the resource. + 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/Rule' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Retrieves a rule + tags: + - events + x-example: | + GET /20181201/rules/<rule_OCID> + Host: events.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates a rule. + operationId: UpdateRule + parameters: + - $ref: '#/components/parameters/RuleIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateRuleDetails' + description: The new rule spec to apply + required: true + responses: + '200': + description: | + Succesfully updated rule. + headers: + etag: + description: | + For optimistic concurrency control. Add this value to the `if-match` parameter + in a PUT or DELETE operation. The resource will be updated only if the value you + provide matches the `etag` on the resource. + 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/Rule' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Updates a rule + tags: + - events + x-example: | + PUT /20181201/rules/<rule_OCID> + Host: events.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + { + "displayName": "This rule sends a notification upon completion of DbaaS backup", + "condition": "{ + \"eventType\": \"com.oraclecloud.databaseservice.autonomous.database.backup.end\" + }", + "isEnabled": true, + "freeformTags": { + "Department": "Finance" + }, + "definedTags": { + Operations": { + "CostCenter": "42" + }, + "actions": { + "actions": [ + { + "actionType": "ONS", + "id": "ocid.action.oc1..<unique_ID>", + "lifecycleMessage":null, + "lifecycleState": "CREATING" + } + ] + } + } + /rules/{ruleId}/actions/changeCompartment: + post: + description: | + Moves a rule into a different compartment within the same tenancy. For information about moving + resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeRuleCompartment + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RuleIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeRuleCompartmentDetails' + required: true + responses: + '204': + description: Response returned for a successful change compartment request. + 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + summary: Moves a rule into a different compartment. When provided, If-Match is checked against ETag values of the resource. + tags: + - events + x-related-resource: '#/definitions/Rule' +components: + schemas: + RuleSummary: + description: | + The summary details of rules for Events. For more information, see + [Managing Rules for Events](/iaas/Content/Events/Task/managingrules.htm). + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs. + maxLength: 1024 + minLength: 1 + type: string + condition: + description: | + A filter that specifies the event that will trigger actions associated with this rule. A few + important things to remember about filters: + + * Fields not mentioned in the condition are ignored. You can create a valid filter that matches + all events with two curly brackets: `{}` + + For more examples, see + [Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm). + * For a condition with fields to match an event, the event must contain all the field names + listed in the condition. Field names must appear in the condition with the same nesting + structure used in the event. + + For a list of reference events, see + [Services that Produce Events](/iaas/Content/Events/Reference/eventsproducers.htm). + * Rules apply to events in the compartment in which you create them and any child compartments. + This means that a condition specified by a rule only matches events emitted from resources in + the compartment or any of its child compartments. + * Wildcard matching is supported with the asterisk (*) character. + + For examples of wildcard matching, see + [Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm) + + Example: `\"eventType\": \"com.oraclecloud.databaseservice.autonomous.database.backup.end\"` + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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 + description: + description: | + A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering + confidential information. + maxLength: 1024 + minLength: 0 + type: string + displayName: + description: | + A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering + confidential information. + + Example: `"This rule sends a notification upon completion of DbaaS backup."` + 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. Exists for cross-compatibility only. + For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this rule. + maxLength: 1024 + minLength: 1 + type: string + isEnabled: + default: true + description: | + Whether or not this rule is currently enabled. + + Example: `true` + type: boolean + lifecycleState: + type: string + x-obmcs-enumref: '#/definitions/Rule/lifecycleState' + timeCreated: + description: | + The time this rule was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) + timestamp format. + + Example: `2018-09-12T22:47:12.613Z` + format: date-time + type: string + required: + - id + - displayName + - lifecycleState + - condition + - compartmentId + - isEnabled + - timeCreated + type: object + x-example: | + { + "displayName": "This rule sends a notification upon completion of DbaaS backup", + "lifecycleState": "CREATING", + "condition": "{ + \"eventType\": \"com.oraclecloud.databaseservice.autonomous.database.backup.end\" + }", + "compartmentId": "ocid.compartment.oc1..<unique_ID>", + "isEnabled": true, + "id": "ocid.rule.oc1..<unique_ID>", + "timeCreated": "2018-09-12T22:47:12.613Z", + "freeformTags": { + "Department": "Finance" + }, + "definedTags": { + "Operations": { + "CostCenter": "42" + }, + } + CreateRuleDetails: + description: Object used to create an events1.0 rule and events2.0 system rule. + properties: + actions: + $ref: '#/components/schemas/ActionDetailsList' + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs. + maxLength: 1024 + minLength: 1 + type: string + condition: + description: | + A filter that specifies the event that will trigger actions associated with this rule. A few + important things to remember about filters: + + * Fields not mentioned in the condition are ignored. You can create a valid filter that matches + all events with two curly brackets: `{}` + + For more examples, see + [Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm). + * For a condition with fields to match an event, the event must contain all the field names + listed in the condition. Field names must appear in the condition with the same nesting + structure used in the event. + + For a list of reference events, see + [Services that Produce Events](/iaas/Content/Events/Reference/eventsproducers.htm). + * Rules apply to events in the compartment in which you create them and any child compartments. + This means that a condition specified by a rule only matches events emitted from resources in + the compartment or any of its child compartments. + * Wildcard matching is supported with the asterisk (*) character. + + For examples of wildcard matching, see + [Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm) + + Example: `\"eventType\": \"com.oraclecloud.databaseservice.autonomous.database.backup.end\"` + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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 + description: + description: | + A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering + confidential information. + maxLength: 1024 + minLength: 0 + type: string + displayName: + description: | + A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering + confidential information. + 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. Exists for cross-compatibility only. + For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + isEnabled: + default: true + description: | + Whether or not this rule is currently enabled. + + Example: `true` + type: boolean + required: + - displayName + - isEnabled + - condition + - actions + - compartmentId + type: object + x-example: | + { + "displayName": "This rule sends a notification upon completion of DbaaS backup", + "condition": "{ + \"eventType\": \"com.oraclecloud.databaseservice.autonomous.database.backup.end\" + }", + "compartmentId": "ocid.compartment.oc1..<unique_ID>", + "isEnabled": true, + "freeformTags": { + "Department": "Finance" + }, + "definedTags": { + "Operations": { + "CostCenter": "42" + }, + "actions": { + "actions": [ + { + "actionType": "ONS", + "id": "ocid.action.oc1..<unique_ID>", + "lifecycleMessage":null, + "lifecycleState": "CREATING" + } + ] + } + } + Rule: + description: | + The configuration details of an Events rule. For more information, see + [Managing Rules for Events](/iaas/Content/Events/Task/managingrules.htm). + properties: + actions: + $ref: '#/components/schemas/ActionList' + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs. + maxLength: 1024 + minLength: 1 + type: string + condition: + description: | + A filter that specifies the event that will trigger actions associated with this rule. A few + important things to remember about filters: + + * Fields not mentioned in the condition are ignored. You can create a valid filter that matches + all events with two curly brackets: `{}` + + For more examples, see + [Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm). + * For a condition with fields to match an event, the event must contain all the field names + listed in the condition. Field names must appear in the condition with the same nesting + structure used in the event. + + For a list of reference events, see + [Services that Produce Events](/iaas/Content/Events/Reference/eventsproducers.htm). + * Rules apply to events in the compartment in which you create them and any child compartments. + This means that a condition specified by a rule only matches events emitted from resources in + the compartment or any of its child compartments. + * Wildcard matching is supported with the asterisk (*) character. + + For examples of wildcard matching, see + [Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm) + + Example: `\"eventType\": \"com.oraclecloud.databaseservice.autonomous.database.backup.end\"` + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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 + description: + description: | + A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering + confidential information. + maxLength: 1024 + minLength: 0 + type: string + displayName: + description: | + A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering + confidential information. + + Example: `"This rule sends a notification upon completion of DbaaS backup."` + 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. Exists for cross-compatibility only. + For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this rule. + maxLength: 1024 + minLength: 1 + type: string + isEnabled: + default: true + description: | + Whether or not this rule is currently enabled. + + Example: `true` + type: boolean + lifecycleMessage: + description: | + A message generated by the Events service about the current state of this rule. + type: string + lifecycleState: + description: | + The current state of the rule. + enum: + - CREATING + - ACTIVE + - INACTIVE + - UPDATING + - DELETING + - DELETED + - FAILED + type: string + timeCreated: + description: | + The time this rule was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) + timestamp format. + + Example: `2018-09-12T22:47:12.613Z` + format: date-time + type: string + required: + - displayName + - lifecycleState + - condition + - actions + - id + - timeCreated + - compartmentId + - isEnabled + type: object + x-example: | + { + "displayName": "This rule sends a notification upon completion of DbaaS backup", + "lifecycleState": "CREATING", + "condition": "{ + \"eventType\": \"com.oraclecloud.databaseservice.autonomous.database.backup.end\" + }", + "compartmentId": "ocid.compartment.oc1..<unique_ID>", + "isEnabled": true, + "freeformTags": { + "Department": "Finance" + }, + "definedTags": { + Operations": { + "CostCenter": "42" + }, + "actions": { + "actions": [ + { + "actionType": "ONS", + "id": "ocid.action.oc1..<unique_ID>", + "lifecycleMessage":null, + "lifecycleState": "CREATING" + } + ] + }, + "id": "ocid.rule.oc1..<unique_ID>", + "timeCreated": "2018-09-12T22:47:12.613Z", + "lifecycleMessage":null + } + UpdateRuleDetails: + description: The rule attributes that you can update. + properties: + actions: + $ref: '#/components/schemas/ActionDetailsList' + condition: + description: | + A filter that specifies the event that will trigger actions associated with this rule. A few + important things to remember about filters: + + * Fields not mentioned in the condition are ignored. You can create a valid filter that matches + all events with two curly brackets: `{}` + + For more examples, see + [Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm). + * For a condition with fields to match an event, the event must contain all the field names + listed in the condition. Field names must appear in the condition with the same nesting + structure used in the event. + + For a list of reference events, see + [Services that Produce Events](/iaas/Content/Events/Reference/eventsproducers.htm). + * Rules apply to events in the compartment in which you create them and any child compartments. + This means that a condition specified by a rule only matches events emitted from resources in + the compartment or any of its child compartments. + * Wildcard matching is supported with the asterisk (*) character. + + For examples of wildcard matching, see + [Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm) + + Example: `\"eventType\": \"com.oraclecloud.databaseservice.autonomous.database.backup.end\"` + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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 + description: + description: | + A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering + confidential information. + maxLength: 1024 + minLength: 0 + type: string + displayName: + description: | + A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering + confidential information. + 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. Exists for cross-compatibility only. + For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + isEnabled: + description: | + Whether or not this rule is currently enabled. + + Example: `true` + type: boolean + type: object + x-example: | + { + "displayName": "This rule sends a notification upon completion of DbaaS backup", + "condition": "{ + \"eventType\": \"com.oraclecloud.databaseservice.autonomous.database.backup.end\" + }", + "isEnabled": true, + "freeformTags": { + "Department": "Finance" + }, + "definedTags": { + "Operations": { + "CostCenter": "42" + }, + "actions": { + "actions": [ + { + "actionType": "ONS", + "id": "ocid.action.oc1..<unique_ID>", + "lifecycleMessage":null, + "lifecycleState": "CREATING" + } + ] + } + } + ChangeRuleCompartmentDetails: + description: | + Specifies which compartment to move a rule to when changing a rule's compartment. + properties: + compartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment + into which the resource should be moved. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + x-example: | + { + "compartmentId": "ocid.compartment.oc1..<unique_ID>" + } + Error: + description: Error details. + properties: + code: + description: | + A short error code that defines the error, meant for programmatic parsing. See + [API Errors](/iaas/Content/API/References/apierrors.htm). + type: string + message: + description: | + A human-readable error string. + type: string + required: + - code + - message + type: object + x-example: | + { + "code" : "400", + "message" : "Bad Request" + } + ActionDetailsList: + description: A list of ActionDetails objects to create for a rule. + properties: + actions: + description: | + A list of one or more ActionDetails objects. + items: + $ref: '#/components/schemas/ActionDetails' + maxItems: 10 + minItems: 1 + type: array + required: + - actions + type: object + x-example: | + { + "actions": [ ] + } + ActionList: + description: | + A list of Action objects associated with a rule. + properties: + actions: + description: | + A list of one or more Action objects. + items: + $ref: '#/components/schemas/Action' + maxItems: 10 + minItems: 1 + type: array + required: + - actions + type: object + x-example: | + { + "actions": { } + } + ActionDetails: + description: | + Object used to create an action. + discriminator: + propertyName: actionType + properties: + actionType: + description: | + The action to perform if the condition in the rule matches an event. + + * **ONS:** Send to an Oracle Notification Service topic. + * **OSS:** Send to a stream from Oracle Streaming Service. + * **FAAS:** Send to an Oracle Functions Service endpoint. + enum: + - ONS + - OSS + - FAAS + type: string + description: + description: | + A string that describes the details of the action. It does not have to be unique, and you can change it. Avoid entering + confidential information. + maxLength: 1024 + minLength: 0 + type: string + isEnabled: + default: true + description: | + Whether or not this action is currently enabled. + + Example: `true` + type: boolean + required: + - actionType + - isEnabled + type: object + x-example: | + { + "actionType": "ONS", + "isEnabled": true, + "description": "Notification action" + } + Action: + description: | + An object that represents an action to trigger for events that match a rule. + discriminator: + propertyName: actionType + properties: + actionType: + description: | + The action to perform if the condition in the rule matches an event. + + * **ONS:** Send to an Oracle Notification Service topic. + * **OSS:** Send to a stream from Oracle Streaming Service. + * **FAAS:** Send to an Oracle Functions Service endpoint. + enum: + - ONS + - OSS + - FAAS + type: string + description: + description: | + A string that describes the details of the action. It does not have to be unique, and you can change it. Avoid entering + confidential information. + maxLength: 1024 + minLength: 0 + type: string + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the action. + maxLength: 1024 + minLength: 1 + type: string + isEnabled: + default: true + description: | + Whether or not this action is currently enabled. + + Example: `true` + type: boolean + lifecycleMessage: + description: | + A message generated by the Events service about the current state of this action. + type: string + lifecycleState: + description: | + The current state of the rule. + enum: + - CREATING + - ACTIVE + - INACTIVE + - UPDATING + - DELETING + - DELETED + - FAILED + type: string + required: + - actionType + - id + - lifecycleState + - lifecycleMessage + type: object + x-example: | + { + "actions": [ + { + "actionType": "ONS", + "id": "ocid.action.oc1..<unique_ID>", + "lifecycleMessage":null, + "lifecycleState": "CREATING" + } + ] + } + ListRulesResponse: + type: object + properties: + rules: + type: array + items: + $ref: '#/components/schemas/RuleSummary' + responses: + '400': + description: Bad Request + 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' + '401': + description: Unauthorized (Unauthenticated) + 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' + '403': + description: Forbidden + 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' + '404': + description: Not found or not authorized + 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' + '409': + description: Invalid state. + 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' + '412': + description: NoEtagMatch + 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' + '429': + description: Too Many Requests + 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' + '500': + description: Internal Server 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' + DefaultError: + description: An error has occurred. + 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' + parameters: + CompartmentIdQueryParam: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs. + in: query + name: compartmentId + required: true + schema: + type: string + minLength: 1 + maxLength: 1024 + PaginationLimitQueryParam: + description: | + The maximum number of items to return. 1 is the minimum, 50 is the maximum. + Default: 10 + in: query + name: limit + required: false + schema: + type: integer + minimum: 1 + maximum: 50 + default: 5 + PaginationTokenQueryParam: + description: | + For list pagination. The value of the opc-next-page response header from the previous + "List" call. For important details about how pagination works, see + [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + in: query + name: page + required: false + schema: + type: string + minLength: 1 + maxLength: 1024 + ListRulesFilterByLifecycleStateQueryParam: + description: | + A filter to return only rules that match the lifecycle state in this parameter. + + Example: `Creating` + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/Rule/lifecycleState' + schema: + type: string + SortOrderQueryParam: + description: | + Specifies sort order. + + * **ASC:** Ascending sort order. + * **DESC:** Descending sort order. + in: query + name: sortOrder + required: false + schema: + type: string + enum: + - ASC + - DESC + OpcRequestIdHeaderParam: + description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + RetryTokenHeader: + description: | + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + may be rejected). + in: header + name: opc-retry-token + schema: + type: string + minLength: 1 + maxLength: 64 + RuleIdPathParam: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this rule. + in: path + name: ruleId + required: true + schema: + type: string + 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 + schema: + type: string + x-stackQL-resources: + rules: + id: oci.events.rules + name: rules + title: Rules + methods: + list: + operation: + $ref: '#/paths/~1rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.rules + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListRulesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"rules\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 50 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1rules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1rules~1{ruleId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1rules~1{ruleId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1rules~1{ruleId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1rules~1{ruleId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rules/methods/get' + - $ref: '#/components/x-stackQL-resources/rules/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/rules/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/rules/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/rules/methods/delete' + replace: [] +servers: + - url: https://events.{region}.oci.oraclecloud.com/20181201 + variables: + region: + default: us-ashburn-1 + description: OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. + x-stackQL-envVar: OCI_REGION +x-stackQL-config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: opc-next-page + location: header diff --git a/providers/src/oci/v00.00.00000/services/functions.yaml b/providers/src/oci/v00.00.00000/services/functions.yaml new file mode 100644 index 00000000..7c7dde1f --- /dev/null +++ b/providers/src/oci/v00.00.00000/services/functions.yaml @@ -0,0 +1,3374 @@ +openapi: 3.0.0 +info: + title: functions API + description: oci functions API + version: '20181201' +paths: + /applications: + get: + description: Lists applications for a compartment. + operationId: ListApplications + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/ListApplicationsFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/ListApplicationsFilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/ListApplicationsFilterByIdQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + Specifies the attribute with which to sort the rules. + + Default: `displayName` + + * **timeCreated:** Sorts by timeCreated. + * **displayName:** Sorts by displayName. + * **id:** Sorts by id. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - timeCreated + - id + - displayName + default: displayName + responses: + '200': + description: Succesfully retrieved summary of applications. + 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/ListApplicationsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Lists applications for a compartment + tags: + - functionsManagement + x-example: | + GET /20181201/applications?compartmentId=ocid1.compartment.oc1..<unique_ID> + Host: functions.us-phoenix-1.oci.oraclecloud.com + <authorization and other headers> + post: + description: Creates a new application. + operationId: CreateApplication + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateApplicationDetails' + description: Specification of the application to create + required: true + responses: + '200': + description: Succesfully created application. + headers: + etag: + description: | + For optimistic concurrency control. Add this value to the `if-match` parameter + in a PUT or DELETE operation. The resource will be updated only if the value you + provide matches the `etag` on the resource. + 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/Application' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Creates a new application + tags: + - functionsManagement + x-example: | + POST /20181201/applications + Host: functions.us-phoenix-1.oci.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "ExampleApplication", + "subnetIds": [ + "ocid1.subnet.oc1..<unique_ID>" + ] + } + /applications/{applicationId}: + delete: + description: Deletes an application. + operationId: DeleteApplication + parameters: + - $ref: '#/components/parameters/ApplicationIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '204': + description: Application deleted successfully. + 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Deletes an application + tags: + - functionsManagement + x-example: | + DELETE /20181201/applications/<application_OCID> + Host: functions.us-phoenix-1.oci.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Application' + get: + description: Retrieves an application. + operationId: GetApplication + parameters: + - $ref: '#/components/parameters/ApplicationIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: Succesfully retrieved application. + headers: + etag: + description: | + For optimistic concurrency control. Add this value to the `if-match` parameter + in a PUT or DELETE operation. The resource will be updated only if the value you + provide matches the `etag` on the resource. + 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/Application' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Retrieves an application + tags: + - functionsManagement + x-example: | + GET /20181201/applications/<application_OCID> + Host: functions.us-phoenix-1.oci.oraclecloud.com + <authorization and other headers> + put: + description: Modifies an application + operationId: UpdateApplication + parameters: + - $ref: '#/components/parameters/ApplicationIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateApplicationDetails' + description: The new application spec to apply + required: true + responses: + '200': + description: | + Succesfully updated application. + headers: + etag: + description: | + For optimistic concurrency control. Add this value to the `if-match` parameter + in a PUT or DELETE operation. The resource will be updated only if the value you + provide matches the `etag` on the resource. + 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/Application' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Modifies an application + tags: + - functionsManagement + x-example: | + PUT /20181201/applications/<application_OCID> + Host: functions.us-phoenix-1.oci.oraclecloud.com + <authorization and other headers> + { + "config": { + "EXAMPLE_KEY": "example-value" + } + } + /applications/{applicationId}/actions/changeCompartment: + post: + description: | + Moves an application into a different compartment within the same tenancy. + For information about moving resources between compartments, see [Moving Resources Between Compartments](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeApplicationCompartment + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/ApplicationIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeApplicationCompartmentDetails' + description: Properties to change the compartment of an application. + required: true + responses: + '204': + description: Application moved successfully. + 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 + '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/DefaultError' + summary: Moves an application into a different compartment. When provided, If-Match is checked against ETag values of the resource. + tags: + - functionsManagement + x-example: | + POST /20181201/applications/<application_OCID>/actions/changeCompartment + Host: functions.us-phoenix-1.oci.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>" + } + x-related-resource: '#/definitions/Application' + /functions: + get: + description: Lists functions for an application. + operationId: ListFunctions + parameters: + - $ref: '#/components/parameters/ApplicationIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/ListFunctionsFilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/ListFunctionsFilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/ListFunctionsFilterByIdQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + Specifies the attribute with which to sort the rules. + + Default: `displayName` + + * **timeCreated:** Sorts by timeCreated. + * **displayName:** Sorts by displayName. + * **id:** Sorts by id. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - timeCreated + - id + - displayName + default: displayName + responses: + '200': + description: Succesfully retrieved summary of functions. + 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/ListFunctionsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Lists functions for an application + tags: + - functionsManagement + x-example: | + GET /20181201/functions?applicationId=<application_OCID> + Host: functions.us-phoenix-1.oci.oraclecloud.com + <authorization and other headers> + post: + description: Creates a new function. + operationId: CreateFunction + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateFunctionDetails' + description: Specification of the function to create + required: true + responses: + '200': + description: Succesfully created function. + headers: + etag: + description: | + For optimistic concurrency control. Add this value to the `if-match` parameter + in a PUT or DELETE operation. The resource will be updated only if the value you + provide matches the `etag` on the resource. + 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/Function' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Creates a new function + tags: + - functionsManagement + x-example: | + POST /20181201/functions + Host: functions.us-phoenix-1.oci.oraclecloud.com + <authorization and other headers> + { + "applicationId": "<application_OCID>", + "displayName": "ExampleFunction", + "image": "phx.ocir.io/example-namespace/example-repo/example-image:0.0.1", + "memoryInMBs": 128 + } + /functions/{functionId}: + delete: + description: Deletes a function. + operationId: DeleteFunction + parameters: + - $ref: '#/components/parameters/FunctionIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '204': + description: Function deleted successfully. + 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Deletes a function + tags: + - functionsManagement + x-example: | + DELETE /20181201/functions/<function_OCID> + Host: functions.us-phoenix-1.oci.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Function' + get: + description: Retrieves a function. + operationId: GetFunction + parameters: + - $ref: '#/components/parameters/FunctionIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: Succesfully retrieved function. + headers: + etag: + description: | + For optimistic concurrency control. Add this value to the `if-match` parameter + in a PUT or DELETE operation. The resource will be updated only if the value you + provide matches the `etag` on the resource. + 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/Function' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Retrieves a function + tags: + - functionsManagement + x-example: | + GET /20181201/functions/<function_OCID> + Host: functions.us-phoenix-1.oci.oraclecloud.com + <authorization and other headers> + put: + description: Modifies a function + operationId: UpdateFunction + parameters: + - $ref: '#/components/parameters/FunctionIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFunctionDetails' + description: The new function spec to apply + required: true + responses: + '200': + description: | + Succesfully updated function. + headers: + etag: + description: | + For optimistic concurrency control. Add this value to the `if-match` parameter + in a PUT or DELETE operation. The resource will be updated only if the value you + provide matches the `etag` on the resource. + 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/Function' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Modifies a function + tags: + - functionsManagement + x-example: | + PUT /20181201/functions/<function_OCID> + Host: functions.us-phoenix-1.oci.oraclecloud.com + <authorization and other headers> + { + "config": { + "EXAMPLE_KEY": "example-value" + } + } + /functions/{functionId}/actions/invoke: + post: + description: Invokes a function + operationId: InvokeFunction + parameters: + - $ref: '#/components/parameters/FunctionIdPathParam' + - $ref: '#/components/parameters/FnIntentHeader' + - $ref: '#/components/parameters/FnInvokeTypeHeader' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/FnDryRunHeader' + requestBody: + content: + '*/*': + schema: + format: binary + type: string + description: | + The body of the function invocation. + Note: The maximum size of the request is limited. This limit is currently 6MB and the endpoint will not accept requests that are bigger than this limit. + responses: + '200': + description: | + Succesfully invoked function. + 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: + '*/*': + schema: + format: binary + type: string + '202': + description: | + Succesfully accepted function call. + 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + '502': + $ref: '#/components/responses/502' + '503': + $ref: '#/components/responses/503' + default: + $ref: '#/components/responses/DefaultError' + summary: Invokes a function + tags: + - functionsInvoke + x-example: | + POST /20181201/functions/<function_OCID>/actions/invoke + Host: <unique_ID>.us-phoenix-1.functions.oci.oraclecloud.com + <authorization and other headers> + { + "ExamplePayloadKey": "ExamplePayloadValue" + } + x-related-resource: '#/definitions/Function' + /pbfListingVersions: + get: + description: | + Fetches a wrapped list of all Pre-built Function(PBF) Listing versions. Returns a PbfListingVersionCollection + containing an array of PbfListingVersionSummary response models. + + Note that the PbfListingIdentifier must be provided as a query parameter, otherwise an exception shall + be thrown. + operationId: ListPbfListingVersions + parameters: + - $ref: '#/components/parameters/PbfListingIdentifierQueryParam' + - $ref: '#/components/parameters/PbfListingVersionIdentifierQueryParam' + - $ref: '#/components/parameters/PbfListingVersionNameQueryParam' + - $ref: '#/components/parameters/PbfListingVersionIsCurrentVersionQueryParam' + - $ref: '#/components/parameters/PbfListingVersionLifecycleStateQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/PbfListingVersionSortByQueryParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: A page of PbfListingVersionSummary objects. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/PbfListingVersionsCollection' + '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/DefaultError' + summary: Get a list of all Pre-built Function(PBF) Listing versions. + tags: + - functionsManagement + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/PbfListingVersion' + /pbfListingVersions/{pbfListingVersionId}: + get: + description: Gets a PbfListingVersion by identifier for a PbfListing. + operationId: GetPbfListingVersion + parameters: + - $ref: '#/components/parameters/PbfListingVersionIdentifierPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: Retrieves the PbfListingVersion for the given PbfListing id and version. + 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/PbfListingVersion' + '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/DefaultError' + summary: Get details for a specific version of a Pre-built Function(PBF) Listing. + tags: + - functionsManagement + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/PbfListingVersion' + /pbfListings: + get: + description: | + Fetches a wrapped list of all Pre-built Function(PBF) Listings. Returns a PbfListingCollection containing + an array of PbfListingSummary response models. + operationId: ListPbfListings + parameters: + - $ref: '#/components/parameters/PbfListingIdentifierOptionalQueryParam' + - $ref: '#/components/parameters/PbfListingNameQueryParam' + - $ref: '#/components/parameters/PbfListingNameQueryContainsParam' + - $ref: '#/components/parameters/PbfListingNameQueryStartsWithParam' + - $ref: '#/components/parameters/PbfTriggerNamesQueryParam' + - $ref: '#/components/parameters/PbfListingLifecycleStateQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/PbfListingSortByQueryParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: A page of PbfListingSummary objects. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/PbfListingsCollection' + '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/DefaultError' + summary: Get a list of all Pre-built Function(PBF) Listings. + tags: + - functionsManagement + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/PbfListing' + /pbfListings/triggers: + get: + description: | + Returns a list of Triggers. + operationId: ListTriggers + parameters: + - $ref: '#/components/parameters/TriggerNameQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: A page of TriggerSummary response models. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/TriggersCollection' + '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/DefaultError' + summary: Gets a list of all Triggers. + tags: + - functionsManagement + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/TriggersCollection' + /pbfListings/{pbfListingId}: + get: + description: | + Fetches a Pre-built Function(PBF) Listing. Returns a PbfListing response model. + operationId: GetPbfListing + parameters: + - $ref: '#/components/parameters/PbfListingIdentifierPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: Retrieves the PbfListing with the given id. + 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/PbfListing' + '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/DefaultError' + summary: Get a Pre-built Function(PBF) Listing. + tags: + - functionsManagement + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/PbfListing' +components: + schemas: + ApplicationSummary: + description: | + Summary of an application. + properties: + compartmentId: + description: | + The OCID of the compartment that contains the application. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + The display name of the application. The display name is unique within the compartment containing the application. + 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 + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the application. + maxLength: 255 + minLength: 1 + type: string + imagePolicyConfig: + $ref: '#/components/schemas/ImagePolicyConfig' + lifecycleState: + description: | + The current state of the application. + type: string + x-obmcs-enumref: '#/definitions/Application/lifecycleState' + logging: + $ref: '#/components/schemas/ApplicationLoggingConfig' + networkSecurityGroupIds: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm)s of the Network Security Groups to add the application to. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". + (opaque JSON object) + type: string + description: | + Key-value pair representing a security attribute key and value, scoped to a namespace. + + Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` + type: object + description: | + Security attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` + type: object + shape: + description: | + Valid values are `GENERIC_X86`, `GENERIC_ARM` and `GENERIC_X86_ARM`. Default is `GENERIC_X86`. Setting this to `GENERIC_X86`, will run the functions in the application on X86 processor architecture. + Setting this to `GENERIC_ARM`, will run the functions in the application on ARM processor architecture. + When set to `GENERIC_X86_ARM`, functions in the application are run on either X86 or ARM processor architecture. + Accepted values are: + `GENERIC_X86`, `GENERIC_ARM`, `GENERIC_X86_ARM` + enum: + - GENERIC_X86 + - GENERIC_ARM + - GENERIC_X86_ARM + type: string + subnetIds: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm)s of the subnets in which to run functions in the application. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + timeCreated: + description: | + The time the application was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) + timestamp format. + + Example: `2018-09-12T22:47:12.613Z` + format: date-time + type: string + timeUpdated: + description: | + The time the application was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) + timestamp format. + Example: `2018-09-12T22:47:12.613Z` + format: date-time + type: string + traceConfig: + $ref: '#/components/schemas/ApplicationTraceConfig' + required: + - id + type: object + CreateApplicationDetails: + description: | + Properties for a new application. + properties: + compartmentId: + description: | + The OCID of the compartment to create the application within. + maxLength: 255 + minLength: 1 + type: string + config: + additionalProperties: + type: string + description: | + Application configuration. These values are passed on to the function as environment variables, functions may override application configuration. + Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters. + + Example: `{"MY_FUNCTION_CONFIG": "ConfVal"}` + + The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8. + maxProperties: 100 + type: object + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + The display name of the application. The display name must be unique within the compartment containing the application. Avoid entering confidential information. + 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 + imagePolicyConfig: + $ref: '#/components/schemas/ImagePolicyConfig' + logging: + $ref: '#/components/schemas/ApplicationLoggingConfig' + networkSecurityGroupIds: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm)s of the Network Security Groups to add the application to. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". + (opaque JSON object) + type: string + description: | + Key-value pair representing a security attribute key and value, scoped to a namespace. + + Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` + type: object + description: | + Security attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` + type: object + shape: + description: | + Valid values are `GENERIC_X86`, `GENERIC_ARM` and `GENERIC_X86_ARM`. Default is `GENERIC_X86`. Setting this to `GENERIC_X86`, will run the functions in the application on X86 processor architecture. + Setting this to `GENERIC_ARM`, will run the functions in the application on ARM processor architecture. + When set to `GENERIC_X86_ARM`, functions in the application are run on either X86 or ARM processor architecture. + Accepted values are: + `GENERIC_X86`, `GENERIC_ARM`, `GENERIC_X86_ARM` + enum: + - GENERIC_X86 + - GENERIC_ARM + - GENERIC_X86_ARM + type: string + subnetIds: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm)s of the subnets in which to run functions in the application. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + syslogUrl: + description: | + A syslog URL to which to send all function logs. Supports tcp, udp, and tcp+tls. + The syslog URL must be reachable from all of the subnets configured for the application. + Note: If you enable the OCI Logging service for this application, the syslogUrl value is ignored. Function logs are sent to the OCI Logging service, and not to the syslog URL. + + Example: `tcp://logserver.myserver:1234` + maxLength: 1024 + type: string + traceConfig: + $ref: '#/components/schemas/ApplicationTraceConfig' + required: + - displayName + - subnetIds + - compartmentId + type: object + Application: + description: | + An application contains functions and defined attributes shared between those functions, such as network configuration and configuration. Avoid entering confidential information. + properties: + compartmentId: + description: | + The OCID of the compartment that contains the application. + maxLength: 255 + minLength: 1 + type: string + config: + additionalProperties: + type: string + description: | + Application configuration for functions in this application (passed as environment variables). Can be overridden by function configuration. + Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters. + + Example: `{"MY_FUNCTION_CONFIG": "ConfVal"}` + + The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8. + maxProperties: 100 + type: object + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + The display name of the application. The display name is unique within the compartment containing the application. + 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 + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the application. + maxLength: 255 + minLength: 1 + type: string + imagePolicyConfig: + $ref: '#/components/schemas/ImagePolicyConfig' + lifecycleState: + description: | + The current state of the application. + enum: + - CREATING + - ACTIVE + - INACTIVE + - UPDATING + - DELETING + - DELETED + - FAILED + type: string + logging: + $ref: '#/components/schemas/ApplicationLoggingConfig' + networkSecurityGroupIds: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm)s of the Network Security Groups to add the application to. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". + (opaque JSON object) + type: string + description: | + Key-value pair representing a security attribute key and value, scoped to a namespace. + + Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` + type: object + description: | + Security attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` + type: object + shape: + description: | + Valid values are `GENERIC_X86`, `GENERIC_ARM` and `GENERIC_X86_ARM`. Default is `GENERIC_X86`. Setting this to `GENERIC_X86`, will run the functions in the application on X86 processor architecture. + Setting this to `GENERIC_ARM`, will run the functions in the application on ARM processor architecture. + When set to `GENERIC_X86_ARM`, functions in the application are run on either X86 or ARM processor architecture. + Accepted values are: + `GENERIC_X86`, `GENERIC_ARM`, `GENERIC_X86_ARM` + enum: + - GENERIC_X86 + - GENERIC_ARM + - GENERIC_X86_ARM + type: string + subnetIds: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm)s of the subnets in which to run functions in the application. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + syslogUrl: + description: | + A syslog URL to which to send all function logs. Supports tcp, udp, and tcp+tls. + The syslog URL must be reachable from all of the subnets configured for the application. + Note: If you enable the OCI Logging service for this application, the syslogUrl value is ignored. Function logs are sent to the OCI Logging service, and not to the syslog URL. + + Example: `tcp://logserver.myserver:1234` + maxLength: 1024 + type: string + timeCreated: + description: | + The time the application was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) + timestamp format. + + Example: `2018-09-12T22:47:12.613Z` + format: date-time + type: string + timeUpdated: + description: | + The time the application was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) + timestamp format. + Example: `2018-09-12T22:47:12.613Z` + format: date-time + type: string + traceConfig: + $ref: '#/components/schemas/ApplicationTraceConfig' + required: + - id + type: object + UpdateApplicationDetails: + description: | + Properties to update an application. + properties: + config: + additionalProperties: + type: string + description: | + Application configuration. These values are passed on to the function as environment variables, functions may override application configuration. + Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters. + + Example: `{"MY_FUNCTION_CONFIG": "ConfVal"}` + + The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8. + maxProperties: 100 + type: object + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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 + imagePolicyConfig: + $ref: '#/components/schemas/ImagePolicyConfig' + logging: + $ref: '#/components/schemas/ApplicationLoggingConfig' + networkSecurityGroupIds: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm)s of the Network Security Groups to add the application to. + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". + (opaque JSON object) + type: string + description: | + Key-value pair representing a security attribute key and value, scoped to a namespace. + + Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` + type: object + description: | + Security attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` + type: object + syslogUrl: + description: | + A syslog URL to which to send all function logs. Supports tcp, udp, and tcp+tls. + The syslog URL must be reachable from all of the subnets configured for the application. + Note: If you enable the OCI Logging service for this application, the syslogUrl value is ignored. Function logs are sent to the OCI Logging service, and not to the syslog URL. + + Example: `tcp://logserver.myserver:1234` + maxLength: 1024 + type: string + traceConfig: + $ref: '#/components/schemas/ApplicationTraceConfig' + type: object + ChangeApplicationCompartmentDetails: + description: | + Properties to change the compartment of an application. + properties: + compartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment + into which the resource should be moved. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + FunctionSummary: + description: | + Summary of a function. + properties: + applicationId: + description: The OCID of the application the function belongs to. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The OCID of the compartment that contains the function. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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 + detachedModeTimeoutInSeconds: + description: Timeout for detached function invocations. Value in seconds. + format: int32 + type: integer + displayName: + description: | + The display name of the function. The display name is unique within the application containing the function. + maxLength: 255 + minLength: 1 + type: string + failureDestination: + $ref: '#/components/schemas/FailureDestinationDetails' + 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 + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the function. + maxLength: 255 + minLength: 1 + type: string + image: + description: | + The qualified name of the Docker image to use in the function, including the image tag. + The image should be in the OCI Registry that is in the same region as the function itself. + Example: `phx.ocir.io/ten/functions/function:0.0.1` + type: string + imageDigest: + description: | + The image digest for the version of the image that will be pulled when invoking this function. + If no value is specified, the digest currently associated with the image in the OCI Registry will be used. + Example: `sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7` + type: string + invokeEndpoint: + description: | + The base https invoke URL to set on a client in order to invoke a function. This URL will never change over the lifetime of the function and can be cached. + type: string + lifecycleState: + description: | + The current state of the function. + type: string + x-obmcs-enumref: '#/definitions/Function/lifecycleState' + memoryInMBs: + description: Maximum usable memory for the function (MiB). + format: int64 + type: integer + provisionedConcurrencyConfig: + $ref: '#/components/schemas/FunctionProvisionedConcurrencyConfig' + shape: + description: | + The processor shape (`GENERIC_X86`/`GENERIC_ARM`) on which to run functions in the application, extracted from the image manifest. + enum: + - GENERIC_X86 + - GENERIC_ARM + - GENERIC_X86_ARM + type: string + sourceDetails: + $ref: '#/components/schemas/FunctionSourceDetails' + successDestination: + $ref: '#/components/schemas/SuccessDestinationDetails' + timeCreated: + description: | + The time the function was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) + timestamp format. + + Example: `2018-09-12T22:47:12.613Z` + format: date-time + type: string + timeUpdated: + description: | + The time the function was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) + timestamp format. + + Example: `2018-09-12T22:47:12.613Z` + format: date-time + type: string + timeoutInSeconds: + default: 30 + description: Timeout for executions of the function. Value in seconds. + format: int32 + type: integer + traceConfig: + $ref: '#/components/schemas/FunctionTraceConfig' + required: + - id + type: object + CreateFunctionDetails: + description: | + Properties to create a new function. + properties: + applicationId: + description: The OCID of the application this function belongs to. + type: string + config: + additionalProperties: + type: string + description: | + Function configuration. These values are passed on to the function as environment variables, this overrides application configuration values. + Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters. + + Example: `{"MY_FUNCTION_CONFIG": "ConfVal"}` + + The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8. + maxProperties: 100 + type: object + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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 + detachedModeTimeoutInSeconds: + description: Timeout for detached function invocations. Value in seconds. + format: int32 + type: integer + displayName: + description: | + The display name of the function. The display name must be unique within the application containing the function. Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + failureDestination: + $ref: '#/components/schemas/FailureDestinationDetails' + 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 + image: + description: | + The qualified name of the Docker image to use in the function, including the image tag. + The image should be in the OCI Registry that is in the same region as the function itself. + Example: `phx.ocir.io/ten/functions/function:0.0.1` + type: string + imageDigest: + description: | + The image digest for the version of the image that will be pulled when invoking this function. + If no value is specified, the digest currently associated with the image in the OCI Registry will be used. + Example: `sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7` + type: string + memoryInMBs: + description: Maximum usable memory for the function (MiB). + format: int64 + type: integer + provisionedConcurrencyConfig: + $ref: '#/components/schemas/FunctionProvisionedConcurrencyConfig' + sourceDetails: + $ref: '#/components/schemas/FunctionSourceDetails' + successDestination: + $ref: '#/components/schemas/SuccessDestinationDetails' + timeoutInSeconds: + default: 30 + description: Timeout for executions of the function. Value in seconds. + format: int32 + type: integer + traceConfig: + $ref: '#/components/schemas/FunctionTraceConfig' + required: + - displayName + - applicationId + - memoryInMBs + type: object + Function: + description: | + A function resource defines the code (Docker image) and configuration for a specific function. Functions are defined in applications. Avoid entering confidential information. + properties: + applicationId: + description: The OCID of the application the function belongs to. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The OCID of the compartment that contains the function. + maxLength: 255 + minLength: 1 + type: string + config: + additionalProperties: + type: string + description: | + Function configuration. Overrides application configuration. + Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters. + + Example: `{"MY_FUNCTION_CONFIG": "ConfVal"}` + + The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8. + maxProperties: 100 + type: object + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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 + detachedModeTimeoutInSeconds: + description: | + Timeout for detached function invocations. Value in seconds. + + Example: `{"detachedModeTimeoutInSeconds": 900}` + format: int32 + type: integer + displayName: + description: | + The display name of the function. The display name is unique within the application containing the function. + maxLength: 255 + minLength: 1 + type: string + failureDestination: + $ref: '#/components/schemas/FailureDestinationDetails' + 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 + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the function. + maxLength: 255 + minLength: 1 + type: string + image: + description: | + The qualified name of the Docker image to use in the function, including the image tag. + The image should be in the OCI Registry that is in the same region as the function itself. + Example: `phx.ocir.io/ten/functions/function:0.0.1` + type: string + imageDigest: + description: | + The image digest for the version of the image that will be pulled when invoking this function. + If no value is specified, the digest currently associated with the image in the OCI Registry will be used. + Example: `sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7` + type: string + invokeEndpoint: + description: | + The base https invoke URL to set on a client in order to invoke a function. This URL will never change over the lifetime of the function and can be cached. + type: string + lifecycleState: + description: | + The current state of the function. + enum: + - CREATING + - ACTIVE + - INACTIVE + - UPDATING + - DELETING + - DELETED + - FAILED + type: string + memoryInMBs: + description: Maximum usable memory for the function (MiB). + format: int64 + type: integer + provisionedConcurrencyConfig: + $ref: '#/components/schemas/FunctionProvisionedConcurrencyConfig' + shape: + description: | + The processor shape (`GENERIC_X86`/`GENERIC_ARM`) on which to run functions in the application, extracted from the image manifest. + enum: + - GENERIC_X86 + - GENERIC_ARM + - GENERIC_X86_ARM + type: string + sourceDetails: + $ref: '#/components/schemas/FunctionSourceDetails' + successDestination: + $ref: '#/components/schemas/SuccessDestinationDetails' + timeCreated: + description: | + The time the function was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) + timestamp format. + + Example: `2018-09-12T22:47:12.613Z` + format: date-time + type: string + timeUpdated: + description: | + The time the function was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) + timestamp format. + + Example: `2018-09-12T22:47:12.613Z` + format: date-time + type: string + timeoutInSeconds: + default: 30 + description: Timeout for executions of the function. Value in seconds. + format: int32 + type: integer + traceConfig: + $ref: '#/components/schemas/FunctionTraceConfig' + required: + - id + type: object + UpdateFunctionDetails: + description: | + Updates attributes of a function. + properties: + config: + additionalProperties: + type: string + description: | + Function configuration. These values are passed on to the function as environment variables, this overrides application configuration values. + Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters. + + Example: `{"MY_FUNCTION_CONFIG": "ConfVal"}` + + The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8. + maxProperties: 100 + type: object + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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 + detachedModeTimeoutInSeconds: + description: Timeout for detached function invocations. Value in seconds. + format: int32 + type: integer + failureDestination: + $ref: '#/components/schemas/FailureDestinationDetails' + 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 + image: + description: | + The qualified name of the Docker image to use in the function, including the image tag. + The image should be in the OCI Registry that is in the same region as the function itself. + If an image is specified but no value for imageDigest is provided, the digest currently associated with the image tag in the OCI Registry will be used. + Example: `phx.ocir.io/ten/functions/function:0.0.1` + type: string + imageDigest: + description: | + The image digest for the version of the image that will be pulled when invoking this function. + Example: `sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7` + type: string + memoryInMBs: + description: Maximum usable memory for the function (MiB). + format: int64 + type: integer + provisionedConcurrencyConfig: + $ref: '#/components/schemas/FunctionProvisionedConcurrencyConfig' + successDestination: + $ref: '#/components/schemas/SuccessDestinationDetails' + timeoutInSeconds: + default: 30 + description: Timeout for executions of the function. Value in seconds. + format: int32 + type: integer + traceConfig: + $ref: '#/components/schemas/FunctionTraceConfig' + type: object + PbfListingVersionsCollection: + description: | + Results of a PbfListingVersion search. Contains both PbfListingVersionSummary + items and other information, such as metadata. + properties: + items: + description: List of PbfListingVersion. + items: + $ref: '#/components/schemas/PbfListingVersionSummary' + maxItems: 100 + type: array + required: + - items + type: object + PbfListingVersion: + description: | + This represents a version of a PbfListing. Each new update from the publisher or the change in the image will + result in the creation of new PbfListingVersion resource creation. This is a sub-resource of a PbfListing. + properties: + changeSummary: + description: Details changes are included in this version. + example: | + First release of the PBF. + maxLength: 1024 + minLength: 1 + type: string + config: + description: | + Details about the required and optional Function configurations needed for proper performance of the PBF. + items: + $ref: '#/components/schemas/ConfigDetails' + maxItems: 100 + type: array + x-default-description: 'null' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing predefined tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{"foo-namespace": {"bar-key": "value"}}` + type: object + freeformTags: + additionalProperties: + type: string + description: | + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{"bar-key": "value"}` + type: object + id: + description: Unique identifier that is immutable on creation + example: ocid1.pbflistingversion.oc1.iad.aaaaaaaal3dkjeliven6l7kw3kiwlkbqjtfhdra6fly7uqekgmuef6forplq + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the PBF resource. + enum: + - ACTIVE + - INACTIVE + - DELETED + type: string + name: + description: Semantic version + example: 0.0.1 + maxLength: 32 + minLength: 1 + type: string + pbfListingId: + description: The OCID of the PbfListing this resource version belongs to. + example: ocid1.pbflisting.oc1.iad.aaaaaaaal3dkjeliven6l7kw3kiwlkbqjtfhdra6fly7uqekgmuef6forplq + maxLength: 255 + minLength: 1 + type: string + requirements: + $ref: '#/components/schemas/RequirementDetails' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + 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: The time the PbfListingVersion was created. An RFC3339 formatted datetime string. + example: 2022-09-30T0710:20:50.52Z + format: date-time + type: string + timeUpdated: + description: The last time the PbfListingVersion was updated. An RFC3339 formatted datetime string. + example: 2022-09-30T0710:20:50.52Z + format: date-time + type: string + triggers: + description: An array of Trigger. A list of triggers that may activate the PBF. + items: + $ref: '#/components/schemas/Trigger' + maxItems: 100 + minItems: 1 + type: array + required: + - id + - pbfListingId + - name + - requirements + - changeSummary + - triggers + - timeCreated + - timeUpdated + - lifecycleState + type: object + PbfListingsCollection: + description: Results of a PbfListing search. Contains boh PbfListingSummary items and other information, such as metadata. + properties: + items: + description: List of PbfListingSummary. + items: + $ref: '#/components/schemas/PbfListingSummary' + maxItems: 100 + type: array + required: + - items + type: object + TriggersCollection: + description: Results of a Trigger search. Contains boh TriggerSummary items and other information, such as metadata. + properties: + items: + description: List of TriggerSummary. + items: + $ref: '#/components/schemas/TriggerSummary' + maxLength: 100 + type: array + required: + - items + type: object + PbfListing: + description: | + PbfListing resources provide details about the available PBFs for consumption by the user. + This resource contains details about PBF's functionality, policies required, configuration parameters expected + etc. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing predefined tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{"foo-namespace": {"bar-key": "value"}}` + type: object + description: + description: 'A short overview of the PBF Listing: the purpose of the PBF and and associated information.' + example: | + A PBF to transform and send logs, metrics and data to Splunk. The PBF pushes data to Splunk through + http/post requests and Splunk's HEC module (https://docs.splunk.com/Documentation/Splunk/9.0.0/Data/UsetheHTTPEventCollector). + maxLength: 1024 + minLength: 1 + type: string + freeformTags: + additionalProperties: + type: string + description: | + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{"bar-key": "value"}` + type: object + id: + description: Unique identifier that is immutable on creation. + example: ocid1.pbflisting.oc1.iad.aaaaaaaal3dkjeliven6l7kw3kiwlkbqjtfhdra6fly7uqekgmuef6forplq + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the PBF resource. + enum: + - ACTIVE + - INACTIVE + - DELETED + type: string + name: + description: | + A brief descriptive name for the PBF listing. The PBF listing name must be unique, and not match and existing + PBF. + example: Logs to Splunk + maxLength: 255 + minLength: 1 + type: string + publisherDetails: + $ref: '#/components/schemas/PublisherDetails' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + 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: The time the PbfListing was created. An RFC3339 formatted datetime string. + example: 2022-09-30T0710:20:50.52Z + format: date-time + type: string + timeUpdated: + description: The last time the PbfListing was updated. An RFC3339 formatted datetime string. + example: 2022-09-30T0710:20:50.52Z + format: date-time + type: string + triggers: + description: An array of Trigger. A list of triggers that may activate the PBF. + items: + $ref: '#/components/schemas/Trigger' + maxItems: 100 + minItems: 1 + type: array + required: + - id + - name + - description + - publisherDetails + - timeCreated + - timeUpdated + - lifecycleState + type: object + ImagePolicyConfig: + description: | + Define the image signature verification policy for an application. + properties: + isPolicyEnabled: + description: | + Define if image signature verification policy is enabled for the application. + type: boolean + keyDetails: + description: A list of KMS key details. + items: + $ref: '#/components/schemas/KeyDetails' + type: array + required: + - isPolicyEnabled + type: object + ApplicationLoggingConfig: + description: | + Set logging configuration for an application. This is only used if Service Logs for the application are enabled in the OCI Logging service. + properties: + lineFormat: + default: PLAIN_TEXT + description: | + Specify the format of log lines emitted by functions in this application. + enum: + - JSON + - PLAIN_TEXT + type: string + type: object + ApplicationTraceConfig: + description: | + Define the tracing configuration for an application. + properties: + domainId: + description: | + The OCID of the collector (e.g. an APM Domain) trace events will be sent to. + maxLength: 255 + minLength: 1 + type: string + isEnabled: + description: | + Define if tracing is enabled for the resource. + type: boolean + type: object + Error: + description: An error has occurred. + properties: + code: + description: A short error code that defines the error, meant for programmatic parsing. + type: string + message: + description: A human-readable error string. + type: string + required: + - code + - message + type: object + FailureDestinationDetails: + description: | + An object that represents the destination to which Oracle Functions will send an invocation record with the details of the error of the failed detached function invocation. + A notification is an example of a failure destination. + + Example: `{"kind": "NOTIFICATION", "topicId": "topic_OCID"}` + discriminator: + propertyName: kind + properties: + kind: + description: | + The type of destination for the response to a failed detached function invocation. + enum: + - NOTIFICATION + - QUEUE + - STREAM + - NONE + type: string + required: + - kind + type: object + FunctionProvisionedConcurrencyConfig: + description: | + Define the strategy for provisioned concurrency for the function. + discriminator: + propertyName: strategy + properties: + strategy: + description: | + The strategy for provisioned concurrency to be used. + enum: + - CONSTANT + - NONE + type: string + required: + - strategy + type: object + FunctionSourceDetails: + description: | + The source details for the Function. The function can be created from various sources. + discriminator: + propertyName: sourceType + properties: + sourceType: + description: | + Type of the Function Source. Possible values: PBF. + enum: + - PRE_BUILT_FUNCTIONS + type: string + required: + - sourceType + type: object + SuccessDestinationDetails: + description: | + An object that represents the destination to which Oracle Functions will send an invocation record with the details of the successful detached function invocation. + A stream is an example of a success destination. + + Example: `{"kind": "STREAM", "streamId": "stream_OCID"}` + discriminator: + propertyName: kind + properties: + kind: + description: | + The type of destination for the response to a successful detached function invocation. + enum: + - NOTIFICATION + - QUEUE + - STREAM + - NONE + type: string + required: + - kind + type: object + FunctionTraceConfig: + description: | + Define the tracing configuration for a function. + properties: + isEnabled: + description: | + Define if tracing is enabled for the resource. + type: boolean + type: object + PbfListingVersionSummary: + description: Summary of the PbfListingVersion. + properties: + changeSummary: + description: Details changes are included in this version. + example: | + First release of the PBF. + maxLength: 1024 + minLength: 1 + type: string + config: + description: | + Details about the required and optional Function configurations needed for proper performance of the PBF. + items: + $ref: '#/components/schemas/ConfigDetails' + maxItems: 100 + type: array + x-default-description: 'null' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing predefined tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{"foo-namespace": {"bar-key": "value"}}` + type: object + freeformTags: + additionalProperties: + type: string + description: | + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{"bar-key": "value"}` + type: object + id: + description: Unique identifier that is immutable on creation + example: ocid1.pbflistingversion.oc1.iad.aaaaaaaal3dkjeliven6l7kw3kiwlkbqjtfhdra6fly7uqekgmuef6forplq + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the PBF resource. + type: string + x-obmcs-enumref: '#/definitions/PbfListingVersion/lifecycleState' + name: + description: Semantic version + example: 0.0.1 + maxLength: 32 + minLength: 1 + type: string + pbfListingId: + description: The OCID of the PbfListing this resource version belongs to. + example: ocid1.pbflisting.oc1.iad.aaaaaaaal3dkjeliven6l7kw3kiwlkbqjtfhdra6fly7uqekgmuef6forplq + maxLength: 255 + minLength: 1 + type: string + requirements: + $ref: '#/components/schemas/RequirementDetails' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + 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: The time the PbfListingVersion was created. An RFC3339 formatted datetime string. + example: 2022-09-30T0710:20:50.52Z + format: date-time + type: string + timeUpdated: + description: The last time the PbfListingVersion was updated. An RFC3339 formatted datetime string. + example: 2022-09-30T0710:20:50.52Z + format: date-time + type: string + triggers: + description: An array of Trigger. A list of triggers that may activate the PBF. + items: + $ref: '#/components/schemas/Trigger' + maxItems: 100 + minItems: 1 + type: array + required: + - id + - pbfListingId + - name + - requirements + - changeSummary + - triggers + - timeCreated + - timeUpdated + - lifecycleState + type: object + ConfigDetails: + description: Details about the required and optional Function configurations needed for proper performance of the PBF. + properties: + description: + description: Details about why this config is required and what it will be used for. + example: The hostname for the target Splunk Enterprise/Cloud instance. + maxLength: 1024 + minLength: 1 + type: string + isOptional: + default: false + description: Is this a required config or an optional one. Requests with required config params missing will be rejected. + example: false + type: boolean + key: + description: The key name of the config param. + example: SPLUNK_HEC_HOST + type: string + required: + - key + - description + type: object + RequirementDetails: + description: | + Minimum memory required by this PBF. The user should use memory greater than or equal to this value + while configuring the Function. + properties: + minMemoryRequiredInMBs: + description: | + Minimum memory required by this PBF. The user should use memory greater than or equal to + this value while configuring the Function. + example: 256 + format: int64 + type: integer + policies: + description: List of policies required for this PBF execution. + items: + $ref: '#/components/schemas/PolicyDetails' + maxItems: 100 + type: array + required: + - minMemoryRequiredInMBs + type: object + Trigger: + description: PBF specific triggers for activating a PBF. + properties: + name: + description: A brief descriptive name for the PBF trigger. + example: API Gateway + maxLength: 32 + minLength: 1 + type: string + required: + - name + type: object + PbfListingSummary: + description: Summary of the PbfListing. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing predefined tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{"foo-namespace": {"bar-key": "value"}}` + type: object + description: + description: 'A short overview of the PBF Listing: the purpose of the PBF and and associated information.' + example: | + A PBF to transform and send logs, metrics and data to Splunk. The PBF pushes data to Splunk through + http/post requests and Splunk's HEC module (https://docs.splunk.com/Documentation/Splunk/9.0.0/Data/UsetheHTTPEventCollector). + maxLength: 1024 + minLength: 1 + type: string + freeformTags: + additionalProperties: + type: string + description: | + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{"bar-key": "value"}` + type: object + id: + description: Unique identifier that is immutable on creation. + example: ocid1.pbflisting.oc1.iad.aaaaaaaal3dkjeliven6l7kw3kiwlkbqjtfhdra6fly7uqekgmuef6forplq + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the PBF resource. + type: string + x-obmcs-enumref: '#/definitions/PbfListing/lifecycleState' + name: + description: | + A brief descriptive name for the PBF listing. The PBF listing name must be unique, and not match and existing + PBF. + example: Logs to Splunk + maxLength: 255 + minLength: 1 + type: string + publisherDetails: + $ref: '#/components/schemas/PublisherDetails' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + 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: The time the PbfListing was created. An RFC3339 formatted datetime string. + example: 2022-09-30T0710:20:50.52Z + format: date-time + type: string + timeUpdated: + description: The last time the PbfListing was updated. An RFC3339 formatted datetime string. + example: 2022-09-30T0710:20:50.52Z + format: date-time + type: string + triggers: + description: An array of Trigger. A list of triggers that may activate the PBF. + items: + $ref: '#/components/schemas/Trigger' + maxItems: 100 + minItems: 1 + type: array + required: + - id + - name + - description + - publisherDetails + - timeCreated + - timeUpdated + - lifecycleState + type: object + TriggerSummary: + description: Summary of the Trigger. + properties: + name: + description: A brief descriptive name for the PBF trigger. + example: API Gateway + maxLength: 32 + minLength: 1 + type: string + required: + - name + type: object + PublisherDetails: + description: Contains details about the publisher of this PBF Listing. + properties: + name: + description: Name of the Publisher + example: OCI Functions + maxLength: 255 + minLength: 1 + type: string + required: + - name + type: object + KeyDetails: + description: The properties that define the kms keys used by Functions for Image Signature verification. + properties: + kmsKeyId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm)s of the KMS key that will be used to verify the image signature. + maxLength: 255 + minLength: 1 + type: string + required: + - kmsKeyId + type: object + PolicyDetails: + description: A policy required for this PBF execution. + properties: + description: + description: Details about why this policy is required and what it will be used for. + example: Allow dynamic-group to manage instances in compartment + maxLength: 1024 + minLength: 1 + type: string + policy: + description: Policy required for PBF execution + example: KEY_READ + type: string + required: + - policy + - description + type: object + ListApplicationsResponse: + type: object + properties: + applications: + type: array + items: + $ref: '#/components/schemas/ApplicationSummary' + ListFunctionsResponse: + type: object + properties: + functions: + type: array + items: + $ref: '#/components/schemas/FunctionSummary' + responses: + '400': + description: Bad Request + 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' + '401': + description: Unauthorized (Unauthenticated) + 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' + '403': + description: Forbidden + 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' + '404': + description: Not found or not authorized + 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' + '409': + description: Not authorized or resource already exists + headers: + opc-request-id: + description: | + Authorization failed or requested resource already exists. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '412': + description: NoEtagMatch + 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' + '429': + description: Too Many Requests + 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' + '500': + description: Internal Server 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' + '502': + description: Function Invoke Failed + 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' + '503': + description: Function Invoke Timedout + 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' + DefaultError: + description: An error has occurred. + 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' + parameters: + CompartmentIdQueryParam: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this resource belongs. + in: query + name: compartmentId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + PaginationLimitQueryParam: + description: | + The maximum number of items to return. 1 is the minimum, 50 is the maximum. + + Default: 10 + in: query + name: limit + required: false + schema: + type: integer + minimum: 1 + maximum: 50 + default: 5 + PaginationTokenQueryParam: + description: | + The pagination token for a list query returned by a previous operation + in: query + name: page + schema: + type: string + minLength: 1 + maxLength: 1024 + OpcRequestIdHeaderParam: + description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + ListApplicationsFilterByLifecycleStateQueryParam: + description: | + A filter to return only applications that match the lifecycle state in this parameter. + Example: `Creating` + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/Application/lifecycleState' + schema: + type: string + ListApplicationsFilterByDisplayNameQueryParam: + description: | + A filter to return only applications with display names that match the display name string. Matching is exact. + in: query + name: displayName + required: false + schema: + type: string + maxLength: 255 + ListApplicationsFilterByIdQueryParam: + description: | + A filter to return only applications with the specified OCID. + in: query + name: id + required: false + schema: + type: string + maxLength: 255 + SortOrderQueryParam: + description: | + Specifies sort order. + + * **ASC:** Ascending sort order. + * **DESC:** Descending sort order. + in: query + name: sortOrder + required: false + schema: + type: string + enum: + - ASC + - DESC + default: ASC + ApplicationIdPathParam: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this application. + in: path + name: applicationId + required: true + schema: + type: string + 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 + schema: + type: string + ApplicationIdQueryParam: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the application to which this function belongs. + in: query + name: applicationId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListFunctionsFilterByLifecycleStateQueryParam: + description: | + A filter to return only functions that match the lifecycle state in this parameter. + Example: `Creating` + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/Function/lifecycleState' + schema: + type: string + ListFunctionsFilterByDisplayNameQueryParam: + description: | + A filter to return only functions with display names that match the display name string. Matching is exact. + in: query + name: displayName + required: false + schema: + type: string + maxLength: 255 + ListFunctionsFilterByIdQueryParam: + description: | + A filter to return only functions with the specified OCID. + in: query + name: id + required: false + schema: + type: string + maxLength: 255 + FunctionIdPathParam: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this function. + in: path + name: functionId + required: true + schema: + type: string + FnIntentHeader: + description: | + An optional intent header that indicates to the FDK the way the event should be interpreted. E.g. 'httprequest', 'cloudevent'. + in: header + name: fn-intent + required: false + x-default-description: 'null' + schema: + type: string + enum: + - httprequest + - cloudevent + FnInvokeTypeHeader: + description: | + Indicates whether Oracle Functions should execute the request and return the result ('sync') of the execution, + or whether Oracle Functions should return as soon as processing has begun ('detached') and leave result handling to the function. + in: header + name: fn-invoke-type + required: false + schema: + type: string + enum: + - detached + - sync + default: sync + FnDryRunHeader: + description: | + Indicates that the request is a dry run, if set to "true". A dry run request does not execute the function. + in: header + name: is-dry-run + required: false + schema: + type: boolean + default: false + PbfListingIdentifierQueryParam: + description: unique PbfListing identifier + in: query + name: pbfListingId + required: true + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + PbfListingVersionIdentifierQueryParam: + description: unique PbfListingVersion identifier + in: query + name: pbfListingVersionId + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + PbfListingVersionNameQueryParam: + description: | + Matches a PbfListingVersion based on a provided semantic version name for a PbfListingVersion. + Each PbfListingVersion name is unique with respect to its associated PbfListing. + in: query + name: name + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 32 + PbfListingVersionIsCurrentVersionQueryParam: + description: | + Matches the current version (the most recently added version with an Active + lifecycleState) associated with a PbfListing. + in: query + name: isCurrentVersion + x-default-description: 'null' + schema: + type: boolean + PbfListingVersionLifecycleStateQueryParam: + description: A filter to return only resources their lifecycleState matches the given lifecycleState. + in: query + name: lifecycleState + required: false + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/PbfListingVersion/lifecycleState' + schema: + type: string + PbfListingVersionSortByQueryParam: + description: | + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. + in: query + name: sortBy + schema: + type: string + enum: + - timeCreated + - name + default: timeCreated + PbfListingVersionIdentifierPathParam: + description: unique PbfListingVersion identifier + in: path + name: pbfListingVersionId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + PbfListingIdentifierOptionalQueryParam: + description: unique PbfListing identifier + in: query + name: pbfListingId + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + PbfListingNameQueryParam: + description: A filter to return only resources that match the entire PBF name given. + in: query + name: name + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 32 + PbfListingNameQueryContainsParam: + description: A filter to return only resources that contain the supplied filter text in the PBF name given. + in: query + name: nameContains + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 32 + PbfListingNameQueryStartsWithParam: + description: A filter to return only resources that start with the supplied filter text in the PBF name given. + in: query + name: nameStartsWith + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 32 + PbfTriggerNamesQueryParam: + description: A filter to return only resources that match the service trigger sources of a PBF. + in: query + name: trigger + x-default-description: 'null' + explode: true + schema: + type: array + items: + maxLength: 32 + minLength: 1 + type: string + PbfListingLifecycleStateQueryParam: + description: A filter to return only resources their lifecycleState matches the given lifecycleState. + in: query + name: lifecycleState + required: false + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/PbfListing/lifecycleState' + schema: + type: string + PbfListingSortByQueryParam: + description: | + The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. + in: query + name: sortBy + schema: + type: string + enum: + - timeCreated + - name + default: timeCreated + TriggerNameQueryParam: + description: A filter to return only resources that match the service trigger source of a PBF. + in: query + name: name + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 32 + PbfListingIdentifierPathParam: + description: unique PbfListing identifier + in: path + name: pbfListingId + required: true + schema: + type: string + x-stackQL-resources: + applications: + id: oci.functions.applications + name: applications + title: Applications + methods: + list: + operation: + $ref: '#/paths/~1applications/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.applications + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListApplicationsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"applications\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 50 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1applications/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1applications~1{applicationId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1applications~1{applicationId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1applications~1{applicationId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1applications~1{applicationId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/applications/methods/get' + - $ref: '#/components/x-stackQL-resources/applications/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/applications/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete' + replace: [] + functions: + id: oci.functions.functions + name: functions + title: Functions + methods: + list: + operation: + $ref: '#/paths/~1functions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.functions + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListFunctionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"functions\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 50 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1functions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1functions~1{functionId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1functions~1{functionId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1functions~1{functionId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + invoke_function: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1functions~1{functionId}~1actions~1invoke/post' + response: + mediaType: '*/*' + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/functions/methods/get' + - $ref: '#/components/x-stackQL-resources/functions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/functions/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/functions/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/functions/methods/delete' + replace: [] + pbf_listing_versions: + id: oci.functions.pbf_listing_versions + name: pbf_listing_versions + title: Pbf Listing Versions + methods: + list: + operation: + $ref: '#/paths/~1pbfListingVersions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 50 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1pbfListingVersions~1{pbfListingVersionId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pbf_listing_versions/methods/get' + - $ref: '#/components/x-stackQL-resources/pbf_listing_versions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + pbf_listings: + id: oci.functions.pbf_listings + name: pbf_listings + title: Pbf Listings + methods: + list: + operation: + $ref: '#/paths/~1pbfListings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 50 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1pbfListings~1{pbfListingId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pbf_listings/methods/get' + - $ref: '#/components/x-stackQL-resources/pbf_listings/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + triggers: + id: oci.functions.triggers + name: triggers + title: Triggers + methods: + list: + operation: + $ref: '#/paths/~1pbfListings~1triggers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 50 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/triggers/methods/list' + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://functions.{region}.oci.oraclecloud.com/20181201 + variables: + region: + default: us-ashburn-1 + description: OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. + x-stackQL-envVar: OCI_REGION +x-stackQL-config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: opc-next-page + location: header diff --git a/providers/src/oci/v00.00.00000/services/identity.yaml b/providers/src/oci/v00.00.00000/services/identity.yaml new file mode 100644 index 00000000..b46fd7c4 --- /dev/null +++ b/providers/src/oci/v00.00.00000/services/identity.yaml @@ -0,0 +1,16777 @@ +openapi: 3.0.0 +info: + title: identity API + description: oci identity API + version: '20160918' +paths: + /allowedDomainLicenseTypes: + get: + description: | + (For tenancies that support identity domains) Lists the license types for identity domains supported by Oracle Cloud Infrastructure. + (License types are also referred to as domain types.) + + If `currentLicenseTypeName` is provided, then the request returns license types that the identity domain with the specified license + type name can change to. Otherwise, the request returns all valid license types currently supported. + operationId: ListAllowedDomainLicenseTypes + parameters: + - $ref: '#/components/parameters/OptionalLicenseTypeQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: A list of allowed license types for identity domains. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListAllowedDomainLicenseTypesResponse' + '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/DefaultError' + summary: List allowed identity domain license types + tags: + - identity + x-related-resource: '#/definitions/Domain' + /authenticationPolicies/{compartmentId}: + get: + description: | + Gets the authentication policy for the given tenancy. You must specify your tenant's OCID as the value for + the compartment ID (remember that the tenancy is simply the root compartment). + operationId: GetAuthenticationPolicy + parameters: + - $ref: '#/components/parameters/CompartmentIdPathParam' + responses: + '200': + description: The authentication policy was found. + 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/AuthenticationPolicy' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetAuthenticationPolicy + tags: + - identity + put: + description: | + Updates authentication policy for the specified tenancy. + operationId: UpdateAuthenticationPolicy + parameters: + - $ref: '#/components/parameters/CompartmentIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAuthenticationPolicyDetails' + description: Request object for updating the authentication policy. + required: true + responses: + '200': + description: The authentication policy is being updated. + 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/AuthenticationPolicy' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: UpdateAuthenticationPolicy + tags: + - identity + /availabilityDomains/: + get: + description: | + Lists the availability domains in your tenancy. Specify the OCID of either the tenancy or another + of your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment). + See [Where to Get the Tenancy's OCID and User's OCID](/Content/API/Concepts/apisigningkey.htm#five). + Note that the order of the results returned can change if availability domains are added or removed; therefore, do not + create a dependency on the list order. + operationId: ListAvailabilityDomains + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + responses: + '200': + description: The list is being retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListAvailabilityDomainsResponse' + '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/DefaultError' + summary: ListAvailabilityDomains + tags: + - identity + /compartments/: + get: + description: | + Lists the compartments in a specified compartment. The members of the list + returned depends on the values set for several parameters. + + With the exception of the tenancy (root compartment), the ListCompartments operation + returns only the first-level child compartments in the parent compartment specified in + `compartmentId`. The list does not include any subcompartments of the child + compartments (grandchildren). + + The parameter `accessLevel` specifies whether to return only those compartments for which the + requestor has INSPECT permissions on at least one resource directly + or indirectly (the resource can be in a subcompartment). + + The parameter `compartmentIdInSubtree` applies only when you perform ListCompartments on the + tenancy (root compartment). When set to true, the entire hierarchy of compartments can be returned. + To get a full list of all compartments and subcompartments in the tenancy (root compartment), + set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ANY. + + See [Where to Get the Tenancy's OCID and User's OCID](/Content/API/Concepts/apisigningkey.htm#five). + operationId: ListCompartments + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/AccessLevelQueryParam' + - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' + - $ref: '#/components/parameters/FilterByNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/Compartment/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListCompartmentsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListCompartments + tags: + - identity + post: + description: | + Creates a new compartment in the specified compartment. + + Specify the parent compartment's OCID as the compartment ID in the request object. Remember that the tenancy + is simply the root compartment. For information about OCIDs, see + [Resource Identifiers](/Content/General/Concepts/identifiers.htm). + + You must also specify a *name* for the compartment, which must be unique across all compartments in + your tenancy. You can use this name or the OCID when writing policies that apply + to the compartment. For more information about policies, see + [How Policies Work](/Content/Identity/policieshow/how-policies-work.htm). + + You must also specify a *description* for the compartment (although it can be an empty string). It does + not have to be unique, and you can change it anytime with + [UpdateCompartment](#/en/identity/20160918/Compartment/UpdateCompartment). + + After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the + object, first make sure its `lifecycleState` has changed to ACTIVE. + operationId: CreateCompartment + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCompartmentDetails' + description: Request object for creating a new compartment. + required: true + responses: + '200': + description: The compartment is being created. + 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/Compartment' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.compartment.oc1..aaaaaaaayzexampleuniqueID", + "compartmentId" : "ocid1.tenancy.oc1..aaaaaaaaba3pexampleuniqueID", + "name" : "Network", + "description" : "For network components", + "lifecycleState" : "ACTIVE", + "timeCreated" : "2016-11-18T23:01:40.936Z" + } + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateCompartment + tags: + - identity + x-example: | + POST /20160918/compartments/ + Host: identity.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.tenancy.oc1..aaaaaaaaba3exampleuniqueID", + "description" : "For network components", + "name" : "Network" + } + /compartments/bulkActionResourceTypes: + get: + description: | + Lists the resource-types supported by compartment bulk actions. Use this API to help you provide the correct + resource-type information to the [BulkDeleteResources](#/en/identity/20160918/Compartment/BulkDeleteResources/) + and [BulkMoveResources](#/en/identity/20160918/Compartment/BulkMoveResources/) operations. The returned list of + resource-types provides the appropriate resource-type names to use with the bulk action operations along with + the type of identifying information you'll need to provide for each resource-type. Most resource-types just + require an [OCID](/Content/General/Concepts/identifiers.htm) to identify a specific resource, but some resource-types, + such as buckets, require you to provide other identifying information. + operationId: ListBulkActionResourceTypes + parameters: + - $ref: '#/components/parameters/BulkActionTypeQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + responses: + '200': + description: The list is being retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/BulkActionResourceTypeCollection' + '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/DefaultError' + summary: ListBulkActionResourceTypes + tags: + - identity + /compartments/{compartmentId}: + delete: + description: | + Deletes the specified compartment. The compartment must be empty. + operationId: DeleteCompartment + parameters: + - $ref: '#/components/parameters/CompartmentIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work 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/DefaultError' + summary: DeleteCompartment + tags: + - identity + x-related-resource: '#/definitions/Compartment' + get: + description: | + Gets the specified compartment's information. + + This operation does not return a list of all the resources inside the compartment. There is no single + API operation that does that. Compartments can contain multiple types of resources (instances, block + storage volumes, etc.). To find out what's in a compartment, you must call the "List" operation for + each resource type and specify the compartment's OCID as a query parameter in the request. For example, + call the [ListInstances](#/en/iaas/20160918/Instance/ListInstances) operation in the Cloud Compute + Service or the [ListVolumes](#/en/iaas/20160918/Volume/ListVolumes) operation in Cloud Block Storage. + operationId: GetCompartment + parameters: + - $ref: '#/components/parameters/CompartmentIdPathParam' + responses: + '200': + description: The compartment was retrieved. + 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/Compartment' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetCompartment + tags: + - identity + put: + description: Updates the specified compartment's description or name. You can't update the root compartment. + operationId: UpdateCompartment + parameters: + - $ref: '#/components/parameters/CompartmentIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCompartmentDetails' + description: Request object for updating a compartment. + required: true + responses: + '200': + description: The compartment is being updated. + 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/Compartment' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: UpdateCompartment + tags: + - identity + /compartments/{compartmentId}/actions/bulkDeleteResources: + post: + description: | + Deletes multiple resources in the compartment. All resources must be in the same compartment. You must have the appropriate + permissions to delete the resources in the request. This API can only be invoked from the tenancy's + [home region](/Content/Identity/regions/managingregions.htm#Home). This operation creates a + [WorkRequest](#/en/workrequests/20160918/WorkRequest/). Use the [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) + API to monitor the status of the bulk action. + operationId: BulkDeleteResources + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/CompartmentIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BulkDeleteResourcesDetails' + description: Request object for bulk delete resources in a compartment. + required: true + responses: + '202': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: Bulk delete resources in the compartment + tags: + - identity + x-related-resource: '#/definitions/Compartment' + /compartments/{compartmentId}/actions/bulkMoveResources: + post: + description: | + Moves multiple resources from one compartment to another. All resources must be in the same compartment. + This API can only be invoked from the tenancy's [home region](/Content/Identity/regions/managingregions.htm#Home). + To move resources, you must have the appropriate permissions to move the resource in both the source and target + compartments. This operation creates a [WorkRequest](#/en/workrequests/20160918/WorkRequest/). + Use the [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) API to monitor the status of the bulk action. + operationId: BulkMoveResources + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/CompartmentIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BulkMoveResourcesDetails' + description: Request object for bulk move resources in the compartment. + required: true + responses: + '202': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: Move multiple resources at once to a different compartment. + tags: + - identity + x-related-resource: '#/definitions/Compartment' + /compartments/{compartmentId}/actions/moveCompartment: + post: + description: | + Move the compartment to a different parent compartment in the same tenancy. When you move a + compartment, all its contents (subcompartments and resources) are moved with it. Note that + the `CompartmentId` that you specify in the path is the compartment that you want to move. + + **IMPORTANT**: After you move a compartment to a new parent compartment, the access policies of + the new parent take effect and the policies of the previous parent no longer apply. Ensure that you + are aware of the implications for the compartment contents before you move it. For more + information, see [Moving a Compartment](/Content/Identity/compartments/managingcompartments.htm#MoveCompartment). + operationId: MoveCompartment + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/CompartmentIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MoveCompartmentDetails' + description: Request object for moving a compartment. + required: true + responses: + '202': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: | + Moves a compartment tree to a different parent compartment. When provided, + If-Match is checked against ETag values of the resource. + tags: + - identity + x-related-resource: '#/definitions/Compartment' + /compartments/{compartmentId}/actions/recoverCompartment: + post: + description: | + Recover the compartment from DELETED state to ACTIVE state. + operationId: RecoverCompartment + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/CompartmentIdPathParam' + responses: + '200': + description: The compartment was recovered. + 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/Compartment' + '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/DefaultError' + summary: RecoverCompartment + tags: + - identity + x-related-resource: '#/definitions/Compartment' + /domains/: + get: + description: | + (For tenancies that support identity domains) Lists all identity domains within a tenancy. + operationId: ListDomains + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/DomainDisplayNameQueryParam' + - $ref: '#/components/parameters/DomainURLQueryParam' + - $ref: '#/components/parameters/DomainHomeRegionURLQueryParam' + - $ref: '#/components/parameters/DomainTypeQueryParam' + - $ref: '#/components/parameters/LicenseTypeQueryParam' + - $ref: '#/components/parameters/IsHiddenOnLoginQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/FilterByNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - description: | + A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/Domain/lifecycleState' + schema: + type: string + responses: + '200': + description: The identity domains were retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListDomainsResponse' + '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/DefaultError' + summary: ListDomains + tags: + - identity + post: + description: | + (For tenancies that support identity domains) Creates a new identity domain in the tenancy with the identity domain home in `homeRegion`. + After you send your request, the temporary `lifecycleState` of this identity domain is set to CREATING and `lifecycleDetails` to UPDATING. + When creation of the identity domain completes, this identity domain's `lifecycleState` is set to ACTIVE and `lifecycleDetails` to null. + + To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves + the operation's status. + + After creating an `identity domain`, first make sure its `lifecycleState` changes from CREATING to ACTIVE before you use it. + operationId: CreateDomain + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateDomainDetails' + description: The request object for creating a new identity domain. + required: true + responses: + '202': + description: This identity domain creation has started. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: CreateDomain + tags: + - identity + x-obmcs-get-work-request-operation: GetIamWorkRequest + x-related-resource: '#/definitions/Domain' + /domains/{domainId}: + delete: + description: | + (For tenancies that support identity domains) Deletes an identity domain. The identity domain must have no active apps present in + the underlying IDCS stripe. You must also deactivate the identity domain, rendering the `lifecycleState` of the identity domain INACTIVE. + Furthermore, as the authenticated user performing the operation, you cannot be a member of the identity domain you are deleting. + Lastly, you cannot delete the default identity domain. A tenancy must always have at least the default identity domain. + + To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves + the operation's status. + operationId: DeleteDomain + parameters: + - $ref: '#/components/parameters/DomainIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '202': + description: The identity domain is being 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](/Content/General/Concepts/identifiers.htm) of the work 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/DefaultError' + summary: DeleteDomain + tags: + - identity + x-obmcs-get-work-request-operation: GetIamWorkRequest + x-related-resource: '#/definitions/Domain' + get: + description: | + (For tenancies that support identity domains) Gets the specified identity domain's information. + operationId: GetDomain + parameters: + - $ref: '#/components/parameters/DomainIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The identity domain was retrieved. + 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/Domain' + '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/DefaultError' + summary: GetDomain + tags: + - identity + x-related-resource: '#/definitions/Domain' + put: + description: | + (For tenancies that support identity domains) Updates identity domain information and the associated Identity Cloud Service (IDCS) stripe. + + To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves + the operation's status. + operationId: UpdateDomain + parameters: + - $ref: '#/components/parameters/DomainIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateDomainDetails' + description: Request object for updating the identity domain. + required: true + responses: + '202': + description: The identity domain is being 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](/Content/General/Concepts/identifiers.htm) of the work 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/DefaultError' + summary: UpdateDomain + tags: + - identity + x-obmcs-get-work-request-operation: GetIamWorkRequest + x-related-resource: '#/definitions/Domain' + /domains/{domainId}/actions/activate: + post: + description: | + (For tenancies that support identity domains) Activates a deactivated identity domain. You can only activate identity domains that your user account is not a part of. + + After you send the request, the `lifecycleDetails` of the identity domain is set to ACTIVATING. When the operation completes, the + `lifecycleDetails` is set to null and the `lifecycleState` of the identity domain is set to ACTIVE. + + To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves + the operation's status. + operationId: ActivateDomain + parameters: + - $ref: '#/components/parameters/DomainIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + description: The identity domain activation is starting. + 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](/Content/General/Concepts/identifiers.htm) of the work 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/DefaultError' + summary: Activate a deactivated domain + tags: + - identity + x-obmcs-get-work-request-operation: GetIamWorkRequest + x-related-resource: '#/definitions/Domain' + /domains/{domainId}/actions/changeCompartment: + post: + description: | + (For tenancies that support identity domains) Moves the identity domain to a different compartment in the tenancy. + + To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves + the operation's status. + operationId: ChangeDomainCompartment + parameters: + - $ref: '#/components/parameters/DomainIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeDomainCompartmentDetails' + description: The request object for moving the identity domain to a different compartment. + required: true + responses: + '202': + description: This identity domain's compartment move is starting. + 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](/Content/General/Concepts/identifiers.htm) of the work 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/DefaultError' + summary: Change domain compartment + tags: + - identity + x-obmcs-get-work-request-operation: GetIamWorkRequest + x-related-resource: '#/definitions/Domain' + /domains/{domainId}/actions/changeLicenseType: + post: + description: | + (For tenancies that support identity domains) Changes the license type of the given identity domain. The identity domain's + `lifecycleState` must be set to ACTIVE and the requested `licenseType` must be allowed. To retrieve the allowed `licenseType` for + the identity domain, use [ListAllowedDomainLicenseTypes](#/en/identity/20160918/Domain/ListAllowedDomainLicenseTypes). + + After you send your request, the `lifecycleDetails` of this identity domain is set to UPDATING. When the update of the identity + domain completes, then the `lifecycleDetails` is set to null. + + To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves + the operation's status. + operationId: ChangeDomainLicenseType + parameters: + - $ref: '#/components/parameters/DomainIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeDomainLicenseTypeDetails' + description: The request object for an update to the license type of the identity domain. + required: true + responses: + '202': + description: The update of the identity domain's license type is starting. + 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](/Content/General/Concepts/identifiers.htm) of the work 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/DefaultError' + summary: Change the license type of an identity domain + tags: + - identity + x-obmcs-get-work-request-operation: GetIamWorkRequest + x-related-resource: '#/definitions/Domain' + /domains/{domainId}/actions/deactivate: + post: + description: | + (For tenancies that support identity domains) Deactivates the specified identity domain. Identity domains must be in an ACTIVE + `lifecycleState` and have no active apps present in the domain or underlying Identity Cloud Service stripe. You cannot deactivate + the default identity domain. + + After you send your request, the `lifecycleDetails` of this identity domain is set to DEACTIVATING. When the operation completes, + then the `lifecycleDetails` is set to null and the `lifecycleState` is set to INACTIVE. + + To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves + the operation's status. + operationId: DeactivateDomain + parameters: + - $ref: '#/components/parameters/DomainIdPathParam' + - description: Indicates whether domain can be forcefully deactivated even when there are Active Apps present + in: query + name: isForceDeactivate + required: false + schema: + type: boolean + default: false + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + description: The identity domain deactivation is starting. + 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](/Content/General/Concepts/identifiers.htm) of the work 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/DefaultError' + summary: Deactivate an active identity domain. + tags: + - identity + x-obmcs-get-work-request-operation: GetIamWorkRequest + x-related-resource: '#/definitions/Domain' + /domains/{domainId}/actions/enableReplicationToRegion: + post: + description: | + (For tenancies that support identity domains) Replicates the identity domain to a new region (provided that the region is the + tenancy home region or other region that the tenancy subscribes to). You can only replicate identity domains that are in an ACTIVE + `lifecycleState` and not currently updating or already replicating. You also can only trigger the replication of secondary identity domains. + The default identity domain is automatically replicated to all regions that the tenancy subscribes to. + + After you send the request, the `state` of the identity domain in the replica region is set to ENABLING_REPLICATION. When the operation + completes, the `state` is set to REPLICATION_ENABLED. + + To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves + the operation's status. + operationId: EnableReplicationToRegion + parameters: + - $ref: '#/components/parameters/DomainIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnableReplicationToRegionDetails' + description: The request object for replicating the identity domain to another region. + required: true + responses: + '202': + description: The identity domain replication is starting. + 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](/Content/General/Concepts/identifiers.htm) of the work 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/DefaultError' + summary: Replicate identity domain to a new region + tags: + - identity + x-obmcs-get-work-request-operation: GetIamWorkRequest + x-related-resource: '#/definitions/Domain' + /dynamicGroups/: + get: + description: | + Lists the dynamic groups in your tenancy. You must specify your tenancy's OCID as the value for + the compartment ID (remember that the tenancy is simply the root compartment). + See [Where to Get the Tenancy's OCID and User's OCID](/Content/API/Concepts/apisigningkey.htm#five). + operationId: ListDynamicGroups + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/FilterByNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/DynamicGroup/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListDynamicGroupsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDynamicGroups + tags: + - identity + post: + description: | + Creates a new dynamic group in your tenancy. + + You must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy + is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies) + reside within the tenancy itself, unlike cloud resources such as compute instances, which typically + reside within compartments inside the tenancy. For information about OCIDs, see + [Resource Identifiers](/Content/General/Concepts/identifiers.htm). + + You must also specify a *name* for the dynamic group, which must be unique across all dynamic groups in your + tenancy, and cannot be changed. Note that this name has to be also unique across all groups in your tenancy. + You can use this name or the OCID when writing policies that apply to the dynamic group. For more information + about policies, see [How Policies Work](/Content/Identity/policieshow/how-policies-work.htm). + + You must also specify a *description* for the dynamic group (although it can be an empty string). It does not + have to be unique, and you can change it anytime with [UpdateDynamicGroup](#/en/identity/20160918/DynamicGroup/UpdateDynamicGroup). + + After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the + object, first make sure its `lifecycleState` has changed to ACTIVE. + operationId: CreateDynamicGroup + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateDynamicGroupDetails' + description: Request object for creating a new dynamic group. + required: true + responses: + '200': + description: The dynamic group is being created. + 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/DynamicGroup' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.group.oc1..aaaaaaaavpexampleuniqueID", + "compartmentId" : "ocid1.tenancy.oc1..aaaaaaaaba3pvexampleuniqueID", + "name" : "DevCompartmentDynamicGroup", + "description" : "Dynamic group for dev compartment", + "matchingRule": "instance.compartment.id=ocid1.compartment.oc1..aaaaaaaayd6exampleuniqueID", + "lifecycleState" : "ACTIVE", + "timeCreated" : "2016-11-18T22:01:40.936Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateDynamicGroup + tags: + - identity + x-example: | + POST /20160918/dynamicGroups/ + Host: identity.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.tenancy.oc1..aaaaaaaaba3pv6exampleuniqueID", + "description" : "Instance group for dev compartment", + "name" : "DevCompartmentDynamicGroup", + "matchingRule": "instance.compartment.id=ocid1.compartment.oc1..aaaaaaaayd6iexampleuniqueID" + } + /dynamicGroups/{dynamicGroupId}: + delete: + description: | + Deletes the specified dynamic group. + operationId: DeleteDynamicGroup + parameters: + - $ref: '#/components/parameters/DynamicGroupIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The dynamic group is being 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: DeleteDynamicGroup + tags: + - identity + get: + description: | + Gets the specified dynamic group's information. + operationId: GetDynamicGroup + parameters: + - $ref: '#/components/parameters/DynamicGroupIdPathParam' + responses: + '200': + description: The dynamic group was retrieved. + 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/DynamicGroup' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetDynamicGroup + tags: + - identity + put: + description: Updates the specified dynamic group. + operationId: UpdateDynamicGroup + parameters: + - $ref: '#/components/parameters/DynamicGroupIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateDynamicGroupDetails' + description: Request object for updating an dynamic group. + required: true + responses: + '200': + description: The dynamic group is being updated. + 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/DynamicGroup' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: UpdateDynamicGroup + tags: + - identity + /faultDomains/: + get: + description: | + Lists the Fault Domains in your tenancy. Specify the OCID of either the tenancy or another + of your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment). + See [Where to Get the Tenancy's OCID and User's OCID](/Content/API/Concepts/apisigningkey.htm#five). + operationId: ListFaultDomains + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListFaultDomainsResponse' + '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/DefaultError' + summary: ListFaultDomains + tags: + - identity + /groups/: + get: + description: | + Lists the groups in your tenancy. You must specify your tenancy's OCID as the value for + the compartment ID (remember that the tenancy is simply the root compartment). + See [Where to Get the Tenancy's OCID and User's OCID](/Content/API/Concepts/apisigningkey.htm#five). + operationId: ListGroups + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/FilterByNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/Group/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListGroupsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListGroups + tags: + - identity + post: + description: | + Creates a new group in your tenancy. + + You must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy + is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies) + reside within the tenancy itself, unlike cloud resources such as compute instances, which typically + reside within compartments inside the tenancy. For information about OCIDs, see + [Resource Identifiers](/Content/General/Concepts/identifiers.htm). + + You must also specify a *name* for the group, which must be unique across all groups in your tenancy and + cannot be changed. You can use this name or the OCID when writing policies that apply to the group. For more + information about policies, see [How Policies Work](/Content/Identity/policieshow/how-policies-work.htm). + + You must also specify a *description* for the group (although it can be an empty string). It does not + have to be unique, and you can change it anytime with [UpdateGroup](#/en/identity/20160918/Group/UpdateGroup). + + After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the + object, first make sure its `lifecycleState` has changed to ACTIVE. + + After creating the group, you need to put users in it and write policies for it. + See [AddUserToGroup](#/en/identity/20160918/UserGroupMembership/AddUserToGroup) and + [CreatePolicy](#/en/identity/20160918/Policy/CreatePolicy). + operationId: CreateGroup + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateGroupDetails' + description: Request object for creating a new group. + required: true + responses: + '200': + description: The group is being created. + 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/Group' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.group.oc1..aaaaaaaavp6exampleuniqueID", + "compartmentId" : "ocid1.tenancy.oc1..aaaaaaaaba3exampleuniqueID", + "name" : "NetworkAdmins", + "description" : "Group for network administrators", + "lifecycleState" : "ACTIVE", + "timeCreated" : "2016-11-18T22:01:40.936Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateGroup + tags: + - identity + x-example: | + POST /20160918/groups/ + Host: identity.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.tenancy.oc1..aaaaaaaaba3pvexampleuniqueID", + "description" : "Group for network administrators", + "name" : "NetworkAdmins" + } + /groups/{groupId}: + delete: + description: | + Deletes the specified group. The group must be empty. + operationId: DeleteGroup + parameters: + - $ref: '#/components/parameters/GroupIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The group is being 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: DeleteGroup + tags: + - identity + get: + description: | + Gets the specified group's information. + + This operation does not return a list of all the users in the group. To do that, use + [ListUserGroupMemberships](#/en/identity/20160918/UserGroupMembership/ListUserGroupMemberships) and + provide the group's OCID as a query parameter in the request. + operationId: GetGroup + parameters: + - $ref: '#/components/parameters/GroupIdPathParam' + responses: + '200': + description: The group was retrieved. + 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/Group' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetGroup + tags: + - identity + put: + description: Updates the specified group. + operationId: UpdateGroup + parameters: + - $ref: '#/components/parameters/GroupIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateGroupDetails' + description: Request object for updating a group. + required: true + responses: + '200': + description: The group is being updated. + 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/Group' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: UpdateGroup + tags: + - identity + /iamWorkRequests: + get: + description: | + Lists the IAM work requests in compartment. The workRequestID is returned in the opc-work-request-id header for any asynchronous operation in the Identity and Access Management service. + operationId: ListIamWorkRequests + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/ResourceIdentifierQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: A list of IAM work requests. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListIamWorkRequestsResponse' + '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/DefaultError' + summary: List IAM work requests + tags: + - identity + /iamWorkRequests/{iamWorkRequestId}: + get: + description: | + Gets the details of a specified IAM work request. The workRequestID is returned in the opc-work-request-id header for any asynchronous operation in the Identity and Access Management service. + operationId: GetIamWorkRequest + parameters: + - $ref: '#/components/parameters/IamWorkRequestIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: IAM Work request + 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/IamWorkRequest' + '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/DefaultError' + summary: Gets IAM work request + tags: + - identity + /iamWorkRequests/{iamWorkRequestId}/errors: + get: + description: | + Gets error details for a specified IAM work request. The workRequestID is returned in the opc-work-request-id header for any asynchronous operation in the Identity and Access Management service. + operationId: ListIamWorkRequestErrors + parameters: + - $ref: '#/components/parameters/IamWorkRequestIdPathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The list of work request errors. + 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/ListIamWorkRequestErrorsResponse' + '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/DefaultError' + summary: Lists work request errors + tags: + - identity + x-related-resource: '#/definitions/IamWorkRequest' + /iamWorkRequests/{iamWorkRequestId}/logs: + get: + description: | + Gets logs for a specified IAM work request. The workRequestID is returned in the opc-work-request-id header for any asynchronous operation in the Identity and Access Management service. + operationId: ListIamWorkRequestLogs + parameters: + - $ref: '#/components/parameters/IamWorkRequestIdPathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The list of IAM work request logs. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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 + retry-after: + description: | + The number of seconds that the client should wait before polling again. + schema: + type: number + format: float + content: + application/json: + schema: + $ref: '#/components/schemas/ListIamWorkRequestLogsResponse' + '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/DefaultError' + summary: List IAM workrequest logs + tags: + - identity + /idcsDomainServiceStatus: + get: + description: | + Internal API to get the IDCS domain service status, value being true specifies secondary domain can be created in + region being build , value being false signifies otherwise + operationId: GetIdcsDomainServiceStatus + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: Get IDCS Domain service status. + 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/IdcsDomainServiceStatusDetails' + '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/DefaultError' + summary: GetIdcsDomainServiceStatus + tags: + - identity + /identityProviders/: + get: + deprecated: true + description: | + **Deprecated.** For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm). + + Lists all the identity providers in your tenancy. You must specify the identity provider type (e.g., `SAML2` for + identity providers using the SAML2.0 protocol). You must specify your tenancy's OCID as the value for the + compartment ID (remember that the tenancy is simply the root compartment). + See [Where to Get the Tenancy's OCID and User's OCID](/Content/API/Concepts/apisigningkey.htm#five). + operationId: ListIdentityProviders + parameters: + - $ref: '#/components/parameters/IdentityProviderProtocolQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/FilterByNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/IdentityProvider/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListIdentityProvidersResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListIdentityProviders + tags: + - identity + post: + deprecated: true + description: | + **Deprecated.** For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm). + + Creates a new identity provider in your tenancy. For more information, see + [Identity Providers and Federation](/Content/Identity/Concepts/federation.htm). + + You must specify your tenancy's OCID as the compartment ID in the request object. + Remember that the tenancy is simply the root compartment. For information about + OCIDs, see [Resource Identifiers](/Content/General/Concepts/identifiers.htm). + + You must also specify a *name* for the `IdentityProvider`, which must be unique + across all `IdentityProvider` objects in your tenancy and cannot be changed. + + You must also specify a *description* for the `IdentityProvider` (although + it can be an empty string). It does not have to be unique, and you can change + it anytime with + [UpdateIdentityProvider](#/en/identity/20160918/IdentityProvider/UpdateIdentityProvider). + + After you send your request, the new object's `lifecycleState` will temporarily + be CREATING. Before using the object, first make sure its `lifecycleState` has + changed to ACTIVE. + operationId: CreateIdentityProvider + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateIdentityProviderDetails' + description: Request object for creating a new SAML2 identity provider. + required: true + responses: + '200': + description: The identity provider is being created. + 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/IdentityProvider' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateIdentityProvider + tags: + - identity + /identityProviders/{identityProviderId}: + delete: + deprecated: true + description: | + **Deprecated.** For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm). + + Deletes the specified identity provider. The identity provider must not have + any group mappings (see [IdpGroupMapping](#/en/identity/20160918/IdpGroupMapping/)). + operationId: DeleteIdentityProvider + parameters: + - $ref: '#/components/parameters/IdentityProviderIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The identity provider is being 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: DeleteIdentityProvider + tags: + - identity + get: + deprecated: true + description: | + **Deprecated.** For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm). + + Gets the specified identity provider's information. + operationId: GetIdentityProvider + parameters: + - $ref: '#/components/parameters/IdentityProviderIdPathParam' + responses: + '200': + description: The user was found. + 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/IdentityProvider' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetIdentityProvider + tags: + - identity + put: + deprecated: true + description: | + **Deprecated.** For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm). + + Updates the specified identity provider. + operationId: UpdateIdentityProvider + parameters: + - $ref: '#/components/parameters/IdentityProviderIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateIdentityProviderDetails' + description: Request object for updating a identity provider. + required: true + responses: + '200': + description: The identity provider is being updated. + 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/IdentityProvider' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: UpdateIdentityProvider + tags: + - identity + /identityProviders/{identityProviderId}/actions/resetScimClient/: + post: + description: | + Resets the OAuth2 client credentials for the SCIM client associated with this identity provider. + operationId: ResetIdpScimClient + parameters: + - $ref: '#/components/parameters/IdentityProviderIdPathParam' + responses: + '200': + description: The client credentials were reset successfully. + 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/ScimClientCredentials' + '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/DefaultError' + summary: ResetIdpScimClient + tags: + - identity + /identityProviders/{identityProviderId}/groupMappings/: + get: + deprecated: true + description: | + **Deprecated.** For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm). + + Lists the group mappings for the specified identity provider. + operationId: ListIdpGroupMappings + parameters: + - $ref: '#/components/parameters/IdentityProviderIdPathParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + responses: + '200': + description: The list is being retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListIdpGroupMappingsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListIdpGroupMappings + tags: + - identity + post: + deprecated: true + description: | + **Deprecated.** For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm). + + Creates a single mapping between an IdP group and an IAM Service + [group](#/en/identity/20160918/Group/). + operationId: CreateIdpGroupMapping + parameters: + - $ref: '#/components/parameters/IdentityProviderIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateIdpGroupMappingDetails' + description: Add a mapping from an SAML2.0 identity provider group to a BMC group. + required: true + responses: + '200': + description: The mapping is being created. + 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/IdpGroupMapping' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateIdpGroupMapping + tags: + - identity + /identityProviders/{identityProviderId}/groupMappings/{mappingId}: + delete: + deprecated: true + description: | + **Deprecated.** For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm). + + Deletes the specified group mapping. + operationId: DeleteIdpGroupMapping + parameters: + - $ref: '#/components/parameters/IdentityProviderIdPathParam' + - $ref: '#/components/parameters/IdpGroupMappingIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The mapping is being 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: DeleteIdpGroupMapping + tags: + - identity + get: + deprecated: true + description: | + **Deprecated.** For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm). + + Gets the specified group mapping. + operationId: GetIdpGroupMapping + parameters: + - $ref: '#/components/parameters/IdentityProviderIdPathParam' + - $ref: '#/components/parameters/IdpGroupMappingIdPathParam' + responses: + '200': + description: The mapping is being retrieved. + 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/IdpGroupMapping' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetIdpGroupMapping + tags: + - identity + put: + deprecated: true + description: | + **Deprecated.** For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm). + + Updates the specified group mapping. + operationId: UpdateIdpGroupMapping + parameters: + - $ref: '#/components/parameters/IdentityProviderIdPathParam' + - $ref: '#/components/parameters/IdpGroupMappingIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateIdpGroupMappingDetails' + description: Request object for updating an identity provider group mapping + required: true + responses: + '200': + description: The identity provider is being updated. + 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/IdpGroupMapping' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: UpdateIdpGroupMapping + tags: + - identity + /identityProviders/{identityProviderId}/groups/: + get: + deprecated: true + description: | + **Deprecated.** For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm). + + Lists the identity provider groups. + operationId: ListIdentityProviderGroups + parameters: + - $ref: '#/components/parameters/IdentityProviderIdPathParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/FilterByNameQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/IdentityProvider/lifecycleState' + schema: + type: string + responses: + '200': + description: The identity provider groups are being retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListIdentityProviderGroupsResponse' + '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/DefaultError' + summary: Gets the identity provider groups. + tags: + - identity + /networkSources: + get: + description: | + Lists the network sources in your tenancy. You must specify your tenancy's OCID as the value for + the compartment ID (remember that the tenancy is simply the root compartment). + See [Where to Get the Tenancy's OCID and User's OCID](/Content/API/Concepts/apisigningkey.htm#five). + operationId: ListNetworkSources + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/FilterByNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/NetworkSources/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListNetworkSourcesResponse' + '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/DefaultError' + summary: ListNetworkSources + tags: + - identity + post: + description: | + Creates a new network source in your tenancy. + + You must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy + is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies) + reside within the tenancy itself, unlike cloud resources such as compute instances, which typically + reside within compartments inside the tenancy. For information about OCIDs, see + [Resource Identifiers](/Content/General/Concepts/identifiers.htm). + + You must also specify a *name* for the network source, which must be unique across all network sources in your + tenancy, and cannot be changed. + You can use this name or the OCID when writing policies that apply to the network source. For more information + about policies, see [How Policies Work](/Content/Identity/policieshow/how-policies-work.htm). + + You must also specify a *description* for the network source (although it can be an empty string). It does not + have to be unique, and you can change it anytime with [UpdateNetworkSource](#/en/identity/20160918/NetworkSource/UpdateNetworkSource). + + After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the + object, first make sure its `lifecycleState` has changed to ACTIVE. + + After your network resource is created, you can use it in policy to restrict access to only requests made from an allowed + IP address specified in your network source. For more information, see [Managing Network Sources](/Content/Identity/Tasks/managingnetworksources.htm). + operationId: CreateNetworkSource + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateNetworkSourceDetails' + description: Request object for creating a new network source. + required: true + responses: + '200': + description: The network source is being created. + 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/NetworkSources' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.networksource.oc1..aaaaaaaavp6jexampleuniqueID4q", + "compartmentId" : "ocid1.tenancy.oc1..aaaaaaaabbbbexampleuniqueIDdsq", + "name" : "corpnet", + "description" : "Network source for corporate network", + "allowedSources": + [ + "virtualSourceList": [{"vcnId": "ocid1.vcn.oc1.iad.aaaaaaaaozfexampleuniqueIDgcq", "ipRanges": [ "129.213.39.0/24" ]}], + "publicSourceList": [ "128.2.13.5", "128.2.14.0/24" ] + ] + "lifecycleState" : "CREATING", + "timeCreated" : "2016-11-18T22:01:40.936Z" + } + '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/DefaultError' + summary: CreateNetworkSource + tags: + - identity + x-example: | + POST /20160918/networkSources/ + Host: identity.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.tenancy.oc1..aaaaaaaaba3exampleuniqueIDdsq", + "description" : "corporate ip ranges to be used for ip based authorization", + "name" : "corpnet", + "virtualSourceList": + [ + {"vcnId": "ocid1.vcn.oc1.iad.aaaaaaaaozexampleuniqueID6wcgcq", "ipRanges": [ "129.213.39.0/24" ]} + ], + "publicSourceList": [ "128.2.13.5", "128.2.13.6" ], + "services": ["all"] + } + /networkSources/{networkSourceId}: + delete: + description: | + Deletes the specified network source. + operationId: DeleteNetworkSource + parameters: + - $ref: '#/components/parameters/NetworkSourceIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The network source is being 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 + '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/DefaultError' + summary: DeleteNetworkSource + tags: + - identity + x-related-resource: '#/definitions/NetworkSources' + get: + description: | + Gets the specified network source's information. + operationId: GetNetworkSource + parameters: + - $ref: '#/components/parameters/NetworkSourceIdPathParam' + responses: + '200': + description: The network source was retrieved. + 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/NetworkSources' + '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/DefaultError' + summary: GetNetworkSource + tags: + - identity + put: + description: | + Updates the specified network source. + operationId: UpdateNetworkSource + parameters: + - $ref: '#/components/parameters/NetworkSourceIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateNetworkSourceDetails' + description: Request object for updating a network source. + required: true + responses: + '200': + description: The network source is being updated. + 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/NetworkSources' + '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/DefaultError' + summary: UpdateNetworkSource + tags: + - identity + /policies/: + get: + description: | + Lists the policies in the specified compartment (either the tenancy or another of your compartments). + See [Where to Get the Tenancy's OCID and User's OCID](/Content/API/Concepts/apisigningkey.htm#five). + + To determine which policies apply to a particular group or compartment, you must view the individual + statements inside all your policies. There isn't a way to automatically obtain that information via the API. + operationId: ListPolicies + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/FilterByNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/Policy/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListPoliciesResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListPolicies + tags: + - identity + post: + description: | + Creates a new policy in the specified compartment (either the tenancy or another of your compartments). + If you're new to policies, see [Get Started with Policies](/Content/Identity/policiesgs/get-started-with-policies.htm). + + You must specify a *name* for the policy, which must be unique across all policies in your tenancy + and cannot be changed. + + You must also specify a *description* for the policy (although it can be an empty string). It does not + have to be unique, and you can change it anytime with [UpdatePolicy](#/en/identity/20160918/Policy/UpdatePolicy). + + You must specify one or more policy statements in the statements array. For information about writing + policies, see [How Policies Work](/Content/Identity/policieshow/how-policies-work.htm) and + [Common Policies](/Content/Identity/policiescommon/commonpolicies.htm). + + After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the + object, first make sure its `lifecycleState` has changed to ACTIVE. + + New policies take effect typically within 10 seconds. + operationId: CreatePolicy + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePolicyDetails' + description: Request object for creating a new policy. + required: true + responses: + '200': + description: The policy is being created. + 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/Policy' + application-json: + examples: + response: + value: | + { + "statements" : + [ + "Allow group InstanceLaunchers to manage instance-family in compartment ABC", + "Allow group InstanceLaunchers to use volume-family in compartment ABC", + "Allow group InstanceLaunchers to use virtual-network-family in compartment XYZ" + ], + "id" : "ocid1.policy.oc1..aaaaaaaauzkexampleuniqueID", + "compartmentId" : "ocid1.tenancy.oc1..aaaaaaaabaexampleuniqueID", + "name" : "LaunchInstances", + "description" : "Policy for users who need to launch instances, attach volumes, manage images", + "lifecycleState" : "ACTIVE", + "timeCreated" : "2016-12-07T00:49:14.807Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreatePolicy + tags: + - identity + x-example: | + POST /20160918/policies/ + Host: identity.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.tenancy.oc1..aaaaaaaaba3pexampleuniqueID", + "description" : "Policy for users who need to launch instances, attach volumes, manage images", + "name" : "LaunchInstances", + "statements": + [ + "Allow group InstanceLaunchers to manage instance-family in compartment ABC", + "Allow group InstanceLaunchers to use volume-family in compartment ABC", + "Allow group InstanceLaunchers to use virtual-network-family in compartment Network" + ] + } + /policies/{policyId}: + delete: + description: Deletes the specified policy. The deletion takes effect typically within 10 seconds. + operationId: DeletePolicy + parameters: + - $ref: '#/components/parameters/PolicyIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OverrideLocksQueryParameter' + responses: + '204': + description: The policy is being 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: DeletePolicy + tags: + - identity + get: + description: Gets the specified policy's information. + operationId: GetPolicy + parameters: + - $ref: '#/components/parameters/PolicyIdPathParam' + responses: + '200': + description: The policy was retrieved. + 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/Policy' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetPolicy + tags: + - identity + put: + description: | + Updates the specified policy. You can update the description or the policy statements themselves. + + Policy changes take effect typically within 10 seconds. + operationId: UpdatePolicy + parameters: + - $ref: '#/components/parameters/PolicyIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OverrideLocksQueryParameter' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePolicyDetails' + description: Request object for updating a policy. + required: true + responses: + '200': + description: The policy was updated. + 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/Policy' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: UpdatePolicy + tags: + - identity + /policies/{policyId}/actions/addLock: + post: + description: | + Add a resource lock to a tag namespace. + operationId: AddPolicyLock + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/PolicyIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddPolicyLockDetails' + description: Lock that is going to be added to resource + required: true + responses: + '200': + description: Lock is added + 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/Policy' + '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/DefaultError' + summary: Add a resource lock to a policy + tags: + - identity + x-related-resource: '#/definitions/Policy' + /policies/{policyId}/actions/removeLock: + post: + description: | + Remove a resource lock to a policy + operationId: RemovePolicyLock + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/PolicyIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemovePolicyLockDetails' + description: Lock that is going to be removed from resource + required: true + responses: + '200': + description: Lock is removed + 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/Policy' + '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/DefaultError' + summary: Remove a resource lock to a policy + tags: + - identity + x-related-resource: '#/definitions/Policy' + /regions: + get: + description: Lists all the regions offered by Oracle Cloud Infrastructure. + operationId: ListRegions + responses: + '200': + description: The list is being retrieved. + 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/ListRegionsResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListRegions + tags: + - identity + /tagDefaults: + get: + description: | + Lists the tag defaults for tag definitions in the specified compartment. + operationId: ListTagDefaults + parameters: + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/FilterByIdQueryParam' + - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' + - $ref: '#/components/parameters/OptionalTagDefinitionIdQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/TagDefaultSummary/lifecycleState' + schema: + type: string + responses: + '200': + description: The list of tag default values. + headers: + opc-next-page: + description: | + For pagination of a list of tag default values. When paging through a list, if this header appears in + the response, then a partial list might have been returned. Include this value as the `page` parameter + for the subsequent GET request to get the next batch of items. + 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/ListTagDefaultsResponse' + application-json: + examples: + response: + value: | + [ + { + "id" : "ocid1.tagdefault.oc1..aaaaaaaasexampleuniqueID", + "compartmentId" : "ocid1.compartment.oc1..aaaaaaaaexampleuniqueID", + "tagNamespaceId" : "ocid1.namespace.oc1..aaaaaaaaexampleuniqueID", + "tagDefinitionId" : "ocid1.tagdefinition.oc1..aaaaaaaaexampleuniqueID", + "tagDefinitionName" : "Finance", + "value" : "W123", + "timeCreated" : "2018-11-22T19:00:00.000Z", + "lifecycleState" : "ACTIVE", + "isRequired" : "true" + }, + { + "id" : "ocid1.tagdefault.oc1..aaaaaaaasexampleuniqueID", + "compartmentId" : "ocid1.compartment.oc1..aaaaaaaaexampleuniqueID", + "tagNamespaceId" : "ocid1.namespace.oc1..aaaaaaaaexampleuniqueID", + "tagDefinitionId" : "ocid1.tagdefinition.oc1..aaaaaaaasexampleuniqueID", + "tagDefinitionName" : "Operations", + "value" : "Dept42", + "timeCreated" : "2018-11-22T20:00:00.000Z", + "lifecycleState" : "ACTIVE", + "isRequired" : "false" + } + ] + '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/DefaultError' + summary: ListTagDefaults + tags: + - identity + x-example: | + GET /20160918/tagDefaults?compartmentId=ocid1.compartment.oc1..aaaaaaaamexampleuniqueID + Host: identity.us-phoenix-1.oraclecloud.com + <authorization and other headers> + post: + description: | + Creates a new tag default in the specified compartment for the specified tag definition. + + If you specify that a value is required, a value is set during resource creation (either by + the user creating the resource or another tag defualt). If no value is set, resource creation + is blocked. + + * If the `isRequired` flag is set to "true", the value is set during resource creation. + * If the `isRequired` flag is set to "false", the value you enter is set during resource creation. + operationId: CreateTagDefault + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTagDefaultDetails' + description: Request object for creating a new tag default. + required: true + responses: + '200': + description: The tag default has been created. + 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/TagDefault' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.tagdefault.oc1..aaaaaaaashexampleuniqueID", + "compartmentId" : "ocid1.compartment.oc1..aaaaaaaaexampleuniqueID", + "tagNamespaceId" : "ocid1.namespace.oc1..aaaaaaaasexampleuniqueID", + "tagDefinitionId" : "ocid1.tagdefinition.oc1..aaaaaaaash5exampleuniqueID", + "tagDefinitionName" : "Finance", + "value" : "W123", + "timeCreated" : "2018-11-22T19:00:00.000Z", + "lifecycleState" : "ACTIVE", + "isRequired" : "true" + } + '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/DefaultError' + summary: CreateTagDefault + tags: + - identity + x-example: | + POST /20160918/tagDefaults + Host: identity.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.compartment.oc1..aaaaaaaaexampleuniqueID", + "tagDefinitionId" : "ocid1.tagdefinition.oc1..aaaaaaaaexampleuniqueID", + "value" : "W123", + "isRequired" : "true" + } + /tagDefaults/actions/assembleEffectiveTagSet: + get: + description: | + Assembles tag defaults in the specified compartment and any parent compartments to determine + the tags to apply. Tag defaults from parent compartments do not override tag defaults + referencing the same tag in a compartment lower down the hierarchy. This set of tag defaults + includes all tag defaults from the current compartment back to the root compartment. + operationId: AssembleEffectiveTagSet + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/TagDefaultSummary/lifecycleState' + schema: + type: string + responses: + '200': + description: The list of tag defaults. + headers: + opc-next-page: + description: | + For pagination of a list of tag default values. When paging through a list, if this header appears in + the response, then a partial list might have been returned. Include this value as the `page` parameter + for the subsequent GET request to get the next batch of items. + 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/AssembleEffectiveTagSetResponse' + application-json: + examples: + response: + value: | + [ + { + "id" : "ocid1.tagdefault.oc1..aaaaaaaasexampleuniqueID", + "compartmentId" : "ocid1.compartment.oc1..aaaaaaaaexampleuniqueID", + "tagNamespaceId" : "ocid1.namespace.oc1..aaaaaaaaexampleuniqueID", + "tagDefinitionId" : "ocid1.tagdefinition.oc1..aaaaaaaaexampleuniqueID", + "tagDefinitionName" : "Finance", + "value" : "W123", + "timeCreated" : "2018-11-22T19:00:00.000Z", + "lifecycleState" : "ACTIVE", + "isRequired" : "true" + }, + { + "id" : "ocid1.tagdefault.oc1..aaaaaaaasexampleuniqueID", + "compartmentId" : "ocid1.compartment.oc1..aaaaaaaaexampleuniqueID", + "tagNamespaceId" : "ocid1.namespace.oc1..aaaaaaaaexampleuniqueID", + "tagDefinitionId" : "ocid1.tagdefinition.oc1..aaaaaaaasexampleuniqueID", + "tagDefinitionName" : "Operations", + "value" : "Dept42", + "timeCreated" : "2018-11-22T20:00:00.000Z", + "lifecycleState" : "ACTIVE", + "isRequired" : "false" + } + ] + '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/DefaultError' + summary: AssembleEffectiveTagSet + tags: + - identity + x-example: | + GET /20160918/tagDefaults/actions/assembleEffectiveTagSet?compartmentId=ocid1.compartment.oc1..aaaaaaaamexampleuniqueID + Host: identity.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/TagDefault' + /tagDefaults/{tagDefaultId}: + delete: + description: | + Deletes the the specified tag default. + operationId: DeleteTagDefault + parameters: + - $ref: '#/components/parameters/TagDefaultIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OverrideLocksQueryParam' + responses: + '204': + description: The tag default was 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 + '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/DefaultError' + summary: DeleteTagDefault + tags: + - identity + x-related-resource: '#/definitions/TagDefault' + get: + description: | + Retrieves the specified tag default. + operationId: GetTagDefault + parameters: + - $ref: '#/components/parameters/TagDefaultIdPathParam' + responses: + '200': + description: The tag default was retrieved. + 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/TagDefault' + '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/DefaultError' + summary: GetTagDefault + tags: + - identity + put: + description: | + Updates the specified tag default. If you specify that a value is required, a value is set + during resource creation (either by the user creating the resource or another tag defualt). + If no value is set, resource creation is blocked. + + * If the `isRequired` flag is set to "true", the value is set during resource creation. + * If the `isRequired` flag is set to "false", the value you enter is set during resource creation. + operationId: UpdateTagDefault + parameters: + - $ref: '#/components/parameters/TagDefaultIdPathParam' + - $ref: '#/components/parameters/OverrideLocksQueryParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateTagDefaultDetails' + description: Request object for updating a tag default. + required: true + responses: + '200': + description: The tag default was updated. + 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/TagDefault' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.tagdefault.oc1..aaaaaaaaexampleuniqueID", + "compartmentId" : "ocid1.compartment.oc1..aaaaaaaaexampleuniqueID", + "tagNamespaceId" : "ocid1.namespace.oc1..aaaaaaaasexampleuniqueID", + "tagDefinitionId" : "ocid1.tagdefinition.oc1..aaaaaaaasexampleuniqueID", + "tagDefinitionName" : "Finance", + "value" : "W123", + "timeCreated" : "2018-11-22T19:00:00.000Z", + "lifecycleState" : "ACTIVE", + "isRequired" : "false" + } + '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/DefaultError' + summary: UpdateTagDefault + tags: + - identity + x-example: | + PUT /20160918/tagDefaults/ocid1.tagdefault.oc1..aaaaaaaasexampleuniqueID + Host: identity.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "value" : "W123", + "isRequired" : "true" + } + /tagDefaults/{tagDefaultId}/actions/addLock: + post: + description: | + Add a resource lock to a tag default. + operationId: AddTagDefaultLock + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/TagDefaultIdPathParam' + requestBody: + $ref: '#/components/requestBodies/AddLockDetails' + responses: + '200': + description: Lock is added + headers: + etag: + schema: + type: string + opc-request-id: + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/TagDefault' + '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/DefaultError' + summary: Add a resource lock to a tag default + tags: + - identity + x-related-resource: '#/definitions/TagDefault' + /tagDefaults/{tagDefaultId}/actions/removeLock: + post: + description: | + Remove a resource lock from a tag default. + operationId: RemoveTagDefaultLock + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/TagDefaultIdPathParam' + requestBody: + $ref: '#/components/requestBodies/RemoveLockDetails' + responses: + '200': + description: Lock is removed + headers: + etag: + schema: + type: string + opc-request-id: + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/TagDefault' + '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/DefaultError' + summary: Remove a resource lock from a tag default + tags: + - identity + x-related-resource: '#/definitions/TagDefault' + /tagNamespaces: + get: + description: | + Lists the tag namespaces in the specified compartment. + operationId: ListTagNamespaces + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - description: | + An optional boolean parameter indicating whether to retrieve all tag namespaces in subcompartments. If this + parameter is not specified, only the tag namespaces defined in the specified compartment are retrieved. + in: query + name: includeSubcompartments + required: false + schema: + type: boolean + - description: | + A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/TagNamespace/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of tagNamespaces. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListTagNamespacesResponse' + '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/DefaultError' + summary: ListTagNamespaces + tags: + - identity + post: + description: | + Creates a new tag namespace in the specified compartment. + + You must specify the compartment ID in the request object (remember that the tenancy is simply the root + compartment). + + You must also specify a *name* for the namespace, which must be unique across all namespaces in your tenancy + and cannot be changed. The name can contain any ASCII character except the space (_) or period (.). + Names are case insensitive. That means, for example, "myNamespace" and "mynamespace" are not allowed + in the same tenancy. Once you created a namespace, you cannot change the name. + If you specify a name that's already in use in the tenancy, a 409 error is returned. + + You must also specify a *description* for the namespace. + It does not have to be unique, and you can change it with + [UpdateTagNamespace](#/en/identity/latest/TagNamespace/UpdateTagNamespace). + operationId: CreateTagNamespace + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTagNamespaceDetails' + description: Request object for creating a new tag namespace. + required: true + responses: + '200': + description: The tagNamespace is being created. + 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/TagNamespace' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.namespace.oc1..aaaaaaaaqexampleuniqueID", + "compartmentId" : "ocid1.tenancy.oc1..aaaaaaaabaexampleuniqueID", + "name" : "BillingTags", + "description" : "This namespace contains tags that will be used in billing.", + "isRetired" : "false", + "lifecycleState" : "ACTIVE", + "timeCreated" : "2017-09-01T18:13:12.210Z" + } + '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/DefaultError' + summary: CreateTagNamespace + tags: + - identity + x-example: | + POST /20160918/tagNamespaces/ + Host: identity.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.tenancy.oc1..aaaaaaaabaexampleuniqueID", + "name" : "BillingTags", + "description" : "This namespace contains tags that will be used in billing.", + } + /tagNamespaces/actions/listCostTrackingTags: + get: + description: | + Lists all the tags enabled for cost-tracking in the specified tenancy. For information about + cost-tracking tags, see [Using Cost-tracking Tags](/Content/Tagging/Tasks/usingcosttrackingtags.htm). + operationId: ListCostTrackingTags + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + responses: + '200': + description: List of cost tracking tags defined in the compartment + headers: + opc-next-page: + description: | + For pagination of a list of cost tracking tag. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. 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/ListCostTrackingTagsResponse' + '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/DefaultError' + summary: ListCostTrackingTags + tags: + - identity + /tagNamespaces/{tagNamespaceId}: + delete: + description: | + Deletes the specified tag namespace. Only an empty tag namespace can be deleted with this operation. To use this operation + to delete a tag namespace that contains tag definitions, first delete all of its tag definitions. + + Use [CascadeDeleteTagNamespace](#/en/identity/20160918/TagNamespace/CascadeDeleteTagNamespace) to delete a tag namespace along with all of + the tag definitions contained within that namespace. + + Use [DeleteTag](#/en/identity/latest/Tag/DeleteTag) to delete a tag definition. + operationId: DeleteTagNamespace + parameters: + - $ref: '#/components/parameters/TagNamespaceIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/OverrideLocksQueryParam' + responses: + '204': + description: The tag namespace has successfully been 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 + '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/DefaultError' + summary: DeleteTagNamespace + tags: + - identity + x-example: | + DELETE /20160918/tagNamespaces/<tagNamespace_OCID> + Host: identity.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/TagNamespace' + get: + description: | + Gets the specified tag namespace's information. + operationId: GetTagNamespace + parameters: + - $ref: '#/components/parameters/TagNamespaceIdPathParam' + responses: + '200': + description: The tagNamespace was retrieved. + 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/TagNamespace' + '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/DefaultError' + summary: GetTagNamespace + tags: + - identity + put: + description: | + Updates the the specified tag namespace. You can't update the namespace name. + + Updating `isRetired` to 'true' retires the namespace and all the tag definitions in the namespace. Reactivating a + namespace (changing `isRetired` from 'true' to 'false') does not reactivate tag definitions. + To reactivate the tag definitions, you must reactivate each one individually *after* you reactivate the namespace, + using [UpdateTag](#/en/identity/20160918/Tag/UpdateTag). For more information about retiring tag namespaces, see + [Retiring Key Definitions and Namespace Definitions](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm#retiringkeys). + + You can't add a namespace with the same name as a retired namespace in the same tenancy. + operationId: UpdateTagNamespace + parameters: + - $ref: '#/components/parameters/TagNamespaceIdPathParam' + - $ref: '#/components/parameters/OverrideLocksQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateTagNamespaceDetails' + description: Request object for updating a namespace. + required: true + responses: + '200': + description: The tagNamespace was 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 + content: + application/json: + schema: + $ref: '#/components/schemas/TagNamespace' + '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/DefaultError' + summary: UpdateTagNamespace + tags: + - identity + /tagNamespaces/{tagNamespaceId}/actions/addLock: + post: + description: | + Add a resource lock to a tag namespace. + operationId: AddTagNamespaceLock + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/TagNamespaceIdPathParam' + requestBody: + $ref: '#/components/requestBodies/AddLockDetails' + responses: + '200': + description: Lock is added + headers: + etag: + schema: + type: string + opc-request-id: + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/TagNamespace' + '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/DefaultError' + summary: Add a resource lock to a tag namespace + tags: + - identity + x-related-resource: '#/definitions/TagNamespace' + /tagNamespaces/{tagNamespaceId}/actions/cascadeDelete: + post: + description: | + Deletes the specified tag namespace. This operation triggers a process that removes all of the tags + defined in the specified tag namespace from all resources in your tenancy and then deletes the tag namespace. + + After you start the delete operation: + + * New tag key definitions cannot be created under the namespace. + * The state of the tag namespace changes to DELETING. + * Tag removal from the resources begins. + + This process can take up to 48 hours depending on the number of tag definitions in the namespace, the number of resources + that are tagged, and the locations of the regions in which those resources reside. + + After all tags are removed, the state changes to DELETED. You cannot restore a deleted tag namespace. After the deleted tag namespace + changes its state to DELETED, you can use the name of the deleted tag namespace again. + + After you start this operation, you cannot start either the [DeleteTag](#/en/identity/20160918/Tag/DeleteTag) or the [BulkDeleteTags](#/en/identity/20160918/Tag/BulkDeleteTags) operation until this process completes. + + To delete a tag namespace, you must first retire it. Use [UpdateTagNamespace](#/en/identity/20160918/TagNamespace/UpdateTagNamespace) + to retire a tag namespace. + operationId: CascadeDeleteTagNamespace + parameters: + - $ref: '#/components/parameters/TagNamespaceIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OverrideLocksQueryParam' + responses: + '202': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work 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/DefaultError' + summary: Delete tag namespace that contains tags + tags: + - identity + x-example: | + POST /tagNamespaces/<tagNamespace_OCID>/actions/cascadeDelete/ + Host: identity.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-get-work-request-operation: GetTaggingWorkRequest + x-related-resource: '#/definitions/TagNamespace' + /tagNamespaces/{tagNamespaceId}/actions/changeCompartment: + post: + description: | + Moves the specified tag namespace to the specified compartment within the same tenancy. + + To move the tag namespace, you must have the manage tag-namespaces permission on both compartments. + For more information about IAM policies, see [Details for IAM](/Content/Identity/policyreference/iampolicyreference.htm). + + Moving a tag namespace moves all the tag key definitions contained in the tag namespace. + operationId: ChangeTagNamespaceCompartment + parameters: + - $ref: '#/components/parameters/TagNamespaceIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OverrideLocksQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeTagNamespaceCompartmentDetail' + description: Request object for changing the compartment of a tag namespace. + required: true + responses: + '204': + description: The compartment of the tag namespace was changed. + 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 + '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/DefaultError' + summary: changes compartment of a tag namespace. + tags: + - identity + x-related-resource: '#/definitions/TagNamespace' + /tagNamespaces/{tagNamespaceId}/actions/removeLock: + post: + description: | + Remove a resource lock from a tag namespace. + operationId: RemoveTagNamespaceLock + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/TagNamespaceIdPathParam' + requestBody: + $ref: '#/components/requestBodies/RemoveLockDetails' + responses: + '200': + description: Lock is removed + headers: + etag: + schema: + type: string + opc-request-id: + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/TagNamespace' + '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/DefaultError' + summary: Remove a resource lock from a tag namespace + tags: + - identity + x-related-resource: '#/definitions/TagNamespace' + /tagNamespaces/{tagNamespaceId}/tags: + get: + description: | + Lists the tag definitions in the specified tag namespace. + operationId: ListTags + parameters: + - $ref: '#/components/parameters/TagNamespaceIdPathParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/Tag/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of tags. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListTagsResponse' + '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/DefaultError' + summary: ListTags + tags: + - identity + post: + description: | + Creates a new tag in the specified tag namespace. + + The tag requires either the OCID or the name of the tag namespace that will contain this + tag definition. + + You must specify a *name* for the tag, which must be unique across all tags in the tag namespace + and cannot be changed. The name can contain any ASCII character except the space (_) or period (.) characters. + Names are case insensitive. That means, for example, "myTag" and "mytag" are not allowed in the same namespace. + If you specify a name that's already in use in the tag namespace, a 409 error is returned. + + The tag must have a *description*. It does not have to be unique, and you can change it with + [UpdateTag](#/en/identity/latest/Tag/UpdateTag). + + The tag must have a value type, which is specified with a validator. Tags can use either a + static value or a list of possible values. Static values are entered by a user applying the tag + to a resource. Lists are created by you and the user must apply a value from the list. Lists + are validiated. + + * If no `validator` is set, the user applying the tag to a resource can type in a static + value or leave the tag value empty. + * If a `validator` is set, the user applying the tag to a resource must select from a list + of values that you supply with [EnumTagDefinitionValidator](#/en/identity/latest/datatypes/EnumTagDefinitionValidator). + operationId: CreateTag + parameters: + - $ref: '#/components/parameters/TagNamespaceIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OverrideLocksQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTagDetails' + description: Request object for creating a new tag in the specified tag namespace. + required: true + responses: + '200': + description: The tag is being created. + 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/Tag' + application-json: + examples: + response: + value: | + { + "name" : "CostCenter", + "description" : "This tag will show the cost center that will be used for billing of associated resources.", + "type" : "string", + "tagNamespaceId" : "ocid1.namespace.oc1..aaaaaaaaqexampleuniqueID", + "tagNameSpaceName" : "BillingTags", + "compartmentId" : "ocid1.tenancy.oc1..aaaaaaaabaexampleuniqueID", + "isRetired" : "false", + "lifecycleState" : "ACTIVE", + "timeCreated" : "2017-09-01T18:13:12.210Z", + "isCostTracking" : "true", + "validator" : {} + } + '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/DefaultError' + summary: CreateTag + tags: + - identity + x-example: | + POST /20160918/tagNamespaces/ocid1.tagnamespace.oc1..aaaaaaaabaexampleuniqueID/tags + Host: identity.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "name" : "CostCenter", + "description" : "This tag will show the cost center that will be used for billing of associated resources.", + "type" : "string" + } + /tagNamespaces/{tagNamespaceId}/tags/{tagName}: + delete: + description: | + Deletes the specified tag definition. This operation triggers a process that removes the + tag from all resources in your tenancy. + + These things happen immediately: + * If the tag was a cost-tracking tag, it no longer counts against your 10 cost-tracking + tags limit, whether you first disabled it or not. + * If the tag was used with dynamic groups, none of the rules that contain the tag will + be evaluated against the tag. + + When you start the delete operation, the state of the tag changes to DELETING and tag removal + from resources begins. This can take up to 48 hours depending on the number of resources that + were tagged as well as the regions in which those resources reside. + + When all tags have been removed, the state changes to DELETED. You cannot restore a deleted tag. Once the deleted tag + changes its state to DELETED, you can use the same tag name again. + + After you start this operation, you cannot start either the [BulkDeleteTags](#/en/identity/20160918/Tag/BulkDeleteTags) or the [CascadeDeleteTagNamespace](#/en/identity/20160918/TagNamespace/CascadeDeleteTagNamespace) operation until this process completes. + + To delete a tag, you must first retire it. Use [UpdateTag](#/en/identity/latest/Tag/UpdateTag) + to retire a tag. + operationId: DeleteTag + parameters: + - $ref: '#/components/parameters/TagNamespaceIdPathParam' + - $ref: '#/components/parameters/TagNamePathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OverrideLocksQueryParam' + responses: + '202': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteTag + tags: + - identity + x-example: | + DELETE /20160918/tagNamespaces/<tagNamespace_OCID>/tags/<TagName> + Host: identity.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-get-work-request-operation: GetTaggingWorkRequest + x-related-resource: '#/definitions/Tag' + get: + description: Gets the specified tag's information. + operationId: GetTag + parameters: + - $ref: '#/components/parameters/TagNamespaceIdPathParam' + - $ref: '#/components/parameters/TagNamePathParam' + responses: + '200': + description: The tag was retrieved. + 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/Tag' + '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/DefaultError' + summary: GetTag + tags: + - identity + put: + description: | + Updates the specified tag definition. + + Setting `validator` determines the value type. Tags can use either a static value or a + list of possible values. Static values are entered by a user applying the tag to a resource. + Lists are created by you and the user must apply a value from the list. On update, any values + in a list that were previously set do not change, but new values must pass validation. Values + already applied to a resource do not change. + + You cannot remove list values that appear in a TagDefault. To remove a list value that + appears in a TagDefault, first update the TagDefault to use a different value. + operationId: UpdateTag + parameters: + - $ref: '#/components/parameters/TagNamespaceIdPathParam' + - $ref: '#/components/parameters/TagNamePathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OverrideLocksQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateTagDetails' + description: Request object for updating a tag. + required: true + responses: + '200': + description: The tag was updated. + 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/Tag' + '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/DefaultError' + summary: UpdateTag + tags: + - identity + /taggingWorkRequests/: + get: + description: | + Lists the tagging work requests in compartment. + operationId: ListTaggingWorkRequests + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/ResourceIdentifierQueryParam' + responses: + '200': + description: A list of tagging work requests. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListTaggingWorkRequestsResponse' + '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/DefaultError' + summary: ListTaggingWorkRequests + tags: + - identity + /taggingWorkRequests/{workRequestId}: + get: + description: | + Gets details on a specified work request. The workRequestID is returned in the opc-work-request-id header + for any asynchronous operation in tagging service. + operationId: GetTaggingWorkRequest + parameters: + - $ref: '#/components/parameters/WorkRequestIdPathParam' + responses: + '200': + description: The work request was retrieved. + 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 + retry-after: + description: | + The number of seconds that the client should wait before polling again. + schema: + type: number + format: float + content: + application/json: + schema: + $ref: '#/components/schemas/TaggingWorkRequest' + '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/DefaultError' + summary: GetTaggingWorkRequest + tags: + - identity + /taggingWorkRequests/{workRequestId}/errors: + get: + description: | + Gets the errors for a work request. + operationId: ListTaggingWorkRequestErrors + parameters: + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + responses: + '200': + description: The list of work request errors. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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 + retry-after: + description: | + The number of seconds that the client should wait before polling again. + schema: + type: number + format: float + content: + application/json: + schema: + $ref: '#/components/schemas/ListTaggingWorkRequestErrorsResponse' + '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/DefaultError' + summary: ListTaggingWorkRequestErrors + tags: + - identity + /taggingWorkRequests/{workRequestId}/logs: + get: + description: | + Gets the logs for a work request. + operationId: ListTaggingWorkRequestLogs + parameters: + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + responses: + '200': + description: The list of work request logs. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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 + retry-after: + description: | + The number of seconds that the client should wait before polling again. + schema: + type: number + format: float + content: + application/json: + schema: + $ref: '#/components/schemas/ListTaggingWorkRequestLogsResponse' + '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/DefaultError' + summary: ListTaggingWorkRequestLogs + tags: + - identity + /tags/actions/bulkDelete: + post: + description: | + Deletes the specified tag key definitions. This operation triggers a process that removes the + tags from all resources in your tenancy. The tag key definitions must be within the same tag namespace. + + The following actions happen immediately: + + * If the tag is a cost-tracking tag, the tag no longer counts against your + 10 cost-tracking tags limit, even if you do not disable the tag before running this operation. + * If the tag is used with dynamic groups, the rules that contain the tag are no longer + evaluated against the tag. + + After you start this operation, the state of the tag changes to DELETING, and tag removal + from resources begins. This process can take up to 48 hours depending on the number of resources that + are tagged and the regions in which those resources reside. + + When all tags have been removed, the state changes to DELETED. You cannot restore a deleted tag. After the tag state + changes to DELETED, you can use the same tag name again. + + After you start this operation, you cannot start either the [DeleteTag](#/en/identity/20160918/Tag/DeleteTag) or the [CascadeDeleteTagNamespace](#/en/identity/20160918/TagNamespace/CascadeDeleteTagNamespace) operation until this process completes. + + In order to delete tags, you must first retire the tags. Use [UpdateTag](#/en/identity/20160918/Tag/UpdateTag) + to retire a tag. + operationId: BulkDeleteTags + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/OverrideLocksQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BulkDeleteTagsDetails' + description: Request object for deleting tags in bulk. + required: true + responses: + '202': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: Delete multiple tag key definitions at the same time + tags: + - identity + x-example: | + POST /20160918/tags/actions/bulkDelete/ + Host: identity.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "tagDefinitionIds": [ + "ocid1.tagdefinition.oc1..<unique_ID_1>", + "ocid1.tagdefinition.oc1..<unique_ID_2>", + "ocid1.tagdefinition.oc1..<unique_ID_3>" + ] + } + x-obmcs-get-work-request-operation: GetTaggingWorkRequest + x-related-resource: '#/definitions/Tag' + /tags/actions/bulkEdit: + post: + description: | + Edits the specified list of tag key definitions for the selected resources. + This operation triggers a process that edits the tags on all selected resources. The possible actions are: + + * Add a defined tag when the tag does not already exist on the resource. + * Update the value for a defined tag when the tag is present on the resource. + * Add a defined tag when it does not already exist on the resource or update the value for a defined tag when the tag is present on the resource. + * Remove a defined tag from a resource. The tag is removed from the resource regardless of the tag value. + + See [BulkEditOperationDetails](#/en/identity/latest/datatypes/BulkEditOperationDetails) for more information. + + The edits can include a combination of operations and tag sets. + However, multiple operations cannot apply to one key definition in the same request. + For example, if one request adds `tag set-1` to a resource and sets a tag value to `tag set-2`, + `tag set-1` and `tag set-2` cannot have any common tag definitions. + operationId: BulkEditTags + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BulkEditTagsDetails' + description: The request object for bulk editing tags on resources in the compartment. + responses: + '202': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: Edit multiple tag key definitions on resources + tags: + - identity + x-obmcs-get-work-request-operation: GetTaggingWorkRequest + x-related-resource: '#/definitions/Tag' + /tags/actions/importStandardTags: + post: + description: | + OCI will release Tag Namespaces that our customers can import. + These Tag Namespaces will provide Tags for our customers and Partners to provide consistency and enable data reporting. + operationId: ImportStandardTags + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ImportStandardTagsDetails' + description: The request object for creating or updating standard tag namespace. + responses: + '202': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: | + Create or update tag namespace and their tag definitions if a given tag namespace is a standard tag namespace. + If the tag namespace already exists, any missing tag definitions will be added. For existing enum tags, any new enum values will be added. + Deleting tagging entities nor removing enum values are not supported. + tags: + - identity + x-obmcs-get-work-request-operation: GetTaggingWorkRequest + x-related-resource: '#/definitions/Tag' + /tags/bulkEditResourceTypes: + get: + description: | + Lists the resource types that support bulk tag editing. + operationId: ListBulkEditTagsResourceTypes + parameters: + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + responses: + '200': + description: The list is being retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/BulkEditTagsResourceTypeCollection' + '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/DefaultError' + summary: ListBulkEditTagsResourceTypes + tags: + - identity + /tags/standardTagNamespaceTemplates: + get: + description: | + Lists available standard tag namespaces that users can create. + operationId: ListStandardTagNamespaces + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + responses: + '200': + description: A list of standard tag namespace templates. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListStandardTagNamespacesResponse' + '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/DefaultError' + summary: ListStandardTagNamespaceTemplates + tags: + - identity + /tags/standardTagNamespaceTemplates/{standardTagNamespaceName}: + get: + description: | + Retrieve the standard tag namespace template given the standard tag namespace name. + operationId: GetStandardTagTemplate + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/StandardTagNamespaceNamePathParam' + responses: + '200': + description: Requested standard tag namespace template has been retrieved. + 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/StandardTagNamespaceTemplate' + '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/DefaultError' + summary: GetStandardTagTemplate + tags: + - identity + /tenancies/{tenancyId}: + get: + description: Get the specified tenancy's information. + operationId: GetTenancy + parameters: + - $ref: '#/components/parameters/TenancyIdPathParam' + responses: + '200': + description: The tenancy was retrieved. + 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/Tenancy' + '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/DefaultError' + summary: GetTenancy + tags: + - identity + /tenancies/{tenancyId}/regionSubscriptions: + get: + description: Lists the region subscriptions for the specified tenancy. + operationId: ListRegionSubscriptions + parameters: + - $ref: '#/components/parameters/TenancyIdPathParam' + responses: + '200': + description: The list has been retrieved. + 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/ListRegionSubscriptionsResponse' + '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/DefaultError' + summary: ListRegionSubscriptions + tags: + - identity + post: + description: | + Creates a subscription to a region for a tenancy. + operationId: CreateRegionSubscription + parameters: + - $ref: '#/components/parameters/TenancyIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateRegionSubscriptionDetails' + description: Request object for activate a new region. + required: true + responses: + '200': + description: The Region Subscription has been created. + 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/RegionSubscription' + '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/DefaultError' + summary: CreateRegionSubscription + tags: + - identity + /userGroupMemberships/: + get: + description: | + Lists the `UserGroupMembership` objects in your tenancy. You must specify your tenancy's OCID + as the value for the compartment ID + (see [Where to Get the Tenancy's OCID and User's OCID](/Content/API/Concepts/apisigningkey.htm#five)). + You must also then filter the list in one of these ways: + + - You can limit the results to just the memberships for a given user by specifying a `userId`. + - Similarly, you can limit the results to just the memberships for a given group by specifying a `groupId`. + - You can set both the `userId` and `groupId` to determine if the specified user is in the specified group. + If the answer is no, the response is an empty list. + - Although`userId` and `groupId` are not individually required, you must set one of them. + operationId: ListUserGroupMemberships + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/UserIdQueryParam' + - $ref: '#/components/parameters/GroupIdQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + responses: + '200': + description: Page of `UserGroupMembership` objects matching the specified criteria. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListUserGroupMembershipsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListUserGroupMemberships + tags: + - identity + post: + description: | + Adds the specified user to the specified group and returns a `UserGroupMembership` object with its own OCID. + + After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the + object, first make sure its `lifecycleState` has changed to ACTIVE. + operationId: AddUserToGroup + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddUserToGroupDetails' + description: Request object for adding a user to a group. + required: true + responses: + '200': + description: The user is being added to the group. + 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/UserGroupMembership' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: AddUserToGroup + tags: + - identity + /userGroupMemberships/{userGroupMembershipId}: + delete: + description: Removes a user from a group by deleting the corresponding `UserGroupMembership`. + operationId: RemoveUserFromGroup + parameters: + - $ref: '#/components/parameters/UserGroupMembershipIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The user is being removed from the group. + 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: RemoveUserFromGroup + tags: + - identity + x-related-resource: '#/definitions/UserGroupMembership' + get: + description: Gets the specified UserGroupMembership's information. + operationId: GetUserGroupMembership + parameters: + - $ref: '#/components/parameters/UserGroupMembershipIdPathParam' + responses: + '200': + description: The membership was retrieved. + 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/UserGroupMembership' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetUserGroupMembership + tags: + - identity + /users/: + get: + description: | + Lists the users in your tenancy. You must specify your tenancy's OCID as the value for the + compartment ID (remember that the tenancy is simply the root compartment). + See [Where to Get the Tenancy's OCID and User's OCID](/Content/API/Concepts/apisigningkey.htm#five). + operationId: ListUsers + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/IdentityProviderIdQueryParam' + - $ref: '#/components/parameters/ExternalIdentifierQueryParam' + - $ref: '#/components/parameters/FilterByNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/User/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListUsersResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListUsers + tags: + - identity + post: + description: | + Creates a new user in your tenancy. For conceptual information about users, your tenancy, and other + IAM Service components, see [Overview of IAM](/Content/Identity/getstarted/identity-domains.htm). + + You must specify your tenancy's OCID as the compartment ID in the request object (remember that the + tenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and + some policies) reside within the tenancy itself, unlike cloud resources such as compute instances, + which typically reside within compartments inside the tenancy. For information about OCIDs, see + [Resource Identifiers](/Content/General/Concepts/identifiers.htm). + + You must also specify a *name* for the user, which must be unique across all users in your tenancy + and cannot be changed. Allowed characters: No spaces. Only letters, numerals, hyphens, periods, + underscores, +, and @. If you specify a name that's already in use, you'll get a 409 error. + This name will be the user's login to the Console. You might want to pick a + name that your company's own identity system (e.g., Active Directory, LDAP, etc.) already uses. + If you delete a user and then create a new user with the same name, they'll be considered different + users because they have different OCIDs. + + You must also specify a *description* for the user (although it can be an empty string). + It does not have to be unique, and you can change it anytime with + [UpdateUser](#/en/identity/20160918/User/UpdateUser). You can use the field to provide the user's + full name, a description, a nickname, or other information to generally identify the user. + + After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before + using the object, first make sure its `lifecycleState` has changed to ACTIVE. + + A new user has no permissions until you place the user in one or more groups (see + [AddUserToGroup](#/en/identity/20160918/UserGroupMembership/AddUserToGroup)). If the user needs to + access the Console, you need to provide the user a password (see + [CreateOrResetUIPassword](#/en/identity/20160918/UIPassword/CreateOrResetUIPassword)). + If the user needs to access the Oracle Cloud Infrastructure REST API, you need to upload a + public API signing key for that user (see + [Required Keys and OCIDs](/Content/API/Concepts/apisigningkey.htm) and also + [UploadApiKey](#/en/identity/20160918/ApiKey/UploadApiKey)). + + **Important:** Make sure to inform the new user which compartment(s) they have access to. + operationId: CreateUser + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateUserDetails' + description: Request object for creating a new user. + required: true + responses: + '200': + description: The user is being created. + 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/User' + application-json: + examples: + response: + value: | + { + "id" : "ocid1.user.oc1..aaaaaaaaqvrabwexampleuniqueID", + "compartmentId" : "ocid1.tenancy.oc1..aaaaaaaaba3pvexampleuniqueID", + "name" : "JohnSmith@example.com", + "description" : "John Smith", + "lifecycleState" : "ACTIVE", + "timeCreated" : "2016-11-18T18:13:12.210Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateUser + tags: + - identity + x-example: | + POST /20160918/users/ + Host: identity.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.tenancy.oc1..aaaaaaaaba3pv6exampleuniqueID", + "description" : "John Smith", + "name" : "JohnSmith@example.com" + } + /users/{userId}: + delete: + description: Deletes the specified user. The user must not be in any groups. + operationId: DeleteUser + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The user is being 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: DeleteUser + tags: + - identity + get: + description: Gets the specified user's information. + operationId: GetUser + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + responses: + '200': + description: The user was retrieved. + 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/User' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetUser + tags: + - identity + put: + description: Updates the description of the specified user. + operationId: UpdateUser + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateUserDetails' + description: Request object for updating a user. + required: true + responses: + '200': + description: The user was updated. + 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/User' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: UpdateUser + tags: + - identity + /users/{userId}/apiKeys/: + get: + description: | + Lists the API signing keys for the specified user. A user can have a maximum of three keys. + + Every user has permission to use this API call for *their own user ID*. An administrator in your + organization does not need to write a policy to give users this ability. + operationId: ListApiKeys + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + responses: + '200': + description: The list is being retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListApiKeysResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListApiKeys + tags: + - identity + post: + description: | + Uploads an API signing key for the specified user. + + Every user has permission to use this operation to upload a key for *their own user ID*. An + administrator in your organization does not need to write a policy to give users this ability. + To compare, administrators who have permission to the tenancy can use this operation to upload a + key for any user, including themselves. + + **Important:** Even though you have permission to upload an API key, you might not yet + have permission to do much else. If you try calling an operation unrelated to your own credential + management (e.g., `ListUsers`, `LaunchInstance`) and receive an "unauthorized" error, + check with an administrator to confirm which IAM Service group(s) you're in and what access + you have. Also confirm you're working in the correct compartment. + + After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using + the object, first make sure its `lifecycleState` has changed to ACTIVE. + operationId: UploadApiKey + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateApiKeyDetails' + description: Request object for uploading an API key for a user. + required: true + responses: + '200': + description: The key is being uploaded. + 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/ApiKey' + application-json: + examples: + response: + value: | + { + "keyId" : "ocid1.tenancy.oc1..aaaaaaaaba3pv6exampleuniqueID/ocid1.user.oc1..aaaaaaaaqvexampleuniqueID/cd:7c:ee:29:8b:2f:c6:48:13:c9:9f:12:66:77:ef:c2", + "keyValue" : "-----BEGIN PUBLIC KEY-----\cmdnMIIBIjANBgkqhkiG9w0BAQEFA...AOCAQ8AMIIBCgKCAQEA7hglbuGudIO3sgoAa1n/\nHgUdIGeQmwf/QIv3Y0nOEP4TB7rbdCH99oJYzF86M2\nmwIDAQAB\n-----END PUBLIC KEY-----", + "fingerprint" : "cd:7c:ee:29:8b:2f:c6:48:13:c9:9f:12:66:77:ef:c2", + "userId" : "ocid1.user.oc1..aaaaaaaaqvrexampleuniqueID", + "lifecycleState" : "ACTIVE", + "timeCreated" : "2016-12-07T00:59:17.326Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UploadApiKey + tags: + - identity + x-example: | + POST /20160918/users/<userId>/apiKeys/ + Host: identity.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "key" : "-----BEGIN PUBLIC KEY-----\cmdnMIIBIjANBgkqhkiG9w0BAQEFA...AOCAQ8AMIIBCgKCAQEA7hglbuGudIO3sgoAa1n/\nHgUdIGeQmwf/QIv3Y0nOEP4TB7rbdCH99oJYzF86M2\nmwIDAQAB\n-----END PUBLIC KEY-----" + } + /users/{userId}/apiKeys/{fingerprint}: + delete: + description: | + Deletes the specified API signing key for the specified user. + + Every user has permission to use this operation to delete a key for *their own user ID*. An + administrator in your organization does not need to write a policy to give users this ability. + To compare, administrators who have permission to the tenancy can use this operation to delete + a key for any user, including themselves. + operationId: DeleteApiKey + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/KeyFingerprintPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The key is being 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: DeleteApiKey + tags: + - identity + /users/{userId}/authTokens/: + get: + description: | + Lists the auth tokens for the specified user. The returned object contains the token's OCID, but not + the token itself. The actual token is returned only upon creation. + operationId: ListAuthTokens + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + responses: + '200': + description: The list is being retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListAuthTokensResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListAuthTokens + tags: + - identity + post: + description: | + Creates a new auth token for the specified user. For information about what auth tokens are for, see + [Managing User Credentials](/Content/Identity/access/managing-user-credentials.htm). + + You must specify a *description* for the auth token (although it can be an empty string). It does not + have to be unique, and you can change it anytime with + [UpdateAuthToken](#/en/identity/20160918/AuthToken/UpdateAuthToken). + + Every user has permission to create an auth token for *their own user ID*. An administrator in your organization + does not need to write a policy to give users this ability. To compare, administrators who have permission to the + tenancy can use this operation to create an auth token for any user, including themselves. + operationId: CreateAuthToken + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAuthTokenDetails' + description: Request object for creating a new auth token. + required: true + responses: + '200': + description: The new auth token is being created. + 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/AuthToken' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateAuthToken + tags: + - identity + /users/{userId}/authTokens/{authTokenId}: + delete: + description: | + Deletes the specified auth token for the specified user. + operationId: DeleteAuthToken + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/AuthTokenIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The auth token is being 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: DeleteAuthToken + tags: + - identity + put: + description: | + Updates the specified auth token's description. + operationId: UpdateAuthToken + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/AuthTokenIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAuthTokenDetails' + description: Request object for updating an auth token. + required: true + responses: + '200': + description: The auth token object was updated. + 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/AuthToken' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: UpdateAuthToken + tags: + - identity + /users/{userId}/capabilities/: + put: + description: | + Updates the capabilities of the specified user. + operationId: UpdateUserCapabilities + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateUserCapabilitiesDetails' + description: Request object for updating user capabilities. + required: true + responses: + '200': + description: The user's capability was updated. + 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/User' + '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/DefaultError' + summary: UpdateUserCapabilities + tags: + - identity + /users/{userId}/customerSecretKeys/: + get: + description: | + Lists the secret keys for the specified user. The returned object contains the secret key's OCID, but not + the secret key itself. The actual secret key is returned only upon creation. + operationId: ListCustomerSecretKeys + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + responses: + '200': + description: The list is being retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListCustomerSecretKeysResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListCustomerSecretKeys + tags: + - identity + post: + description: | + Creates a new secret key for the specified user. Secret keys are used for authentication with the Object Storage Service's Amazon S3 + compatible API. The secret key consists of an Access Key/Secret Key pair. For information, see + [Managing User Credentials](/Content/Identity/access/managing-user-credentials.htm). + + You must specify a *description* for the secret key (although it can be an empty string). It does not + have to be unique, and you can change it anytime with + [UpdateCustomerSecretKey](#/en/identity/20160918/CustomerSecretKeySummary/UpdateCustomerSecretKey). + + Every user has permission to create a secret key for *their own user ID*. An administrator in your organization + does not need to write a policy to give users this ability. To compare, administrators who have permission to the + tenancy can use this operation to create a secret key for any user, including themselves. + operationId: CreateCustomerSecretKey + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCustomerSecretKeyDetails' + description: Request object for creating a new secret key. + required: true + responses: + '200': + description: The new secret key is being created. + 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/CustomerSecretKey' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateCustomerSecretKey + tags: + - identity + /users/{userId}/customerSecretKeys/{customerSecretKeyId}: + delete: + description: | + Deletes the specified secret key for the specified user. + operationId: DeleteCustomerSecretKey + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/CustomerSecretKeyIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The secret key is being 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: DeleteCustomerSecretKey + tags: + - identity + put: + description: | + Updates the specified secret key's description. + operationId: UpdateCustomerSecretKey + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/CustomerSecretKeyIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCustomerSecretKeyDetails' + description: Request object for updating a secret key. + required: true + responses: + '200': + description: Summary for the secret key that was updated. + 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/CustomerSecretKeySummary' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: UpdateCustomerSecretKey + tags: + - identity + /users/{userId}/dbCredentials/: + get: + description: | + Lists the DB credentials for the specified user. The returned object contains the credential's OCID + operationId: ListDbCredentials + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/FilterByNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/DbCredential/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListDbCredentialsResponse' + '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/DefaultError' + summary: ListDbCredentials + tags: + - identity + x-related-resource: '#/definitions/User' + post: + description: | + Creates a new DB credential for the specified user. + operationId: CreateDbCredential + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateDbCredentialDetails' + description: Request object for creating a new DB credential with the user. + required: true + responses: + '200': + description: The new DB credential is being created. + 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/DbCredential' + '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/DefaultError' + summary: CreateDbCredential + tags: + - identity + x-example: | + POST /20160918/users/ocid1.user.dev..aaaaaaaaghj3exampleuniqueID/dbCredentials/ + Host: identity.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + 'description': 'DB credential' + 'password': 'Pas$$1234word' + } + x-related-resource: '#/definitions/User' + /users/{userId}/dbCredentials/{dbCredentialId}: + delete: + description: | + Deletes the specified DB credential for the specified user. + operationId: DeleteDbCredential + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/DbCredentialIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The Db credential is being 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 + '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/DefaultError' + summary: DeleteDbCredential + tags: + - identity + x-related-resource: '#/definitions/User' + /users/{userId}/mfaTotpDevices: + get: + description: | + Lists the MFA TOTP devices for the specified user. The returned object contains the device's OCID, but not + the seed. The seed is returned only upon creation or when the IAM service regenerates the MFA seed for the device. + operationId: ListMfaTotpDevices + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The list of MFA TOTP devices. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListMfaTotpDevicesResponse' + '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/DefaultError' + summary: ListMfaTotpDevices + tags: + - identity + post: + description: | + Creates a new MFA TOTP device for the user. A user can have one MFA TOTP device. + operationId: CreateMfaTotpDevice + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '200': + description: The new MFA TOTP device has been created. + 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/MfaTotpDevice' + '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/DefaultError' + summary: CreateMfaTotpDevice + tags: + - identity + /users/{userId}/mfaTotpDevices/{mfaTotpDeviceId}: + delete: + description: | + Deletes the specified MFA TOTP device for the specified user. + operationId: DeleteMfaTotpDevice + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/MfaTotpDeviceIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The MFA TOTP device is being 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 + '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/DefaultError' + summary: DeleteMfaTotpDevice + tags: + - identity + x-related-resource: '#/definitions/MfaTotpDevice' + get: + description: | + Get the specified MFA TOTP device for the specified user. + operationId: GetMfaTotpDevice + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/MfaTotpDeviceIdPathParam' + responses: + '200': + description: The MFA TOTP device. + 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/MfaTotpDeviceSummary' + '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/DefaultError' + summary: GetMfaTotpDevice + tags: + - identity + /users/{userId}/mfaTotpDevices/{mfaTotpDeviceId}/actions/activate: + post: + description: | + Activates the specified MFA TOTP device for the user. Activation requires manual interaction with the Console. + operationId: ActivateMfaTotpDevice + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/MfaTotpDeviceIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MfaTotpToken' + description: MFA TOTP token + required: true + responses: + '200': + description: Summary for the MFA TOTP device that was activated. + 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/MfaTotpDeviceSummary' + '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/DefaultError' + summary: ActivateMfaTotpDevice + tags: + - identity + /users/{userId}/mfaTotpDevices/{mfaTotpDeviceId}/actions/generateSeed: + post: + description: | + Generate seed for the MFA TOTP device. + operationId: GenerateTotpSeed + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/MfaTotpDeviceIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '200': + description: Details for the MFA TOTP device that was activated. + 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/MfaTotpDevice' + '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/DefaultError' + summary: GenerateTotpSeed + tags: + - identity + /users/{userId}/oauth2ClientCredentials: + get: + description: | + List of Oauth tokens for the user + operationId: ListOAuthClientCredentials + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/OAuth2ClientCredentialSummary/lifecycleState' + schema: + type: string + responses: + '200': + description: The list of Oauth tokens. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListOAuthClientCredentialsResponse' + '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/DefaultError' + summary: List of Oauth tokens for the user + tags: + - identity + x-related-resource: '#/definitions/User' + post: + description: | + Creates Oauth token for the user + operationId: CreateOAuthClientCredential + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateOAuth2ClientCredentialDetails' + description: Request object containing the information required to generate an Oauth token. + required: true + responses: + '200': + description: The new Oauth token created. + 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/OAuth2ClientCredential' + '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/DefaultError' + summary: Creates Oauth token for the user + tags: + - identity + x-related-resource: '#/definitions/User' + /users/{userId}/oauth2ClientCredentials/{oauth2ClientCredentialId}: + delete: + description: | + Delete Oauth token for the user + operationId: DeleteOAuthClientCredential + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/Oauth2ClientCredentialIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The Oauth token is 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 + '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/DefaultError' + summary: Delete Oauth token for the user + tags: + - identity + x-related-resource: '#/definitions/User' + put: + description: | + Updates Oauth token for the user + operationId: UpdateOAuthClientCredential + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/Oauth2ClientCredentialIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateOAuth2ClientCredentialDetails' + description: Request object containing the information required to generate an Oauth token. + required: true + responses: + '200': + description: The Oauth token is updated. + 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/OAuth2ClientCredential' + '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/DefaultError' + summary: Updates Oauth token for the user + tags: + - identity + x-related-resource: '#/definitions/User' + /users/{userId}/smtpCredentials/: + get: + description: | + Lists the SMTP credentials for the specified user. The returned object contains the credential's OCID, + the SMTP user name but not the SMTP password. The SMTP password is returned only upon creation. + operationId: ListSmtpCredentials + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + responses: + '200': + description: The list is being retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListSmtpCredentialsResponse' + '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/DefaultError' + summary: ListSmtpCredentials + tags: + - identity + post: + description: | + Creates a new SMTP credential for the specified user. An SMTP credential has an SMTP user name and an SMTP password. + You must specify a *description* for the SMTP credential (although it can be an empty string). It does not + have to be unique, and you can change it anytime with + [UpdateSmtpCredential](#/en/identity/20160918/SmtpCredentialSummary/UpdateSmtpCredential). + operationId: CreateSmtpCredential + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateSmtpCredentialDetails' + description: Request object for creating a new SMTP credential with the user. + required: true + responses: + '200': + description: The new SMTP credential is being created. + 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/SmtpCredential' + '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/DefaultError' + summary: CreateSmtpCredential + tags: + - identity + /users/{userId}/smtpCredentials/{smtpCredentialId}: + delete: + description: | + Deletes the specified SMTP credential for the specified user. + operationId: DeleteSmtpCredential + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/SmtpCredentialIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The Smtp credential is being 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 + '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/DefaultError' + summary: DeleteSmtpCredential + tags: + - identity + put: + description: | + Updates the specified SMTP credential's description. + operationId: UpdateSmtpCredential + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/SmtpCredentialIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSmtpCredentialDetails' + description: Request object for updating a SMTP credential. + required: true + responses: + '200': + description: The SMTP credential object was updated. + 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/SmtpCredentialSummary' + '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/DefaultError' + summary: UpdateSmtpCredential + tags: + - identity + /users/{userId}/state/: + put: + description: | + Updates the state of the specified user. + operationId: UpdateUserState + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateStateDetails' + description: Request object for updating a user state. + required: true + responses: + '200': + description: The user state was updated. + 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/User' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: UpdateUserState + tags: + - identity + /users/{userId}/swiftPasswords/: + get: + description: | + **Deprecated. Use [ListAuthTokens](#/en/identity/20160918/AuthToken/ListAuthTokens) instead.** + + Lists the Swift passwords for the specified user. The returned object contains the password's OCID, but not + the password itself. The actual password is returned only upon creation. + operationId: ListSwiftPasswords + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + responses: + '200': + description: The list is being retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListSwiftPasswordsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListSwiftPasswords + tags: + - identity + post: + description: | + **Deprecated. Use [CreateAuthToken](#/en/identity/20160918/AuthToken/CreateAuthToken) instead.** + + Creates a new Swift password for the specified user. For information about what Swift passwords are for, see + [Managing User Credentials](/Content/Identity/Tasks/managingcredentials.htm). + + You must specify a *description* for the Swift password (although it can be an empty string). It does not + have to be unique, and you can change it anytime with + [UpdateSwiftPassword](#/en/identity/20160918/SwiftPassword/UpdateSwiftPassword). + + Every user has permission to create a Swift password for *their own user ID*. An administrator in your organization + does not need to write a policy to give users this ability. To compare, administrators who have permission to the + tenancy can use this operation to create a Swift password for any user, including themselves. + operationId: CreateSwiftPassword + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateSwiftPasswordDetails' + description: Request object for creating a new swift password. + required: true + responses: + '200': + description: The new Swift password is being created. + 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/SwiftPassword' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateSwiftPassword + tags: + - identity + /users/{userId}/swiftPasswords/{swiftPasswordId}: + delete: + description: | + **Deprecated. Use [DeleteAuthToken](#/en/identity/20160918/AuthToken/DeleteAuthToken) instead.** + + Deletes the specified Swift password for the specified user. + operationId: DeleteSwiftPassword + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/SwiftPasswordIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The Swift password is being 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: DeleteSwiftPassword + tags: + - identity + put: + description: | + **Deprecated. Use [UpdateAuthToken](#/en/identity/20160918/AuthToken/UpdateAuthToken) instead.** + + Updates the specified Swift password's description. + operationId: UpdateSwiftPassword + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/SwiftPasswordIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSwiftPasswordDetails' + description: Request object for updating a Swift password. + required: true + responses: + '200': + description: The Swift password object was updated. + 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/SwiftPassword' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '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/DefaultError' + summary: UpdateSwiftPassword + tags: + - identity + /users/{userId}/uiPassword: + get: + description: | + Gets the specified user's console password information. The returned object contains the user's OCID, + but not the password itself. The actual password is returned only when created or reset. + operationId: GetUserUIPasswordInformation + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + responses: + '200': + description: The user UI password information was retrieved. + 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/UIPasswordInformation' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetUserUIPasswordInformation + tags: + - identity + post: + description: | + Creates a new Console one-time password for the specified user. For more information about user + credentials, see [User Credentials](/Content/Identity/usercred/usercredentials.htm). + + Use this operation after creating a new user, or if a user forgets their password. The new one-time + password is returned to you in the response, and you must securely deliver it to the user. They'll + be prompted to change this password the next time they sign in to the Console. If they don't change + it within 7 days, the password will expire and you'll need to create a new one-time password for the + user. + + (For tenancies that support identity domains) Resetting a user's password generates a reset password email + with a link that the user must follow to reset their password. If the user does not reset their password before the + link expires, you'll need to reset the user's password again. + + **Note:** The user's Console login is the unique name you specified when you created the user + (see [CreateUser](#/en/identity/20160918/User/CreateUser)). + operationId: CreateOrResetUIPassword + parameters: + - $ref: '#/components/parameters/UserIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '200': + description: The new UI password is being created. + 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/UIPassword' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateOrResetUIPassword + tags: + - identity + /workRequests/: + get: + description: | + Lists the work requests in compartment. + operationId: ListWorkRequests + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/ResourceIdentifierQueryParam' + responses: + '200': + description: The list is being retrieved. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ListWorkRequestsResponse' + '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/DefaultError' + summary: ListWorkRequests + tags: + - identity + /workRequests/{workRequestId}: + get: + description: | + Gets details on a specified work request. The workRequestID is returned in the opc-work-request-id header + for any asynchronous operation in the compartment service. + operationId: GetWorkRequest + parameters: + - $ref: '#/components/parameters/WorkRequestIdPathParam' + responses: + '200': + description: The work request was retrieved. + 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 + retry-after: + description: | + The number of seconds that the client should wait before polling again. + schema: + type: number + format: float + content: + application/json: + schema: + $ref: '#/components/schemas/WorkRequest' + '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/DefaultError' + summary: GetWorkRequest + tags: + - identity +components: + schemas: + AllowedDomainLicenseTypeSummary: + description: | + (For tenancies that support identity domains) The 'AllowedDomainLicenseTypeSummary' object contains information about the license type of the identity domain. + properties: + description: + description: The license type description. + maxLength: 4000 + minLength: 1 + type: string + licenseType: + description: | + The license type identifier. + + Example: "oracle-apps-premium" + maxLength: 4000 + minLength: 1 + type: string + name: + description: | + The license type name. + + Example: "Oracle Apps Premium" + maxLength: 4000 + minLength: 1 + type: string + required: + - name + - licenseType + - description + type: object + AuthenticationPolicy: + description: | + Authentication policy, currently set for the given compartment. + properties: + compartmentId: + description: Compartment OCID. + type: string + networkPolicy: + $ref: '#/components/schemas/NetworkPolicy' + passwordPolicy: + $ref: '#/components/schemas/PasswordPolicy' + type: object + UpdateAuthenticationPolicyDetails: + description: | + Update request for authentication policy, describes set of validation rules and their parameters to be updated. + properties: + networkPolicy: + $ref: '#/components/schemas/NetworkPolicy' + passwordPolicy: + $ref: '#/components/schemas/PasswordPolicy' + type: object + AvailabilityDomain: + description: | + One or more isolated, fault-tolerant Oracle data centers that host cloud resources such as instances, volumes, + and subnets. A region contains several Availability Domains. For more information, see + [Regions and Availability Domains](/Content/General/Concepts/regions.htm). + properties: + compartmentId: + description: The OCID of the tenancy. + type: string + id: + description: The OCID of the Availability Domain. + type: string + name: + description: The name of the Availability Domain. + type: string + type: object + Compartment: + description: | + A collection of related resources. Compartments are a fundamental component of Oracle Cloud Infrastructure + for organizing and isolating your cloud resources. You use them to clearly separate resources for the purposes + of measuring usage and billing, access (through the use of IAM Service policies), and isolation (separating the + resources for one project or business unit from another). A common approach is to create a compartment for each + major part of your organization. For more information, see + [Overview of IAM](//Content/Identity/getstarted/identity-domains.htm) and also + [Setting Up Your Tenancy](/Content/GSG/Concepts/settinguptenancy.htm). + + To place a resource in a compartment, simply specify the compartment ID in the "Create" request object when + initially creating the resource. For example, to launch an instance into a particular compartment, specify + that compartment's OCID in the `LaunchInstance` request. You can't move an existing resource from one + compartment to another. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see [Get Started with Policies](/Content/Identity/policiesgs/get-started-with-policies.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values + using the API. + properties: + compartmentId: + description: The OCID of the parent compartment containing the compartment. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description you assign to the compartment. Does not have to be unique, and it's changeable. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the compartment. + type: string + inactiveStatus: + description: The detailed status of INACTIVE lifecycleState. + format: int64 + type: integer + isAccessible: + description: | + Indicates whether or not the compartment is accessible for the user making the request. + Returns true when the user has INSPECT permissions directly on a resource in the + compartment or indirectly (permissions can be on a resource in a subcompartment). + type: boolean + lifecycleState: + description: | + The compartment's current state. After creating a compartment, make sure its `lifecycleState` changes from + CREATING to ACTIVE before using it. + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - DELETED + maxLength: 64 + minLength: 1 + type: string + name: + description: | + The name you assign to the compartment during creation. The name must be unique across all + compartments in the parent. Avoid entering confidential information. + maxLength: 100 + minLength: 1 + type: string + timeCreated: + description: | + Date and time the compartment was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - name + - description + - timeCreated + - lifecycleState + type: object + CreateCompartmentDetails: + properties: + compartmentId: + description: The OCID of the parent compartment containing the compartment. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: | + The description you assign to the compartment during creation. Does not have to be unique, and it's changeable. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + name: + description: | + The name you assign to the compartment during creation. The name must be unique across all compartments + in the parent compartment. Avoid entering confidential information. + maxLength: 100 + minLength: 1 + type: string + required: + - name + - compartmentId + - description + type: object + BulkActionResourceTypeCollection: + description: | + Collection of resource-types supported by a compartment bulk action. + properties: + items: + description: Collection of the resource-types supported by a compartment bulk action. + items: + $ref: '#/components/schemas/BulkActionResourceType' + type: array + required: + - items + type: object + UpdateCompartmentDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description you assign to the compartment. Does not have to be unique, and it's changeable. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + name: + description: | + The new name you assign to the compartment. The name must be unique across all compartments in the parent compartment. + Avoid entering confidential information. + maxLength: 100 + minLength: 1 + type: string + type: object + BulkDeleteResourcesDetails: + properties: + resources: + description: | + The resources to be deleted. + items: + $ref: '#/components/schemas/BulkActionResource' + type: array + required: + - resources + type: object + BulkMoveResourcesDetails: + properties: + resources: + description: | + The resources to be moved. + items: + $ref: '#/components/schemas/BulkActionResource' + type: array + targetCompartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the destination compartment + into which to move the resources. + maxLength: 255 + minLength: 1 + type: string + required: + - resources + - targetCompartmentId + type: object + MoveCompartmentDetails: + properties: + targetCompartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the destination compartment + into which to move the compartment. + maxLength: 255 + minLength: 1 + type: string + required: + - targetCompartmentId + type: object + DomainSummary: + description: | + (For tenancies that support identity domains) As the name suggests, a `DomainSummary` object contains information about a `Domain`. + properties: + compartmentId: + description: The OCID of the compartment containing the identity domain. + maxLength: 100 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The identity domain description. You can have an empty description. + maxLength: 400 + minLength: 1 + type: string + displayName: + description: The mutable display name of the identity domain. + maxLength: 100 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + homeRegion: + description: The home region for the identity domain. + maxLength: 50 + minLength: 1 + type: string + homeRegionUrl: + description: Region-specific identity domain URL. + type: string + id: + description: The OCID of the identity domain. + maxLength: 100 + minLength: 1 + type: string + isHiddenOnLogin: + description: | + Indicates whether the identity domain is hidden on the sign-in screen or not. + type: boolean + licenseType: + description: The license type of the identity domain. + maxLength: 64 + minLength: 1 + type: string + lifecycleDetails: + description: | + Any additional details about the current state of the identity domain. + enum: + - DEACTIVATING + - ACTIVATING + - UPDATING + maxLength: 64 + minLength: 1 + type: string + lifecycleState: + description: | + The current state. + enum: + - CREATING + - ACTIVE + - DELETING + - INACTIVE + maxLength: 64 + minLength: 1 + type: string + x-obmcs-enumref: '#/definitions/Domain/lifecycleState' + replicaRegions: + description: The regions where replicas of the identity domain exist. + items: + $ref: '#/components/schemas/ReplicatedRegionDetails' + type: array + timeCreated: + description: | + Date and time the identity domain was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + type: + description: | + The type of the identity domain. + enum: + - DEFAULT + - SECONDARY + maxLength: 64 + minLength: 1 + type: string + x-obmcs-enumref: '#/definitions/Domain/type' + url: + description: Region-agnostic identity domain URL. + type: string + required: + - id + - compartmentId + - displayName + - description + - url + - homeRegionUrl + - homeRegion + - replicaRegions + - type + - licenseType + - isHiddenOnLogin + - timeCreated + - lifecycleState + type: object + CreateDomainDetails: + description: (For tenancies that support identity domains) Details for creating an identity domain. + properties: + adminEmail: + description: The administrator's email address. + maxLength: 256 + minLength: 5 + type: string + adminFirstName: + description: The administrator's first name. + maxLength: 150 + minLength: 1 + type: string + adminLastName: + description: The administrator's last name. + maxLength: 150 + minLength: 1 + type: string + adminUserName: + description: The administrator's user name. + maxLength: 256 + minLength: 1 + type: string + compartmentId: + description: The OCID of the compartment where the identity domain is created. + maxLength: 100 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The identity domain description. You can have an empty description. + maxLength: 400 + minLength: 1 + type: string + displayName: + description: The mutable display name of the identity domain. + maxLength: 100 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + homeRegion: + description: | + The region's name identifier. See [Regions and Availability Domains](/Content/General/Concepts/regions.htm) + for the full list of supported region names. + + Example: `us-phoenix-1` + maxLength: 50 + minLength: 1 + type: string + isHiddenOnLogin: + description: | + Indicates whether the identity domain is hidden on the sign-in screen or not. + type: boolean + isNotificationBypassed: + description: | + Indicates whether or not the administrator user created in the IDCS stripe would like to receive notifications like a welcome email. + This field is required only if admin information is provided. This field is otherwise optional. + type: boolean + isPrimaryEmailRequired: + description: | + Optional field to indicate whether users in the identity domain are required to have a primary email address or not. The default is true. + type: boolean + licenseType: + description: The license type of the identity domain. + maxLength: 64 + minLength: 1 + type: string + required: + - compartmentId + - displayName + - description + - homeRegion + - licenseType + type: object + Domain: + description: | + (For tenancies that support identity domains) Properties for an identity domain. An identity domain is used to manage users and groups, integration standards, external identities, and secure application integration through Oracle Single Sign-on (SSO) configuration. + properties: + compartmentId: + description: The OCID of the compartment containing the identity domain. + maxLength: 100 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The identity domain description. You can have an empty description. + maxLength: 400 + minLength: 1 + type: string + displayName: + description: The mutable display name of the identity domain. + maxLength: 100 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + homeRegion: + description: | + The home region for the identity domain. + See [Regions and Availability Domains](/Content/General/Concepts/regions.htm) + for the full list of supported region names. + + Example: `us-phoenix-1` + maxLength: 50 + minLength: 1 + type: string + homeRegionUrl: + description: Region-specific identity domain URL. + type: string + id: + description: The OCID of the identity domain. + maxLength: 100 + minLength: 1 + type: string + isHiddenOnLogin: + description: | + Indicates whether the identity domain is hidden on the sign-in screen or not. + type: boolean + licenseType: + description: The license type of the identity domain. + maxLength: 64 + minLength: 1 + type: string + lifecycleDetails: + description: | + Any additional details about the current state of the identity domain. + enum: + - DEACTIVATING + - ACTIVATING + - UPDATING + maxLength: 64 + minLength: 1 + type: string + lifecycleState: + description: | + The current state. + enum: + - CREATING + - ACTIVE + - DELETING + - INACTIVE + maxLength: 64 + minLength: 1 + type: string + replicaRegions: + description: The regions where replicas of the identity domain exist. + items: + $ref: '#/components/schemas/ReplicatedRegionDetails' + type: array + timeCreated: + description: | + Date and time the identity domain was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + type: + description: | + The type of the domain. + enum: + - DEFAULT + - SECONDARY + maxLength: 64 + minLength: 1 + type: string + url: + description: Region-agnostic identity domain URL. + type: string + required: + - id + - compartmentId + - displayName + - description + - url + - homeRegionUrl + - homeRegion + - replicaRegions + - type + - licenseType + - isHiddenOnLogin + - timeCreated + - lifecycleState + type: object + UpdateDomainDetails: + description: (For tenancies that support identity domains) Update identity domain details. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The identity domain description. You can have an empty description. + maxLength: 400 + minLength: 1 + type: string + displayName: + description: The mutable display name of the identity domain. + maxLength: 100 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + isHiddenOnLogin: + description: | + Indicates whether the identity domain is hidden on the sign-in screen or not. + type: boolean + type: object + ChangeDomainCompartmentDetails: + properties: + compartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the destination compartment + into which to move the identity domain. + maxLength: 100 + minLength: 1 + type: string + required: + - compartmentId + type: object + ChangeDomainLicenseTypeDetails: + description: (For tenancies that support identity domains) Details for updating the license type of the identity domain. + properties: + licenseType: + description: The license type of the identity domain. + maxLength: 64 + minLength: 1 + type: string + type: object + EnableReplicationToRegionDetails: + description: (For tenancies that support identity domains) Identity domain replication request packet. + properties: + replicaRegion: + description: | + A region to which you want identity domain replication to occur. + See [Regions and Availability Domains](/Content/General/Concepts/regions.htm) + for the full list of supported region names. + + Example: `us-phoenix-1` + maxLength: 50 + minLength: 1 + type: string + type: object + DynamicGroup: + description: | + A dynamic group defines a matching rule. Every bare metal or virtual machine instance is deployed with an instance certificate. + The certificate contains metadata about the instance. This includes the instance OCID and the compartment OCID, along + with a few other optional properties. When an API call is made using this instance certificate as the authenticator, + the certificate can be matched to one or multiple dynamic groups. The instance can then get access to the API + based on the permissions granted in policies written for the dynamic groups. + + This works like regular user/group membership. But in that case, the membership is a static relationship, whereas + in a dynamic group, the membership of an instance certificate to a dynamic group is determined during runtime. + For more information, see [Managing Dynamic Groups](/Content/Identity/dynamicgroups/managingdynamicgroups.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using + the API. + properties: + compartmentId: + description: The OCID of the tenancy containing the group. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: | + The description you assign to the group. Does not have to be unique, and it's changeable. + + (For tenancies that support identity domains) You can have an empty description. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the group. + type: string + inactiveStatus: + description: The detailed status of INACTIVE lifecycleState. + format: int64 + type: integer + lifecycleState: + description: | + The group's current state. After creating a group, make sure its `lifecycleState` changes from CREATING to + ACTIVE before using it. + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - DELETED + maxLength: 64 + minLength: 1 + type: string + matchingRule: + description: | + A rule string that defines which instance certificates will be matched. + For syntax, see [Managing Dynamic Groups](/Content/Identity/dynamicgroups/managingdynamicgroups.htm). + maxLength: 100000 + minLength: 1 + type: string + name: + description: | + The name you assign to the group during creation. The name must be unique across all groups in + the tenancy and cannot be changed. + maxLength: 100 + minLength: 1 + type: string + timeCreated: + description: | + Date and time the group was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - name + - description + - matchingRule + - timeCreated + - lifecycleState + type: object + CreateDynamicGroupDetails: + description: Properties for creating a dynamic group. + properties: + compartmentId: + description: The OCID of the tenancy containing the group. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: | + The description you assign to the group during creation. Does not have to be unique, and it's changeable. + + (For tenancies that support identity domains) You can have an empty description. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + matchingRule: + description: | + The matching rule to dynamically match an instance certificate to this dynamic group. + For rule syntax, see [Managing Dynamic Groups](/Content/Identity/dynamicgroups/managingdynamicgroups.htm). + maxLength: 100000 + minLength: 1 + type: string + name: + description: | + The name you assign to the group during creation. The name must be unique across all groups + in the tenancy and cannot be changed. + maxLength: 100 + minLength: 1 + type: string + required: + - name + - compartmentId + - matchingRule + - description + type: object + UpdateDynamicGroupDetails: + description: Properties for updating a dynamic group. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: | + The description you assign to the dynamic group. Does not have to be unique, and it's changeable. + + (For tenancies that support identity domains) You can have an empty description. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + matchingRule: + description: | + The matching rule to dynamically match an instance certificate to this dynamic group. + For rule syntax, see [Managing Dynamic Groups](/Content/Identity/dynamicgroups/managingdynamicgroups.htm). + maxLength: 100000 + minLength: 1 + type: string + type: object + FaultDomain: + description: | + A Fault Domain is a logical grouping of hardware and infrastructure within an Availability Domain that can become + unavailable in its entirety either due to hardware failure such as Top-of-rack (TOR) switch failure or due to + planned software maintenance such as security updates that reboot your instances. + properties: + availabilityDomain: + description: The name of the availabilityDomain where the Fault Domain belongs. + type: string + compartmentId: + description: The OCID of the compartment. Currently only tenancy (root) compartment can be provided. + type: string + id: + description: The OCID of the Fault Domain. + type: string + name: + description: The name of the Fault Domain. + type: string + type: object + Group: + description: | + A collection of users who all need the same type of access to a particular set of resources or compartment. + For conceptual information about groups and other IAM Service components, see + [Overview of IAM](/Content/Identity/getstarted/identity-domains.htm). + + If you're federating with an identity provider (IdP), you need to create mappings between the groups + defined in the IdP and groups you define in the IAM service. For more information, see + [Identity Providers and Federation](/Content/Identity/Concepts/federation.htm). Also see + [IdentityProvider](#/en/identity/20160918/IdentityProvider/) and + [IdpGroupMapping](#/en/identity/20160918/IdpGroupMapping/). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see [Get Started with Policies](/Content/Identity/policiesgs/get-started-with-policies.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values + using the API. + properties: + compartmentId: + description: The OCID of the tenancy containing the group. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: | + The description you assign to the group. Does not have to be unique, and it's changeable. + + (For tenancies that support identity domains) You can have an empty description. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the group. + type: string + inactiveStatus: + description: The detailed status of INACTIVE lifecycleState. + format: int64 + type: integer + lifecycleState: + description: | + The group's current state. After creating a group, make sure its `lifecycleState` changes from CREATING to + ACTIVE before using it. + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - DELETED + maxLength: 64 + minLength: 1 + type: string + name: + description: | + The name you assign to the group during creation. The name must be unique across all groups in + the tenancy and cannot be changed. + maxLength: 100 + minLength: 1 + type: string + timeCreated: + description: | + Date and time the group was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - name + - description + - timeCreated + - lifecycleState + type: object + CreateGroupDetails: + properties: + compartmentId: + description: The OCID of the tenancy containing the group. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: | + The description you assign to the group during creation. Does not have to be unique, and it's changeable. + + (For tenancies that support identity domains) You can have an empty description. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + name: + description: | + The name you assign to the group during creation. The name must be unique across all groups + in the tenancy and cannot be changed. + maxLength: 100 + minLength: 1 + type: string + required: + - name + - compartmentId + - description + type: object + UpdateGroupDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: | + The description you assign to the group. Does not have to be unique, and it's changeable. + + (For tenancies that support identity domains) You can have an empty description. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + type: object + IamWorkRequestSummary: + description: | + (For tenancies that support identity domains) The IAM work request summary. Tracks the status of asynchronous operations. + properties: + compartmentId: + description: The OCID of the compartment containing this IAM work request. + maxLength: 100 + minLength: 1 + type: string + id: + description: The OCID of the work request. + maxLength: 100 + minLength: 1 + type: string + operationType: + description: The asynchronous operation tracked by this IAM work request. + enum: + - CREATE_DOMAIN + - REPLICATE_DOMAIN_TO_REGION + - UPDATE_DOMAIN + - ACTIVATE_DOMAIN + - DEACTIVATE_DOMAIN + - DELETE_DOMAIN + - CHANGE_COMPARTMENT_FOR_DOMAIN + - CHANGE_LICENSE_TYPE_FOR_DOMAIN + maxLength: 34 + minLength: 1 + type: string + percentComplete: + description: | + How much progress the operation has made. + format: float + maximum: 100 + minimum: 1 + type: number + resources: + description: The resources this work request affects. + items: + $ref: '#/components/schemas/IamWorkRequestResource' + type: array + status: + description: The status of the work request. + enum: + - ACCEPTED + - IN_PROGRESS + - FAILED + - SUCCEEDED + - CANCELING + - CANCELED + maxLength: 15 + minLength: 1 + type: string + timeAccepted: + description: | + Date and time the work was accepted, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeFinished: + description: | + Date and time the work completed, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeStarted: + description: | + Date and time the work started, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - operationType + - status + type: object + IamWorkRequest: + description: | + (For tenancies that support identity domains) An IAM work request object that allows users to track the status of asynchronous API requests. + properties: + compartmentId: + description: The OCID of the compartment containing this IAM work request. + maxLength: 100 + minLength: 1 + type: string + id: + description: The OCID of the work request. + maxLength: 100 + minLength: 1 + type: string + operationType: + description: The asynchronous operation tracked by this IAM work request. + enum: + - CREATE_DOMAIN + - REPLICATE_DOMAIN_TO_REGION + - UPDATE_DOMAIN + - ACTIVATE_DOMAIN + - DEACTIVATE_DOMAIN + - DELETE_DOMAIN + - CHANGE_COMPARTMENT_FOR_DOMAIN + - CHANGE_LICENSE_TYPE_FOR_DOMAIN + maxLength: 34 + minLength: 1 + type: string + percentComplete: + description: | + How much progress the operation has made. + format: float + maximum: 100 + minimum: 1 + type: number + resources: + description: The resources this work request affects. + items: + $ref: '#/components/schemas/IamWorkRequestResource' + type: array + status: + description: The status of the work request. + enum: + - ACCEPTED + - IN_PROGRESS + - FAILED + - SUCCEEDED + - CANCELING + - CANCELED + maxLength: 15 + minLength: 1 + type: string + timeAccepted: + description: | + Date and time the work was accepted, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeFinished: + description: | + Date and time the work completed, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeStarted: + description: | + Date and time the work started, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - operationType + - status + type: object + IamWorkRequestErrorSummary: + description: | + (For tenancies that support identity domains) An error encountered while executing an operation that is tracked by a IAM work request. + properties: + code: + description: A machine-usable code for the error that occured. + maxLength: 32 + minLength: 1 + type: string + message: + description: A human-readable error string. + maxLength: 4000 + minLength: 1 + type: string + timestamp: + description: The date and time the error occurred. + format: date-time + type: string + required: + - code + - message + - timestamp + x-example: | + { + "code" : "InternalError", + "message" : "Launch instance failed, Retrying failed to complete successfully after 5 attempts.", + "timestamp" : "2019-05-07T01:04:43.543Z" + } + type: object + IamWorkRequestLogSummary: + description: | + (For tenancies that support identity domains) The log entity for a IAM work request. + properties: + message: + description: A human-readable error string. + maxLength: 4000 + minLength: 1 + type: string + timestamp: + description: | + Date and time the log was written, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - message + type: object + IdcsDomainServiceStatusDetails: + description: | + IDCS Domain Service Status + properties: + isIdcsDomainServiceServiceAvailable: + description: | + If flag is set to true it specifies idcs domain service is available + type: boolean + required: + - isIdcsDomainServiceServiceAvailable + type: object + IdentityProvider: + description: | + The resulting base object when you add an identity provider to your tenancy. A + [Saml2IdentityProvider](#/en/identity/20160918/Saml2IdentityProvider/) + is a specific type of `IdentityProvider` that supports the SAML 2.0 protocol. Each + `IdentityProvider` object has its own OCID. For more information, see + [Identity Providers and Federation](/Content/Identity/Concepts/federation.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see [Get Started with Policies](/Content/Identity/policiesgs/get-started-with-policies.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string + values using the API. + discriminator: + propertyName: protocol + properties: + compartmentId: + description: The OCID of the tenancy containing the `IdentityProvider`. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: | + The description you assign to the `IdentityProvider` during creation. Does + not have to be unique, and it's changeable. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the `IdentityProvider`. + type: string + inactiveStatus: + description: The detailed status of INACTIVE lifecycleState. + format: int64 + type: integer + lifecycleState: + description: | + The current state. After creating an `IdentityProvider`, make sure its + `lifecycleState` changes from CREATING to ACTIVE before using it. + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - DELETED + maxLength: 64 + minLength: 1 + type: string + name: + description: | + The name you assign to the `IdentityProvider` during creation. The name + must be unique across all `IdentityProvider` objects in the tenancy and + cannot be changed. This is the name federated users see when choosing + which identity provider to use when signing in to the Oracle Cloud Infrastructure + Console. + maxLength: 100 + minLength: 1 + type: string + productType: + description: | + The identity provider service or product. + Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft + Active Directory Federation Services (ADFS). + + Allowed values are: + - `ADFS` + - `IDCS` + + Example: `IDCS` + maxLength: 64 + minLength: 1 + type: string + protocol: + description: | + The protocol used for federation. Allowed value: `SAML2`. + + Example: `SAML2` + maxLength: 64 + minLength: 1 + type: string + timeCreated: + description: | + Date and time the `IdentityProvider` was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - name + - description + - productType + - timeCreated + - lifecycleState + - protocol + type: object + CreateIdentityProviderDetails: + discriminator: + propertyName: protocol + properties: + compartmentId: + description: The OCID of your tenancy. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: | + The description you assign to the `IdentityProvider` during creation. + Does not have to be unique, and it's changeable. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + name: + description: | + The name you assign to the `IdentityProvider` during creation. + The name must be unique across all `IdentityProvider` objects in the + tenancy and cannot be changed. + maxLength: 100 + minLength: 1 + type: string + productType: + description: | + The identity provider service or product. + Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft + Active Directory Federation Services (ADFS). + + Example: `IDCS` + enum: + - IDCS + - ADFS + type: string + protocol: + description: | + The protocol used for federation. + + Example: `SAML2` + enum: + - SAML2 + - ADFS + type: string + required: + - name + - compartmentId + - productType + - description + - protocol + type: object + UpdateIdentityProviderDetails: + discriminator: + propertyName: protocol + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: | + The description you assign to the `IdentityProvider`. Does not have to + be unique, and it's changeable. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + protocol: + description: | + The protocol used for federation. + + Example: `SAML2` + enum: + - SAML2 + type: string + required: + - protocol + type: object + ScimClientCredentials: + description: | + The OAuth2 client credentials. + properties: + clientId: + description: The client identifier. + type: string + clientSecret: + description: The client secret. + type: string + type: object + IdpGroupMapping: + description: | + A mapping between a single group defined by the identity provider (IdP) you're federating with + and a single IAM Service [group](#/en/identity/20160918/Group/) in Oracle Cloud Infrastructure. + For more information about group mappings and what they're for, see + [Identity Providers and Federation](/Content/Identity/Concepts/federation.htm). + + A given IdP group can be mapped to zero, one, or multiple IAM Service groups, and vice versa. + But each `IdPGroupMapping` object is between only a single IdP group and IAM Service group. + Each `IdPGroupMapping` object has its own OCID. + + **Note:** Any users who are in more than 50 IdP groups cannot be authenticated to use the Oracle + Cloud Infrastructure Console. + properties: + compartmentId: + description: The OCID of the tenancy containing the `IdentityProvider`. + type: string + groupId: + description: The OCID of the IAM Service group that is mapped to the IdP group. + type: string + id: + description: The OCID of the `IdpGroupMapping`. + type: string + idpGroupName: + description: The name of the IdP group that is mapped to the IAM Service group. + type: string + idpId: + description: The OCID of the `IdentityProvider` this mapping belongs to. + type: string + inactiveStatus: + description: The detailed status of INACTIVE lifecycleState. + format: int64 + type: integer + lifecycleState: + description: | + The mapping's current state. After creating a mapping object, make sure its `lifecycleState` changes + from CREATING to ACTIVE before using it. + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - DELETED + maxLength: 64 + minLength: 1 + type: string + timeCreated: + description: | + Date and time the mapping was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - idpId + - idpGroupName + - groupId + - compartmentId + - timeCreated + - lifecycleState + type: object + CreateIdpGroupMappingDetails: + properties: + groupId: + description: | + The OCID of the IAM Service [group](#/en/identity/20160918/Group/) + you want to map to the IdP group. + type: string + idpGroupName: + description: The name of the IdP group you want to map. + type: string + required: + - idpGroupName + - groupId + type: object + UpdateIdpGroupMappingDetails: + properties: + groupId: + description: The OCID of the group. + type: string + idpGroupName: + description: The idp group name. + type: string + type: object + IdentityProviderGroupSummary: + description: | + A group created in an identity provider that can be mapped to a group in OCI + properties: + displayName: + description: Display name of the group + type: string + externalIdentifier: + description: Identifier of the group in the identity provider + type: string + id: + description: The OCID of the `IdentityProviderGroup`. + type: string + identityProviderId: + description: The OCID of the `IdentityProvider` this group belongs to. + type: string + name: + description: Display name of the group + type: string + timeCreated: + description: | + Date and time the `IdentityProviderGroup` was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeModified: + description: | + Date and time the `IdentityProviderGroup` was last modified, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + type: object + NetworkSourcesSummary: + description: | + A network source specifies a list of source IP addresses that are allowed to make authorization requests. + Use the network source in policy statements to restrict access to only requests that come from the specified IPs. + For more information, see [Managing Network Sources](/Content/Identity/Tasks/managingnetworksources.htm). + properties: + compartmentId: + description: The OCID of the tenancy (root compartment) containing the network source. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description you assign to the network source. Does not have to be unique, and it's changeable. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the network source. + type: string + lifecycleState: + description: | + The network source object's current state. After creating a network source, make sure its `lifecycleState` changes from CREATING to + ACTIVE before using it. + type: string + x-obmcs-enumref: '#/definitions/NetworkSources/lifecycleState' + name: + description: | + The name you assign to the network source during creation. The name must be unique across + the tenancy and cannot be changed. + maxLength: 100 + minLength: 1 + type: string + publicSourceList: + description: | + A list of allowed public IP addresses and CIDR ranges. + items: + type: string + maxItems: 100 + minItems: 0 + type: array + services: + description: | + -- The services attribute has no effect and is reserved for use by Oracle. -- + items: + type: string + maxItems: 1 + minItems: 1 + type: array + timeCreated: + description: | + Date and time the network source was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + virtualSourceList: + description: | + A list of allowed VCN OCID and IP range pairs. + Example:`"vcnId": "ocid1.vcn.oc1.iad.aaaaaaaaexampleuniqueID", "ipRanges": [ "129.213.39.0/24" ]` + items: + properties: + ipRanges: + items: + type: string + type: array + vcnId: + type: string + type: object + maxItems: 100 + minItems: 0 + type: array + required: + - id + - compartmentId + - name + - description + - timeCreated + - lifecycleState + type: object + CreateNetworkSourceDetails: + description: | + Properties for creating a network source object. + properties: + compartmentId: + description: The OCID of the tenancy (root compartment) containing the network source object. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description you assign to the network source during creation. Does not have to be unique, and it's changeable. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + name: + description: | + The name you assign to the network source during creation. The name must be unique across all groups + in the tenancy and cannot be changed. + maxLength: 100 + minLength: 1 + type: string + publicSourceList: + description: | + A list of allowed public IP addresses and CIDR ranges. + items: + type: string + maxItems: 100 + minItems: 0 + type: array + services: + description: | + -- The services attribute has no effect and is reserved for use by Oracle. -- + items: + type: string + maxItems: 1 + minItems: 1 + type: array + virtualSourceList: + description: | + A list of allowed VCN OCID and IP range pairs. + Example:`"vcnId": "ocid1.vcn.oc1.iad.aaaaaaaaexampleuniqueID", "ipRanges": [ "129.213.39.0/24" ]` + items: + properties: + ipRanges: + items: + type: string + type: array + vcnId: + type: string + type: object + maxItems: 100 + minItems: 0 + type: array + required: + - name + - compartmentId + - description + type: object + NetworkSources: + description: | + A network source specifies a list of source IP addresses that are allowed to make authorization requests. + Use the network source in policy statements to restrict access to only requests that come from the specified IPs. + For more information, see [Managing Network Sources](/Content/Identity/Tasks/managingnetworksources.htm). + properties: + compartmentId: + description: The OCID of the tenancy containing the network source. The tenancy is the root compartment. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description you assign to the network source. Does not have to be unique, and it's changeable. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the network source. + type: string + inactiveStatus: + description: The detailed status of INACTIVE lifecycleState. + format: int64 + type: integer + lifecycleState: + description: | + The network source object's current state. After creating a network source, make sure its `lifecycleState` changes from CREATING to + ACTIVE before using it. + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - DELETED + maxLength: 64 + minLength: 1 + type: string + name: + description: | + The name you assign to the network source during creation. The name must be unique across + the tenancy and cannot be changed. + maxLength: 100 + minLength: 1 + type: string + publicSourceList: + description: | + A list of allowed public IPs and CIDR ranges. + items: + type: string + maxItems: 100 + minItems: 0 + type: array + services: + description: | + -- The services attribute has no effect and is reserved for use by Oracle. -- + items: + type: string + maxItems: 1 + minItems: 1 + type: array + timeCreated: + description: | + Date and time the network source was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + virtualSourceList: + description: | + A list of allowed VCN OCID and IP range pairs. + Example:`"vcnId": "ocid1.vcn.oc1.iad.aaaaaaaaexampleuniqueID", "ipRanges": [ "129.213.39.0/24" ]` + items: + properties: + ipRanges: + items: + type: string + type: array + vcnId: + type: string + type: object + maxItems: 100 + minItems: 0 + type: array + required: + - id + - compartmentId + - name + - description + - timeCreated + - lifecycleState + type: object + UpdateNetworkSourceDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description you assign to the network source. Does not have to be unique, and it's changeable. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + publicSourceList: + description: | + A list of allowed public IP addresses and CIDR ranges. + items: + type: string + maxItems: 100 + minItems: 0 + type: array + services: + description: | + -- The services attribute has no effect and is reserved for use by Oracle. -- + items: + type: string + maxItems: 1 + minItems: 1 + type: array + virtualSourceList: + description: | + A list of allowed VCN OCID and IP range pairs. + Example:`"vcnId": "ocid1.vcn.oc1.iad.aaaaaaaaexampleuniqueID", "ipRanges": [ "129.213.39.0/24" ]` + items: + properties: + ipRanges: + items: + type: string + type: array + vcnId: + type: string + type: object + maxItems: 100 + minItems: 0 + type: array + type: object + Policy: + description: | + A document that specifies the type of access a group has to the resources in a compartment. For information about + policies and other IAM Service components, see + [Overview of IAM](/Content/Identity/getstarted/identity-domains.htm). If you're new to policies, see + [Get Started with Policies](/Content/Identity/policiesgs/get-started-with-policies.htm). + + The word "policy" is used by people in different ways: + + * An individual statement written in the policy language + * A collection of statements in a single, named "policy" document (which has an Oracle Cloud ID (OCID) assigned to it) + * The overall body of policies your organization uses to control access to resources + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values + using the API. + properties: + compartmentId: + description: | + The OCID of the compartment containing the policy (either the tenancy or another compartment). + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description you assign to the policy. Does not have to be unique, and it's changeable. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the policy. + type: string + inactiveStatus: + description: The detailed status of INACTIVE lifecycleState. + format: int64 + type: integer + lifecycleState: + description: | + The policy's current state. After creating a policy, make sure its `lifecycleState` changes from CREATING to + ACTIVE before using it. + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - DELETED + maxLength: 64 + minLength: 1 + type: string + locks: + description: Locks associated with this resource. + items: + $ref: '#/components/schemas/ResourceLockPolicy' + type: array + name: + description: | + The name you assign to the policy during creation. The name must be unique across all policies + in the tenancy and cannot be changed. + maxLength: 100 + minLength: 1 + type: string + statements: + description: An array of one or more policy statements written in the policy language. + items: + type: string + type: array + timeCreated: + description: | + Date and time the policy was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + versionDate: + description: | + The version of the policy. If null or set to an empty string, when a request comes in for authorization, the + policy will be evaluated according to the current behavior of the services at that moment. If set to a particular + date (YYYY-MM-DD), the policy will be evaluated according to the behavior of the services on that date. + format: date-time + type: string + required: + - id + - compartmentId + - name + - statements + - description + - timeCreated + - lifecycleState + type: object + CreatePolicyDetails: + properties: + compartmentId: + description: The OCID of the compartment containing the policy (either the tenancy or another compartment). + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: | + The description you assign to the policy during creation. Does not have to be unique, and it's changeable. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + locks: + description: Locks associated with this resource. + items: + $ref: '#/components/schemas/AddPolicyLockDetails' + maxItems: 1 + type: array + name: + description: | + The name you assign to the policy during creation. The name must be unique across all policies + in the tenancy and cannot be changed. + maxLength: 100 + minLength: 1 + type: string + statements: + description: | + An array of policy statements written in the policy language. See + [How Policies Work](/Content/Identity/policieshow/how-policies-work.htm) and + [Common Policies](/Content/Identity/policiescommon/commonpolicies.htm). + items: + type: string + type: array + versionDate: + description: | + The version of the policy. If null or set to an empty string, when a request comes in for authorization, the + policy will be evaluated according to the current behavior of the services at that moment. If set to a particular + date (YYYY-MM-DD), the policy will be evaluated according to the behavior of the services on that date. + format: date-time + type: string + required: + - name + - compartmentId + - statements + - description + type: object + UpdatePolicyDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description you assign to the policy. Does not have to be unique, and it's changeable. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + statements: + description: | + An array of policy statements written in the policy language. See + [How Policies Work](/Content/Identity/policieshow/how-policies-work.htm) and + [Common Policies](/Content/Identity/policiescommon/commonpolicies.htm). + items: + type: string + type: array + versionDate: + description: | + The version of the policy. If null or set to an empty string, when a request comes in for authorization, the + policy will be evaluated according to the current behavior of the services at that moment. If set to a particular + date (YYYY-MM-DD), the policy will be evaluated according to the behavior of the services on that date. + format: date-time + type: string + type: object + AddPolicyLockDetails: + description: | + Request payload to add lock to the resource. + properties: + message: + description: | + A message added by the creator of the lock. This is typically used to give an + indication of why the resource is locked. + type: string + relatedResourceId: + description: | + The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. + type: string + type: + description: Type of the lock. + enum: + - FULL + - DELETE + type: string + required: + - type + type: object + RemovePolicyLockDetails: + description: | + Request payload to remove lock to the resource. + properties: + type: + description: Type of the lock. + enum: + - FULL + - DELETE + type: string + required: + - type + type: object + Region: + description: | + A localized geographic area, such as Phoenix, AZ. Oracle Cloud Infrastructure is hosted in regions and Availability + Domains. A region is composed of several Availability Domains. An Availability Domain is one or more data centers + located within a region. For more information, see [Regions and Availability Domains](/Content/General/Concepts/regions.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see [Get Started with Policies](/Content/Identity/policiesgs/get-started-with-policies.htm). + properties: + key: + description: | + The key of the region. See [Regions and Availability Domains](/Content/General/Concepts/regions.htm) for + the full list of supported 3-letter region codes. + + Example: `PHX` + maxLength: 16 + minLength: 1 + type: string + name: + description: | + The name of the region. See [Regions and Availability Domains](/Content/General/Concepts/regions.htm) + for the full list of supported region names. + + Example: `us-phoenix-1` + maxLength: 16 + minLength: 1 + type: string + type: object + TagDefaultSummary: + description: | + Summary information for the specified tag default. + properties: + compartmentId: + description: | + The OCID of the compartment. The tag default will apply to all new resources that are created in the compartment. + type: string + id: + description: The OCID of the tag default. + type: string + isRequired: + description: | + If you specify that a value is required, a value is set during resource creation (either by + the user creating the resource or another tag defualt). If no value is set, resource + creation is blocked. + + * If the `isRequired` flag is set to "true", the value is set during resource creation. + * If the `isRequired` flag is set to "false", the value you enter is set during resource creation. + + Example: `false` + type: boolean + lifecycleState: + description: | + The tag default's current state. After creating a `TagDefault`, make sure its `lifecycleState` is ACTIVE before using it. + enum: + - ACTIVE + type: string + locks: + description: Locks associated with this resource. + items: + $ref: '#/components/schemas/ResourceLock' + type: array + tagDefinitionId: + description: | + The OCID of the tag definition. The tag default will always assign a default value for this tag definition. + type: string + tagDefinitionName: + description: | + The name used in the tag definition. This field is informational in the context of the tag default. + type: string + tagNamespaceId: + description: | + The OCID of the tag namespace that contains the tag definition. + type: string + timeCreated: + description: | + Date and time the `TagDefault` object was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + value: + description: | + The default value for the tag definition. This will be applied to all new resources created in the compartment. + type: string + required: + - id + - compartmentId + - tagNamespaceId + - tagDefinitionId + - tagDefinitionName + - value + - timeCreated + - isRequired + x-example: | + { + "id" : "ocid1.tagdefault.oc1..<unique_ID>", + "compartmentId" : "ocid1.compartment.oc1..<unique_ID>", + "tagNamespaceId" : "ocid1.namespace.oc1..<unique_ID>", + "tagDefinitionId" : "ocid1.tagdefinition.oc1..<unique_ID>", + "tagDefinitionName" : "Finance", + "value" : "W123", + "timeCreated" : "2018-11-22T19:00:00.000Z", + "lifecycleState" : "ACTIVE", + "isRequired" : "false" + } + type: object + CreateTagDefaultDetails: + properties: + compartmentId: + description: | + The OCID of the compartment. The tag default will be applied to all new resources created in this compartment. + type: string + isRequired: + description: | + If you specify that a value is required, a value is set during resource creation (either by + the user creating the resource or another tag defualt). If no value is set, resource + creation is blocked. + + * If the `isRequired` flag is set to "true", the value is set during resource creation. + * If the `isRequired` flag is set to "false", the value you enter is set during resource creation. + + Example: `false` + type: boolean + locks: + description: Locks associated with this resource. + items: + $ref: '#/components/schemas/AddLockDetails' + maxItems: 1 + type: array + tagDefinitionId: + description: | + The OCID of the tag definition. The tag default will always assign a default value for this tag definition. + type: string + value: + description: | + The default value for the tag definition. This will be applied to all new resources created in the compartment. + type: string + required: + - compartmentId + - tagDefinitionId + - value + x-example: | + { + "compartmentId" : "ocid1.compartment.oc1..<unique_ID>", + "tagDefinitionId" : "ocid1.tagdefinition.oc1..<unique_ID>", + "value" : "W123", + "isRequired" : "false" + } + type: object + TagDefault: + description: | + Tag defaults let you specify a default tag (tagnamespace.tag="value") to apply to all resource types + in a specified compartment. The tag default is applied at the time the resource is created. Resources + that exist in the compartment before you create the tag default are not tagged. The `TagDefault` object + specifies the tag and compartment details. + + Tag defaults are inherited by child compartments. This means that if you set a tag default on the root compartment + for a tenancy, all resources that are created in the tenancy are tagged. For more information about + using tag defaults, see [Managing Tag Defaults](/Content/Tagging/Tasks/managingtagdefaults.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. + properties: + compartmentId: + description: | + The OCID of the compartment. The tag default applies to all new resources that get created in the + compartment. Resources that existed before the tag default was created are not tagged. + type: string + id: + description: The OCID of the tag default. + type: string + isRequired: + description: | + If you specify that a value is required, a value is set during resource creation (either by the + user creating the resource or another tag defualt). If no value is set, resource creation is + blocked. + + * If the `isRequired` flag is set to "true", the value is set during resource creation. + * If the `isRequired` flag is set to "false", the value you enter is set during resource creation. + + Example: `false` + type: boolean + lifecycleState: + description: | + The tag default's current state. After creating a `TagDefault`, make sure its `lifecycleState` is ACTIVE before using it. + enum: + - ACTIVE + type: string + locks: + description: Locks associated with this resource. + items: + $ref: '#/components/schemas/ResourceLock' + type: array + tagDefinitionId: + description: | + The OCID of the tag definition. The tag default will always assign a default value for this tag definition. + type: string + tagDefinitionName: + description: | + The name used in the tag definition. This field is informational in the context of the tag default. + type: string + tagNamespaceId: + description: | + The OCID of the tag namespace that contains the tag definition. + type: string + timeCreated: + description: | + Date and time the `TagDefault` object was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + value: + description: | + The default value for the tag definition. This will be applied to all resources created in the compartment. + type: string + required: + - id + - compartmentId + - tagNamespaceId + - tagDefinitionId + - tagDefinitionName + - value + - timeCreated + - isRequired + x-example: | + { + "id" : "ocid1.tagdefault.oc1..<unique_ID>", + "compartmentId" : "ocid1.compartment.oc1..<unique_ID>", + "tagNamespaceId" : "ocid1.namespace.oc1..<unique_ID>", + "tagDefinitionId" : "ocid1.tagdefinition.oc1..<unique_ID>", + "tagDefinitionName" : "Finance", + "value" : "W123", + "timeCreated" : "2018-11-22T19:00:00.000Z", + "lifecycleState" : "ACTIVE", + "isRequired" : "true" + } + type: object + UpdateTagDefaultDetails: + properties: + isRequired: + description: | + If you specify that a value is required, a value is set during resource creation (either by + the user creating the resource or another tag defualt). If no value is set, resource + creation is blocked. + + * If the `isRequired` flag is set to "true", the value is set during resource creation. + * If the `isRequired` flag is set to "false", the value you enter is set during resource creation. + + Example: `false` + type: boolean + value: + description: | + The default value for the tag definition. This will be applied to all resources created in the Compartment. + type: string + required: + - value + x-example: | + { + "value" : "W123", + "isRequired" : "false" + } + type: object + TagNamespaceSummary: + description: | + A container for defined tags. + properties: + compartmentId: + description: The OCID of the compartment that contains the tag namespace. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description you assign to the tag namespace. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the tag namespace. + type: string + isRetired: + description: | + Whether the tag namespace is retired. + For more information, see [Retiring Key Definitions and Namespace Definitions](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm#retiringkeys). + type: boolean + lifecycleState: + description: The tagnamespace's current state. After creating a tagnamespace, make sure its `lifecycleState` is ACTIVE before using it. After retiring a tagnamespace, make sure its `lifecycleState` is INACTIVE before using it. + type: string + x-obmcs-enumref: '#/definitions/TagNamespace/lifecycleState' + locks: + description: Locks associated with this resource. + items: + $ref: '#/components/schemas/ResourceLock' + type: array + name: + description: | + The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed. + maxLength: 100 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. + (opaque JSON object) + type: string + description: | + Key-value pair representing a system tag key and value, scoped to a namespace. + Example: `{"free-tier-retained" : "true"}` + type: object + description: | + The 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: | + Date and time the tag namespace was created, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + type: object + CreateTagNamespaceDetails: + properties: + compartmentId: + description: The OCID of the tenancy containing the tag namespace. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description you assign to the tag namespace during creation. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + locks: + description: Locks associated with this resource. + items: + $ref: '#/components/schemas/AddLockDetails' + maxItems: 1 + type: array + name: + description: | + The name you assign to the tag namespace during creation. It must be unique across all tag namespaces in the tenancy and cannot be changed. + maxLength: 100 + minLength: 1 + type: string + required: + - name + - compartmentId + - description + type: object + TagNamespace: + description: | + A managed container for defined tags. A tag namespace is unique in a tenancy. For more information, + see [Managing Tags and Tag Namespaces](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values + using the API. + properties: + compartmentId: + description: The OCID of the compartment that contains the tag namespace. + maxLength: 100 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description you assign to the tag namespace. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the tag namespace. + maxLength: 100 + minLength: 1 + type: string + isRetired: + description: | + Whether the tag namespace is retired. + See [Retiring Key Definitions and Namespace Definitions](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm#retiringkeys). + type: boolean + lifecycleState: + description: The tagnamespace's current state. After creating a tagnamespace, make sure its `lifecycleState` is ACTIVE before using it. After retiring a tagnamespace, make sure its `lifecycleState` is INACTIVE before using it. + enum: + - ACTIVE + - INACTIVE + - DELETING + - DELETED + type: string + locks: + description: Locks associated with this resource. + items: + $ref: '#/components/schemas/ResourceLock' + type: array + name: + description: | + The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed. + maxLength: 100 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + timeCreated: + description: | + Date and time the tagNamespace was created, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - name + - description + - isRetired + - timeCreated + type: object + Tag: + description: | + A tag definition that belongs to a specific tag namespace. "Defined tags" must be set up in your tenancy before + you can apply them to resources. + For more information, see [Managing Tags and Tag Namespaces](/Content/Identity/Concepts/taggingoverview.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values + using the API. + properties: + compartmentId: + description: The OCID of the compartment that contains the tag definition. + maxLength: 100 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description you assign to the tag. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the tag definition. + maxLength: 100 + minLength: 1 + type: string + isCostTracking: + description: | + Indicates whether the tag is enabled for cost tracking. + type: boolean + isRetired: + description: | + Indicates whether the tag is retired. + See [Retiring Key Definitions and Namespace Definitions](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm#retiringkeys). + type: boolean + lifecycleState: + description: The tag's current state. After creating a tag, make sure its `lifecycleState` is ACTIVE before using it. After retiring a tag, make sure its `lifecycleState` is INACTIVE before using it. If you delete a tag, you cannot delete another tag until the deleted tag's `lifecycleState` changes from DELETING to DELETED. + enum: + - ACTIVE + - INACTIVE + - DELETING + - DELETED + type: string + name: + description: | + The name assigned to the tag during creation. This is the tag key definition. + The name must be unique within the tag namespace and cannot be changed. + maxLength: 100 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. + (opaque JSON object) + type: string + description: | + Key-value pair representing a system tag key and value, scoped to a namespace. + Example: `{"free-tier-retained" : "true"}` + type: object + description: | + The system tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + tagNamespaceId: + description: The OCID of the namespace that contains the tag definition. + maxLength: 100 + minLength: 1 + type: string + tagNamespaceName: + description: | + The name of the tag namespace that contains the tag definition. + maxLength: 100 + minLength: 1 + type: string + timeCreated: + description: | + Date and time the tag was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + validator: + $ref: '#/components/schemas/BaseTagDefinitionValidator' + required: + - compartmentId + - tagNamespaceId + - tagNamespaceName + - id + - name + - description + - isRetired + - timeCreated + type: object + UpdateTagNamespaceDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description you assign to the tag namespace. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + isRetired: + description: | + Whether the tag namespace is retired. + See [Retiring Key Definitions and Namespace Definitions](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm#retiringkeys). + type: boolean + type: object + ChangeTagNamespaceCompartmentDetail: + description: | + Details of the compartment the resource is being moved to. + properties: + compartmentId: + description: The Oracle Cloud ID (OCID) of the destination compartment. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + TagSummary: + description: | + A tag definition that belongs to a specific tag namespace. + properties: + compartmentId: + description: The OCID of the compartment that contains the tag definition. + maxLength: 100 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description you assign to the tag. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the tag definition. + maxLength: 100 + minLength: 1 + type: string + isCostTracking: + description: | + Indicates whether the tag is enabled for cost tracking. + type: boolean + isRetired: + description: | + Whether the tag is retired. + See [Retiring Key Definitions and Namespace Definitions](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm#retiringkeys). + type: boolean + lifecycleState: + description: The tag's current state. After creating a tag, make sure its `lifecycleState` is ACTIVE before using it. After retiring a tag, make sure its `lifecycleState` is INACTIVE before using it. If you delete a tag, you cannot delete another tag until the deleted tag's `lifecycleState` changes from DELETING to DELETED. + type: string + x-obmcs-enumref: '#/definitions/Tag/lifecycleState' + name: + description: | + The name assigned to the tag during creation. This is the tag key definition. + The name must be unique within the tag namespace and cannot be changed. + maxLength: 100 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. + (opaque JSON object) + type: string + description: | + Key-value pair representing a system tag key and value, scoped to a namespace. + Example: `{"free-tier-retained" : "true"}` + type: object + description: | + The 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: | + Date and time the tag was created, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + type: object + CreateTagDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description you assign to the tag during creation. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + isCostTracking: + description: | + Indicates whether the tag is enabled for cost tracking. + type: boolean + name: + description: | + The name you assign to the tag during creation. This is the tag key definition. + The name must be unique within the tag namespace and cannot be changed. + maxLength: 100 + minLength: 1 + type: string + validator: + $ref: '#/components/schemas/BaseTagDefinitionValidator' + required: + - name + - description + type: object + UpdateTagDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description you assign to the tag during creation. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + isCostTracking: + description: | + Indicates whether the tag is enabled for cost tracking. + type: boolean + isRetired: + description: | + Whether the tag is retired. + See [Retiring Key Definitions and Namespace Definitions](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm#retiringkeys). + type: boolean + validator: + $ref: '#/components/schemas/BaseTagDefinitionValidator' + type: object + TaggingWorkRequestSummary: + description: | + The work request summary. Tracks the status of the asynchronous operation. + properties: + compartmentId: + description: The OCID of the compartment that contains the work request. + type: string + id: + description: The OCID of the work request. + type: string + operationType: + description: An enum-like description of the type of work the work request is doing. + enum: + - DELETE_TAG_DEFINITION + - DELETE_NON_EMPTY_TAG_NAMESPACE + - BULK_DELETE_TAG_DEFINITION + - BULK_EDIT_OF_TAGS + - IMPORT_STANDARD_TAGS + type: string + percentComplete: + description: | + How much progress the operation has made. + format: float + maximum: 100 + minimum: 1 + type: number + resources: + description: | + The resources this work request affects. + items: + $ref: '#/components/schemas/WorkRequestResource' + type: array + status: + description: The current status of the work request. + enum: + - ACCEPTED + - IN_PROGRESS + - FAILED + - SUCCEEDED + - PARTIALLY_SUCCEEDED + - CANCELING + - CANCELED + type: string + timeAccepted: + description: | + Date and time the work was accepted, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeFinished: + description: | + Date and time the work completed, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeStarted: + description: | + Date and time the work started, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - operationType + - status + type: object + TaggingWorkRequest: + description: | + The asynchronous API request does not take effect immediately. This request spawns an asynchronous + workflow to fulfill the request. WorkRequest objects provide visibility for in-progress workflows. + properties: + compartmentId: + description: The OCID of the compartment that contains the work request. + type: string + id: + description: The OCID of the work request. + type: string + operationType: + description: An enum-like description of the type of work the work request is doing. + enum: + - DELETE_TAG_DEFINITION + - DELETE_NON_EMPTY_TAG_NAMESPACE + - BULK_DELETE_TAG_DEFINITION + - BULK_EDIT_OF_TAGS + - IMPORT_STANDARD_TAGS + type: string + percentComplete: + description: | + How much progress the operation has made. + format: float + maximum: 100 + minimum: 1 + type: number + resources: + description: | + The resources this work request affects. + items: + $ref: '#/components/schemas/WorkRequestResource' + type: array + status: + description: The current status of the work request. + enum: + - ACCEPTED + - IN_PROGRESS + - FAILED + - SUCCEEDED + - PARTIALLY_SUCCEEDED + - CANCELING + - CANCELED + type: string + timeAccepted: + description: | + Date and time the work was accepted, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeFinished: + description: | + Date and time the work completed, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeStarted: + description: | + Date and time the work started, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - operationType + - status + type: object + TaggingWorkRequestErrorSummary: + description: | + The error entity. + properties: + code: + description: A machine-usable code for the error that occured. + type: string + message: + description: A human-readable error string. + type: string + timestamp: + description: | + Date and time the error happened, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - code + - message + type: object + TaggingWorkRequestLogSummary: + description: | + The log entity. + properties: + message: + description: A human-readable error string. + type: string + timestamp: + description: | + Date and time the log was written, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - message + type: object + BulkDeleteTagsDetails: + description: Properties for deleting tags in bulk + properties: + tagDefinitionIds: + description: The OCIDs of the tag definitions to delete + items: + type: string + type: array + uniqueItems: true + required: + - tagDefinitionIds + type: object + BulkEditTagsDetails: + properties: + bulkEditOperations: + description: | + The operations associated with the request to bulk edit tags. + items: + $ref: '#/components/schemas/BulkEditOperationDetails' + type: array + compartmentId: + description: | + The OCID of the compartment where the bulk tag edit request is submitted. + type: string + resources: + description: | + The resources to be updated. + items: + $ref: '#/components/schemas/BulkEditResource' + type: array + uniqueItems: true + required: + - compartmentId + - resources + - bulkEditOperations + type: object + ImportStandardTagsDetails: + properties: + compartmentId: + description: | + The OCID of the compartment where the bulk create request is submitted and where the tag namespaces will be created. + type: string + standardTagNamespaceName: + description: | + The name of standard tag namespace that will be imported in bulk + type: string + required: + - compartmentId + - standardTagNamespaceName + type: object + BulkEditTagsResourceTypeCollection: + description: | + The list of resource types that support bulk editing of tags. + properties: + items: + description: The collection of resource types that support bulk editing of tags. + items: + $ref: '#/components/schemas/BulkEditTagsResourceType' + type: array + required: + - items + type: object + StandardTagNamespaceTemplateSummary: + description: The template of the standard tag namespace. This object includes necessary details to create the provided standard tag namespace. + properties: + description: + description: The default description of the tag namespace that users can use to create the tag namespace + type: string + standardTagNamespaceName: + description: The reserved name of this standard tag namespace + type: string + status: + description: The status of the standard tag namespace + type: string + required: + - standardTagNamespaceName + - description + - status + type: object + StandardTagNamespaceTemplate: + description: The template of the standard tag namespace. This object includes necessary details to create the provided standard tag namespace. + properties: + description: + description: The default description of the tag namespace that users can use to create the tag namespace + type: string + standardTagNamespaceName: + description: The reserved name of this standard tag namespace + type: string + status: + description: The status of the standard tag namespace + type: string + tagDefinitionTemplates: + description: The template of the tag definition. This object includes necessary details to create the provided standard tag definition. + items: + $ref: '#/components/schemas/StandardTagDefinitionTemplate' + type: array + required: + - standardTagNamespaceName + - description + - tagDefinitionTemplates + - status + type: object + Tenancy: + description: | + The root compartment that contains all of your organization's compartments and other + Oracle Cloud Infrastructure cloud resources. When you sign up for Oracle Cloud Infrastructure, + Oracle creates a tenancy for your company, which is a secure and isolated partition + where you can create, organize, and administer your cloud resources. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see [Get Started with Policies](/Content/Identity/policiesgs/get-started-with-policies.htm). + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: The description of the tenancy. + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + homeRegionKey: + description: | + The region key for the tenancy's home region. For the full list of supported regions, see + [Regions and Availability Domains](/Content/General/Concepts/regions.htm). + + Example: `PHX` + type: string + id: + description: The OCID of the tenancy. + type: string + name: + description: The name of the tenancy. + type: string + upiIdcsCompatibilityLayerEndpoint: + description: Url which refers to the UPI IDCS compatibility layer endpoint configured for this Tenant's home region. + type: string + type: object + RegionSubscription: + description: | + An object that represents your tenancy's access to a particular region (i.e., a subscription), the status of that + access, and whether that region is the home region. For more information, see [Managing Regions](/Content/Identity/regions/managingregions.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see [Get Started with Policies](/Content/Identity/policiesgs/get-started-with-policies.htm). + properties: + isHomeRegion: + description: Indicates if the region is the home region or not. + type: boolean + regionKey: + description: | + The region's key. See [Regions and Availability Domains](/Content/General/Concepts/regions.htm) + for the full list of supported 3-letter region codes. + + Example: `PHX` + maxLength: 16 + minLength: 1 + type: string + regionName: + description: | + The region's name. See [Regions and Availability Domains](/Content/General/Concepts/regions.htm) + for the full list of supported region names. + + Example: `us-phoenix-1` + maxLength: 16 + minLength: 1 + type: string + status: + description: The region subscription status. + enum: + - READY + - IN_PROGRESS + type: string + required: + - regionKey + - regionName + - status + - isHomeRegion + type: object + CreateRegionSubscriptionDetails: + properties: + regionKey: + description: | + The regions's key. See [Regions and Availability Domains](/Content/General/Concepts/regions.htm) for + the full list of supported 3-letter region codes. + + Example: `PHX` + maxLength: 16 + minLength: 1 + type: string + required: + - regionKey + type: object + UserGroupMembership: + description: | + An object that represents the membership of a user in a group. When you add a user to a group, the result is a + `UserGroupMembership` with its own OCID. To remove a user from a group, you delete the `UserGroupMembership` object. + properties: + compartmentId: + description: The OCID of the tenancy containing the user, group, and membership object. + type: string + groupId: + description: The OCID of the group. + type: string + id: + description: The OCID of the membership. + type: string + inactiveStatus: + description: The detailed status of INACTIVE lifecycleState. + format: int64 + type: integer + lifecycleState: + description: | + The membership's current state. After creating a membership object, make sure its `lifecycleState` changes + from CREATING to ACTIVE before using it. + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - DELETED + maxLength: 64 + minLength: 1 + type: string + timeCreated: + description: | + Date and time the membership was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + userId: + description: The OCID of the user. + type: string + required: + - id + - compartmentId + - timeCreated + - lifecycleState + - groupId + - userId + type: object + AddUserToGroupDetails: + properties: + groupId: + description: The OCID of the group. + type: string + userId: + description: The OCID of the user. + type: string + required: + - userId + - groupId + type: object + User: + description: | + An individual employee or system that needs to manage or use your company's Oracle Cloud Infrastructure + resources. Users might need to launch instances, manage remote disks, work with your cloud network, etc. Users + have one or more IAM Service credentials ([ApiKey](#/en/identity/20160918/ApiKey/), + [UIPassword](#/en/identity/20160918/UIPassword/), [SwiftPassword](#/en/identity/20160918/SwiftPassword/) and + [AuthToken](#/en/identity/20160918/AuthToken/)). + For more information, see [User Credentials](/Content/Identity/usercred/usercredentials.htm)). End users of your + application are not typically IAM Service users, but for tenancies that have identity domains, they might be. + For conceptual information about users and other IAM Service components, see [Overview of IAM](/Content/Identity/getstarted/identity-domains.htm). + + These users are created directly within the Oracle Cloud Infrastructure system, via the IAM service. + They are different from *federated users*, who authenticate themselves to the Oracle Cloud Infrastructure + Console via an identity provider. For more information, see + [Identity Providers and Federation](/Content/Identity/Concepts/federation.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, + see [Get Started with Policies](/Content/Identity/policiesgs/get-started-with-policies.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values + using the API. + properties: + capabilities: + $ref: '#/components/schemas/UserCapabilities' + compartmentId: + description: The OCID of the tenancy containing the user. + type: string + dbUserName: + description: DB username of the DB credential. Has to be unique across the tenancy. + maxLength: 201 + minLength: 0 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: | + The description you assign to the user. Does not have to be unique, and it's changeable. + + (For tenancies that support identity domains) You can have an empty description. + maxLength: 400 + minLength: 1 + type: string + email: + description: | + The email address you assign to the user. + The email address must be unique across all users in the tenancy. + + (For tenancies that support identity domains) The email address is required unless the requirement is disabled at the tenancy level. + maxLength: 254 + minLength: 0 + type: string + emailVerified: + description: Whether the email address has been validated. + type: boolean + externalIdentifier: + description: Identifier of the user in the identity provider + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the user. + type: string + identityProviderId: + description: The OCID of the `IdentityProvider` this user belongs to. + type: string + inactiveStatus: + description: | + Returned only if the user's `lifecycleState` is INACTIVE. A 16-bit value showing the reason why the user + is inactive: + + - bit 0: SUSPENDED (reserved for future use) + - bit 1: DISABLED (reserved for future use) + - bit 2: BLOCKED (the user has exceeded the maximum number of failed login attempts for the Console) + format: int64 + type: integer + isMfaActivated: + description: Flag indicates if MFA has been activated for the user. + type: boolean + lastSuccessfulLoginTime: + description: | + The date and time of when the user most recently logged in the + format defined by RFC3339 (ex. `2016-08-25T21:10:29.600Z`). + If there is no login history, this field is null. + + For illustrative purposes, suppose we have a user who has logged in + at July 1st, 2020 at 1200 PST and logged out 30 minutes later. + They then login again on July 2nd, 2020 at 1500 PST. + + Their previousSuccessfulLoginTime would be `2020-07-01:19:00.000Z`. + + Their lastSuccessfulLoginTime would be `2020-07-02:22:00.000Z`. + format: date-time + type: string + lifecycleState: + description: | + The user's current state. After creating a user, make sure its `lifecycleState` changes from CREATING to + ACTIVE before using it. + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - DELETED + maxLength: 64 + minLength: 1 + type: string + name: + description: | + The name you assign to the user during creation. This is the user's login for the Console. + The name must be unique across all users in the tenancy and cannot be changed. + maxLength: 100 + minLength: 1 + type: string + previousSuccessfulLoginTime: + description: | + The date and time of when the user most recently logged in the + format defined by RFC3339 (ex. `2016-08-25T21:10:29.600Z`). + If there is no login history, this field is null. + + For illustrative purposes, suppose we have a user who has logged in + at July 1st, 2020 at 1200 PST and logged out 30 minutes later. + They then login again on July 2nd, 2020 at 1500 PST. + + Their previousSuccessfulLoginTime would be `2020-07-01:19:00.000Z`. + + Their lastSuccessfulLoginTime would be `2020-07-02:22:00.000Z`. + format: date-time + type: string + timeCreated: + description: | + Date and time the user was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - name + - description + - timeCreated + - lifecycleState + - isMfaActivated + type: object + CreateUserDetails: + properties: + compartmentId: + description: The OCID of the tenancy containing the user. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: | + The description you assign to the user during creation. Does not have to be unique, and it's changeable. + + (For tenancies that support identity domains) You can have an empty description. + maxLength: 400 + minLength: 1 + type: string + email: + description: | + The email you assign to the user during creation. The email must be unique across all users in the tenancy. + + (For tenancies that support identity domains) You must provide an email for each user. + maxLength: 254 + minLength: 0 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + name: + description: | + The name you assign to the user during creation. This is the user's login for the Console. + The name must be unique across all users in the tenancy and cannot be changed. + maxLength: 100 + minLength: 1 + type: string + required: + - name + - compartmentId + - description + type: object + UpdateUserDetails: + properties: + dbUserName: + description: DB username of the DB credential. Has to be unique across the tenancy. + maxLength: 201 + minLength: 0 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: | + The description you assign to the user. Does not have to be unique, and it's changeable. + + (For tenancies that support identity domains) You can have an empty description. + maxLength: 400 + minLength: 1 + type: string + email: + description: | + The email you assign to the user during creation. The email must be unique across all users in the tenancy. + + (For tenancies that support identity domains) You must provide an email for each user. + maxLength: 254 + minLength: 0 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + type: object + ApiKey: + description: | + A PEM-format RSA credential for securing requests to the Oracle Cloud Infrastructure REST API. Also known + as an *API signing key*. Specifically, this is the public key from the key pair. The private key remains with + the user calling the API. For information about generating a key pair + in the required PEM format, see [Required Keys and OCIDs](/Content/API/Concepts/apisigningkey.htm). + + **Important:** This is **not** the SSH key for accessing compute instances. + + Each user can have a maximum of three API signing keys. + + For more information about user credentials, see [User Credentials](/Content/Identity/Concepts/usercredentials.htm). + properties: + fingerprint: + description: The key's fingerprint (e.g., 12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef). + type: string + inactiveStatus: + description: The detailed status of INACTIVE lifecycleState. + format: int64 + type: integer + keyId: + description: | + An Oracle-assigned identifier for the key, in this format: + TENANCY_OCID/USER_OCID/KEY_FINGERPRINT. + type: string + keyValue: + description: The key's value. + type: string + lifecycleState: + description: | + The API key's current state. After creating an `ApiKey` object, make sure its `lifecycleState` changes from + CREATING to ACTIVE before using it. + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - DELETED + maxLength: 64 + minLength: 1 + type: string + timeCreated: + description: | + Date and time the `ApiKey` object was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + userId: + description: The OCID of the user the key belongs to. + type: string + type: object + CreateApiKeyDetails: + properties: + key: + description: The public key. Must be an RSA key in PEM format. + type: string + required: + - key + type: object + AuthToken: + description: | + An `AuthToken` is an Oracle-generated token string that you can use to authenticate with third-party APIs + that do not support Oracle Cloud Infrastructure's signature-based authentication. For example, use an `AuthToken` + to authenticate with a Swift client with the Object Storage Service. + + The auth token is associated with the user's Console login. Auth tokens never expire. A user can have up to two + auth tokens at a time. + + **Note:** The token is always an Oracle-generated string; you can't change it to a string of your choice. + + For more information, see [Managing User Credentials](/Content/Identity/access/managing-user-credentials.htm). + properties: + description: + description: | + The description you assign to the auth token. Does not have to be unique, and it's changeable. + + (For tenancies that support identity domains) You can have an empty description. + type: string + id: + description: The OCID of the auth token. + type: string + inactiveStatus: + description: The detailed status of INACTIVE lifecycleState. + format: int64 + type: integer + lifecycleState: + description: | + The token's current state. After creating an auth token, make sure its `lifecycleState` changes from + CREATING to ACTIVE before using it. + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - DELETED + maxLength: 64 + minLength: 1 + type: string + timeCreated: + description: | + Date and time the `AuthToken` object was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeExpires: + description: | + Date and time when this auth token will expire, in the format defined by RFC3339. + Null if it never expires. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + token: + description: | + The auth token. The value is available only in the response for `CreateAuthToken`, and not + for `ListAuthTokens` or `UpdateAuthToken`. + format: password + type: string + userId: + description: The OCID of the user the auth token belongs to. + type: string + type: object + CreateAuthTokenDetails: + properties: + description: + description: | + The description you assign to the auth token during creation. Does not have to be unique, and it's changeable. + + (For tenancies that support identity domains) You can have an empty description. + maxLength: 400 + minLength: 1 + type: string + required: + - description + type: object + UpdateAuthTokenDetails: + properties: + description: + description: | + The description you assign to the auth token. Does not have to be unique, and it's changeable. + + (For tenancies that support identity domains) You can have an empty description. + type: string + type: object + UpdateUserCapabilitiesDetails: + properties: + canUseApiKeys: + description: | + Indicates if the user can use API keys. + type: boolean + canUseAuthTokens: + description: | + Indicates if the user can use SWIFT passwords / auth tokens. + type: boolean + canUseConsolePassword: + description: | + Indicates if the user can log in to the console. + type: boolean + canUseCustomerSecretKeys: + description: | + Indicates if the user can use SigV4 symmetric keys. + type: boolean + canUseDBCredentials: + description: | + Indicates if the user can use DB passwords. + type: boolean + canUseOAuth2ClientCredentials: + description: | + Indicates if the user can use OAuth2 credentials and tokens. + type: boolean + canUseSmtpCredentials: + description: | + Indicates if the user can use SMTP passwords. + type: boolean + type: object + CustomerSecretKeySummary: + description: | + As the name suggests, a `CustomerSecretKeySummary` object contains information about a `CustomerSecretKey`. + A `CustomerSecretKey` is an Oracle-provided key for using the Object Storage Service's Amazon S3 compatible API. + properties: + displayName: + description: The displayName you assign to the secret key. Does not have to be unique, and it's changeable. + type: string + id: + description: The OCID of the secret key. + type: string + inactiveStatus: + description: The detailed status of INACTIVE lifecycleState. + format: int64 + type: integer + lifecycleState: + description: | + The secret key's current state. After creating a secret key, make sure its `lifecycleState` changes from + CREATING to ACTIVE before using it. + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - DELETED + maxLength: 64 + minLength: 1 + type: string + timeCreated: + description: | + Date and time the `CustomerSecretKey` object was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeExpires: + description: | + Date and time when this password will expire, in the format defined by RFC3339. + Null if it never expires. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + userId: + description: The OCID of the user the password belongs to. + type: string + type: object + CreateCustomerSecretKeyDetails: + properties: + displayName: + description: | + The name you assign to the secret key during creation. Does not have to be unique, and it's changeable. + maxLength: 200 + minLength: 1 + type: string + required: + - displayName + type: object + CustomerSecretKey: + description: | + A `CustomerSecretKey` is an Oracle-provided key for using the Object Storage Service's + [Amazon S3 compatible API](/Content/Object/Tasks/s3compatibleapi.htm). The key consists of a + secret key/access key pair. A user can have up to two secret keys at a time. + + **Note:** The secret key is always an Oracle-generated string; you can't change it to a string of your choice. + + For more information, see [Managing User Credentials](/Content/Identity/access/managing-user-credentials.htm). + properties: + displayName: + description: The display name you assign to the secret key. Does not have to be unique, and it's changeable. + type: string + id: + description: The access key portion of the key pair. + type: string + inactiveStatus: + description: The detailed status of INACTIVE lifecycleState. + format: int64 + type: integer + key: + description: | + The secret key. + type: string + lifecycleState: + description: | + The secret key's current state. After creating a secret key, make sure its `lifecycleState` changes from + CREATING to ACTIVE before using it. + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - DELETED + maxLength: 64 + minLength: 1 + type: string + timeCreated: + description: | + Date and time the `CustomerSecretKey` object was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeExpires: + description: | + Date and time when this password will expire, in the format defined by RFC3339. + Null if it never expires. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + userId: + description: The OCID of the user the password belongs to. + type: string + type: object + UpdateCustomerSecretKeyDetails: + properties: + displayName: + description: | + The description you assign to the secret key. Does not have to be unique, and it's changeable. + + (For tenancies that support identity domains) You can have an empty description. + type: string + type: object + DbCredentialSummary: + description: | + As the name suggests, an `DbCredentialSummary` object contains information about an `DbCredential`. + The DB credential is used for DB authentication with + the [DB Service]. + properties: + description: + description: | + The description you assign to the DB credential. Does not have to be unique, and it's changeable. + + (For tenancies that support identity domains) You can have an empty description. + type: string + id: + description: The OCID of the DB credential. + type: string + lifecycleState: + description: | + The credential's current state. After creating a DB credential, make sure its `lifecycleState` changes from + CREATING to ACTIVE before using it. + maxLength: 64 + minLength: 1 + type: string + x-obmcs-enumref: '#/definitions/DbCredential/lifecycleState' + timeCreated: + description: | + Date and time the `DbCredential` object was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeExpires: + description: | + Date and time when this credential will expire, in the format defined by RFC3339. + Null if it never expires. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + userId: + description: The OCID of the user the DB credential belongs to. + type: string + type: object + CreateDbCredentialDetails: + properties: + description: + description: | + The description you assign to the DB credentials during creation. + + (For tenancies that support identity domains) You can have an empty description. + type: string + password: + description: | + The password for the DB credentials during creation. + type: string + required: + - password + - description + type: object + DbCredential: + description: | + Database credentials are needed for onboarding cloud database to identity. + The DB credentials are used for DB authentication with the service. + properties: + id: + description: The OCID of the DB credential. + type: string + lifecycleDetails: + description: The detailed status of INACTIVE lifecycleState. + format: int64 + type: integer + lifecycleState: + description: | + The credential's current state. After creating a DB credential, make sure its `lifecycleState` changes from + CREATING to ACTIVE before using it. + enum: + - CREATING + - ACTIVE + - DELETING + - DELETED + maxLength: 64 + minLength: 1 + type: string + timeCreated: + description: | + Date and time the `DbCredential` object was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeExpires: + description: | + Date and time when this credential will expire, in the format defined by RFC3339. + Null if it never expires. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + userId: + description: The OCID of the user the DB credential belongs to. + type: string + type: object + MfaTotpDeviceSummary: + description: | + As the name suggests, a `MfaTotpDeviceSummary` object contains information about a `MfaTotpDevice`. + properties: + id: + description: The OCID of the MFA TOTP Device. + type: string + inactiveStatus: + description: | + The detailed status of INACTIVE lifecycleState. + Allowed values are: + - 1 - SUSPENDED + - 2 - DISABLED + - 4 - BLOCKED + - 8 - LOCKED + format: int64 + type: integer + isActivated: + description: Flag to indicate if the MFA TOTP device has been activated + type: boolean + lifecycleState: + description: | + The MFA TOTP device's current state. + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - DELETED + maxLength: 64 + minLength: 1 + type: string + timeCreated: + description: | + Date and time the `MfaTotpDevice` object was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeExpires: + description: | + Date and time when this MFA TOTP device will expire, in the format defined by RFC3339. + Null if it never expires. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + userId: + description: The OCID of the user the MFA TOTP device belongs to. + type: string + required: + - id + - userId + - isActivated + - timeCreated + - lifecycleState + type: object + MfaTotpDevice: + description: | + Users can enable multi-factor authentication (MFA) for their own user accounts. After MFA is enabled, the + user is prompted for a time-based one-time password (TOTP) to authenticate before they can sign in to the + Console. To enable multi-factor authentication, the user must register a mobile device with a TOTP authenticator app + installed. The registration process creates the `MfaTotpDevice` object. The registration process requires + interaction with the Console and cannot be completed programmatically. For more information, see + [Managing Multi-Factor Authentication](/Content/Identity/mfa/understand-multi-factor-authentication.htm). + properties: + id: + description: The OCID of the MFA TOTP device. + type: string + inactiveStatus: + description: | + The detailed status of INACTIVE lifecycleState. + Allowed values are: + - 1 - SUSPENDED + - 2 - DISABLED + - 4 - BLOCKED + - 8 - LOCKED + format: int64 + type: integer + isActivated: + description: Flag to indicate if the MFA TOTP device has been activated. + type: boolean + lifecycleState: + description: | + The MFA TOTP device's current state. After creating the MFA TOTP device, make sure its `lifecycleState` changes from + CREATING to ACTIVE before using it. + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - DELETED + maxLength: 64 + minLength: 1 + type: string + seed: + description: | + The seed for the MFA TOTP device (Base32 encoded). + type: string + timeCreated: + description: | + Date and time the `MfaTotpDevice` object was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeExpires: + description: | + Date and time when this MFA TOTP device will expire, in the format defined by RFC3339. + Null if it never expires. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + userId: + description: The OCID of the user the MFA TOTP device belongs to. + type: string + required: + - id + - seed + - userId + - isActivated + - timeCreated + - lifecycleState + type: object + MfaTotpToken: + description: | + Totp token for MFA + properties: + totpToken: + description: | + The Totp token for MFA. + type: string + type: object + OAuth2ClientCredentialSummary: + description: | + User can define Oauth clients in IAM, then use it to generate a token to grant access to app resources. + properties: + compartmentId: + description: The OCID of the compartment containing the Oauth credential. + type: string + description: + description: The description of the Oauth credential. + type: string + expiresOn: + description: | + Date and time when this credential will expire, in the format defined by RFC3339. + Null if it never expires. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + id: + description: The OCID of the Oauth credential. + type: string + lifecycleState: + description: | + The credential's current state. After creating a Oauth credential, make sure its `lifecycleState` changes from + CREATING to ACTIVE before using it. + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - DELETED + type: string + name: + description: The name of the Oauth credential. + type: string + scopes: + description: Allowed scopes for the given oauth credential. + items: + $ref: '#/components/schemas/FullyQualifiedScope' + type: array + timeCreated: + description: | + Date and time the `OAuth2ClientCredential` object was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + userId: + description: The OCID of the user the Oauth credential belongs to. + type: string + type: object + CreateOAuth2ClientCredentialDetails: + properties: + description: + description: Description of the oauth credential to help user differentiate them. + type: string + name: + description: Name of the oauth credential to help user differentiate them. + type: string + scopes: + description: Allowed scopes for the given oauth credential. + items: + $ref: '#/components/schemas/FullyQualifiedScope' + type: array + required: + - name + - description + - scopes + type: object + OAuth2ClientCredential: + description: | + User can define Oauth clients in IAM, then use it to generate a token to grant access to app resources. + properties: + compartmentId: + description: The OCID of the compartment containing the Oauth credential. + type: string + description: + description: The description of the Oauth credential. + type: string + expiresOn: + description: | + Date and time when this credential will expire, in the format defined by RFC3339. + Null if it never expires. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + id: + description: The OCID of the Oauth credential. + type: string + lifecycleState: + description: | + The credential's current state. After creating a Oauth credential, make sure its `lifecycleState` changes from + CREATING to ACTIVE before using it. + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - DELETED + type: string + name: + description: The name of the Oauth credential. + type: string + password: + description: Returned during create and update with password reset requests. + type: string + scopes: + description: Allowed scopes for the given oauth credential. + items: + $ref: '#/components/schemas/FullyQualifiedScope' + type: array + timeCreated: + description: | + Date and time the `OAuth2ClientCredential` object was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + userId: + description: The OCID of the user the Oauth credential belongs to. + type: string + type: object + UpdateOAuth2ClientCredentialDetails: + properties: + description: + description: Description of the oauth credential to help user differentiate them. + type: string + isResetPassword: + description: Indicate if the password to be reset or not in the update. + type: boolean + scopes: + description: Allowed scopes for the given oauth credential. + items: + $ref: '#/components/schemas/FullyQualifiedScope' + type: array + required: + - description + - scopes + - passwordReset + type: object + SmtpCredentialSummary: + description: | + As the name suggests, an `SmtpCredentialSummary` object contains information about an `SmtpCredential`. + The SMTP credential is used for SMTP authentication with + the [Email Delivery Service](/Content/Email/Concepts/overview.htm). + properties: + description: + description: | + The description you assign to the SMTP credential. Does not have to be unique, and it's changeable. + + (For tenancies that support identity domains) You can have an empty description. + type: string + id: + description: The OCID of the SMTP credential. + type: string + inactiveStatus: + description: The detailed status of INACTIVE lifecycleState. + format: int64 + type: integer + lifecycleState: + description: | + The credential's current state. After creating a SMTP credential, make sure its `lifecycleState` changes from + CREATING to ACTIVE before using it. + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - DELETED + maxLength: 64 + minLength: 1 + type: string + timeCreated: + description: | + Date and time the `SmtpCredential` object was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeExpires: + description: | + Date and time when this credential will expire, in the format defined by RFC3339. + Null if it never expires. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + userId: + description: The OCID of the user the SMTP credential belongs to. + type: string + username: + description: | + The SMTP user name. + type: string + type: object + CreateSmtpCredentialDetails: + properties: + description: + description: | + The description you assign to the SMTP credentials during creation. Does not have to be unique, and it's changeable. + + (For tenancies that support identity domains) You can have an empty description. + maxLength: 400 + minLength: 1 + type: string + required: + - description + type: object + SmtpCredential: + description: | + Simple Mail Transfer Protocol (SMTP) credentials are needed to send email through Email Delivery. + The SMTP credentials are used for SMTP authentication with the service. The credentials never expire. + A user can have up to 2 SMTP credentials at a time. + + **Note:** The credential set is always an Oracle-generated SMTP user name and password pair; + you cannot designate the SMTP user name or the SMTP password. + + For more information, see [Managing User Credentials](/Content/Identity/access/managing-user-credentials.htm#SMTP). + properties: + description: + description: | + The description you assign to the SMTP credential. Does not have to be unique, and it's changeable. + + (For tenancies that support identity domains) You can have an empty description. + type: string + id: + description: The OCID of the SMTP credential. + type: string + inactiveStatus: + description: The detailed status of INACTIVE lifecycleState. + format: int64 + type: integer + lifecycleState: + description: | + The credential's current state. After creating a SMTP credential, make sure its `lifecycleState` changes from + CREATING to ACTIVE before using it. + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - DELETED + maxLength: 64 + minLength: 1 + type: string + password: + description: | + The SMTP password. + type: string + timeCreated: + description: | + Date and time the `SmtpCredential` object was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeExpires: + description: | + Date and time when this credential will expire, in the format defined by RFC3339. + Null if it never expires. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + userId: + description: The OCID of the user the SMTP credential belongs to. + type: string + username: + description: | + The SMTP user name. + type: string + type: object + UpdateSmtpCredentialDetails: + properties: + description: + description: | + The description you assign to the SMTP credential. Does not have to be unique, and it's changeable. + + (For tenancies that support identity domains) You can have an empty description. + type: string + type: object + UpdateStateDetails: + properties: + blocked: + description: | + Update state to blocked or unblocked. Only "false" is supported (for changing the state to unblocked). + type: boolean + type: object + SwiftPassword: + description: | + **Deprecated. Use [AuthToken](#/en/identity/20160918/AuthToken/) instead.** + + Swift is the OpenStack object storage service. A `SwiftPassword` is an Oracle-provided password for using a + Swift client with the Object Storage Service. This password is associated with + the user's Console login. Swift passwords never expire. A user can have up to two Swift passwords at a time. + + **Note:** The password is always an Oracle-generated string; you can't change it to a string of your choice. + + For more information, see [Managing User Credentials](/Content/Identity/Tasks/managingcredentials.htm). + properties: + description: + description: The description you assign to the Swift password. Does not have to be unique, and it's changeable. + type: string + expiresOn: + description: | + Date and time when this password will expire, in the format defined by RFC3339. + Null if it never expires. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + id: + description: The OCID of the Swift password. + type: string + inactiveStatus: + description: The detailed status of INACTIVE lifecycleState. + format: int64 + type: integer + lifecycleState: + description: | + The password's current state. After creating a password, make sure its `lifecycleState` changes from + CREATING to ACTIVE before using it. + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - DELETED + maxLength: 64 + minLength: 1 + type: string + password: + description: | + The Swift password. The value is available only in the response for `CreateSwiftPassword`, and not + for `ListSwiftPasswords` or `UpdateSwiftPassword`. + type: string + timeCreated: + description: | + Date and time the `SwiftPassword` object was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + userId: + description: The OCID of the user the password belongs to. + type: string + type: object + CreateSwiftPasswordDetails: + properties: + description: + description: | + The description you assign to the Swift password during creation. Does not have to be unique, and it's changeable. + + (For tenancies that support identity domains) You can have an empty description. + maxLength: 400 + minLength: 1 + type: string + required: + - description + type: object + UpdateSwiftPasswordDetails: + properties: + description: + description: | + The description you assign to the Swift password. Does not have to be unique, and it's changeable. + + (For tenancies that support identity domains) You can have an empty description. + type: string + type: object + UIPasswordInformation: + description: | + Information about the UIPassword, which is a text password that enables a user to sign in to the Console, + the user interface for interacting with Oracle Cloud Infrastructure. + + For more information about user credentials, see [User Credentials](/Content/Identity/Concepts/usercredentials.htm). + properties: + lifecycleState: + description: | + The password's current state. After creating a password, make sure its `lifecycleState` changes from + CREATING to ACTIVE before using it. + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - DELETED + maxLength: 64 + minLength: 1 + type: string + timeCreated: + description: | + Date and time the password was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + userId: + description: The OCID of the user. + type: string + type: object + UIPassword: + description: | + A text password that enables a user to sign in to the Console, the user interface for interacting with Oracle + Cloud Infrastructure. + + For more information about user credentials, see [User Credentials](/Content/Identity/usercred/usercredentials.htm). + properties: + inactiveStatus: + description: The detailed status of INACTIVE lifecycleState. + format: int64 + type: integer + lifecycleState: + description: | + The password's current state. After creating a password, make sure its `lifecycleState` changes from + CREATING to ACTIVE before using it. + enum: + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - DELETED + maxLength: 64 + minLength: 1 + type: string + password: + description: The user's password for the Console. + type: string + timeCreated: + description: | + Date and time the password was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + userId: + description: The OCID of the user. + type: string + type: object + WorkRequestSummary: + description: | + The work request summary. Tracks the status of the asynchronous operation. + properties: + compartmentId: + description: The OCID of the compartment that contains the work request. + type: string + errors: + description: | + The errors for work request. + items: + $ref: '#/components/schemas/WorkRequestError' + type: array + id: + description: The OCID of the work request. + type: string + operationType: + description: An enum-like description of the type of work the work request is doing. + enum: + - DELETE_COMPARTMENT + - DELETE_TAG_DEFINITION + type: string + percentComplete: + description: | + How much progress the operation has made. + format: float + maximum: 100 + minimum: 1 + type: number + resources: + description: | + The resources this work request affects. + items: + $ref: '#/components/schemas/WorkRequestResource' + type: array + status: + description: The current status of the work request. + enum: + - ACCEPTED + - IN_PROGRESS + - FAILED + - SUCCEEDED + - CANCELING + - CANCELED + type: string + timeAccepted: + description: | + Date and time the work was accepted, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeFinished: + description: | + Date and time the work completed, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeStarted: + description: | + Date and time the work started, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - operationType + - status + type: object + WorkRequest: + description: | + The asynchronous API request does not take effect immediately. This request spawns an asynchronous + workflow to fulfill the request. WorkRequest objects provide visibility for in-progress workflows. + properties: + compartmentId: + description: The OCID of the compartment that contains the work request. + type: string + errors: + description: | + The errors for work request. + items: + $ref: '#/components/schemas/WorkRequestError' + type: array + id: + description: The OCID of the work request. + type: string + logs: + description: | + The logs for work request. + items: + $ref: '#/components/schemas/WorkRequestLogEntry' + type: array + operationType: + description: An enum-like description of the type of work the work request is doing. + enum: + - DELETE_COMPARTMENT + - DELETE_TAG_DEFINITION + type: string + percentComplete: + description: | + How much progress the operation has made. + format: float + maximum: 100 + minimum: 1 + type: number + resources: + description: | + The resources this work request affects. + items: + $ref: '#/components/schemas/WorkRequestResource' + type: array + status: + description: The current status of the work request. + enum: + - ACCEPTED + - IN_PROGRESS + - FAILED + - SUCCEEDED + - CANCELING + - CANCELED + type: string + timeAccepted: + description: | + Date and time the work was accepted, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeFinished: + description: | + Date and time the work completed, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeStarted: + description: | + Date and time the work started, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - operationType + - status + type: object + Error: + properties: + code: + description: | + A short error code that defines the error, meant for programmatic parsing. See + [API Errors](/Content/API/References/apierrors.htm). + type: string + message: + description: A human-readable error string. + type: string + required: + - code + - message + type: object + NetworkPolicy: + description: | + Network policy, which consists of a list of network source IDs. + properties: + networkSourceIds: + description: | + Network Source ids + items: + maxLength: 255 + minLength: 1 + type: string + type: array + type: object + PasswordPolicy: + description: | + Password policy, currently set for the given compartment. + properties: + isLowercaseCharactersRequired: + default: true + description: At least one lower case character required. + type: boolean + isNumericCharactersRequired: + default: true + description: At least one numeric character required. + type: boolean + isSpecialCharactersRequired: + default: true + description: At least one special character required. + type: boolean + isUppercaseCharactersRequired: + default: true + description: At least one uppercase character required. + type: boolean + isUsernameContainmentAllowed: + default: false + description: User name is allowed to be part of the password. + type: boolean + minimumPasswordLength: + default: 12 + description: Minimum password length required. + type: integer + type: object + BulkActionResourceType: + properties: + metadataKeys: + description: | + List of metadata keys required to identify a specific resource. Some resource-types require information besides an OCID to identify + a specific resource. For example, the resource-type `buckets` requires metadataKeys ["namespaceName", "bucketName"] to + identify a specific bucket. The required information to identify a resource is in the API documentation for the + resource-type. For example, the required information for `buckets` is found in the + [DeleteBucket API](#/en/objectstorage/20160918/Bucket/DeleteBucket). + items: + maxLength: 255 + minLength: 1 + type: string + type: array + name: + description: | + The unique name of the resource-type. + maxLength: 255 + minLength: 1 + type: string + required: + - name + type: object + BulkActionResource: + description: | + The bulk action resource entity. + properties: + entityType: + description: | + The resource-type. To get the list of supported resource-types use + [ListBulkActionResourceTypes API](#/en/identity/20160918/BulkActionResourceTypeCollection/ListBulkActionResourceTypes/). + type: string + identifier: + description: The resource OCID. + type: string + metadata: + additionalProperties: + type: string + description: | + Additional information that helps to identity the resource for bulk action. + + The APIs to delete and move most resource types only require the resource identifier (ocid). + But some resource-types require additional identifying information. + + This information is provided in the resource's public API document. It is also + available through the + [ListBulkActionResourceTypes API](#/en/identity/20160918/BulkActionResourceTypeCollection/ListBulkActionResourceTypes/). + + **Example**: + The APIs to delete or move the `buckets` resource-type require `namespaceName` and `bucketName` to identify the resource, as + shown in the APIs, [DeleteBucket](#/en/objectstorage/20160918/Bucket/DeleteBucket) and + [UpdateBucket](#/en/objectstorage/20160918/Bucket/UpdateBucket). + + To add a bucket for bulk actions, specify `namespaceName` and `bucketName` in + the metadata property as shown in this example + + { + "identifier": "" + "entityType": "bucket", + "metadata": + { + "namespaceName": "sampleNamespace", + "bucketName": "sampleBucket" + } + } + type: object + required: + - identifier + - entityType + type: object + ReplicatedRegionDetails: + description: (For tenancies that support identity domains) Properties for a region where a replica for the identity domain exists. + properties: + region: + description: | + A REPLICATION_ENABLED region, e.g. us-ashburn-1. + See [Regions and Availability Domains](/Content/General/Concepts/regions.htm) + for the full list of supported region names. + maxLength: 50 + minLength: 1 + type: string + regionalUrl: + description: Region-specific identity domain URL. + type: string + state: + description: | + The IDCS-replicated region state. + enum: + - ENABLING_REPLICATION + - REPLICATION_ENABLED + - DISABLING_REPLICATION + - REPLICATION_DISABLED + - DELETED + maxLength: 64 + minLength: 1 + type: string + url: + description: Region-agnostic identity domain URL. + type: string + type: object + IamWorkRequestResource: + description: (For tenancies that support identity domains) A IAM work request resource entry. + properties: + actionType: + description: | + The way in which this resource is affected by the work tracked in the work request. + A resource being created, updated, or deleted will remain in the IN_PROGRESS state until + work is complete for that resource at which point it will transition to CREATED, UPDATED, + or DELETED, respectively. + enum: + - CREATED + - UPDATED + - DELETED + - RELATED + - IN_PROGRESS + maxLength: 11 + minLength: 1 + type: string + entityType: + description: The resource type the work request is affects. + maxLength: 32 + minLength: 1 + type: string + entityUri: + description: The URI path that the user can do a GET on to access the resource metadata. + maxLength: 1000 + minLength: 1 + type: string + identifier: + description: An OCID of the resource that the work request affects. + maxLength: 100 + minLength: 1 + type: string + required: + - actionType + - entityType + - identifier + type: object + ResourceLockPolicy: + description: | + Resource locks are used to prevent certain APIs from being called for the resource. + A full lock prevents both updating the resource and deleting the resource. A delete + lock prevents deleting the resource. + properties: + compartmentId: + description: The compartment ID of the lock. + type: string + isActive: + description: Indicates if the lock is active or not. For example, if there are mutliple FULL locks, the first-created FULL lock wi`ll be effective. + type: boolean + message: + description: | + A message added by the creator of the lock. This is typically used to give an + indication of why the resource is locked. + type: string + relatedResourceId: + description: | + The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. + type: string + timeCreated: + description: When the lock was created. + format: date-time + type: string + type: + description: Type of the lock. + enum: + - FULL + - DELETE + type: string + required: + - type + type: object + ResourceLock: + description: | + Resource locks are used to prevent certain APIs from being called for the resource. + A full lock prevents both updating the resource and deleting the resource. A delete + lock prevents deleting the resource. + properties: + isActive: + description: Indicates if the lock is active or not. For example, if there are mutliple FULL locks, the first-created FULL lock will be effective. + type: boolean + message: + description: | + A message added by the creator of the lock. This is typically used to give an + indication of why the resource is locked. + type: string + relatedResourceId: + description: | + The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. + type: string + timeCreated: + description: When the lock was created. + format: date-time + type: string + type: + description: Type of the lock. + enum: + - FULL + - DELETE + type: string + required: + - type + type: object + AddLockDetails: + description: | + Request payload to add lock to the resource. + properties: + message: + description: | + A message added by the creator of the lock. This is typically used to give an + indication of why the resource is locked. + type: string + relatedResourceId: + description: | + The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. + type: string + type: + description: Type of the lock. + enum: + - FULL + - DELETE + type: string + required: + - type + type: object + RemoveLockDetails: + description: | + Request payload to remove lock to the resource. + properties: + type: + description: Type of the lock. + enum: + - FULL + - DELETE + type: string + required: + - type + type: object + BaseTagDefinitionValidator: + description: | + Validates a definedTag value. Each validator performs validation steps in addition to the standard + validation for definedTag values. For more information, see + [Limits on Tags](/Content/Tagging/Concepts/taggingoverview.htm#limits). + + If you define a validator after a value has been set for a defined tag, then any updates that + attempt to change the value must pass the additional validation defined by the current rule. + Previously set values (even those that would fail the current validation) are not updated. You can + still update other attributes to resources that contain a non-valid defined tag. + + To clear the validator call UpdateTag with + [DefaultTagDefinitionValidator](/api/#/en/identity/latest/datatypes/DefaultTagDefinitionValidator). + discriminator: + propertyName: validatorType + properties: + validatorType: + description: | + Specifies the type of validation: a static value (no validation) or a list. + enum: + - ENUM + - DEFAULT + type: string + required: + - validatorType + type: object + WorkRequestResource: + description: | + The resource entity. + properties: + actionType: + description: The way in which this resource was affected by the work tracked by the work request. + enum: + - CREATED + - UPDATED + - DELETED + - RELATED + - IN_PROGRESS + - FAILED + type: string + entityType: + description: The resource type the work request is affects. + type: string + entityUri: + description: The URI path that the user can do a GET on to access the resource metadata. + type: string + identifier: + description: The resource identifier the work request affects. + type: string + required: + - identifier + - actionType + - entityType + type: object + BulkEditOperationDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + operationType: + description: | + An enum-like description of the type of operation. + + * `ADD_WHERE_ABSENT` adds a defined tag only if the tag does not already exist on the resource. + * `SET_WHERE_PRESENT` updates the value for a defined tag only if the tag is present on the resource. + * `ADD_OR_SET` combines the first two operations to add a defined tag if it does not already exist on the resource + or update the value for a defined tag only if the tag is present on the resource. + * `REMOVE` removes the defined tag from the resource. The tag is removed from the resource regardless of the tag value. + enum: + - ADD_WHERE_ABSENT + - SET_WHERE_PRESENT + - ADD_OR_SET + - REMOVE + type: string + required: + - operationType + - definedTags + type: object + BulkEditResource: + properties: + id: + description: The unique OCID of the resource. + type: string + metadata: + additionalProperties: + description: Additional information that helps to identify the resource. + type: string + description: | + Additional information that identifies the resource for bulk editing of tags. This information is provided in the resource's API documentation. + example: | + UPDATE API for bucket require 'namespaceName' and 'bucketName'. + https://docs.cloud.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/Bucket/DeleteBucket + https://docs.cloud.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/Bucket/UpdateBucket + + To add a bucket for bulk actions, specify 'namespaceName' and 'bucketName' in + the metadata property: + { + "identifier": "ocid_of_bucket" + "entityType": "bucket", + "metadata": + { + "namespaceName": "sampleNamespace", + "bucketName": "sampleBucket" + } + } + type: object + resourceType: + description: The type of resource. See [BulkEditResourceTypes](#/en/identity/latest/BulkEditTagsResourceTypeCollection/ListBulkEditTagsResourceTypes). + type: string + required: + - id + - resourceType + type: object + BulkEditTagsResourceType: + properties: + metadataKeys: + description: | + The metadata keys required to identify the resource. + + For example, for a bucket, the value of `metadataKeys` will be ["namespaceName", "bucketName"]. + This information will match the API documentation. + See [UpdateBucket](/api/#/en/objectstorage/latest/Bucket/UpdateBucket) and + [DeleteBucket](/api/#/en/objectstorage/latest/Bucket/DeleteBucket). + items: + maxLength: 255 + minLength: 1 + type: string + type: array + resourceType: + description: | + The unique name of the resource type. + maxLength: 255 + minLength: 1 + type: string + required: + - resourceType + type: object + StandardTagDefinitionTemplate: + description: The template of the tag definition. This object includes necessary details to create the provided standard tag definition. + properties: + description: + description: The default description of the tag namespace that users can use to create the tag definition + type: string + enumMutability: + description: The mutability of the possible values list for enum tags. This will default to IMMUTABLE for string value tags + enum: + - IMMUTABLE + - MUTABLE + - APPENDABLE + type: string + isCostTracking: + description: Is the tag a cost tracking tag. Default will be false as cost tracking tags have been deprecated + type: boolean + possibleValues: + description: List of possible values. An optional parameter that will be present if the type of definition is enum. + items: + type: string + type: array + uniqueItems: true + tagDefinitionName: + description: The name of this standard tag definition + type: string + type: + description: The type of tag definition. Enum or string. + enum: + - ENUM + - STRING + type: string + required: + - description + - tagDefinitionName + - type + - isCostTracking + type: object + UserCapabilities: + description: Properties indicating how the user is allowed to authenticate. + properties: + canUseApiKeys: + description: Indicates if the user can use API keys. + type: boolean + canUseAuthTokens: + description: Indicates if the user can use SWIFT passwords / auth tokens. + type: boolean + canUseConsolePassword: + description: Indicates if the user can log in to the console. + type: boolean + canUseCustomerSecretKeys: + description: Indicates if the user can use SigV4 symmetric keys. + type: boolean + canUseDbCredentials: + description: | + Indicates if the user can use DB passwords. + type: boolean + canUseOAuth2ClientCredentials: + description: | + Indicates if the user can use OAuth2 credentials and tokens. + type: boolean + canUseSmtpCredentials: + description: Indicates if the user can use SMTP passwords. + type: boolean + type: object + FullyQualifiedScope: + properties: + audience: + description: Audience for the given scope context. + type: string + scope: + description: Allowed permission scope for the given context. + type: string + required: + - audience + - scope + type: object + WorkRequestError: + description: | + The error entity. + properties: + code: + description: A machine-usable code for the error that occured. + type: string + message: + description: A human-readable error string. + type: string + timestamp: + description: | + Date and time the error happened, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - code + - message + type: object + WorkRequestLogEntry: + description: | + The log entity. + properties: + message: + description: A human-readable error string. + type: string + timestamp: + description: | + Date and time the log was written, in the format defined by RFC3339. + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - message + type: object + ListAllowedDomainLicenseTypesResponse: + type: object + properties: + allowed_domain_license_types: + type: array + items: + $ref: '#/components/schemas/AllowedDomainLicenseTypeSummary' + ListAvailabilityDomainsResponse: + type: object + properties: + availability_domains: + type: array + items: + $ref: '#/components/schemas/AvailabilityDomain' + ListCompartmentsResponse: + type: object + properties: + compartments: + type: array + items: + $ref: '#/components/schemas/Compartment' + ListDomainsResponse: + type: object + properties: + domains: + type: array + items: + $ref: '#/components/schemas/DomainSummary' + ListDynamicGroupsResponse: + type: object + properties: + dynamic_groups: + type: array + items: + $ref: '#/components/schemas/DynamicGroup' + ListFaultDomainsResponse: + type: object + properties: + fault_domains: + type: array + items: + $ref: '#/components/schemas/FaultDomain' + ListGroupsResponse: + type: object + properties: + groups: + type: array + items: + $ref: '#/components/schemas/Group' + ListIamWorkRequestsResponse: + type: object + properties: + iam_work_requests: + type: array + items: + $ref: '#/components/schemas/IamWorkRequestSummary' + ListIamWorkRequestErrorsResponse: + type: object + properties: + iam_work_request_errors: + type: array + items: + $ref: '#/components/schemas/IamWorkRequestErrorSummary' + ListIamWorkRequestLogsResponse: + type: object + properties: + iam_work_request_logs: + type: array + items: + $ref: '#/components/schemas/IamWorkRequestLogSummary' + ListIdentityProvidersResponse: + type: object + properties: + identity_providers: + type: array + items: + $ref: '#/components/schemas/IdentityProvider' + ListIdpGroupMappingsResponse: + type: object + properties: + idp_group_mappings: + type: array + items: + $ref: '#/components/schemas/IdpGroupMapping' + ListIdentityProviderGroupsResponse: + type: object + properties: + identity_provider_groups: + type: array + items: + $ref: '#/components/schemas/IdentityProviderGroupSummary' + ListNetworkSourcesResponse: + type: object + properties: + network_sources: + type: array + items: + $ref: '#/components/schemas/NetworkSourcesSummary' + ListPoliciesResponse: + type: object + properties: + policies: + type: array + items: + $ref: '#/components/schemas/Policy' + ListRegionsResponse: + type: object + properties: + regions: + type: array + items: + $ref: '#/components/schemas/Region' + ListTagDefaultsResponse: + type: object + properties: + tag_defaults: + type: array + items: + $ref: '#/components/schemas/TagDefaultSummary' + AssembleEffectiveTagSetResponse: + type: object + properties: + assemble_effective_tag_set: + type: array + items: + $ref: '#/components/schemas/TagDefaultSummary' + ListTagNamespacesResponse: + type: object + properties: + tag_namespaces: + type: array + items: + $ref: '#/components/schemas/TagNamespaceSummary' + ListCostTrackingTagsResponse: + type: object + properties: + cost_tracking_tags: + type: array + items: + $ref: '#/components/schemas/Tag' + ListTagsResponse: + type: object + properties: + tags: + type: array + items: + $ref: '#/components/schemas/TagSummary' + ListTaggingWorkRequestsResponse: + type: object + properties: + tagging_work_requests: + type: array + items: + $ref: '#/components/schemas/TaggingWorkRequestSummary' + ListTaggingWorkRequestErrorsResponse: + type: object + properties: + tagging_work_request_errors: + type: array + items: + $ref: '#/components/schemas/TaggingWorkRequestErrorSummary' + ListTaggingWorkRequestLogsResponse: + type: object + properties: + tagging_work_request_logs: + type: array + items: + $ref: '#/components/schemas/TaggingWorkRequestLogSummary' + ListStandardTagNamespacesResponse: + type: object + properties: + standard_tag_namespaces: + type: array + items: + $ref: '#/components/schemas/StandardTagNamespaceTemplateSummary' + ListRegionSubscriptionsResponse: + type: object + properties: + region_subscriptions: + type: array + items: + $ref: '#/components/schemas/RegionSubscription' + ListUserGroupMembershipsResponse: + type: object + properties: + user_group_memberships: + type: array + items: + $ref: '#/components/schemas/UserGroupMembership' + ListUsersResponse: + type: object + properties: + users: + type: array + items: + $ref: '#/components/schemas/User' + ListApiKeysResponse: + type: object + properties: + api_keys: + type: array + items: + $ref: '#/components/schemas/ApiKey' + ListAuthTokensResponse: + type: object + properties: + auth_tokens: + type: array + items: + $ref: '#/components/schemas/AuthToken' + ListCustomerSecretKeysResponse: + type: object + properties: + customer_secret_keys: + type: array + items: + $ref: '#/components/schemas/CustomerSecretKeySummary' + ListDbCredentialsResponse: + type: object + properties: + db_credentials: + type: array + items: + $ref: '#/components/schemas/DbCredentialSummary' + ListMfaTotpDevicesResponse: + type: object + properties: + mfa_totp_devices: + type: array + items: + $ref: '#/components/schemas/MfaTotpDeviceSummary' + ListOAuthClientCredentialsResponse: + type: object + properties: + oauth_client_credentials: + type: array + items: + $ref: '#/components/schemas/OAuth2ClientCredentialSummary' + ListSmtpCredentialsResponse: + type: object + properties: + smtp_credentials: + type: array + items: + $ref: '#/components/schemas/SmtpCredentialSummary' + ListSwiftPasswordsResponse: + type: object + properties: + swift_passwords: + type: array + items: + $ref: '#/components/schemas/SwiftPassword' + ListWorkRequestsResponse: + type: object + properties: + work_requests: + type: array + items: + $ref: '#/components/schemas/WorkRequestSummary' + responses: + '400': + description: Bad Request + 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' + '401': + description: Unauthorized + 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' + '403': + description: Forbidden + 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' + '404': + description: Not Found + 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' + '409': + description: Conflict + 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' + '412': + description: Precondition Failed + 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' + '429': + description: Too Many Requests + 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' + '500': + description: Internal Server 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' + DefaultError: + description: | + An error has occurred. + 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' + parameters: + OptionalLicenseTypeQueryParam: + description: The license type of the identity domain. + in: query + name: currentLicenseTypeName + required: false + x-default-description: 'null' + schema: + type: string + RequestIdHeader: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + schema: + type: string + CompartmentIdPathParam: + description: The OCID of the compartment. + in: path + name: compartmentId + required: true + schema: + type: string + 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 + schema: + type: string + CompartmentIdQueryParam: + description: | + The OCID of the compartment (remember that the tenancy is simply the root compartment). + in: query + name: compartmentId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + PaginationTokenQueryParam: + description: | + The value of the `opc-next-page` response header from the previous "List" call. + in: query + name: page + schema: + type: string + minLength: 1 + maxLength: 512 + PaginationLimitQueryParam: + description: | + The maximum number of items to return in a paginated "List" call. + in: query + name: limit + x-default-description: 'null' + schema: + type: integer + minimum: 1 + maximum: 1000 + AccessLevelQueryParam: + description: | + Valid values are `ANY` and `ACCESSIBLE`. Default is `ANY`. + Setting this to `ACCESSIBLE` returns only those compartments for which the + user has INSPECT permissions directly or indirectly (permissions can be on a + resource in a subcompartment). For the compartments on which the user indirectly has + INSPECT permissions, a restricted set of fields is returned. + + When set to `ANY` permissions are not checked. + in: query + name: accessLevel + schema: + type: string + enum: + - ANY + - ACCESSIBLE + CompartmentIdInSubtreeQueryParam: + description: | + Default is false. Can only be set to true when performing + ListCompartments on the tenancy (root compartment). + When set to true, the hierarchy of compartments is traversed + and all compartments and subcompartments in the tenancy are + returned depending on the the setting of `accessLevel`. + in: query + name: compartmentIdInSubtree + required: false + schema: + type: boolean + FilterByNameQueryParam: + description: | + A filter to only return resources that match the given name exactly. + in: query + name: name + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + SortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for + TIMECREATED is descending. Default order for NAME is ascending. The NAME + sort order is case sensitive. + + **Note:** In general, some "List" operations (for example, `ListInstances`) let you + optionally filter by Availability Domain if the scope of the resource type is within a + single Availability Domain. If you call one of these "List" operations without specifying + an Availability Domain, the resources are grouped by Availability Domain, then sorted. + in: query + name: sortBy + required: false + x-default-description: 'null' + schema: + type: string + enum: + - TIMECREATED + - NAME + SortOrderQueryParam: + description: | + The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order + is case sensitive. + in: query + name: sortOrder + required: false + x-default-description: 'null' + schema: + type: string + enum: + - ASC + - DESC + RetryTokenHeader: + description: | + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations (e.g., if a resource + has been deleted and purged from the system, then a retry of the original creation request + may be rejected). + in: header + name: opc-retry-token + schema: + type: string + minLength: 1 + maxLength: 64 + BulkActionTypeQueryParam: + description: | + The type of bulk action. + in: query + name: bulkActionType + required: true + schema: + type: string + enum: + - BULK_MOVE_RESOURCES + - BULK_DELETE_RESOURCES + DomainDisplayNameQueryParam: + description: The mutable display name of the identity domain. + in: query + name: displayName + x-default-description: 'null' + schema: + type: string + DomainURLQueryParam: + description: The region-agnostic identity domain URL. + in: query + name: url + x-default-description: 'null' + schema: + type: string + DomainHomeRegionURLQueryParam: + description: The region-specific identity domain URL. + in: query + name: homeRegionUrl + x-default-description: 'null' + schema: + type: string + DomainTypeQueryParam: + description: The identity domain type. + in: query + name: type + x-default-description: 'null' + schema: + type: string + LicenseTypeQueryParam: + description: The license type of the identity domain. + in: query + name: licenseType + x-default-description: 'null' + schema: + type: string + IsHiddenOnLoginQueryParam: + description: Indicates whether or not the identity domain is visible at the sign-in screen. + in: query + name: isHiddenOnLogin + x-default-description: 'null' + schema: + type: boolean + DomainIdPathParam: + description: The OCID of the identity domain. + in: path + name: domainId + required: true + schema: + type: string + DynamicGroupIdPathParam: + description: The OCID of the dynamic group. + in: path + name: dynamicGroupId + required: true + schema: + type: string + AvailabilityDomainQueryParam: + description: | + The name of the availabilityDomain. + in: query + name: availabilityDomain + required: true + schema: + type: string + GroupIdPathParam: + description: The OCID of the group. + in: path + name: groupId + required: true + schema: + type: string + ResourceIdentifierQueryParam: + description: The identifier of the resource the work request affects. + in: query + name: resourceIdentifier + required: false + x-default-description: 'null' + schema: + type: string + IamWorkRequestIdPathParam: + description: The OCID of the IAM work request. + in: path + name: iamWorkRequestId + required: true + schema: + type: string + IdentityProviderProtocolQueryParam: + description: The protocol used for federation. + in: query + name: protocol + required: true + x-obmcs-inline-enum: false + schema: + type: string + enum: + - SAML2 + IdentityProviderIdPathParam: + description: The OCID of the identity provider. + in: path + name: identityProviderId + required: true + schema: + type: string + IdpGroupMappingIdPathParam: + description: The OCID of the group mapping. + in: path + name: mappingId + required: true + schema: + type: string + NetworkSourceIdPathParam: + description: The OCID of the network source. + in: path + name: networkSourceId + required: true + schema: + type: string + PolicyIdPathParam: + description: The OCID of the policy. + in: path + name: policyId + required: true + schema: + type: string + OverrideLocksQueryParameter: + description: Whether to override locks (if any exist). + in: query + name: isLockOverride + schema: + type: boolean + default: false + FilterByIdQueryParam: + description: | + A filter to only return resources that match the specified OCID exactly. + in: query + name: id + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + OptionalCompartmentIdQueryParam: + description: | + The OCID of the compartment (remember that the tenancy is simply the root compartment). + in: query + name: compartmentId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + OptionalTagDefinitionIdQueryParam: + description: | + The OCID of the tag definition. + in: query + name: tagDefinitionId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + TagDefaultIdPathParam: + description: The OCID of the tag default. + in: path + name: tagDefaultId + required: true + schema: + type: string + OverrideLocksQueryParam: + description: Whether to override locks (if any exist). + in: query + name: isLockOverride + schema: + type: boolean + default: false + TagNamespaceIdPathParam: + description: | + The OCID of the tag namespace. + in: path + name: tagNamespaceId + required: true + schema: + type: string + minLength: 1 + maxLength: 100 + TagNamePathParam: + description: | + The name of the tag. + in: path + name: tagName + required: true + schema: + type: string + minLength: 1 + maxLength: 100 + WorkRequestIdPathParam: + description: The OCID of the work request. + in: path + name: workRequestId + required: true + schema: + type: string + StandardTagNamespaceNamePathParam: + description: | + The name of the standard tag namespace tempate that is requested + in: path + name: standardTagNamespaceName + required: true + schema: + type: string + minLength: 1 + maxLength: 100 + TenancyIdPathParam: + description: The OCID of the tenancy. + in: path + name: tenancyId + required: true + schema: + type: string + UserIdQueryParam: + description: The OCID of the user. + in: query + name: userId + schema: + type: string + GroupIdQueryParam: + description: The OCID of the group. + in: query + name: groupId + schema: + type: string + UserGroupMembershipIdPathParam: + description: The OCID of the userGroupMembership. + in: path + name: userGroupMembershipId + required: true + schema: + type: string + IdentityProviderIdQueryParam: + description: | + The id of the identity provider. + in: query + name: identityProviderId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + ExternalIdentifierQueryParam: + description: | + The id of a user in the identity provider. + in: query + name: externalIdentifier + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + UserIdPathParam: + description: The OCID of the user. + in: path + name: userId + required: true + schema: + type: string + KeyFingerprintPathParam: + description: The key's fingerprint. + in: path + name: fingerprint + required: true + schema: + type: string + AuthTokenIdPathParam: + description: The OCID of the auth token. + in: path + name: authTokenId + required: true + schema: + type: string + CustomerSecretKeyIdPathParam: + description: The access token of the secret key. + in: path + name: customerSecretKeyId + required: true + schema: + type: string + DbCredentialIdPathParam: + description: The OCID of the DB credential. + in: path + name: dbCredentialId + required: true + schema: + type: string + MfaTotpDeviceIdPathParam: + description: The OCID of the MFA TOTP device. + in: path + name: mfaTotpDeviceId + required: true + schema: + type: string + Oauth2ClientCredentialIdPathParam: + description: The ID of the Oauth credential. + in: path + name: oauth2ClientCredentialId + required: true + schema: + type: string + SmtpCredentialIdPathParam: + description: The OCID of the SMTP credential. + in: path + name: smtpCredentialId + required: true + schema: + type: string + SwiftPasswordIdPathParam: + description: The OCID of the Swift password. + in: path + name: swiftPasswordId + required: true + schema: + type: string + requestBodies: + AddLockDetails: + content: + application/json: + schema: + $ref: '#/components/schemas/AddLockDetails' + description: Lock that is going to be added to resource + required: true + RemoveLockDetails: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveLockDetails' + description: Lock that is going to be removed from resource + required: true + x-stackQL-resources: + allowed_domain_license_types: + id: oci.identity.allowed_domain_license_types + name: allowed_domain_license_types + title: Allowed Domain License Types + methods: + list: + operation: + $ref: '#/paths/~1allowedDomainLicenseTypes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.allowed_domain_license_types + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAllowedDomainLicenseTypesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"allowed_domain_license_types\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/allowed_domain_license_types/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + authentication_policies: + id: oci.identity.authentication_policies + name: authentication_policies + title: Authentication Policies + methods: + get: + operation: + $ref: '#/paths/~1authenticationPolicies~1{compartmentId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1authenticationPolicies~1{compartmentId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/authentication_policies/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/authentication_policies/methods/update' + delete: [] + replace: [] + availability_domains: + id: oci.identity.availability_domains + name: availability_domains + title: Availability Domains + methods: + list: + operation: + $ref: '#/paths/~1availabilityDomains~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.availability_domains + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAvailabilityDomainsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"availability_domains\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/availability_domains/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + compartments: + id: oci.identity.compartments + name: compartments + title: Compartments + methods: + list: + operation: + $ref: '#/paths/~1compartments~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.compartments + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListCompartmentsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"compartments\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1compartments~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1compartments~1{compartmentId}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get_compartment: + operation: + $ref: '#/paths/~1compartments~1{compartmentId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1compartments~1{compartmentId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + bulk_delete_resources: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1compartments~1{compartmentId}~1actions~1bulkDeleteResources/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + bulk_move_resources: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1compartments~1{compartmentId}~1actions~1bulkMoveResources/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + move_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1compartments~1{compartmentId}~1actions~1moveCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + recover_compartment: + operation: + $ref: '#/paths/~1compartments~1{compartmentId}~1actions~1recoverCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/compartments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/compartments/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/compartments/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/compartments/methods/delete' + replace: [] + bulk_action_resource_types: + id: oci.identity.bulk_action_resource_types + name: bulk_action_resource_types + title: Bulk Action Resource Types + methods: + list: + operation: + $ref: '#/paths/~1compartments~1bulkActionResourceTypes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/bulk_action_resource_types/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + domains: + id: oci.identity.domains + name: domains + title: Domains + methods: + list: + operation: + $ref: '#/paths/~1domains~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.domains + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDomainsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"domains\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1domains~1/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1domains~1{domainId}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1domains~1{domainId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1domains~1{domainId}/put' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + activate_domain: + operation: + $ref: '#/paths/~1domains~1{domainId}~1actions~1activate/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1domains~1{domainId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_domain_license_type: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1domains~1{domainId}~1actions~1changeLicenseType/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + deactivate_domain: + operation: + $ref: '#/paths/~1domains~1{domainId}~1actions~1deactivate/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + enable_replication_to_region: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1domains~1{domainId}~1actions~1enableReplicationToRegion/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/domains/methods/get' + - $ref: '#/components/x-stackQL-resources/domains/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/domains/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/domains/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/domains/methods/delete' + replace: [] + dynamic_groups: + id: oci.identity.dynamic_groups + name: dynamic_groups + title: Dynamic Groups + methods: + list: + operation: + $ref: '#/paths/~1dynamicGroups~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.dynamic_groups + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDynamicGroupsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"dynamic_groups\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dynamicGroups~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1dynamicGroups~1{dynamicGroupId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1dynamicGroups~1{dynamicGroupId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dynamicGroups~1{dynamicGroupId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dynamic_groups/methods/get' + - $ref: '#/components/x-stackQL-resources/dynamic_groups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/dynamic_groups/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/dynamic_groups/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/dynamic_groups/methods/delete' + replace: [] + fault_domains: + id: oci.identity.fault_domains + name: fault_domains + title: Fault Domains + methods: + list: + operation: + $ref: '#/paths/~1faultDomains~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.fault_domains + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListFaultDomainsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"fault_domains\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/fault_domains/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + groups: + id: oci.identity.groups + name: groups + title: Groups + methods: + list: + operation: + $ref: '#/paths/~1groups~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.groups + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListGroupsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"groups\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1groups~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1groups~1{groupId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1groups~1{groupId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1groups~1{groupId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/groups/methods/get' + - $ref: '#/components/x-stackQL-resources/groups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/groups/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/groups/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/groups/methods/delete' + replace: [] + iam_work_requests: + id: oci.identity.iam_work_requests + name: iam_work_requests + title: Iam Work Requests + methods: + list: + operation: + $ref: '#/paths/~1iamWorkRequests/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.iam_work_requests + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListIamWorkRequestsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"iam_work_requests\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1iamWorkRequests~1{iamWorkRequestId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/iam_work_requests/methods/get' + - $ref: '#/components/x-stackQL-resources/iam_work_requests/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + iam_work_request_errors: + id: oci.identity.iam_work_request_errors + name: iam_work_request_errors + title: Iam Work Request Errors + methods: + list: + operation: + $ref: '#/paths/~1iamWorkRequests~1{iamWorkRequestId}~1errors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.iam_work_request_errors + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListIamWorkRequestErrorsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"iam_work_request_errors\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/iam_work_request_errors/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + iam_work_request_logs: + id: oci.identity.iam_work_request_logs + name: iam_work_request_logs + title: Iam Work Request Logs + methods: + list: + operation: + $ref: '#/paths/~1iamWorkRequests~1{iamWorkRequestId}~1logs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.iam_work_request_logs + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListIamWorkRequestLogsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"iam_work_request_logs\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/iam_work_request_logs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + idcs_domain_service_status: + id: oci.identity.idcs_domain_service_status + name: idcs_domain_service_status + title: Idcs Domain Service Status + methods: + get: + operation: + $ref: '#/paths/~1idcsDomainServiceStatus/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/idcs_domain_service_status/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + identity_providers: + id: oci.identity.identity_providers + name: identity_providers + title: Identity Providers + methods: + list: + operation: + $ref: '#/paths/~1identityProviders~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.identity_providers + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListIdentityProvidersResponse' + transform: + body: |- + {{- $wrapped := printf "{\"identity_providers\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1identityProviders~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1identityProviders~1{identityProviderId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1identityProviders~1{identityProviderId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1identityProviders~1{identityProviderId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + reset_idp_scim_client: + operation: + $ref: '#/paths/~1identityProviders~1{identityProviderId}~1actions~1resetScimClient~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/identity_providers/methods/get' + - $ref: '#/components/x-stackQL-resources/identity_providers/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/identity_providers/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/identity_providers/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/identity_providers/methods/delete' + replace: [] + idp_group_mappings: + id: oci.identity.idp_group_mappings + name: idp_group_mappings + title: Idp Group Mappings + methods: + list: + operation: + $ref: '#/paths/~1identityProviders~1{identityProviderId}~1groupMappings~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.idp_group_mappings + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListIdpGroupMappingsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"idp_group_mappings\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1identityProviders~1{identityProviderId}~1groupMappings~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1identityProviders~1{identityProviderId}~1groupMappings~1{mappingId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1identityProviders~1{identityProviderId}~1groupMappings~1{mappingId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1identityProviders~1{identityProviderId}~1groupMappings~1{mappingId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/idp_group_mappings/methods/get' + - $ref: '#/components/x-stackQL-resources/idp_group_mappings/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/idp_group_mappings/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/idp_group_mappings/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/idp_group_mappings/methods/delete' + replace: [] + identity_provider_groups: + id: oci.identity.identity_provider_groups + name: identity_provider_groups + title: Identity Provider Groups + methods: + list: + operation: + $ref: '#/paths/~1identityProviders~1{identityProviderId}~1groups~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.identity_provider_groups + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListIdentityProviderGroupsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"identity_provider_groups\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/identity_provider_groups/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + network_sources: + id: oci.identity.network_sources + name: network_sources + title: Network Sources + methods: + list: + operation: + $ref: '#/paths/~1networkSources/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.network_sources + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListNetworkSourcesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"network_sources\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networkSources/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1networkSources~1{networkSourceId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1networkSources~1{networkSourceId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networkSources~1{networkSourceId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/network_sources/methods/get' + - $ref: '#/components/x-stackQL-resources/network_sources/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/network_sources/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/network_sources/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/network_sources/methods/delete' + replace: [] + policies: + id: oci.identity.policies + name: policies + title: Policies + methods: + list: + operation: + $ref: '#/paths/~1policies~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.policies + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListPoliciesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"policies\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1policies~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1policies~1{policyId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1policies~1{policyId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1policies~1{policyId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + add_policy_lock: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1policies~1{policyId}~1actions~1addLock/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + remove_policy_lock: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1policies~1{policyId}~1actions~1removeLock/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/policies/methods/get' + - $ref: '#/components/x-stackQL-resources/policies/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/policies/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/policies/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/policies/methods/delete' + replace: [] + regions: + id: oci.identity.regions + name: regions + title: Regions + methods: + list: + operation: + $ref: '#/paths/~1regions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.regions + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListRegionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"regions\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/regions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + tag_defaults: + id: oci.identity.tag_defaults + name: tag_defaults + title: Tag Defaults + methods: + list: + operation: + $ref: '#/paths/~1tagDefaults/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tag_defaults + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListTagDefaultsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"tag_defaults\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1tagDefaults/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + assemble_effective_tag_set: + operation: + $ref: '#/paths/~1tagDefaults~1actions~1assembleEffectiveTagSet/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.assemble_effective_tag_set + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/AssembleEffectiveTagSetResponse' + transform: + body: |- + {{- $wrapped := printf "{\"assemble_effective_tag_set\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1tagDefaults~1{tagDefaultId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1tagDefaults~1{tagDefaultId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1tagDefaults~1{tagDefaultId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + add_tag_default_lock: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1tagDefaults~1{tagDefaultId}~1actions~1addLock/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + remove_tag_default_lock: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1tagDefaults~1{tagDefaultId}~1actions~1removeLock/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tag_defaults/methods/get' + - $ref: '#/components/x-stackQL-resources/tag_defaults/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/tag_defaults/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/tag_defaults/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/tag_defaults/methods/delete' + replace: [] + tag_namespaces: + id: oci.identity.tag_namespaces + name: tag_namespaces + title: Tag Namespaces + methods: + list: + operation: + $ref: '#/paths/~1tagNamespaces/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tag_namespaces + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListTagNamespacesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"tag_namespaces\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1tagNamespaces/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1tagNamespaces~1{tagNamespaceId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1tagNamespaces~1{tagNamespaceId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1tagNamespaces~1{tagNamespaceId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + add_tag_namespace_lock: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1tagNamespaces~1{tagNamespaceId}~1actions~1addLock/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + cascade_delete_tag_namespace: + operation: + $ref: '#/paths/~1tagNamespaces~1{tagNamespaceId}~1actions~1cascadeDelete/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1tagNamespaces~1{tagNamespaceId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + remove_tag_namespace_lock: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1tagNamespaces~1{tagNamespaceId}~1actions~1removeLock/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tag_namespaces/methods/get' + - $ref: '#/components/x-stackQL-resources/tag_namespaces/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/tag_namespaces/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/tag_namespaces/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/tag_namespaces/methods/delete' + replace: [] + cost_tracking_tags: + id: oci.identity.cost_tracking_tags + name: cost_tracking_tags + title: Cost Tracking Tags + methods: + list: + operation: + $ref: '#/paths/~1tagNamespaces~1actions~1listCostTrackingTags/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.cost_tracking_tags + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListCostTrackingTagsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"cost_tracking_tags\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cost_tracking_tags/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + tags: + id: oci.identity.tags + name: tags + title: Tags + methods: + list: + operation: + $ref: '#/paths/~1tagNamespaces~1{tagNamespaceId}~1tags/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tags + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListTagsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"tags\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1tagNamespaces~1{tagNamespaceId}~1tags/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1tagNamespaces~1{tagNamespaceId}~1tags~1{tagName}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1tagNamespaces~1{tagNamespaceId}~1tags~1{tagName}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1tagNamespaces~1{tagNamespaceId}~1tags~1{tagName}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + bulk_delete_tags: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1tags~1actions~1bulkDelete/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + bulk_edit_tags: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1tags~1actions~1bulkEdit/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + import_standard_tags: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1tags~1actions~1importStandardTags/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tags/methods/get' + - $ref: '#/components/x-stackQL-resources/tags/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/tags/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/tags/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/tags/methods/delete' + replace: [] + tagging_work_requests: + id: oci.identity.tagging_work_requests + name: tagging_work_requests + title: Tagging Work Requests + methods: + list: + operation: + $ref: '#/paths/~1taggingWorkRequests~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tagging_work_requests + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListTaggingWorkRequestsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"tagging_work_requests\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1taggingWorkRequests~1{workRequestId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tagging_work_requests/methods/get' + - $ref: '#/components/x-stackQL-resources/tagging_work_requests/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + tagging_work_request_errors: + id: oci.identity.tagging_work_request_errors + name: tagging_work_request_errors + title: Tagging Work Request Errors + methods: + list: + operation: + $ref: '#/paths/~1taggingWorkRequests~1{workRequestId}~1errors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tagging_work_request_errors + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListTaggingWorkRequestErrorsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"tagging_work_request_errors\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tagging_work_request_errors/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + tagging_work_request_logs: + id: oci.identity.tagging_work_request_logs + name: tagging_work_request_logs + title: Tagging Work Request Logs + methods: + list: + operation: + $ref: '#/paths/~1taggingWorkRequests~1{workRequestId}~1logs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tagging_work_request_logs + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListTaggingWorkRequestLogsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"tagging_work_request_logs\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tagging_work_request_logs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + bulk_edit_tags_resource_types: + id: oci.identity.bulk_edit_tags_resource_types + name: bulk_edit_tags_resource_types + title: Bulk Edit Tags Resource Types + methods: + list: + operation: + $ref: '#/paths/~1tags~1bulkEditResourceTypes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/bulk_edit_tags_resource_types/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + standard_tag_namespaces: + id: oci.identity.standard_tag_namespaces + name: standard_tag_namespaces + title: Standard Tag Namespaces + methods: + list: + operation: + $ref: '#/paths/~1tags~1standardTagNamespaceTemplates/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.standard_tag_namespaces + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListStandardTagNamespacesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"standard_tag_namespaces\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/standard_tag_namespaces/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + standard_tag_templates: + id: oci.identity.standard_tag_templates + name: standard_tag_templates + title: Standard Tag Templates + methods: + get: + operation: + $ref: '#/paths/~1tags~1standardTagNamespaceTemplates~1{standardTagNamespaceName}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/standard_tag_templates/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + tenancies: + id: oci.identity.tenancies + name: tenancies + title: Tenancies + methods: + get: + operation: + $ref: '#/paths/~1tenancies~1{tenancyId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tenancies/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + region_subscriptions: + id: oci.identity.region_subscriptions + name: region_subscriptions + title: Region Subscriptions + methods: + list: + operation: + $ref: '#/paths/~1tenancies~1{tenancyId}~1regionSubscriptions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.region_subscriptions + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListRegionSubscriptionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"region_subscriptions\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1tenancies~1{tenancyId}~1regionSubscriptions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/region_subscriptions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/region_subscriptions/methods/create' + update: [] + delete: [] + replace: [] + user_group_memberships: + id: oci.identity.user_group_memberships + name: user_group_memberships + title: User Group Memberships + methods: + list: + operation: + $ref: '#/paths/~1userGroupMemberships~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.user_group_memberships + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListUserGroupMembershipsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"user_group_memberships\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + add_user_to_group: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1userGroupMemberships~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + remove_user_from_group: + operation: + $ref: '#/paths/~1userGroupMemberships~1{userGroupMembershipId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1userGroupMemberships~1{userGroupMembershipId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/user_group_memberships/methods/get' + - $ref: '#/components/x-stackQL-resources/user_group_memberships/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + users: + id: oci.identity.users + name: users + title: Users + methods: + list: + operation: + $ref: '#/paths/~1users~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.users + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListUsersResponse' + transform: + body: |- + {{- $wrapped := printf "{\"users\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1users~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1users~1{userId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1users~1{userId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1users~1{userId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/users/methods/get' + - $ref: '#/components/x-stackQL-resources/users/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/users/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/users/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/users/methods/delete' + replace: [] + api_keys: + id: oci.identity.api_keys + name: api_keys + title: Api Keys + methods: + list: + operation: + $ref: '#/paths/~1users~1{userId}~1apiKeys~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.api_keys + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListApiKeysResponse' + transform: + body: |- + {{- $wrapped := printf "{\"api_keys\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + upload_api_key: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1users~1{userId}~1apiKeys~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1users~1{userId}~1apiKeys~1{fingerprint}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/api_keys/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/api_keys/methods/delete' + replace: [] + auth_tokens: + id: oci.identity.auth_tokens + name: auth_tokens + title: Auth Tokens + methods: + list: + operation: + $ref: '#/paths/~1users~1{userId}~1authTokens~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.auth_tokens + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAuthTokensResponse' + transform: + body: |- + {{- $wrapped := printf "{\"auth_tokens\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1users~1{userId}~1authTokens~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1users~1{userId}~1authTokens~1{authTokenId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1users~1{userId}~1authTokens~1{authTokenId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/auth_tokens/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/auth_tokens/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/auth_tokens/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/auth_tokens/methods/delete' + replace: [] + user_capabilities: + id: oci.identity.user_capabilities + name: user_capabilities + title: User Capabilities + methods: + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1users~1{userId}~1capabilities~1/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/user_capabilities/methods/update' + delete: [] + replace: [] + customer_secret_keys: + id: oci.identity.customer_secret_keys + name: customer_secret_keys + title: Customer Secret Keys + methods: + list: + operation: + $ref: '#/paths/~1users~1{userId}~1customerSecretKeys~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.customer_secret_keys + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListCustomerSecretKeysResponse' + transform: + body: |- + {{- $wrapped := printf "{\"customer_secret_keys\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1users~1{userId}~1customerSecretKeys~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1users~1{userId}~1customerSecretKeys~1{customerSecretKeyId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1users~1{userId}~1customerSecretKeys~1{customerSecretKeyId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/customer_secret_keys/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/customer_secret_keys/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/customer_secret_keys/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/customer_secret_keys/methods/delete' + replace: [] + db_credentials: + id: oci.identity.db_credentials + name: db_credentials + title: Db Credentials + methods: + list: + operation: + $ref: '#/paths/~1users~1{userId}~1dbCredentials~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.db_credentials + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDbCredentialsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"db_credentials\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1users~1{userId}~1dbCredentials~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1users~1{userId}~1dbCredentials~1{dbCredentialId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/db_credentials/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/db_credentials/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/db_credentials/methods/delete' + replace: [] + mfa_totp_devices: + id: oci.identity.mfa_totp_devices + name: mfa_totp_devices + title: Mfa Totp Devices + methods: + list: + operation: + $ref: '#/paths/~1users~1{userId}~1mfaTotpDevices/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.mfa_totp_devices + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListMfaTotpDevicesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"mfa_totp_devices\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + operation: + $ref: '#/paths/~1users~1{userId}~1mfaTotpDevices/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1users~1{userId}~1mfaTotpDevices~1{mfaTotpDeviceId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1users~1{userId}~1mfaTotpDevices~1{mfaTotpDeviceId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + activate_mfa_totp_device: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1users~1{userId}~1mfaTotpDevices~1{mfaTotpDeviceId}~1actions~1activate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + generate_totp_seed: + operation: + $ref: '#/paths/~1users~1{userId}~1mfaTotpDevices~1{mfaTotpDeviceId}~1actions~1generateSeed/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/mfa_totp_devices/methods/get' + - $ref: '#/components/x-stackQL-resources/mfa_totp_devices/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/mfa_totp_devices/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/mfa_totp_devices/methods/delete' + replace: [] + o_auth_client_credentials: + id: oci.identity.o_auth_client_credentials + name: o_auth_client_credentials + title: O Auth Client Credentials + methods: + list: + operation: + $ref: '#/paths/~1users~1{userId}~1oauth2ClientCredentials/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.oauth_client_credentials + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListOAuthClientCredentialsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"oauth_client_credentials\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1users~1{userId}~1oauth2ClientCredentials/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1users~1{userId}~1oauth2ClientCredentials~1{oauth2ClientCredentialId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1users~1{userId}~1oauth2ClientCredentials~1{oauth2ClientCredentialId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/o_auth_client_credentials/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/o_auth_client_credentials/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/o_auth_client_credentials/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/o_auth_client_credentials/methods/delete' + replace: [] + smtp_credentials: + id: oci.identity.smtp_credentials + name: smtp_credentials + title: Smtp Credentials + methods: + list: + operation: + $ref: '#/paths/~1users~1{userId}~1smtpCredentials~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.smtp_credentials + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListSmtpCredentialsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"smtp_credentials\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1users~1{userId}~1smtpCredentials~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1users~1{userId}~1smtpCredentials~1{smtpCredentialId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1users~1{userId}~1smtpCredentials~1{smtpCredentialId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/smtp_credentials/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/smtp_credentials/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/smtp_credentials/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/smtp_credentials/methods/delete' + replace: [] + user_states: + id: oci.identity.user_states + name: user_states + title: User States + methods: + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1users~1{userId}~1state~1/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/user_states/methods/update' + delete: [] + replace: [] + swift_passwords: + id: oci.identity.swift_passwords + name: swift_passwords + title: Swift Passwords + methods: + list: + operation: + $ref: '#/paths/~1users~1{userId}~1swiftPasswords~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.swift_passwords + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListSwiftPasswordsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"swift_passwords\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1users~1{userId}~1swiftPasswords~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1users~1{userId}~1swiftPasswords~1{swiftPasswordId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1users~1{userId}~1swiftPasswords~1{swiftPasswordId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/swift_passwords/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/swift_passwords/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/swift_passwords/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/swift_passwords/methods/delete' + replace: [] + user_ui_password_informations: + id: oci.identity.user_ui_password_informations + name: user_ui_password_informations + title: User Ui Password Informations + methods: + get: + operation: + $ref: '#/paths/~1users~1{userId}~1uiPassword/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/user_ui_password_informations/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + or_reset_ui_passwords: + id: oci.identity.or_reset_ui_passwords + name: or_reset_ui_passwords + title: Or Reset Ui Passwords + methods: + create: + operation: + $ref: '#/paths/~1users~1{userId}~1uiPassword/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/or_reset_ui_passwords/methods/create' + update: [] + delete: [] + replace: [] + work_requests: + id: oci.identity.work_requests + name: work_requests + title: Work Requests + methods: + list: + operation: + $ref: '#/paths/~1workRequests~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.work_requests + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListWorkRequestsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"work_requests\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1workRequests~1{workRequestId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/work_requests/methods/get' + - $ref: '#/components/x-stackQL-resources/work_requests/methods/list' + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://identity.{region}.oci.oraclecloud.com/20160918 + variables: + region: + default: us-ashburn-1 + description: OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. + x-stackQL-envVar: OCI_REGION +x-stackQL-config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: opc-next-page + location: header diff --git a/providers/src/oci/v00.00.00000/services/kms.yaml b/providers/src/oci/v00.00.00000/services/kms.yaml new file mode 100644 index 00000000..a92d32ab --- /dev/null +++ b/providers/src/oci/v00.00.00000/services/kms.yaml @@ -0,0 +1,7698 @@ +openapi: 3.0.0 +info: + title: kms API + description: oci kms API + version: release +paths: + /20180608/decrypt: + post: + description: | + Decrypts data using the given [DecryptDataDetails](/api/#/en/key/latest/datatypes/DecryptDataDetails) resource. + operationId: Decrypt + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DecryptDataDetails' + description: DecryptDataDetails + required: true + responses: + '200': + description: | + The decrypted data in plaintext. + 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/DecryptedData' + '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/DefaultError' + summary: Decrypt + tags: + - kmsCrypto + x-example: | + POST /20180608/decrypt + <authorization and other headers> + { + "key-id": "ocid1.key.oc1.iad.annnb3f42acuu.abuwcljstscov63fvwp3yrrfepbnqyqlvqso3mfkpqg6aijasggkxglfzjia", + "key-version-id": "ocid1.keyversion.oc1.iad.annnb3f4a2cuu.arcnlvkg4zyaa.abuwcljsemiqtbccvmfppbpua3ll3f5kmfgireh62hfcxgg7tgcs5gwsg5ma", + "plaintext": "abcdefgh", + "plaintext-checksum": "1434553411" + } + /20180608/ekmsPrivateEndpoints: + get: + description: | + Returns a list of all the EKMS private endpoints in the specified compartment. + operationId: ListEkmsPrivateEndpoints + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: A list of EKMS private endpoint summary objects. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListEkmsPrivateEndpointsResponse' + '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/DefaultError' + summary: Lists all the EKMS private endpoints in the specified compartment + tags: + - Ekm + x-example: | + GET /20180608/ekmsPrivateEndpoints?compartmentId=<compartmentId> + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + post: + description: Create a new EKMS private endpoint used to connect to external key manager system + operationId: CreateEkmsPrivateEndpoint + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateEkmsPrivateEndpointDetails' + description: The information used to create EKMS private endpoint. + required: true + responses: + '202': + description: The ekmsPrivateEndpoint is being created. + 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 + opc-work-request-id: + description: | + Work request id to track progress of the create operation + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/EkmsPrivateEndpoint' + '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/DefaultError' + summary: Create a new EKMS private endpoint. + tags: + - Ekm + x-example: | + POST /20180608/ekmsPrivateEndpoints + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + { + "subnetId": "ocid1.subnet.oc1.phx.aaaaaaaarzlbjasxeir5mg5sux6fcah2lsdmgpytduuuv4ktnjpb2hpwqunq", + "freeformTags": {}, + "definedTags": {}, + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5ltpneskcfy7lr4a6wfauxuwrwed5b3xea", + "displayName": "EKMS Private Endpoint 1", + "caBundle": "----- BEGIN CERTIFICATE ----- abcRTynddf567= ---- END CERTIFICATE ---", + "externalKeyManagerIp": "1.2.3.4", + "port": 1234 + } + x-related-resource: '#/definitions/EkmsPrivateEndpoint' + /20180608/ekmsPrivateEndpoints/{ekmsPrivateEndpointId}: + delete: + description: Deletes EKMS private endpoint by identifier. + operationId: DeleteEkmsPrivateEndpoint + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/EkmsPrivateEndpointIdentifierPathParam' + responses: + '202': + description: Accepted the request. The EKMS private endpoint 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: | + Unique Oracle-assigned identifier for the work request, used to track the progress of the + operation. + 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/DefaultError' + summary: Delete EKMS private endpoint. + tags: + - Ekm + x-example: | + DELETE /20180608/ekmsPrivateEndpoints/<ekmsPrivateEndpointId> + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/EkmsPrivateEndpoint' + get: + description: Gets a specific EKMS private by identifier. + operationId: GetEkmsPrivateEndpoint + parameters: + - $ref: '#/components/parameters/EkmsPrivateEndpointIdentifierPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: Retrieves EKMS private endpoint with given id. + 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/EkmsPrivateEndpoint' + '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/DefaultError' + summary: Get EKMS private endpoint by Id. + tags: + - Ekm + x-example: | + GET /20180608/ekmsPrivateEndpoints/<ekmsPrivateEndpointId> + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + put: + description: Updates EKMS private endpoint. + operationId: UpdateEkmsPrivateEndpoint + parameters: + - $ref: '#/components/parameters/EkmsPrivateEndpointIdentifierPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateEkmsPrivateEndpointDetails' + description: The information to be updated in EKMS private endpoint + required: true + responses: + '200': + description: The ekmsPrivateEndpoint is being created. + 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/EkmsPrivateEndpoint' + '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/DefaultError' + summary: Update EKMS private endpoint identified by the id. + tags: + - Ekm + x-example: | + PUT /20180608/ekmsPrivateEndpoints/<ekmsPrivateEndpointId> + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + { + "displayName": "EKMS Private Endpoint Update" + } + x-related-resource: '#/definitions/EkmsPrivateEndpoint' + /20180608/encrypt: + post: + description: | + Encrypts data using the given [EncryptDataDetails](/api/#/en/key/latest/datatypes/EncryptDataDetails) resource. + Plaintext included in the example request is a base64-encoded value of a UTF-8 string. + operationId: Encrypt + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EncryptDataDetails' + description: EncryptDataDetails + required: true + responses: + '200': + description: The encrypted data, presented as ciphertext. + 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/EncryptedData' + '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/DefaultError' + summary: Encrypt + tags: + - kmsCrypto + x-example: | + POST /20180608/encrypt + Host: <cryptoEndpoint> + <authorization and other headers> + { + "keyId": "ocid1.key.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23tteidhj4q2c6qfauxm32i577yu5a", + "plaintext": "aGVsbG8sIHdvcmxk" + } + /20180608/exportKey: + post: + description: | + Exports a specific version of a master encryption key according to the details of the request. For their protection, + keys that you create and store on a hardware security module (HSM) can never leave the HSM. You can only export keys + stored on the server. For export, the key version is encrypted by an RSA public key that you provide. + This operation is not supported for keys having protection mode `EXTERNAL`. + operationId: ExportKey + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExportKeyDetails' + description: ExportKeyDetails + required: true + responses: + '200': + description: The encrypted exported key. + 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/ExportedKeyData' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Exports a master encryption key. + tags: + - kmsCrypto + x-example: | + POST /20180608/exportKey + Host: <cryptoEndpoint> + <authorization and other headers> + { + "keyId": "ocid1.key.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23tteidhj4q2c6qfauxm32i577yu5a", + "keyVersionId": "ocid1.keyversion.oc1.iad.examplevriiaa.examples4h2bocax3damnsxw4cvbbndged2gftlho4ufxwa4faux2eiqwija", + "algorithm": "RSA_OAEP_AES_SHA256", + "publicKey": "-----BEGIN PUBLIC KEY----- ..... -----END PUBLIC KEY-----" + } + x-related-resource: '#/definitions/ExportedKeyData' + /20180608/generateDataEncryptionKey: + post: + description: | + Generates a key that you can use to encrypt or decrypt data. + operationId: GenerateDataEncryptionKey + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GenerateKeyDetails' + description: GenerateKeyDetails + required: true + responses: + '200': + description: The data encryption key. + 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/GeneratedKey' + '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/DefaultError' + summary: GenerateDataEncryptionKey + tags: + - kmsCrypto + x-example: | + POST /20180608/generateDataEncryptionKey + Host: <cryptoEndpoint> + <authorization and other headers> + { + "includePlaintextKey": true, + "keyId": "ocid1.key.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23tteidhj4q2c6qfauxm32i577yu5a", + "keyShape": { + "algorithm": "AES", + "length": 16 + } + } + /20180608/hsmClusters: + get: + description: | + Lists all HSM cluster resources contained within the specified compartment. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning read operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + read operations exceeds 10 requests per second for a given tenancy. + operationId: ListHsmClusters + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: A list of HsmCluster resources. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/HsmClusterCollection' + '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/DefaultError' + summary: Lists all HSM cluster resources contained within the specified compartment. + tags: + - kmsHsmCluster + x-example: | + GET /20180608/hsmClusters?compartmentId=<compartmentId> + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/HsmCluster' + post: + description: | + Creates a new HSM cluster resource. + operationId: CreateHsmCluster + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateHsmClusterDetails' + description: Details for the new HsmCluster resource + required: true + responses: + '200': + description: HsmCluster resource is being created. + 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/HsmCluster' + '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/DefaultError' + summary: Creates a new HSM cluster resource + tags: + - kmsHsmCluster + x-example: | + POST /20180608/hsmClusters + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5ltpneskcfy7lr4a6wfauxuwrwed5bsdea", + "displayName": "Hsm Cluster 1" + } + x-related-resource: '#/definitions/HsmCluster' + /20180608/hsmClusters/{hsmClusterId}: + get: + description: | + Retrieves configuration details for the specified HSM Cluster resource. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning read operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + read operations exceeds 10 requests per second for a given tenancy. + operationId: GetHsmCluster + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/HsmClusterIdPathParam' + responses: + '200': + description: The specified HSM Cluster resource. + 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/HsmCluster' + '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/DefaultError' + summary: Gets details about a HSM Cluster resource. + tags: + - kmsHsmCluster + x-example: | + GET /20180608/hsmClusters/<hsmClusterId> + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/HsmCluster' + put: + description: | + Modifies properties of an HSM cluster resource, including `displayName`, `freeformTags` and `definedTags`. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. + operationId: UpdateHsmCluster + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/HsmClusterIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateHsmClusterDetails' + description: Details of the HsmCluster Resource + required: true + responses: + '200': + description: The HSM Cluster resource is updated according to the request. + 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/HsmCluster' + '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/DefaultError' + summary: Updates the properties of a HSM Cluster resource. + tags: + - kmsHsmCluster + x-example: | + PUT /20180608/hsmClusters/<hsmClusterId> + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + { + "displayName": "Hsm 1" + } + x-related-resource: '#/definitions/HsmCluster' + /20180608/hsmClusters/{hsmClusterId}/actions/cancelDeletion: + post: + description: Cancels deletion of specified HSM Cluster, restores it and associated HSM partitions to pre-deletion states. + operationId: CancelHsmClusterDeletion + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/HsmClusterIdPathParam' + responses: + '200': + description: The HSM Cluster resource's scheduled deletion is cancelled successfully + 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/HsmCluster' + '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/DefaultError' + summary: Cancels the scheduled deletion of a HSM Cluster resource. + tags: + - kmsHsmCluster + x-example: | + POST /20180608/hsmClusters/<hsmClusterId>/actions/cancelDeletion + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/HsmCluster' + /20180608/hsmClusters/{hsmClusterId}/actions/changeCompartment: + post: + description: | + Moves a HSM Cluster resource to a different compartment within the same tenancy. + operationId: ChangeHsmClusterCompartment + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/HsmClusterIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeHsmClusterCompartmentDetails' + description: Details of change HSM Cluster compartment. + required: true + responses: + '204': + description: The compartment information for the HSM Cluster resource has been updated. + 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 + '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/DefaultError' + summary: Moves a HSM Cluster resource into a different compartment. + tags: + - kmsHsmCluster + x-example: | + POST /20180608/hsmClusters/<hsmClusterId>/actions/changeCompartment + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5lsdneskcfy7lr4a6wfauxuwrwed5b3xea", + } + x-related-resource: '#/definitions/HsmCluster' + /20180608/hsmClusters/{hsmClusterId}/actions/downloadCertificateSigningRequest: + post: + description: | + Retrieves the certificate signing request for the designated HSM Cluster resource. + operationId: DownloadCertificateSigningRequest + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/HsmClusterIdPathParam' + responses: + '200': + description: The request is processed successfully. The CSR will be returned in the body of the response. + 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: + maxLength: 5000 + 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/DefaultError' + summary: Download certificate signing request for the HSM Cluster resource. + tags: + - kmsHsmCluster + x-example: | + GET /20180608/hsmClusters/<hsmClusterId>/actions/downloadCertificateSigningRequest + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/HsmCluster' + /20180608/hsmClusters/{hsmClusterId}/actions/scheduleDeletion: + post: + description: | + Schedules HSM cluster for deletion, update its lifecycle state to 'PENDING_DELETION' + and deletes it after the retention period. + operationId: ScheduleHsmClusterDeletion + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/HsmClusterIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScheduleHsmClusterDeletionDetails' + description: Details of ScheduleHsmClusterDeletionDetails + required: true + responses: + '200': + description: The HSM Cluster resource is scheduled for deletion. + 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/HsmCluster' + '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/DefaultError' + summary: Schedules the deletion of a HSM Cluster resource. + tags: + - kmsHsmCluster + x-example: | + POST /20180608/hsmClusters/<hsmClusterId>/actions/scheduleDeletion + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + { + "timeOfDeletion": "2023-04-03T21:10:29.600Z" + } + x-related-resource: '#/definitions/HsmCluster' + /20180608/hsmClusters/{hsmClusterId}/actions/uploadPartitionCertificates: + post: + description: | + Uploads the partition owner certificates to the HSM Cluster resource. + operationId: UploadPartitionCertificates + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/HsmClusterIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UploadPartitionCertificatesDetails' + description: To upload partition certificates. + required: true + responses: + '200': + description: Partition certificates uploaded successfully. + 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 + '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/DefaultError' + summary: Upload partition certificate and partition owner certificate for the HSM cluster. + tags: + - kmsHsmCluster + x-example: | + POST /20180608/hsmClusters/<hsmClusterId>/actions/uploadPartitionCertificates + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/HsmCluster' + /20180608/hsmClusters/{hsmClusterId}/hsmPartitions: + get: + description: | + Lists all HSM partitions within the specified HSM Cluster resource. + operationId: ListHsmPartitions + parameters: + - $ref: '#/components/parameters/HsmClusterIdPathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: A filter that returns only resources that match the specified lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/HsmPartition/lifecycleState' + schema: + type: string + responses: + '200': + description: List of HSM summary is returned. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/HsmPartitionCollection' + '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/DefaultError' + summary: Lists all HSM and details for a HSM Cluster resource. + tags: + - kmsHsmCluster + x-example: | + GET /20180608/hsmClusters/<hsmClusterId>/hsmPartitions + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/HsmPartition' + /20180608/hsmClusters/{hsmClusterId}/hsmPartitions/{hsmPartitionId}: + get: + description: | + Retrieves HSM partition details for the specified HSM cluster. + operationId: GetHsmPartition + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/HsmClusterIdPathParam' + - $ref: '#/components/parameters/HsmPartitionIdPathParam' + responses: + '200': + description: The request is processed successfully. HSM information is returned as response. + 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/HsmPartition' + '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/DefaultError' + summary: Get HSM information for the specific hsmPartitionId. + tags: + - kmsHsmCluster + x-example: | + GET /20180608/hsmCluster/<hsmClusterId>/hsmPartitions/<hsmPartitionId>/hsmPartitionId + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/HsmPartition' + /20180608/hsmClusters/{hsmClusterId}/preCoUserCredentials: + get: + description: | + Retrieves Pre Crypto Officer user credentials for the specified HSM cluster. + operationId: GetPreCoUserCredentials + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/HsmClusterIdPathParam' + responses: + '200': + description: The request is processed successfully. The preCo username and password will be returned in the body of the response. Copy credentials for your records will not be shown again. + 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/PreCoUserCredentials' + '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/DefaultError' + summary: Get Pre Crypto Officer User Credentials. + tags: + - kmsHsmCluster + x-example: | + GET /20180608/hsmClusters/<hsmClusterId>/preCoUserCredentials + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/HsmCluster' + /20180608/keys: + get: + description: | + Lists the master encryption keys in the specified vault and compartment. + + As a management operation, this call is subject to a Key Management limit that applies to the total number + of requests across all management read operations. Key Management might throttle this call to reject an + otherwise valid request when the total rate of management read operations exceeds 10 requests per second + for a given tenancy. + operationId: ListKeys + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ProtectionModeQueryParam' + - $ref: '#/components/parameters/KeyAlgorithmQueryParam' + - $ref: '#/components/parameters/KeyLengthQueryParam' + - $ref: '#/components/parameters/KeyCurveQueryParam' + responses: + '200': + description: A list of keys. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListKeysResponse' + '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/DefaultError' + summary: Lists keys in the specified vault and compartment. + tags: + - kmsManagement + x-example: | + GET /20180608/keys?compartmentId=<compartmentId> + Host: <managementEndpoint> + <authorization and other headers> + x-stackql-bare-array-wrap: + wrapperKey: keys + wrapperName: ListKeysResponse + mediaType: application/json + scalar: false + post: + description: | + Creates a new master encryption key. + + As a management operation, this call is subject to a Key Management limit that applies to the total + number of requests across all management write operations. Key Management might throttle this call + to reject an otherwise valid request when the total rate of management write operations exceeds 10 + requests per second for a given tenancy. + operationId: CreateKey + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateKeyDetails' + description: CreateKeyDetails + required: true + responses: + '200': + description: The key is being created. + 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/Key' + '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/DefaultError' + summary: Creates a new key. + tags: + - kmsManagement + x-example: | + POST /20180608/keys + Host: <managementEndpoint> + <authorization and other headers> + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5lsdneskcfy7lr4a6wfauxuwrwed5b3xea", + "displayName": "Key C", + "keyShape": { + "algorithm": "AES", + "length": 16 + } + } + /20180608/keys/actions/restoreFromFile: + post: + description: | + Restores the specified key to the specified vault, based on information in the backup file provided. + If the vault doesn't exist, the operation returns a response with a 404 HTTP status error code. You + need to first restore the vault associated with the key. + operationId: RestoreKeyFromFile + parameters: + - $ref: '#/components/parameters/ContentLengthHeader' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalContentMD5Header' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/octet-stream: + schema: + format: binary + type: string + description: The encrypted backup file to upload to restore the key. + required: true + responses: + '202': + description: The key restore operation started successfully. + headers: + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + opc-content-md5: + description: | + The base64-encoded MD5 hash value of the request body, as computed + by the server. + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the work request, used to track the progress of the + restore operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Key' + '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/DefaultError' + summary: Restores a key to a vault from a file. + tags: + - kmsManagement + x-example: | + POST /20180608/keys/actions/restoreFromFile + Host: <managementEndpoint> + <authorization and other headers> + { + "RestoreKeyFromFileDetails" : "key backup bytes.." + } + x-related-resource: '#/definitions/Key' + /20180608/keys/actions/restoreFromObjectStore: + post: + description: | + Restores the specified key to the specified vault from an Oracle Cloud Infrastructure + Object Storage location. If the vault doesn't exist, the operation returns a response with a + 404 HTTP status error code. You need to first restore the vault associated with the key. + operationId: RestoreKeyFromObjectStore + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RestoreKeyFromObjectStoreDetails' + description: Location to restore the backup from + responses: + '202': + description: The key restore operation started successfully. + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the work request, used to track the progress of the + restore operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Key' + '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/DefaultError' + summary: Restores a key to a vault from an object storage location. + tags: + - kmsManagement + x-example: | + POST /20180608/keys/actions/restoreFromObjectStore + Host: <managementEndpoint> + <authorization and other headers> + "RestoreKeyFromObjectStoreDetails" : { + "backupLocation" : { + "BackupLocationURI" : { + "uri" : "http://n/namespace/b/bucket/o/object" + } + } + } + x-related-resource: '#/definitions/Key' + /20180608/keys/import: + post: + description: | + Imports AES and RSA keys to create a new key. The key material must be base64-encoded + and wrapped by the vault's public RSA wrapping key before you can import it. + Key Management supports both RSA and AES keys. The AES keys are symmetric keys + of length 128 bits (16 bytes), 192 bits (24 bytes), or 256 bits (32 bytes), and the RSA keys are asymmetric keys of length 2048 bits (256 bytes), 3072 bits (384 bytes), and 4096 bits (512 bytes). + Furthermore, the key length must match what you specify at the time of import. When importing an asymmetric key, + only private key must be wrapped in PKCS8 format while the corresponding public key is generated internally by KMS. + operationId: ImportKey + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ImportKeyDetails' + description: ImportKeyDetails + required: true + responses: + '200': + description: The key is being imported and is in the `CREATING` state. After the key is imported, it is set to the `ENABLED` state. + 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/Key' + '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/DefaultError' + summary: Imports the given wrapped AES key. + tags: + - kmsManagement + x-example: | + POST /20180608/keys/import + Host: <managementEndpoint> + <authorization and other headers> + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5lsdneskcfy7lr4a6wfauxuwrwed5b3xea", + "displayName": "Key C", + "keyShape": { + "algorithm": "AES", + "length": 16 + }, + "wrappedImportKey":{ + "wrappingAlgorithm": "RSA_OAEP_SHA256", + "keyMaterial": "089d08927390280802d0987c09e7798h09f879870909c098709a709870970987b09709870c987098d70e==" + }, + "protectionMode":"HSM" + } + /20180608/keys/{keyId}: + get: + description: | + Gets information about the specified master encryption key. + + As a management operation, this call is subject to a Key Management limit that applies to the total number + of requests across all management read operations. Key Management might throttle this call to reject an + otherwise valid request when the total rate of management read operations exceeds 10 requests per second for + a given tenancy. + operationId: GetKey + parameters: + - $ref: '#/components/parameters/KeyIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The specified key. + 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/Key' + '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/DefaultError' + summary: Gets details about a key. + tags: + - kmsManagement + x-example: | + GET /20180608/keys/<key_OCID> + Host: <managementEndpoint> + <authorization and other headers> + put: + description: | + Updates the properties of a master encryption key. Specifically, you can update the + `displayName`, `freeformTags`, and `definedTags` properties. Furthermore, + the key must be in an `ENABLED` or `CREATING` state to be updated. + + As a management operation, this call is subject to a Key Management limit that applies to the total number + of requests across all management write operations. Key Management might throttle this call to reject an + otherwise valid request when the total rate of management write operations exceeds 10 requests per second + for a given tenancy. + operationId: UpdateKey + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/KeyIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateKeyDetails' + description: UpdateKeyDetails + required: true + responses: + '200': + description: The key is being updated according to the request. + 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/Key' + '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/DefaultError' + summary: Updates a key's properties. + tags: + - kmsManagement + x-example: | + PUT /20180608/keys/<key_OCID> + Host: <managementEndpoint> + <authorization and other headers> + { + "displayName": "Key CC" + } + /20180608/keys/{keyId}/actions/backup: + post: + description: | + Backs up an encrypted file that contains all key versions and metadata of the specified key so that you can restore + the key later. The file also contains the metadata of the vault that the key belonged to. + operationId: BackupKey + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/KeyIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackupKeyDetails' + description: BackupKeyDetails + responses: + '202': + description: The key backup operation started successfully. + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the work request, used to track the progress of the + backup operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Key' + '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/DefaultError' + summary: Backs up the key and associated key metadata. + tags: + - kmsManagement + x-example: | + POST /20180608/keys/<key_OCID>/actions/backup + Host: <managementEndpoint> + <authorization and other headers> + { + "BackupKeyDetails": { + "backupLocation" : { + "BackupLocationURI" : { + "uri" : "http://n/namespace/b/bucket/o/object" + } + } + } + } + x-related-resource: '#/definitions/Key' + /20180608/keys/{keyId}/actions/cancelDeletion: + post: + description: | + Cancels the scheduled deletion of the specified key. Canceling + a scheduled deletion restores the key's lifecycle state to what + it was before its scheduled deletion. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. + operationId: CancelKeyDeletion + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/KeyIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '200': + description: The key's scheduled deletion has been canceled. + 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/Key' + '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/DefaultError' + summary: Cancels the scheduled deletion of a key. + tags: + - kmsManagement + x-example: | + POST /20180608/keys/<key_OCID>/actions/cancelDeletion + Host: <managementEndpoint> + <authorization and other headers> + x-related-resource: '#/definitions/Key' + /20180608/keys/{keyId}/actions/changeCompartment: + post: + description: | + Moves a key into a different compartment within the same tenancy. For information about + moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + + When provided, if-match is checked against the ETag values of the key. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. + operationId: ChangeKeyCompartment + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/KeyIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeKeyCompartmentDetails' + description: Details of change key compartment. + required: true + responses: + '204': + description: The compartment information for the key has been updated. + 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 + '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/DefaultError' + summary: Moves a key into a different compartment. + tags: + - kmsManagement + x-example: | + POST /20180608/keys/<key_OCID>/actions/changeCompartment + Host: <managementEndpoint> + <authorization and other headers> + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5lsdneskcfy7lr4a6wfauxuwrwed5b3xea", + } + x-related-resource: '#/definitions/Key' + /20180608/keys/{keyId}/actions/disable: + post: + description: | + Disables a master encryption key so it can no longer be used for encryption, decryption, or + generating new data encryption keys. + + As a management operation, this call is subject to a Key Management limit that applies to the total number + of requests across all management write operations. Key Management might throttle this call to reject an + otherwise valid request when the total rate of management write operations exceeds 10 requests per second + for a given tenancy. + operationId: DisableKey + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/KeyIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '200': + description: The key is being disabled. + 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/Key' + '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/DefaultError' + summary: Disables a key so it cannot be used for cryptographic operations. + tags: + - kmsManagement + x-example: | + POST /20180608/keys/<key_OCID>/actions/disable + Host: <managementEndpoint> + <authorization and other headers> + x-related-resource: '#/definitions/Key' + /20180608/keys/{keyId}/actions/enable: + post: + description: | + Enables a master encryption key so it can be used for encryption, decryption, or + generating new data encryption keys. + + As a management operation, this call is subject to a Key Management limit that applies to the total number + of requests across all management write operations. Key Management might throttle this call to reject an + otherwise valid request when the total rate of management write operations exceeds 10 requests per second + for a given tenancy. + operationId: EnableKey + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/KeyIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '200': + description: The key is being enabled. + 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/Key' + '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/DefaultError' + summary: Enables a key so it can be used for cryptographic operations. + tags: + - kmsManagement + x-example: | + POST /20180608/keys/<key_OCID>/actions/enable + Host: <managementEndpoint> + <authorization and other headers> + x-related-resource: '#/definitions/Key' + /20180608/keys/{keyId}/actions/scheduleDeletion: + post: + description: | + Schedules the deletion of the specified key. This sets the lifecycle state of the key + to `PENDING_DELETION` and then deletes it after the specified retention period ends. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. + operationId: ScheduleKeyDeletion + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/KeyIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScheduleKeyDeletionDetails' + description: ScheduleKeyDeletionDetails + required: true + responses: + '200': + description: The key is scheduled for deletion. + 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/Key' + '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/DefaultError' + summary: Schedules the deletion of a key. + tags: + - kmsManagement + x-example: | + POST /20180608/keys/<key_OCID>/actions/scheduleDeletion + Host: <managementEndpoint> + <authorization and other headers> + { + "timeOfDeletion": "2018-04-03T21:10:29.600Z" + } + x-related-resource: '#/definitions/Key' + /20180608/keys/{keyId}/keyVersions: + get: + description: | + Lists all [KeyVersion](/api/#/en/key/latest/KeyVersion/) resources for the specified + master encryption key. + + As a management operation, this call is subject to a Key Management limit that applies to the total number + of requests across all management read operations. Key Management might throttle this call to reject an + otherwise valid request when the total rate of management read operations exceeds 10 requests per second + for a given tenancy. + operationId: ListKeyVersions + parameters: + - $ref: '#/components/parameters/KeyIdPathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: | + The [KeyVersionSummary](/api/#/en/key/latest/KeyVersionSummary/) resource for the specified + master encryption key. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListKeyVersionsResponse' + '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/DefaultError' + summary: Lists all key versions for a key. + tags: + - kmsManagement + x-example: | + GET /20180608/keys/<key_OCID>/keyVersions?limit=20&sortBy=timeCreated&sortOrder=DESC + Host: <managementEndpoint> + <authorization and other headers> + x-stackql-bare-array-wrap: + wrapperKey: key_versions + wrapperName: ListKeyVersionsResponse + mediaType: application/json + scalar: false + post: + description: | + Generates a new [KeyVersion](/api/#/en/key/latest/KeyVersion/) resource that provides new cryptographic + material for a master encryption key. The key must be in an `ENABLED` state to be rotated. + + As a management operation, this call is subject to a Key Management limit that applies to the total number + of requests across all management write operations. Key Management might throttle this call to reject an + otherwise valid request when the total rate of management write operations exceeds 10 requests per second + for a given tenancy. + operationId: CreateKeyVersion + parameters: + - $ref: '#/components/parameters/KeyIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalKeyVersionReference' + description: CreateKeyMetadataDetails + responses: + '200': + description: The new key version. + 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/KeyVersion' + '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/DefaultError' + summary: Creates a new key version resource and rotates the key to use it for encryption. + tags: + - kmsManagement + x-example: | + POST /20180201/keys/<key_OCID>/keyVersions + Host: <managementEndpoint> + <authorization and other headers> + { + "keyId" : "ocid1.key.region1.sea.avqwccqbaacu2.abzwkljskoqxgp5gswxqhk6za5vjsd2rocdmu333iolcoto6jvmnnuzlclib", + "externalKeyVersionId": "1036f5083e1b4ef49b60c01f50d9e337baa8fa3c28504265bf36760d351c4534" + } + /20180608/keys/{keyId}/keyVersions/import: + post: + description: | + Imports AES key material to create a new key version and then rotate the key to begin using the new + key version. The key material must be base64-encoded and wrapped by the vault's public RSA wrapping key + before you can import it. Key Management supports AES symmetric keys that are exactly 16, 24, or 32 bytes. + Furthermore, the key length must match the length of the specified key and what you specify as the length + at the time of import. When importing an asymmetric key, only the private key must be wrapped in PKCS8 format + while the corresponding public key is generated internally by KMS. + operationId: ImportKeyVersion + parameters: + - $ref: '#/components/parameters/KeyIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ImportKeyVersionDetails' + description: ImportKeyVersionDetails + required: true + responses: + '200': + description: The new key version. + 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/KeyVersion' + '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/DefaultError' + summary: Imports the given wrapped key material and then rotate the key to begin using the new key version for the specified key. + tags: + - kmsManagement + x-example: | + POST /20180608/keys/<key_OCID>/keyVersions/import + Host: <managementEndpoint> + <authorization and other headers> + { + "wrappedImportKey": + { + "wrappingAlgorithm": "RSA_OAEP_SHA256", + "keyMaterial": "089d08927390280802d0987c09e7798h09f879870909c098709a709870970987b09709870c987098d70e==" + } + } + /20180608/keys/{keyId}/keyVersions/{keyVersionId}: + get: + description: | + Gets information about the specified key version. + + As a management operation, this call is subject to a Key Management limit that applies to the total number + of requests across all management read operations. Key Management might throttle this call to reject an + otherwise valid request when the total rate of management read operations exceeds 10 requests per second + for a given tenancy. + operationId: GetKeyVersion + parameters: + - $ref: '#/components/parameters/KeyIdPathParam' + - $ref: '#/components/parameters/KeyVersionIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The specified key version. + 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/KeyVersion' + '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/DefaultError' + summary: Gets details about a key version. + tags: + - kmsManagement + x-example: | + GET /20180608/keyVersions/<key_version_OCID> + Host: <managementEndpoint> + <authorization and other headers> + /20180608/keys/{keyId}/keyVersions/{keyVersionId}/actions/cancelDeletion: + post: + description: | + Cancels the scheduled deletion of the specified key version. Canceling + a scheduled deletion restores the key version to its lifecycle state from + before its scheduled deletion. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. + operationId: CancelKeyVersionDeletion + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/KeyIdPathParam' + - $ref: '#/components/parameters/KeyVersionIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '200': + description: The key version's scheduled deletion has been canceled. + 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/KeyVersion' + '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/DefaultError' + summary: Cancels the scheduled deletion of a key version. + tags: + - kmsManagement + x-example: | + POST /20180608/keys/<key_OCID>/keyVersions/<key_version_OCID>actions/cancelDeletion + Host: <managementEndpoint> + <authorization and other headers> + x-related-resource: '#/definitions/KeyVersion' + /20180608/keys/{keyId}/keyVersions/{keyVersionId}/actions/scheduleDeletion: + post: + description: | + Schedules the deletion of the specified key version. This sets the lifecycle state of the key version + to `PENDING_DELETION` and then deletes it after the specified retention period ends. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. + operationId: ScheduleKeyVersionDeletion + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/KeyIdPathParam' + - $ref: '#/components/parameters/KeyVersionIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScheduleKeyVersionDeletionDetails' + description: ScheduleKeyVersionDeletionDetails + required: true + responses: + '200': + description: The key version is scheduled for deletion. + 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/KeyVersion' + '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/DefaultError' + summary: Schedules the deletion of a key version. + tags: + - kmsManagement + x-example: | + POST /20180608/keys/<key_OCID>/keyVersions/<key_version_OCID>/actions/scheduleDeletion + Host: <managementEndpoint> + <authorization and other headers> + { + "timeOfDeletion": "2018-04-03T21:10:29.600Z" + } + x-related-resource: '#/definitions/KeyVersion' + /20180608/replicaOperations/{replicationId}/status: + get: + description: | + When a vault has a replica, each operation on the vault or its resources, such as + keys, is replicated and has an associated replicationId. Replication status provides + details about whether the operation associated with the given replicationId has been + successfully applied across replicas. + operationId: GetReplicationStatus + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/ReplicationIdPathParam' + responses: + '200': + description: | + Replication status indicating whether replication corresponding to a replicationId is complete or still in progress + 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/ReplicationStatusDetails' + '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/DefaultError' + summary: Gets the replication status of a replica operation + tags: + - kmsManagement + x-example: | + GET /20180608/replicaOperations/<replicationId>/status + Host: <managementEndpoint> + <authorization and other headers> + /20180608/sign: + post: + description: | + Creates a digital signature for a message or message digest by using the private key of a public-private key pair, + also known as an asymmetric key. To verify the generated signature, you can use the [Verify](/api/#/en/key/latest/VerifiedData/Verify) + operation. Or, if you want to validate the signature outside of the service, you can do so by using the public key of the same asymmetric key. + This operation is not supported for keys having protection mode `EXTERNAL`. + operationId: Sign + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SignDataDetails' + description: SignDataDetails + required: true + responses: + '200': + description: | + The signed data. + 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/SignedData' + '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/DefaultError' + summary: Signs data by using the given SignDataDetails resource. + tags: + - kmsCrypto + x-example: | + POST /20180608/sign + Host: <cryptoEndpoint> + <authorization and other headers> + { + "keyId": "ocid1.key.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23tteidhj4q2c6qfauxm32i577yu5a", + "message": "aGVsbG8sIHdvcmxk" + "signingAlgorithm": "SHA256_RSA_PKCS_PSS" + }, + /20180608/vaults: + get: + description: | + Lists the vaults in the specified compartment. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning read operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + read operations exceeds 10 requests per second for a given tenancy. + operationId: ListVaults + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: A list of vaults. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListVaultsResponse' + '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/DefaultError' + summary: Lists vaults in the compartment. + tags: + - kmsVault + x-example: | + GET /20180608/vaults?compartmentId=<compartmentId> + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + post: + description: | + Creates a new vault. The type of vault you create determines key placement, pricing, and + available options. Options include storage isolation, a dedicated service endpoint instead + of a shared service endpoint for API calls, and either a dedicated hardware security module + (HSM) or a multitenant HSM. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. + operationId: CreateVault + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateVaultDetails' + description: CreateVaultDetails + required: true + responses: + '200': + description: The vault is being created. + 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/Vault' + '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/DefaultError' + summary: Creates a new vault. + tags: + - kmsVault + x-example: | + POST /20180608/vaults + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5ltpneskcfy7lr4a6wfauxuwrwed5bsdea", + "displayName": "Vault 1", + "vaultType": "VIRTUAL_PRIVATE" + } + /20180608/vaults/actions/restoreFromFile: + post: + description: | + Restores a vault from an encrypted backup file. If a vault + with the same OCID already exists, this operation returns a response with a + 409 HTTP status error code. + operationId: RestoreVaultFromFile + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/ContentLengthHeader' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/OptionalContentMD5Header' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/octet-stream: + schema: + format: binary + type: string + description: The encrypted backup file to upload to restore the vault. + required: true + responses: + '202': + description: The vault has been restored. + headers: + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + opc-content-md5: + description: | + The base64-encoded MD5 hash value of the request body, as computed + by the server. + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the work request, used to track the progress of the + restore operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Vault' + '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/DefaultError' + summary: Restores a vault from an encrypted backup file. + tags: + - KmsVault + x-example: | + POST /20180608/vaults/actions/restoreFromFile?compartmentId=<compartmentId> + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + { + "RestoreVaultFromFileDetails" : "vault backup bytes.." + } + x-related-resource: '#/definitions/Vault' + /20180608/vaults/actions/restoreFromObjectStore: + post: + description: | + Restores a vault from an encrypted backup file stored in Oracle Cloud Infrastructure Object + Storage. If a vault with the same OCID already exists, this operation returns + a response with a 409 HTTP status error code. + operationId: RestoreVaultFromObjectStore + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RestoreVaultFromObjectStoreDetails' + description: RestoreVaultFromObjectStoreDetails + responses: + '202': + description: The vault restore operation started successfully. + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the work request, used to track the progress of the + restore operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Vault' + '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/DefaultError' + summary: Restores a vault from an object storage location. + tags: + - KmsVault + x-example: | + POST /20180608/vaults/actions/restoreFromObjectStore?compartmentId=<compartmentId> + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + { + "RestoreVaultFromObjectStoreDetails" : { + "backupLocation" : { + "BackupLocationURI" : { + "uri" : "http://n/namespace/b/bucket/o/object" + } + } + } + } + x-related-resource: '#/definitions/Vault' + /20180608/vaults/{vaultId}: + get: + description: | + Gets the specified vault's configuration information. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning read operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + read operations exceeds 10 requests per second for a given tenancy. + operationId: GetVault + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/VaultIdPathParam' + responses: + '200': + description: The specified vault. + 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/Vault' + '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/DefaultError' + summary: Gets details about a vault. + tags: + - kmsVault + x-example: | + GET /20180608/vaults/<vaultId> + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the properties of a vault. Specifically, you can update the + `displayName`, `freeformTags`, and `definedTags` properties. Furthermore, + the vault must be in an ACTIVE or CREATING state to be updated. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. + operationId: UpdateVault + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/VaultIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateVaultDetails' + description: UpdateVaultDetails + required: true + responses: + '200': + description: The vault is updated according to the request. + 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/Vault' + '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/DefaultError' + summary: Updates the properties of a vault. + tags: + - kmsVault + x-example: | + PUT /20180608/vaults/<vaultId> + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + { + "displayName": "Vault 1" + } + /20180608/vaults/{vaultId}/actions/backup: + post: + description: | + Backs up an encrypted file that contains all the metadata of a vault so that you can restore the vault later. + You can backup a vault whether or not it contains keys. This operation only backs up the + metadata of the vault, and does not include key metadata. + operationId: BackupVault + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/VaultIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackupVaultDetails' + description: BackupVaultDetails + responses: + '202': + description: The vault backup operation started successfully. + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the work request, used to track the progress of the + backup operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Vault' + '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/DefaultError' + summary: Backs up a vault. + tags: + - KmsVault + x-example: | + POST /20180608/vaults/<vault_OCID>/actions/backup + Host: <managementEndpoint> + <authorization and other headers> + { + "BackupVaultDetails" : { + "backupLocation" : { + "BackupLocationURI" : { + "uri" : "http://n/namespace/b/bucket/o/object" + } + }, + "isIncludeKeys" : false + } + } + x-related-resource: '#/definitions/Vault' + /20180608/vaults/{vaultId}/actions/cancelDeletion: + post: + description: | + Cancels the scheduled deletion of the specified vault. Canceling a scheduled deletion + restores the vault and all keys in it to their respective states from before their + scheduled deletion. All keys that were scheduled for deletion prior to vault + deletion retain their lifecycle state and time of deletion. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. + operationId: CancelVaultDeletion + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/VaultIdPathParam' + responses: + '200': + description: The vault's scheduled deletion has been canceled. + 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/Vault' + '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/DefaultError' + summary: Cancels the scheduled deletion of a vault. + tags: + - kmsVault + x-example: | + POST /20180608/vaults/<vaultId>/actions/cancelDeletion + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Vault' + /20180608/vaults/{vaultId}/actions/changeCompartment: + post: + description: | + Moves a vault into a different compartment within the same tenancy. For information about + moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + + When provided, if-match is checked against the ETag values of the resource. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. + operationId: ChangeVaultCompartment + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/VaultIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeVaultCompartmentDetails' + description: ChangeVaultCompartmentDetails + required: true + responses: + '204': + description: The compartment information for the vault has been updated. + 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 + '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/DefaultError' + summary: Moves a vault into a different compartment. + tags: + - kmsVault + x-example: | + POST /20180608/vaults/<vault_OCID>/actions/changeCompartment + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5lsdneskcfy7lr4a6wfauxuwrwed5b3xea", + } + x-related-resource: '#/definitions/Vault' + /20180608/vaults/{vaultId}/actions/createReplica: + post: + description: | + Creates a replica for the vault in another region in the same realm + + The API is a no-op if called for same region that a vault is already replicated to. + 409 if called on a vault that is already replicated to a different region. Users need to delete + existing replica first before calling it with a different region. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. + operationId: CreateVaultReplica + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/VaultIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateVaultReplicaDetails' + description: CreateVaultReplicaDetails + required: true + responses: + '202': + description: The vault replica is being created according to the request. + 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: | + Unique Oracle-assigned identifier for the work request, used to track the progress of the + create replica operation. + 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/DefaultError' + summary: Creates a replica for the vault in another region in the same realm + tags: + - kmsVault + x-example: | + POST /20180608/vaults/<vault_OCID>/actions/createReplica + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Vault' + /20180608/vaults/{vaultId}/actions/deleteReplica: + post: + description: | + Deletes a vault replica + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. + operationId: DeleteVaultReplica + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/VaultIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteVaultReplicaDetails' + description: DeleteVaultReplicaDetails + required: true + responses: + '202': + description: Vault replica delete request has been accepted successfully + 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: | + Unique Oracle-assigned identifier for the work request, used to track the progress of the + delete replica operation. + 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/DefaultError' + summary: Deletes a vault replica + tags: + - kmsVault + x-example: | + POST /20180608/vaults/<vault_OCID>/actions/deleteReplica + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + {"region" : "us-ashburn-1"} + x-related-resource: '#/definitions/Vault' + /20180608/vaults/{vaultId}/actions/listReplicas: + get: + description: | + Lists the replicas for a vault + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. + operationId: ListVaultReplicas + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/VaultIdPathParam' + responses: + '200': + description: List of vault replicas + headers: + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/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/ListVaultReplicasResponse' + '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/DefaultError' + summary: Lists the replicas for a vault + tags: + - kmsVault + x-example: | + GET /20180608/vaults/<vault_OCID>/actions/listReplicas + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Vault' + /20180608/vaults/{vaultId}/actions/scheduleDeletion: + post: + description: | + Schedules the deletion of the specified vault. This sets the lifecycle state of the vault and all keys in it + that are not already scheduled for deletion to `PENDING_DELETION` and then deletes them after the + retention period ends. The lifecycle state and time of deletion for keys already scheduled for deletion won't + change. If any keys in the vault are scheduled to be deleted after the specified time of + deletion for the vault, the call is rejected with the error code 409. + + As a provisioning operation, this call is subject to a Key Management limit that applies to + the total number of requests across all provisioning write operations. Key Management might + throttle this call to reject an otherwise valid request when the total rate of provisioning + write operations exceeds 10 requests per second for a given tenancy. + operationId: ScheduleVaultDeletion + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/VaultIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScheduleVaultDeletionDetails' + description: ScheduleVaultDeletionDetails + required: true + responses: + '200': + description: The vault is scheduled for deletion. + 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/Vault' + '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/DefaultError' + summary: Schedules the deletion of a vault. + tags: + - kmsVault + x-example: | + POST /20180608/vaults/<vaultId>/actions/scheduleDeletion + Host: kms.us-ashburn-1.oraclecloud.com + <authorization and other headers> + { + "timeOfDeletion": "2018-04-03T21:10:29.600Z" + } + x-related-resource: '#/definitions/Vault' + /20180608/vaults/{vaultId}/usage: + get: + description: | + Gets the count of keys and key versions in the specified vault to calculate usage against service limits. + operationId: GetVaultUsage + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/VaultIdPathParam' + responses: + '200': + description: The usage level of keys and key versions in the specified vault. + 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/VaultUsage' + '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/DefaultError' + summary: Gets the specified vault's usage against service limits. + tags: + - KmsVault + x-example: | + GET /20180608/vaults/<vault_OCID>/usage + Host: <managementEndpoint> + <authorization and other headers> + /20180608/verify: + post: + description: | + Verifies a digital signature that was generated by the [Sign](/api/#/en/key/latest/SignedData/Sign) operation + by using the public key of the same asymmetric key that was used to sign the data. If you want to validate the + digital signature outside of the service, you can do so by using the public key of the asymmetric key. + This operation is not supported for keys having protection mode `EXTERNAL`. + operationId: Verify + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VerifyDataDetails' + description: VerifyDataDetails + required: true + responses: + '200': + description: | + The verified signed material. + 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/VerifiedData' + '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/DefaultError' + summary: Verifies signed data by using the given VerifyDataDetails resource. + tags: + - kmsCrypto + x-example: | + POST /20180608/verify + Host: <cryptoEndpoint> + <authorization and other headers> + { + "keyId": "ocid1.key.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23tteidhj4q2c6qfauxm32i577yu5a", + "keyVersionId": "ocid1.keyversion.oc1.iad.exampledaaeug.xd5q23tteidhj4q2c6qfauxm32i577yuamplestkvmbjdnbickxasfaf", + "signature": "dsdfsljfnsjnfsnfdsnf", + "signingAlgorithm": "SHA256_RSA_PKCS_PSS" + } + /20180608/wrappingKeys: + get: + description: | + Gets details about the public RSA wrapping key associated with the vault in the endpoint. Each vault has an RSA key-pair that wraps and + unwraps AES key material for import into Key Management. + operationId: GetWrappingKey + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The public RSA wrapping key associated with the vault. + 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/WrappingKey' + '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/DefaultError' + summary: Gets details about the RSA wrapping key associated with the vault. + tags: + - kmsManagement + x-example: | + GET /20180608/wrappingKeys + Host: <managementEndpoint> + <authorization and other headers> +components: + schemas: + DecryptDataDetails: + description: The details of the encrypted data that you want to decrypt. + properties: + associatedData: + additionalProperties: + type: string + description: | + Information that can be used to provide an encryption context for the encrypted data. + The length of the string representation of the associated data must be fewer than 4096 characters. + type: object + ciphertext: + description: The encrypted data to decrypt. + maxLength: 65536 + minLength: 1 + type: string + encryptionAlgorithm: + default: AES_256_GCM + description: | + The encryption algorithm to use to encrypt or decrypt data with a customer-managed key. + `AES_256_GCM` indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and + that the mode of encryption is the Galois/Counter Mode (GCM). `RSA_OAEP_SHA_1` indicates that the + key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP). + `RSA_OAEP_SHA_256` indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash + and uses OAEP. + enum: + - AES_256_GCM + - RSA_OAEP_SHA_1 + - RSA_OAEP_SHA_256 + type: string + keyId: + description: The OCID of the key used to encrypt the ciphertext. + maxLength: 255 + minLength: 1 + type: string + keyVersionId: + description: The OCID of the key version used to encrypt the ciphertext. + maxLength: 255 + minLength: 1 + type: string + loggingContext: + additionalProperties: + type: string + description: | + Information that provides context for audit logging. You can provide this additional + data as key-value pairs to include in audit logs when audit logging is enabled. + type: object + required: + - ciphertext + - keyId + type: object + DecryptedData: + description: The response to a request to decrypt the encrypted data. + properties: + encryptionAlgorithm: + default: AES_256_GCM + description: | + The encryption algorithm to use to encrypt and decrypt data with a customer-managed key + `AES_256_GCM` indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and + that the mode of encryption is the Galois/Counter Mode (GCM). `RSA_OAEP_SHA_1` indicates that the + key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP). + `RSA_OAEP_SHA_256` indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash + and uses OAEP. + enum: + - AES_256_GCM + - RSA_OAEP_SHA_1 + - RSA_OAEP_SHA_256 + type: string + keyId: + description: The OCID of the key used to encrypt the ciphertext. + maxLength: 255 + minLength: 1 + type: string + keyVersionId: + description: The OCID of the key version used to encrypt the ciphertext. + maxLength: 255 + minLength: 1 + type: string + plaintext: + description: The decrypted data, expressed as a base64-encoded value. + maxLength: 4096 + minLength: 1 + type: string + plaintextChecksum: + description: The checksum of the decrypted data. + maxLength: 1024 + minLength: 1 + type: string + required: + - plaintext + - plaintextChecksum + type: object + x-example: | + { + "plaintext": "aGVsbG8sIHdvcmxk", + "plaintextChecksum": "4289425978" + } + EkmsPrivateEndpointSummary: + description: EKMS private endpoints summary + properties: + compartmentId: + description: Identifier of the compartment this EKMS private endpoint belongs to + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing predefined tags, keys, and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{"foo-namespace": {"bar-key": "value"}}` + type: object + displayName: + description: Mutable name of the EKMS private endpoint + maxLength: 100 + minLength: 1 + type: string + freeformTags: + additionalProperties: + type: string + description: | + Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. + Example: `{"bar-key": "value"}` + type: object + id: + description: Unique identifier that is immutable + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the EKMS private endpoint resource. + enum: + - CREATING + - ACTIVE + - DELETING + - DELETED + - FAILED + type: string + subnetId: + description: Subnet Identifier + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: The time the EKMS private endpoint was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. + format: date-time + type: string + timeUpdated: + description: The time the EKMS private endpoint was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. + format: date-time + type: string + required: + - id + - compartmentId + - subnetId + - displayName + - lifecycleState + - timeCreated + type: object + x-example: | + [ + { + "id": "ocid1.ekmsprivateendpoint.region1.sea.exampleaaacu2.examples26q544r24g2cvbzg7u6be7nq4d3sfauxiqmz6elcnj55egmfe4kq", + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5ltpneskcfy7lr4a6wfauxuwrwed5b3xea", + "subnetId": "ocid1.subnet.oc1.phx.exampleaaaarzlbjasxeir5mg5sux6fcah2lsdmgpytduuuv4ktnjpb2hpwqunq", + "displayName": "EKMS Private Endpoint 1" + "timeCreated": "2018-04-04T00:33:59.874Z", + "timeUpdated": "2018-04-04T00:33:59.874Z", + "freeformTags": {"Type": "CTM"}, + "definedTags": + { + "MyFirstNamespace": + { + "CostCenter": "SmartAlec", + "Project": "42", + "CreatedBy": "SmartAlec", + "CreatedDate": "9/21/2017T14:00" + }, + "Audit": + { + "DataSensitivity": "PII", + "CageSecurity": "High", + "Simplicity": "complex" + } + "lifecycleState": "CREATING", + } + ] + CreateEkmsPrivateEndpointDetails: + description: Information needed to create EKMS private endpoint resource + properties: + caBundle: + description: | + CABundle to validate TLS certificate of the external key manager system in PEM format + type: string + compartmentId: + description: Compartment identifier. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing predefined tags, keys, and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{"foo-namespace": {"bar-key": "value"}}` + type: object + displayName: + description: Display name of the EKMS private endpoint resource being created. + maxLength: 100 + minLength: 1 + type: string + externalKeyManagerIp: + description: | + External private IP to connect to from this EKMS private endpoint + maxLength: 15 + minLength: 7 + type: string + freeformTags: + additionalProperties: + type: string + description: | + Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. + Example: `{"bar-key": "value"}` + type: object + port: + description: The port of the external key manager system + type: integer + subnetId: + description: | + The OCID of subnet in which the EKMS private endpoint is to be created + maxLength: 255 + minLength: 1 + type: string + required: + - subnetId + - compartmentId + - externalKeyManagerIp + - caBundle + - displayName + type: object + x-example: | + { + "subnetId": "ocid1.subnet.oc1.phx.exampleaaaarzlbjasxeir5mg5sux6fcah2lsdmgpytduuuv4ktnjpb2hpwqunq", + "freeformTags": {"Type": "CTM"}, + "definedTags": + { + "MyFirstNamespace": + { + "CostCenter": "SmartAlec", + "Project": "42", + "CreatedBy": "SmartAlec", + "CreatedDate": "9/21/2017T14:00" + }, + "Audit": + { + "DataSensitivity": "PII", + "CageSecurity": "High", + "Simplicity": "complex" + } + } + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5ltpneskcfy7lr4a6wfauxuwrwed5b3xea", + "displayName": "EKMS Private Endpoint 1", + "caBundle": "----- BEGIN CERTIFICATE ----- abcRTynddf567= ---- END CERTIFICATE ---", + "externalKeyManagerIp": "1.2.3.4", + "port": 1234 + } + EkmsPrivateEndpoint: + description: EKMS private endpoint created in customer subnet used to connect to external key manager system + properties: + caBundle: + description: | + CABundle to validate TLS certificate of the external key manager system in PEM format + type: string + compartmentId: + description: Compartment Identifier. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing predefined tags, keys, and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{"foo-namespace": {"bar-key": "value"}}` + type: object + displayName: + description: EKMS Private Endpoint display name + maxLength: 100 + minLength: 1 + type: string + externalKeyManagerIp: + description: | + Private IP of the external key manager system to connect to from the EKMS private endpoint + maxLength: 15 + minLength: 7 + type: string + freeformTags: + additionalProperties: + type: string + description: | + Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. + Example: `{"bar-key": "value"}` + type: object + id: + description: Unique identifier that is immutable + type: string + lifecycleDetails: + description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the EKMS private endpoint resource. + enum: + - CREATING + - ACTIVE + - DELETING + - DELETED + - FAILED + type: string + port: + description: The port of the external key manager system + type: integer + privateEndpointIp: + description: The IP address in the customer's VCN for the EKMS private endpoint. This is taken from subnet + maxLength: 46 + minLength: 8 + type: string + subnetId: + description: Subnet Identifier + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: The time the EKMS private endpoint was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. + format: date-time + type: string + timeUpdated: + description: The time the EKMS private endpoint was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. + format: date-time + type: string + required: + - id + - compartmentId + - subnetId + - displayName + - externalKeyManagerIp + - lifecycleState + - timeCreated + type: object + x-example: | + { + "id": "ocid1.ekmsprivateendpoint.region1.sea.exampleaaacu2.examples26q544r24g2cvbzg7u6be7nq4d3sfauxiqmz6elcnj55egmfe4kq", + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5ltpneskcfy7lr4a6wfauxuwrwed5b3xea", + "subnetId": "ocid1.subnet.oc1.phx.exampleaaaarzlbjasxeir5mg5sux6fcah2lsdmgpytduuuv4ktnjpb2hpwqunq", + "displayName": "EKMS Private Endpoint 1" + "timeCreated": "2018-04-04T00:33:59.874Z", + "timeUpdated": "2018-04-04T00:33:59.874Z", + "freeformTags": {"Type": "CTM"}, + "definedTags": + { + "MyFirstNamespace": + { + "CostCenter": "SmartAlec", + "Project": "42", + "CreatedBy": "SmartAlec", + "CreatedDate": "9/21/2017T14:00" + }, + "Audit": + { + "DataSensitivity": "PII", + "CageSecurity": "High", + "Simplicity": "complex" + } + } + "lifecycleState": "CREATING", + "lifecycleDetails": "Resource is being created", + "externalKeyManagerIp": "1.2.3.4", + "port": 1234, + "caBundle": "----- BEGIN CERTIFICATE ----- abcRTynddf567= ---- END CERTIFICATE ---", + "privateEndpointIp": "5.6.7.8" + } + UpdateEkmsPrivateEndpointDetails: + description: Information needed to modify EKMS private endpoint resource + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing predefined tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{"foo-namespace": {"bar-key": "value"}}` + type: object + displayName: + description: Display name of EKMS private endpoint resource. + maxLength: 100 + minLength: 1 + type: string + freeformTags: + additionalProperties: + type: string + description: | + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{"bar-key": "value"}` + type: object + type: object + x-example: | + { + "displayName": "EKMS Private Endpoint 2", + "freeformTags": {"Type": "CTM"}, + "definedTags": + { + "MyFirstNamespace": + { + "CostCenter": "SmartAlec", + "Project": "42", + "CreatedBy": "SmartAlec", + "CreatedDate": "9/21/2017T14:00" + }, + "Audit": + { + "DataSensitivity": "PII", + "CageSecurity": "High", + "Simplicity": "complex" + } + } + } + EncryptDataDetails: + description: The details of the plaintext data that you want to encrypt. + properties: + associatedData: + additionalProperties: + type: string + description: | + Information that can be used to provide an encryption context for the + encrypted data. The length of the string representation of the associated data + must be fewer than 4096 characters. + type: object + encryptionAlgorithm: + default: AES_256_GCM + description: | + The encryption algorithm to use to encrypt and decrypt data with a customer-managed key. + `AES_256_GCM` indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and + that the mode of encryption is the Galois/Counter Mode (GCM). `RSA_OAEP_SHA_1` indicates that the + key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP). + `RSA_OAEP_SHA_256` indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash + and uses OAEP. + enum: + - AES_256_GCM + - RSA_OAEP_SHA_1 + - RSA_OAEP_SHA_256 + type: string + keyId: + description: The OCID of the key to encrypt with. + maxLength: 255 + minLength: 1 + type: string + keyVersionId: + description: The OCID of the key version used to encrypt the ciphertext. + maxLength: 255 + minLength: 1 + type: string + loggingContext: + additionalProperties: + type: string + description: | + Information that provides context for audit logging. You can provide this additional + data as key-value pairs to include in the audit logs when audit logging is enabled. + type: object + plaintext: + description: The plaintext data to encrypt. + maxLength: 4096 + minLength: 1 + type: string + required: + - keyId + - plaintext + type: object + x-example: | + { + "keyId": "ocid1.key.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxdee23kueidhj4q2c6qfauxm32i577yu5a", + "plaintext": "aGVsbG8sIHdvcmxk" + } + EncryptedData: + description: The response to a request to encrypt the plaintext data. + properties: + ciphertext: + description: The encrypted data. + maxLength: 65536 + minLength: 1 + type: string + encryptionAlgorithm: + default: AES_256_GCM + description: | + The encryption algorithm to use to encrypt and decrypt data with a customer-managed key. + `AES_256_GCM` indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and + that the mode of encryption is the Galois/Counter Mode (GCM). `RSA_OAEP_SHA_1` indicates that the + key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP). + `RSA_OAEP_SHA_256` indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash + and uses OAEP. + enum: + - AES_256_GCM + - RSA_OAEP_SHA_1 + - RSA_OAEP_SHA_256 + type: string + keyId: + description: The OCID of the key used to encrypt the ciphertext. + maxLength: 255 + minLength: 1 + type: string + keyVersionId: + description: The OCID of the key version used to encrypt the ciphertext. + maxLength: 255 + minLength: 1 + type: string + required: + - ciphertext + type: object + x-example: | + { + "ciphertext": "AAwgpauIe9AAAM6dU7pS7AKwmDFyXOqNh0uAvNY9a3E95rw7Ae3LZNBnDtHWdkB1l/pIDBfg" + } + ExportKeyDetails: + description: The details of the key that you want to wrap and export. + properties: + algorithm: + description: | + The encryption algorithm to use to encrypt exportable key material from a software-backed key. Specifying `RSA_OAEP_AES_SHA256` + invokes the RSA AES key wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped by the RSA public + wrapping key provided along with the request, creating a wrapped temporary AES key. The temporary AES key is also used to wrap + the exportable key material. The wrapped temporary AES key and the wrapped exportable key material are concatenated, producing + concatenated blob output that jointly represents them. Specifying `RSA_OAEP_SHA256` means that the software key is wrapped by + the RSA public wrapping key provided along with the request. + enum: + - RSA_OAEP_AES_SHA256 + - RSA_OAEP_SHA256 + type: string + keyId: + description: The OCID of the master encryption key associated with the key version you want to export. + maxLength: 255 + minLength: 1 + type: string + keyVersionId: + description: | + The OCID of the specific key version to export. If not specified, the service exports the current key version. + maxLength: 255 + minLength: 1 + type: string + loggingContext: + additionalProperties: + type: string + description: | + Information that provides context for audit logging. You can provide this additional + data as key-value pairs to include in the audit logs when audit logging is enabled. + type: object + publicKey: + description: | + The PEM format of the 2048-bit, 3072-bit, or 4096-bit RSA wrapping key in your possession that you want to use to encrypt the key. + maxLength: 810 + minLength: 390 + type: string + required: + - keyId + - algorithm + - publicKey + type: object + x-example: | + { + "keyId": "ocid1.key.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23tteidhj4q2c6qfauxm32i577yu5a", + "keyVersionId": "ocid1.keyversion.oc1.iad.examplevriiaa.examples4h2bocax3damnsxw4cvbbndged2gftlho4ufxwa4faux2eiqwija", + "algorithm": "RSA_OAEP_AES_SHA256", + "publicKey": "-----BEGIN PUBLIC KEY----- ..... -----END PUBLIC KEY-----" + } + ExportedKeyData: + description: The response to a request to export key material. + properties: + algorithm: + description: | + The encryption algorithm to use to encrypt exportable key material from a key that persists on the server (as opposed to a key that + persists on a hardware security module and, therefore, cannot be exported). Specifying RSA_OAEP_AES_SHA256 invokes the RSA AES key + wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped by the RSA public wrapping key provided along + with the request, creating a wrapped temporary AES key. The temporary AES key is also used to wrap the exportable key material. The + wrapped temporary AES key and the wrapped exportable key material are concatenated, producing concatenated blob output that jointly + represents them. Specifying RSA_OAEP_SHA256 means that the exportable key material is wrapped by the RSA public wrapping key provided + along with the request. + enum: + - RSA_OAEP_AES_SHA256 + - RSA_OAEP_SHA256 + type: string + encryptedKey: + description: | + The base64-encoded exported key material, which is encrypted by using the public RSA wrapping key specified in the export request. + type: string + keyId: + description: The OCID of the master encryption key associated with this key version. + maxLength: 255 + minLength: 1 + type: string + keyVersionId: + description: The OCID of the key version. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time this key version was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + example: '2018-04-03T21:10:29.600Z' + format: date-time + type: string + vaultId: + description: The OCID of the vault that contains this key version. + maxLength: 255 + minLength: 1 + type: string + required: + - keyVersionId + - timeCreated + - vaultId + - encryptedKey + - keyId + - algorithm + type: object + x-example: | + { + "KeyVersionId": "ocid1.keyversion.oc1.iad.examplevriiaa.examples4h2bocax3damnsxw4cvbbndged2gftlho4ufxwa4faux2eiqwija", + "keyId": "ocid1.key.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23tteidhj4q2c6qfauxm32i577yu5a", + "timeCreated": "2018-04-04T00:33:59.874Z", + "vaultId": "ocid1.vault.oc1.iad.examplevaaeuk.examplettv5i3qbkp22g3cvbjqy7c7sqlywv25eajvnvcfauxpdgga6gct4a", + "encryptedKey": "089d08927390280802d0987c09e7798h09f879870909c098709a709870970987b09709870c987098d70e==", + "algorithm": "RSA_OAEP_AES_SHA256" + } + GenerateKeyDetails: + description: The details of the key that you want to encrypt or decrypt data. + properties: + associatedData: + additionalProperties: + type: string + description: | + Information that can be used to provide an encryption context for the encrypted data. + The length of the string representation of the associated data must be fewer than 4096 + characters. + type: object + includePlaintextKey: + description: If true, the generated key is also returned unencrypted. + type: boolean + keyId: + description: The OCID of the master encryption key to encrypt the generated data encryption key with. + maxLength: 255 + minLength: 1 + type: string + keyShape: + $ref: '#/components/schemas/KeyShape' + loggingContext: + additionalProperties: + type: string + description: | + Information that provides context for audit logging. You can provide this additional + data by formatting it as key-value pairs to include in audit logs when audit logging is enabled. + type: object + required: + - keyId + - keyShape + - includePlaintextKey + type: object + x-example: | + { + "includePlaintextKey": true, + "keyId": "ocid1.key.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23tteidhj4q2c6qfauxm32i577yu5a", + "keyShape": { + "algorithm": "AES", + "length": 16 + } + } + GeneratedKey: + description: The reponse to the regeuest to generate the key to encrypt or decrypt the data. + properties: + ciphertext: + description: The encrypted data encryption key generated from a master encryption key. + maxLength: 65536 + minLength: 1 + type: string + plaintext: + description: | + The plaintext data encryption key, a base64-encoded sequence of random bytes, which is + included if the [GenerateDataEncryptionKey](/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey) + request includes the `includePlaintextKey` parameter and sets its value to "true". + maxLength: 65536 + minLength: 1 + type: string + plaintextChecksum: + description: | + The checksum of the plaintext data encryption key, which is included if the + [GenerateDataEncryptionKey](/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey) + request includes the `includePlaintextKey` parameter and sets its value to "true". + maxLength: 1024 + minLength: 1 + type: string + required: + - ciphertext + type: object + x-example: | + { + "ciphertext": "AAwRhavVBkAAAJNF0nE7tBz/CQDanO33toIAWpw/lCn9GuadiyNNZ2QCmeUksvor8HD00o0TiUHzj6IsDJ5z1j/AEXZrhBtEcz4=", + "plaintext": "lqGERnQJYzljUfMITDub/uV5ZbQkvCE906Wg/mflz2s=", + "plaintextChecksum": "1140988275" + } + HsmClusterCollection: + description: HsmClusterCollection object with page of HsmClusterSummary objects. + properties: + items: + description: List of HSM Cluster Summary Objects. + items: + $ref: '#/components/schemas/HsmClusterSummary' + type: array + required: + - items + type: object + CreateHsmClusterDetails: + description: The details of the HSM cluster resource that you want to create. + properties: + compartmentId: + description: The OCID of the compartment where you want to create this HSM cluster resource. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only the string type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + A user-friendly display name for the HSM cluster resource. It does not have to be unique, and it is changeable. + Avoid entering confidential information. + maxLength: 100 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + required: + - compartmentId + - displayName + type: object + x-example: | + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5ltpneskcfy7lr4auufauxuwrwed5b3xea", + "displayName": "Hsm 1", + "freeformTags": {"Department": "Finance"}, + "definedTags": + { + "MyFirstNamespace": + { + "CostCenter": "SmartAlec", + "Project": "42", + "CreatedBy": "SmartAlec", + "CreatedDate": "9/21/2017T14:00" + }, + "Audit": + { + "DataSensitivity": "PII", + "CageSecurity": "High", + "Simplicity": "complex" + } + } + } + HsmCluster: + description: Dedicated KMS-HSM Cluster Management + properties: + compartmentId: + description: The OCID of the compartment that contains this HSMCluster resource. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only the string type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + A user-friendly display name for the HSMCluster resource. It does not have to be unique, and it is changeable. + Avoid entering confidential information. + maxLength: 100 + minLength: 1 + type: string + dnsName: + description: DNS name for the HSM Cluster -- this will contain information about the region as well. + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the HSMCluster resource. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: | + The HSMCluster's current state. + + Example: `ACTIVE` + enum: + - CREATING + - INITIALIZATION_REQUIRED + - INITIALIZING + - ACTIVATION_REQUIRED + - ACTIVATING + - ACTIVE + - DELETING + - DELETED + - PENDING_DELETION + - SCHEDULING_DELETION + - CANCELLING_DELETION + type: string + timeCreated: + description: | + The date and time this HSM resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + + Example: `2023-04-03T21:10:29.600Z` + format: date-time + type: string + timeOfDeletion: + description: | + An optional property indicating when to delete the key, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time this HSM resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + + Example: `2023-04-03T21:10:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - displayName + - timeCreated + - timeUpdated + - lifecycleState + - dnsName + type: object + x-example: | + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wee6cvbxq4iusld5ltpneskcfy7lr4a6wfauxuwrwed5b3xea", + "definedTags": { }, + "displayName": "Hsm 1", + "freeformTags": { }, + "id": "ocid1.hsm.oc1.iad.examplevaaeuk.examplehhv5i3qbkp22g3cvbjqy7c7sqlywv25eajvnvcfauxpdgga6gct4a", + "lifecycleState": "ACTIVE", + "timeCreated": "2023-04-03T20:35:12.023Z", + "timeOfDeletion": "2023-04-03T20:35:12.023Z", + "dnsName": "https://exampleaaacu2-hsmcluster.kms.us-ashburn-1.oraclecloud.com" + } + UpdateHsmClusterDetails: + description: The details of the HsmCluster resource that you wish to update. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only the string type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + A user-friendly name for the HSM resource. It does not have to be unique, and it is changeable. + Avoid entering confidential information. + maxLength: 100 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + type: object + x-example: | + { + "displayName": "Hsm 1", + "freeformTags": {"Department": "Finance"}, + "definedTags": + { + "MyFirstNamespace": + { + "CostCenter": "SmartAlec", + "Project": "42", + "CreatedBy": "SmartAlec", + "CreatedDate": "9/21/2023T14:00" + }, + "Audit": + { + "DataSensitivity": "PII", + "CageSecurity": "High", + "Simplicity": "complex" + } + } + } + ChangeHsmClusterCompartmentDetails: + description: The details of the compartment you wish to move the hsm cluster to. + properties: + compartmentId: + description: The [OCID] of the compartment to move the hsm cluster to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + x-example: | + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5lsdneskcfy7lr4a6wfauxuwrwed5b3xea", + } + ScheduleHsmClusterDeletionDetails: + description: Details for scheduling HSM resource deletion. + properties: + timeOfDeletion: + description: | + An optional property indicating when to delete the HsmCluster resource, expressed in + [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. The specified + time must be between 7 and 30 days from the time when the request is received. + If this property is missing, it will be set to 30 days from the time of the request + by default. + format: date-time + type: string + type: object + x-example: | + { + "timeOfDeletion": "2023-04-03T21:10:29.600Z" + } + UploadPartitionCertificatesDetails: + description: An object that encapsulates the necessary partition certificates. + properties: + partitionCertificate: + description: Base64 encoded (StandardCharsets.UTF_8) Partition Certificate, which gets created when the CSR is signed. + maxLength: 5000 + type: string + partitionOwnerCertificate: + description: Base64 encoded (StandardCharsets.UTF_8) Partition Owner Certificate, which is used to help sign the CSR. + maxLength: 5000 + type: string + required: + - partitionCertificate + - partitionOwnerCertificate + type: object + HsmPartitionCollection: + description: HsmPartitionCollection object with page of HsmPartitionSummary objects. A HsmPartitionSummary object contains details about the corresponding HSM. + properties: + items: + description: List of HsmPartitionSummaries. + items: + $ref: '#/components/schemas/HsmPartitionSummary' + type: array + required: + - items + type: object + HsmPartition: + description: Dedicated KMS-HSM Partition Management + properties: + compartmentId: + description: The OCID of the compartment that contains a particular HSM resource. + maxLength: 255 + minLength: 1 + type: string + id: + description: The OCID of the HSM resource. Each HSM resource has a unique OCID as an identifier. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: | + A HSMCluster resource's current lifecycle state. + + Example: `ACTIVE` + enum: + - ACTIVE + - INACTIVE + - ACTIVATING + - ACTIVATION_REQUIRED + - SCHEDULING_DELETION + - PENDING_DELETION + - DELETING + - DELETED + type: string + portInformation: + description: Details of a single portInformation item include the PortNumber (an integer used as an identifier) and the PortType (refers to either an enum value of Managementutility,Clientutility, or null) + items: + $ref: '#/components/schemas/PortInformation' + type: array + timeCreated: + description: | + The date and time a HSMPartition was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + + Example: `2018-04-03T21:10:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time a HSMPartition was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + + Example: `2018-04-03T21:10:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - portInformation + - timeCreated + - timeUpdated + - lifecycleState + type: object + PreCoUserCredentials: + description: Pre Crypto officer user credentials. + properties: + password: + description: The base 64 encoded pre crypto officer password. + maxLength: 32 + minLength: 8 + type: string + username: + description: The pre crypto officer username, which should be chosen as a non confidential string. + maxLength: 255 + minLength: 1 + type: string + required: + - username + - password + type: object + KeySummary: + description: The details of the Key. + properties: + algorithm: + description: The algorithm used by a key's key versions to encrypt or decrypt data. + enum: + - AES + - RSA + - ECDSA + type: string + compartmentId: + description: The OCID of the compartment that contains the key. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only the string type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + A user-friendly name for the key. It does not have to be unique, and it is changeable. + Avoid entering confidential information. + maxLength: 100 + minLength: 1 + type: string + externalKeyReferenceDetails: + $ref: '#/components/schemas/ExternalKeyReferenceDetails' + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the key. + maxLength: 255 + minLength: 1 + type: string + isAutoRotationEnabled: + description: A parameter specifying whether the auto key rotation is enabled or not. + type: boolean + lifecycleState: + description: | + The key's current lifecycle state. + + Example: `ENABLED` + enum: + - CREATING + - ENABLING + - ENABLED + - DISABLING + - DISABLED + - DELETING + - DELETED + - PENDING_DELETION + - SCHEDULING_DELETION + - CANCELLING_DELETION + - UPDATING + - BACKUP_IN_PROGRESS + - RESTORING + type: string + protectionMode: + description: | + The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. + A protection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside + the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's RSA wrapping key which persists + on the HSM. All cryptographic operations that use a key with a protection mode of `SOFTWARE` are performed on the server. By default, + a key's protection mode is set to `HSM`. You can't change a key's protection mode after the key is created or imported. + A protection mode of `EXTERNAL` mean that the key persists on the customer's external key manager which is hosted externally outside of oracle. + Oracle only hold a reference to that key. + All cryptographic operations that use a key with a protection mode of `EXTERNAL` are performed by external key manager. + enum: + - HSM + - SOFTWARE + - EXTERNAL + type: string + timeCreated: + description: | + The date and time the key was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + + Example: `2018-04-03T21:10:29.600Z` + format: date-time + type: string + vaultId: + description: The OCID of the vault that contains the key. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - displayName + - timeCreated + - lifecycleState + - vaultId + type: object + x-example: | + [ + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5ltpneskcfy7lr4a6wfauxuwrhhd5b3xea", + "definedTags": { }, + "displayName": "Key A", + "freeformTags": { }, + "id": "ocid1.key.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23kueidhj4q2c6qfauxm32ikk7yu5a", + "lifecycleState": "ENABLED", + "timeCreated": "2018-04-03T17:16:01.509Z", + "protectionMode": "HSM", + "vaultId": "ocid1.vault.oc1.iad.examplevaaeuk.examplettv5i3qbkp22g3cvbjqy7c7sqlywv25eajvnvcfauxpdgga6gct4a" + "externalKeyReferenceDetails": { + "externalKeyId": "ce01d0adc75b43be88ed404056fd43ba0489321993534d66bf0f925dd5b95147", + "externalKeyVersionId": "d1e1d0adc75b43te88ed4f4056f443ba0489321963534d66bfhf925dd5a95148" + } + "isAutoRotationEnabled" : true + }, + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5ltpneskcffflr4a6wfauxuwrwed5b3xea", + "definedTags": { }, + "displayName": "Key B", + "freeformTags": { }, + "id": "ocid1.key.oc1.iad.examplefaafqw.examplesstlnmdng4b4elwodcvbbbms57hmyazfeay25faux32oxw4c7zlsa", + "lifecycleState": "ENABLED", + "timeCreated": "2018-04-03T20:36:49.818Z", + "protectionMode": "HSM", + "vaultId": "ocid1.vault.oc1.iad.examplevaaeuk.examplettv5i3qbkp22g3cvbjqy7c7sqlywv25eajvnvcfauxpdgga6gct4a" + "externalKeyReferenceDetails": { + "externalKeyId": "ce01d0adc75b43be88ed404056fd43ba0489321993534d66bf0f925dd5b95147", + "externalKeyVersionId": "d1e1d0adc75b43te88ed4f4056f443ba0489321963534d66bfhf925dd5a95148" + } + "isAutoRotationEnabled" : true + } + ] + CreateKeyDetails: + description: The details of the key that you want to create. + properties: + autoKeyRotationDetails: + $ref: '#/components/schemas/AutoKeyRotationDetails' + compartmentId: + description: The OCID of the compartment where you want to create the master encryption key. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only the string type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + A user-friendly name for the key. It does not have to be unique, and it is changeable. + Avoid entering confidential information. + maxLength: 100 + minLength: 1 + type: string + externalKeyReference: + $ref: '#/components/schemas/ExternalKeyReference' + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + isAutoRotationEnabled: + description: A parameter specifying whether the auto key rotation is enabled or not. + type: boolean + keyShape: + $ref: '#/components/schemas/KeyShape' + protectionMode: + description: | + The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. + A protection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside + the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's RSA wrapping key which persists + on the HSM. All cryptographic operations that use a key with a protection mode of `SOFTWARE` are performed on the server. By default, + a key's protection mode is set to `HSM`. You can't change a key's protection mode after the key is created or imported. + A protection mode of `EXTERNAL` mean that the key persists on the customer's external key manager which is hosted externally outside of oracle. + Oracle only hold a reference to that key. + All cryptographic operations that use a key with a protection mode of `EXTERNAL` are performed by external key manager. + enum: + - HSM + - SOFTWARE + - EXTERNAL + type: string + required: + - compartmentId + - displayName + - keyShape + type: object + x-example: | + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5ltpneskcfy7lr4yywfauxuwrwed5b3xea", + "displayName": "Key C", + "keyShape": { + "algorithm": "AES", + "length": 16 + }, + "freeformTags": {"Department": "Finance"}, + "protectionMode": "HSM", + "isAutoRotationEnabled" : true, + "autoKeyRotationDetails": { + "rotationIntervalInDays": "60", + "timeOfScheduleStart": "2023-04-04T00:00:00Z", + } + "definedTags": + { + "MyFirstNamespace": + { + "CostCenter": "SmartAlec", + "Project": "42", + "CreatedBy": "SmartAlec", + "CreatedDate": "9/21/2017T14:00" + }, + "Audit": + { + "DataSensitivity": "PII", + "CageSecurity": "High", + "Simplicity": "complex" + } + } + "externalKeyReference": + { + "externalKeyId": "ce01d0adc75b43be88ed404056fd43ba0489321993534d66bf0f925dd5b95147" + } + } + Key: + description: The logical entities that represent one or more key versions, each of which contains cryptographic material. + properties: + autoKeyRotationDetails: + $ref: '#/components/schemas/AutoKeyRotationDetails' + compartmentId: + description: The OCID of the compartment that contains this master encryption key. + maxLength: 255 + minLength: 1 + type: string + currentKeyVersion: + description: | + The OCID of the key version used in cryptographic operations. During key rotation, the service might be + in a transitional state where this or a newer key version are used intermittently. The `currentKeyVersion` + property is updated when the service is guaranteed to use the new key version for all subsequent encryption operations. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only the string type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + A user-friendly name for the key. It does not have to be unique, and it is changeable. + Avoid entering confidential information. + maxLength: 100 + minLength: 1 + type: string + externalKeyReferenceDetails: + $ref: '#/components/schemas/ExternalKeyReferenceDetails' + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the key. + maxLength: 255 + minLength: 1 + type: string + isAutoRotationEnabled: + description: A parameter specifying whether the auto key rotation is enabled or not. + type: boolean + isPrimary: + description: A Boolean value that indicates whether the Key belongs to primary Vault or replica vault. + type: boolean + keyShape: + $ref: '#/components/schemas/KeyShape' + lifecycleState: + description: | + The key's current lifecycle state. + + Example: `ENABLED` + enum: + - CREATING + - ENABLING + - ENABLED + - DISABLING + - DISABLED + - DELETING + - DELETED + - PENDING_DELETION + - SCHEDULING_DELETION + - CANCELLING_DELETION + - UPDATING + - BACKUP_IN_PROGRESS + - RESTORING + type: string + protectionMode: + description: | + The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. + A protection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside + the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's RSA wrapping key which persists + on the HSM. All cryptographic operations that use a key with a protection mode of `SOFTWARE` are performed on the server. By default, + a key's protection mode is set to `HSM`. You can't change a key's protection mode after the key is created or imported. + A protection mode of `EXTERNAL` mean that the key persists on the customer's external key manager which is hosted externally outside of oracle. + Oracle only hold a reference to that key. + All cryptographic operations that use a key with a protection mode of `EXTERNAL` are performed by external key manager. + enum: + - HSM + - SOFTWARE + - EXTERNAL + type: string + replicaDetails: + $ref: '#/components/schemas/KeyReplicaDetails' + restoredFromKeyId: + description: The OCID of the key from which this key was restored. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the key was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + + Example: `2018-04-03T21:10:29.600Z` + format: date-time + type: string + timeOfDeletion: + description: | + An optional property indicating when to delete the key, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + vaultId: + description: The OCID of the vault that contains this key. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - displayName + - timeCreated + - lifecycleState + - vaultId + - keyShape + - currentKeyVersion + type: object + x-example: | + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5ltpneskcfy7lr4a6wfauxuwrwed5b3xea", + "currentKeyVersion": "ocid1.keyversion.oc1.iad.exampledaaeug.examplevriiaa.examples4h2bocax3damnsxw4cvbbndged2gftlho4ufxwa4faux2eiqwija", + "definedTags": { }, + "displayName": "Key C", + "freeformTags": { }, + "id": "ocid1.key.oc1.iad.examplefaafqw.exampletn3m2p4cvb6nv7oer2p3nliijfw4qyuguvmrfauxr622ife7urnqa", + "keyShape": { + "algorithm": "AES", + "length": 16 + }, + "lifecycleState": "CREATING", + "protectionMode": "HSM", + "timeCreated": "2018-04-04T00:33:59.874Z", + "timeOfDeletion": "2018-04-03T20:35:12.023Z", + "vaultId": "ocid1.vault.oc1.iad.examplevaaeuk.examplettv5i3qbkp22g3cvbjqy7c7sqlywv25eajvnvcfauxpdgga6gct4a", + "restoredFromKeyId": "ocid1.key.oc1.iad.examplefaafqw.exampletn3m2p4cvb6nv7oer2p3nliijfw4qyuguvmrfauxr622ife7urnta" + "replicaDetails": {"replicationId" : "12345abc"} + "isPrimary": true + "isAutoRotationEnabled" : true, + "autoKeyRotationDetails": { + "rotationIntervalInDays": "60", + "timeOfScheduleStart": "2023-04-04T00:00:00Z" + "timeOfNextRotation": "2023-06-04T00:00:00Z", + "timeOfLastRotation": "2023-02-04T00:00:00Z", + "lastRotationStatus": "SUCCESS", + "lastRotationMessage": "Rotation Completed" + } + "externalKeyReferenceDetails": { + "externalKeyId": "ce01d0adc75b43be88ed404056fd43ba0489321993534d66bf0f925dd5b95147", + "externalKeyVersionId": "d1e1d0adc75b43te88ed4f4056f443ba0489321963534d66bfhf925dd5a95148" + } + } + RestoreKeyFromObjectStoreDetails: + description: The details of the backup location from which you want to restore the Key. + properties: + backupLocation: + $ref: '#/components/schemas/BackupLocation' + type: object + x-example: | + { + "backupLocation" : { + "BackupLocationURI" : { + "uri" : "http://n/namespace/b/bucket/o/object" + } + }, + } + ImportKeyDetails: + description: The details of the Key that you wish to import. + properties: + autoKeyRotationDetails: + $ref: '#/components/schemas/AutoKeyRotationDetails' + compartmentId: + description: The OCID of the compartment that contains this key. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only string, integer, and Boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing predefined tag keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{"foo-namespace": {"bar-key": "foo-value"}}` + type: object + displayName: + description: | + A user-friendly name for the key. It does not have to be unique, and it is changeable. + Avoid entering confidential information. + maxLength: 100 + minLength: 1 + type: string + freeformTags: + additionalProperties: + type: string + description: | + Simple key-value pair that is applied without any predefined name, type, or scope. + Exists for cross-compatibility only. + Example: `{"bar-key": "value"}` + type: object + isAutoRotationEnabled: + description: A parameter specifying whether the auto key rotation is enabled or not. + type: boolean + keyShape: + $ref: '#/components/schemas/KeyShape' + protectionMode: + default: HSM + description: | + The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. + A protection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside + the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's RSA wrapping key which persists + on the HSM. All cryptographic operations that use a key with a protection mode of `SOFTWARE` are performed on the server. By default, + a key's protection mode is set to `HSM`. You can't change a key's protection mode after the key is created or imported. + enum: + - HSM + - SOFTWARE + type: string + wrappedImportKey: + $ref: '#/components/schemas/WrappedImportKey' + required: + - compartmentId + - displayName + - wrappedImportKey + - keyShape + type: object + x-example: | + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5ltpneskcfy7lr4yywfauxuwrwed5b3xea", + "displayName": "Key C", + "keyShape": { + "algorithm": "AES", + "length": 16 + }, + "wrappedImportKey": { + "wrappingAlgorithm": "RSA_OAEP_SHA256", + "keyMaterial": "089d08927390280802d0987c09e7798h09f879870909c098709a709870970987b09709870c987098d70e==" + }, + "protectionMode": "HSM", + "isAutoRotationEnabled" : true, + "autoKeyRotationDetails": { + "rotationIntervalInDays": "60", + "timeOfScheduleStart": "2023-04-04T00:00:00Z", + } + "freeformTags": {"Department": "Finance"}, + "definedTags": + { + "MyFirstNamespace": + { + "CostCenter": "SmartAlec", + "Project": "42" + }, + "Audit": + { + "DataSensitivity": "PII", + "CageSecurity": "High", + "Simplicity": "complex" + } + } + } + UpdateKeyDetails: + description: The details of the Key that you wish to update. + properties: + autoKeyRotationDetails: + $ref: '#/components/schemas/AutoKeyRotationDetails' + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only the string type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + A user-friendly name for the key. It does not have to be unique, and it is changeable. + Avoid entering confidential information. + maxLength: 100 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + isAutoRotationEnabled: + description: A parameter specifying whether the auto key rotation is enabled or not. + type: boolean + type: object + x-example: | + { + "displayName": "Key CC", + "freeformTags": {"Department": "Finance"}, + "definedTags": + { + "MyFirstNamespace": + { + "CostCenter": "SmartAlec", + "Project": "42", + "CreatedBy": "SmartAlec", + "CreatedDate": "9/21/2017T14:00" + }, + "Audit": + { + "DataSensitivity": "PII", + "CageSecurity": "High", + "Simplicity": "complex" + } + } + "isAutoRotationEnabled" : true, + "autoKeyRotationDetails": { + "rotationIntervalInDays": "60", + "timeOfScheduleStart": "2023-04-04T00:00:00Z", + } + } + BackupKeyDetails: + description: The details of the Key that you wish to backup. + properties: + backupLocation: + $ref: '#/components/schemas/BackupLocation' + type: object + x-example: | + { + "backupLocation" : { + "BackupLocationURI" : { + "uri" : "http://n/namespace/b/bucket/o/object" + } + } + } + ChangeKeyCompartmentDetails: + description: The deatils of the compartment that you wish to move the Key. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that you want to move the key to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + x-example: | + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5lsdneskcfy7lr4a6wfauxuwrwed5b3xea", + } + ScheduleKeyDeletionDetails: + description: Details for scheduling key deletion. + properties: + timeOfDeletion: + description: | + An optional property to indicate when to delete the vault, expressed in + [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. The specified + time must be between 7 and 30 days from when the request is received. + If this property is missing, it will be set to 30 days from the time of the request + by default. + format: date-time + type: string + type: object + x-example: | + { + "timeOfDeletion": "2019-04-03T21:10:29.600Z" + } + KeyVersionSummary: + description: The details of the KeyVersion. + properties: + compartmentId: + description: The OCID of the compartment that contains this key version. + maxLength: 255 + minLength: 1 + type: string + externalKeyReferenceDetails: + $ref: '#/components/schemas/ExternalKeyReferenceDetails' + id: + description: The OCID of the key version. + maxLength: 255 + minLength: 1 + type: string + isAutoRotated: + description: An optional property indicating whether this keyversion is generated from auto rotatation. + type: boolean + keyId: + description: The OCID of the master encryption key associated with this key version. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: | + The key version's current lifecycle state. + + Example: `ENABLED` + enum: + - CREATING + - ENABLING + - ENABLED + - DISABLING + - DISABLED + - DELETING + - DELETED + - PENDING_DELETION + - SCHEDULING_DELETION + - CANCELLING_DELETION + type: string + origin: + description: The source of the key material. When this value is INTERNAL, Key Management created the key material. When this value is EXTERNAL, the key material was imported from an external source. + enum: + - INTERNAL + - EXTERNAL + type: string + timeCreated: + description: | + The date and time this key version was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + + Example: `2018-04-03T21:10:29.600Z` + format: date-time + type: string + timeOfDeletion: + description: | + An optional property to indicate when to delete the key version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + vaultId: + description: The OCID of the vault that contains this key version. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - timeCreated + - vaultId + - keyId + - origin + type: object + x-example: | + [ + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5ltpneskcfy7lsda6wfauxuwrwed5b3xea", + "id": "ocid1.keyversion.oc1.iad.exampledaaeug.examplevriiaa.examples4h2bocax3dfgdnsxw4ceocvbged2gftlho4ufxwa4faux2eiqwija", + "keyId": "ocid1.key.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23kueityj4q2c6qfauxm32i577yu5a", + "timeCreated": "2018-04-04T18:52:47.405Z", + "origin": "INTERNAL", + "vaultId": "ocid1.vault.oc1.iad.examplevaaeuk.examplettv5i3qbkp22g3cvbjqy7c7welywv25eajvnvcfauxpdgga6gct4a" + "lifecycleState": "CREATING", + "timeOfDeletion": "2018-04-03T20:35:12.023Z" + "externalKeyReferenceDetails":{ + "externalKeyId": "ce01d0adc75b43be88ed404056fd43ba0489321993534d66bf0f925dd5b95147", + "externalKeyVersionId": "d1e1d0adc75b43te88ed4f4056f443ba0489321963534d66bfhf925dd5a95148" + } + "isAutoRotated" : true + }, + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5ltpnesktyy7lr4a6wfauxuwrwed5b3xea", + "id": "ocid1.keyversion.oc1.iad.exampledaaeug.examplevriiaa.examples4h2bocax3damnsxw4ceocvbged2gftlho4ufxwa4faux2eiqwija", + "keyId": "ocid1.key.oc1.iad.exampledaaeug.examplestkvmyudnbickxcvbotxd5q23kueidhj4q2c6qfauxm32i577yu5a", + "timeCreated": "2018-04-03T17:16:01.509Z", + "origin": "INTERNAL", + "vaultId": "ocid1.vault.oc1.iad.examplevaaeuk.examplettv5i3qjkp22g3cvbjqy7c7sqlywv25eajvnvcfauxpdgga6gct4a" + "lifecycleState": "CREATING", + "timeOfDeletion": null, + "externalKeyReferenceDetails": { + "externalKeyId": "ce01d0adc75b43be88ed404056fd43ba0489321993534d66bf0f925dd5b95147", + "externalKeyVersionId": "d1e1d0adc75b43te88ed4f4056f443ba0489321963534d66bfhf925dd5a95148" + } + "isAutoRotated" : true + } + ] + ExternalKeyVersionReference: + description: A reference to key version on external key manager. + properties: + externalKeyVersionId: + description: Key version ID associated with the external key. + maxLength: 255 + minLength: 1 + type: string + type: object + KeyVersion: + description: The details of the KeyVersion associated with the Key. + properties: + compartmentId: + description: The OCID of the compartment that contains this key version. + maxLength: 255 + minLength: 1 + type: string + externalKeyReferenceDetails: + $ref: '#/components/schemas/ExternalKeyReferenceDetails' + id: + description: The OCID of the key version. + maxLength: 255 + minLength: 1 + type: string + isAutoRotated: + description: A Boolean Value indicating whether this keyversion is generated from auto rotation of key + type: boolean + isPrimary: + description: A Boolean value that indicates whether the KeyVersion belongs to primary Vault or replica Vault. + type: boolean + keyId: + description: The OCID of the key associated with this key version. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: | + The key version's current lifecycle state. + + Example: `ENABLED` + enum: + - CREATING + - ENABLING + - ENABLED + - DISABLING + - DISABLED + - DELETING + - DELETED + - PENDING_DELETION + - SCHEDULING_DELETION + - CANCELLING_DELETION + type: string + origin: + description: | + The source of the key material. When this value is `INTERNAL`, Key Management + created the key material. When this value is `EXTERNAL`, the key material + was imported from an external source. + enum: + - INTERNAL + - EXTERNAL + type: string + publicKey: + description: | + The public key in PEM format. (This value pertains only to RSA and ECDSA keys.) + type: string + replicaDetails: + $ref: '#/components/schemas/KeyVersionReplicaDetails' + restoredFromKeyVersionId: + description: The OCID of the key version from which this key version was restored. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time this key version was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + + Example: "2018-04-03T21:10:29.600Z" + format: date-time + type: string + timeOfDeletion: + description: | + An optional property indicating when to delete the key version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + vaultId: + description: The OCID of the vault that contains this key version. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - timeCreated + - vaultId + - keyId + type: object + x-example: | + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5ltpneskcffflr4a6wfauxuwrwed5b3xea", + "id": "ocid1.keyversion.oc1.iad.exampledaaeug.examplevriiaa.examples4h2bocax3dfgdnsxw4ceocvbged2gftlho4ufxwa4faux2eiqwija", + "keyId": "ocid1.key.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23kueityj4q2c6qfauxm32i577yu5a", + "timeCreated": "2018-04-04T18:52:47.405Z", + "vaultId": "ocid1.vault.oc1.iad.examplevaaeuk.examplettv5i3qbkp22g3cvbjqy7c7welywv25eajvnvcfauxpdgga6gct4a" + "lifecycleState": "CREATING", + "timeOfDeletion": "2018-04-03T20:35:12.023Z", + "restoredFromKeyVersionId": "ocid1.keyversion.oc1.iad.examplefaafqw.exampletn3m2p4cvb6nv7oer2p3nliijfw4qyuguvmrfauxr622ife7urnta" + "origin": "INTERNAL" + "replicaDetails": {"replicationId" : "12345abc"} + "isPrimary": true + "externalKeyReferenceDetails":{ + "externalKeyId": "ce01d0adc75b43be88ed404056fd43ba0489321993534d66bf0f925dd5b95147", + "externalKeyVersionId": "d1e1d0adc75b43te88ed4f4056f443ba0489321963534d66bfhf925dd5a95148" + } + "isAutoRotated" : true + } + ImportKeyVersionDetails: + description: The details of the KeyVersion that you wish to import. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only string, integer, and Boolean types are supported. + (opaque JSON object) + type: string + 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](/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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + wrappedImportKey: + $ref: '#/components/schemas/WrappedImportKey' + required: + - wrappedImportKey + type: object + x-example: | + { + "wrappedImportKey": { + "wrappingAlgorithm": "RSA_OAEP_SHA256", + "keyMaterial": "089d08927390280802d0987c09e7798h09f879870909c098709a709870970987b09709870c987098d70e==" + } + } + ScheduleKeyVersionDeletionDetails: + description: Details for scheduling key version deletion. + properties: + timeOfDeletion: + description: | + An optional property to indicate when to delete the key version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) + timestamp format. The specified time must be between 7 and 30 days from the time + when the request is received. If this property is missing, it will be set to 30 days from the time of the request by default. + format: date-time + type: string + type: object + x-example: | + { + "timeOfDeletion": "2019-04-03T21:10:29.600Z" + } + ReplicationStatusDetails: + description: Details of replication status across all replica regions + properties: + replicaDetails: + description: Replica Details. + items: + $ref: '#/components/schemas/ReplicaDetails' + type: array + type: object + SignDataDetails: + description: The details of the message that you want to sign. + properties: + keyId: + description: The OCID of the key used to sign the message. + maxLength: 255 + minLength: 1 + type: string + keyVersionId: + description: The OCID of the key version used to sign the message. + maxLength: 255 + minLength: 1 + type: string + loggingContext: + additionalProperties: + type: string + description: | + Information that can be used to provide context for audit logging. It is a map that contains any additional + data that you provide to include with audit logs, if audit logging is enabled. + type: object + message: + description: The base64-encoded binary data object denoting the message or message digest to sign. You can have a message up to 4096 bytes in size. To sign a larger message, provide the message digest. + maxLength: 4096 + minLength: 1 + type: string + messageType: + default: RAW + description: | + Denotes whether the value of the message parameter is a raw message or a message digest. + The default value, `RAW`, indicates a message. To indicate a message digest, use `DIGEST`. + enum: + - RAW + - DIGEST + type: string + signingAlgorithm: + description: | + The algorithm to use to sign the message or message digest. + For RSA keys, supported signature schemes include PKCS #1 and RSASSA-PSS, along with + different hashing algorithms. + For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. + When you pass a message digest for signing, ensure that you specify the same hashing algorithm + as used when creating the message digest. + enum: + - SHA_224_RSA_PKCS_PSS + - SHA_256_RSA_PKCS_PSS + - SHA_384_RSA_PKCS_PSS + - SHA_512_RSA_PKCS_PSS + - SHA_224_RSA_PKCS1_V1_5 + - SHA_256_RSA_PKCS1_V1_5 + - SHA_384_RSA_PKCS1_V1_5 + - SHA_512_RSA_PKCS1_V1_5 + - ECDSA_SHA_256 + - ECDSA_SHA_384 + - ECDSA_SHA_512 + type: string + required: + - message + - keyId + - signingAlgorithm + type: object + SignedData: + description: The response to a request to sign the message. + properties: + keyId: + description: The OCID of the key used to sign the message. + maxLength: 255 + minLength: 1 + type: string + keyVersionId: + description: The OCID of the key version used to sign the message. + maxLength: 255 + minLength: 1 + type: string + signature: + description: | + The base64-encoded binary data object denoting the cryptographic signature generated for the message or message digest. + type: string + signingAlgorithm: + description: | + The algorithm to use to sign the message or message digest. + For RSA keys, supported signature schemes include PKCS #1 and RSASSA-PSS, along with + different hashing algorithms. + For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. + When you pass a message digest for signing, ensure that you specify the same hashing algorithm + as used when creating the message digest. + enum: + - SHA_224_RSA_PKCS_PSS + - SHA_256_RSA_PKCS_PSS + - SHA_384_RSA_PKCS_PSS + - SHA_512_RSA_PKCS_PSS + - SHA_224_RSA_PKCS1_V1_5 + - SHA_256_RSA_PKCS1_V1_5 + - SHA_384_RSA_PKCS1_V1_5 + - SHA_512_RSA_PKCS1_V1_5 + - ECDSA_SHA_256 + - ECDSA_SHA_384 + - ECDSA_SHA_512 + type: string + required: + - keyId + - keyVersionId + - signature + - signingAlgorithm + type: object + x-example: | + { + "keyId": "ocid1.key.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23tteidhj4q2c6qfauxm32i577yu5a", + "keyVersionId": "ocid1.keyversion.oc1.iad.exampledaaeug.xd5q23tteidhj4q2c6qfauxm32i577yuamplestkvmbjdnbickxasfaf", + "signature": "", + "signingAlgorithm": "SHA256_RSA_PKCS_PSS" + } + VaultSummary: + description: The details of the Vault. + properties: + compartmentId: + description: The OCID of the compartment that contains a particular vault. + maxLength: 255 + minLength: 1 + type: string + cryptoEndpoint: + description: | + The service endpoint to perform cryptographic operations against. Cryptographic operations include + [Encrypt](/api/#/en/key/latest/EncryptedData/Encrypt), [Decrypt](/api/#/en/key/latest/DecryptedData/Decrypt), + and [GenerateDataEncryptionKey](/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey) operations. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only the string type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + A user-friendly name for a vault. It does not have to be unique, and it is changeable. + Avoid entering confidential information. + maxLength: 100 + minLength: 1 + type: string + externalKeyManagerMetadataSummary: + $ref: '#/components/schemas/ExternalKeyManagerMetadataSummary' + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of a vault. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: | + A vault's current lifecycle state. + + Example: `ACTIVE` + enum: + - CREATING + - ACTIVE + - DELETING + - DELETED + - PENDING_DELETION + - SCHEDULING_DELETION + - CANCELLING_DELETION + - UPDATING + - BACKUP_IN_PROGRESS + - RESTORING + type: string + managementEndpoint: + description: | + The service endpoint to perform management operations against. Management operations include "Create," "Update," "List," "Get," and "Delete" operations. + type: string + timeCreated: + description: | + The date and time a vault was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + + Example: `2018-04-03T21:10:29.600Z` + format: date-time + type: string + vaultType: + description: | + The type of vault. Each type of vault stores keys with different + degrees of isolation and has different options and pricing. + enum: + - VIRTUAL_PRIVATE + - EXTERNAL + - DEFAULT + type: string + required: + - id + - compartmentId + - displayName + - timeCreated + - lifecycleState + - vaultType + - cryptoEndpoint + - managementEndpoint + type: object + x-example: | + [ + { + "compartmentId": "ocid1.tenancy.oc1..examplerti4wjo6cvbxq4iusld5ltpneskcfy7lr4a6wfauxuwrwed5b3xea", + "cryptoEndpoint": "https://exampleaaacu2-crypto.kms.us-ashburn-1.oraclecloud.com/", + "definedTags": { }, + "displayName": "Vault 1", + "freeformTags": { }, + "id": "ocid1.vault.oc1.iad.examplevaaeuk.examplettv5i3qbkp22g3cvbnqy7c7sqlywv25eajvnvcfauxpdgga6gct4a", + "lifecycleState": "ACTIVE", + "managementEndpoint": "https://exampleaaacu2-management.kms.us-ashburn-1.oraclecloud.com", + "timeCreated": "2018-04-03T20:35:12.023Z", + "vaultType": "VIRTUAL_PRIVATE", + "externalKeyManagerMetadataSummary": { + "oauthMetadataSummary": { + "idcsAccountNameUrl": "https://idcs-fb7a45fc4569481f88d675e213272f77.identity.r1labiad1.c9dev1.oc9qadev.com:443", + "clientAppId": "2a2007581ad04d7293791457a3989d38" + }, + "externalVaultEndpointUrl": "https://21.1.5.10/api/v1/cckm/oci/external-vaults/37900289-47cf-4172-91c5-7ea6cb87c4b7", + "privateEndpointId": "ocid1.privateendpoint.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23tteidhj4q2c6qfauxm32i577yu5a" + } + }, + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5lggneskcfy7lr4a6wfauxuwrwed5b3xea", + "cryptoEndpoint": "https://examplecaacu2-crypto.kms.us-ashburn-1.oraclecloud.com", + "definedTags": { }, + "displayName": "Vault 0", + "freeformTags": { }, + "id": "ocid1.vault.oc1.iad.examplevaaeuk.examplettv5i3qbkp22g3cvb123jqy7c7sqlywv25eajvnvcfauxpdgga6gct4a", + "lifecycleState": "ACTIVE", + "managementEndpoint": "https://examplecaacu2-management.kms.us-ashburn-1.oraclecloud.com", + "timeCreated": "2018-04-03T18:20:50.352Z", + "vaultType": "VIRTUAL_PRIVATE" + "externalKeyManagerMetadata": { + "oauthMetadata": { + "idcsAccountNameUrl": "https://idcs-fb7a45fc4569481f88d675e213272f77.identity.r1labiad1.c9dev1.oc9qadev.com:443", + "clientAppId": "2a2007581ad04d7293791457a3989d38" + }, + "externalVaultEndpointUrl": "https://21.1.5.10/api/v1/cckm/oci/external-vaults/37900289-47cf-4172-91c5-7ea6cb87c4b7", + "privateEndpointId": "ocid1.privateendpoint.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23tteidhj4q2c6qfauxm32i577yu5a" + } + } + ] + CreateVaultDetails: + description: The details of the vault that you want to create. + properties: + compartmentId: + description: The OCID of the compartment where you want to create this vault. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only the string type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + A user-friendly name for the vault. It does not have to be unique, and it is changeable. + Avoid entering confidential information. + maxLength: 100 + minLength: 1 + type: string + externalKeyManagerMetadata: + $ref: '#/components/schemas/ExternalKeyManagerMetadata' + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + vaultType: + description: | + The type of vault to create. Each type of vault stores the key with different degrees of isolation and has different options and pricing. + enum: + - VIRTUAL_PRIVATE + - DEFAULT + - EXTERNAL + type: string + required: + - compartmentId + - displayName + - vaultType + type: object + x-example: | + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5ltpneskcfy7lr4auufauxuwrwed5b3xea", + "displayName": "Vault 1", + "vaultType": "VIRTUAL_PRIVATE", + "freeformTags": {"Department": "Finance"}, + "definedTags": + { + "MyFirstNamespace": + { + "CostCenter": "SmartAlec", + "Project": "42", + "CreatedBy": "SmartAlec", + "CreatedDate": "9/21/2017T14:00" + }, + "Audit": + { + "DataSensitivity": "PII", + "CageSecurity": "High", + "Simplicity": "complex" + } + } + "externalKeyManagerMetadata": { + "oauthMetadata":{ + "idcsAccountNameUrl": "https://idcs-fb7a45fc4569481f88d675e213272f77.identity.r1labiad1.c9dev1.oc9qadev.com:443", + "clientAppId": "6b50726c6c2b5118a1c56f4246878417", + "clientAppSecret": "7945ea13-d387-443a-ba67-66dc06a08923" + }, + "externalVaultEndpointUrl": "https://localhost/api/v1/cckm/oci/external-vaults/37900289-47cf-4172-91c5-7ea6cb87c4b7", + "privateEndpointId": "ocid1.privateendpoint.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23tteidhj4q2c6qfauxm32i577yu5a" + } + } + Vault: + description: The logical entity where the Vault service creates and durably stores keys. + properties: + compartmentId: + description: The OCID of the compartment that contains this vault. + maxLength: 255 + minLength: 1 + type: string + cryptoEndpoint: + description: | + The service endpoint to perform cryptographic operations against. Cryptographic operations include + [Encrypt](/api/#/en/key/latest/EncryptedData/Encrypt), [Decrypt](/api/#/en/key/latest/DecryptedData/Decrypt), + and [GenerateDataEncryptionKey](/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey) operations. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only the string type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + A user-friendly name for the vault. It does not have to be unique, and it is changeable. + Avoid entering confidential information. + maxLength: 100 + minLength: 1 + type: string + externalKeyManagerMetadataSummary: + $ref: '#/components/schemas/ExternalKeyManagerMetadataSummary' + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the vault. + maxLength: 255 + minLength: 1 + type: string + isPrimary: + description: A Boolean value that indicates whether the Vault is primary Vault or replica Vault. + type: boolean + lifecycleState: + description: | + The vault's current lifecycle state. + + Example: `DELETED` + enum: + - CREATING + - ACTIVE + - DELETING + - DELETED + - PENDING_DELETION + - SCHEDULING_DELETION + - CANCELLING_DELETION + - UPDATING + - BACKUP_IN_PROGRESS + - RESTORING + type: string + managementEndpoint: + description: | + The service endpoint to perform management operations against. Management operations include "Create," "Update," "List," "Get," and "Delete" operations. + type: string + replicaDetails: + $ref: '#/components/schemas/VaultReplicaDetails' + restoredFromVaultId: + description: | + The OCID of the vault from which this vault was restored, if it was restored from a backup file. + If you restore a vault to the same region, the vault retains the same OCID that it had when you + backed up the vault. + type: string + timeCreated: + description: | + The date and time this vault was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + + Example: `2018-04-03T21:10:29.600Z` + format: date-time + type: string + timeOfDeletion: + description: | + An optional property to indicate when to delete the vault, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2018-04-03T21:10:29.600Z` + format: date-time + type: string + vaultType: + description: | + The type of vault. Each type of vault stores the key with different + degrees of isolation and has different options and pricing. + enum: + - VIRTUAL_PRIVATE + - DEFAULT + - EXTERNAL + type: string + wrappingkeyId: + description: The OCID of the vault's wrapping key. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - displayName + - timeCreated + - lifecycleState + - vaultType + - cryptoEndpoint + - managementEndpoint + - wrappingkeyId + type: object + x-example: | + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wee6cvbxq4iusld5ltpneskcfy7lr4a6wfauxuwrwed5b3xea", + "cryptoEndpoint": "https://exampleaaacu2-crypto.kms.us-ashburn-1.oraclecloud.com", + "definedTags": { }, + "displayName": "Vault 1", + "freeformTags": { }, + "id": "ocid1.vault.oc1.iad.examplevaaeuk.examplehhv5i3qbkp22g3cvbjqy7c7sqlywv25eajvnvcfauxpdgga6gct4a", + "lifecycleState": "ACTIVE", + "managementEndpoint": "https://exampleaaacu2-management.kms.us-ashburn-1.oraclecloud.com", + "timeCreated": "2018-04-03T20:35:12.023Z", + "timeOfDeletion": "2018-04-03T20:35:12.023Z", + "vaultType": "VIRTUAL_PRIVATE", + "restoredFromVaultId": "ocid1.vault.oc1.iad.examplevaaeuk.examplettv5i3qbkp22g3cvbjqy7c7sqlywv25eajvnvcfauxpdgga6gct4a" + "wrappingKeyId": "ocid1.key.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23kueityj4q2c6qfauxm32i577yu5a", + "replicaDetails": {"replicationId" : "12345abc"} + "isPrimary": true + "externalKeyManagerMetadataSummary": { + "oauthMetadataSummary": { + "idcsAccountNameUrl": "https://idcs-fb7a45fc4569481f88d675e213272f77.identity.r1labiad1.c9dev1.oc9qadev.com:443", + "clientAppId": "6b50726c6a2b4118y1e56f4246878417" + }, + "externalVaultEndpointUrl": "https://localhost/api/v1/cckm/oci/external-vaults/37900289-47cf-4172-91c5-7ea6cb87c4b7", + "privateEndpointId": "ocid1.privateendpoint.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23tteidhj4q2c6qfauxm32i577yu5a" + } + } + RestoreVaultFromObjectStoreDetails: + description: The details of the backup location from which you want to restore the Vault. + properties: + backupLocation: + $ref: '#/components/schemas/BackupLocation' + type: object + x-example: | + { + "backupLocation" : { + "BackupLocationURI" : { + "uri" : "http://n/namespace/b/bucket/o/object" + } + }, + } + UpdateVaultDetails: + description: The details of the Vault that you wish to update. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only the string type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + A user-friendly name for the vault. It does not have to be unique, and it is changeable. + Avoid entering confidential information. + maxLength: 100 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + type: object + x-example: | + { + "displayName": "Vault 1", + "freeformTags": {"Department": "Finance"}, + "definedTags": + { + "MyFirstNamespace": + { + "CostCenter": "SmartAlec", + "Project": "42", + "CreatedBy": "SmartAlec", + "CreatedDate": "9/21/2017T14:00" + }, + "Audit": + { + "DataSensitivity": "PII", + "CageSecurity": "High", + "Simplicity": "complex" + } + } + } + BackupVaultDetails: + description: The details of the Vault that you wish to backup. + properties: + backupLocation: + $ref: '#/components/schemas/BackupLocation' + isIncludeKeys: + description: A Boolean value that indicates whether the Keys should be included during backing up the Vault. + type: boolean + type: object + x-example: | + { + "backupLocation" : { + "BackupLocationURI" : { + "uri" : "http://n/namespace/b/bucket/o/object" + } + }, + "isIncludeKeys" : false + } + ChangeVaultCompartmentDetails: + description: The details of the compartment you wish to move the Vault. + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to move the vault to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + x-example: | + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5lsdneskcfy7lr4a6wfauxuwrwed5b3xea", + } + CreateVaultReplicaDetails: + description: Creates a vault replica. + properties: + replicaRegion: + description: | + The region in the realm to which the vault need to be replicated to + maxLength: 255 + minLength: 1 + type: string + replicaVaultMetadata: + $ref: '#/components/schemas/ReplicaVaultMetadata' + required: + - replicaRegion + type: object + x-example: | + { + "replicaRegion" : "us-ashburn-1" + "replicaVaultMetadata": { + "vaultType" : EXTERNAL, + "privateEndpointId": "ocid1.privateendpoint.oc1.secondary-region.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23tteidhj4q2c6qfauxm32i577yu5a", + "idcsAccountNameUrl": "https://idcs-fb7a45fc4569481f88d675e213272f77.us-phoenix-idcs-3.identity.r1labiad1.c9dev1.oc9qadev.com" + } + } + DeleteVaultReplicaDetails: + description: Deletes a vault replica + properties: + replicaRegion: + description: | + The region in the realm on which the replica should be deleted + maxLength: 255 + minLength: 1 + type: string + required: + - replicaRegion + type: object + x-example: | + { + "replicaRegion" : "us-ashburn-1" + } + VaultReplicaSummary: + description: Summary of vault replicas + properties: + cryptoEndpoint: + description: | + The vault replica's crypto endpoint + type: string + managementEndpoint: + description: | + The vault replica's management endpoint + type: string + region: + description: | + Region to which vault is replicated to + type: string + status: + description: Status of the Vault + enum: + - CREATING + - CREATED + - DELETING + - DELETED + type: string + type: object + ScheduleVaultDeletionDetails: + description: Details for scheduling vault deletion. + properties: + timeOfDeletion: + description: | + An optional property indicating when to delete the vault, expressed in + [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. The specified + time must be between 7 and 30 days from the time when the request is received. + If this property is missing, it will be set to 30 days from the time of the request + by default. + format: date-time + type: string + type: object + x-example: | + { + "timeOfDeletion": "2018-04-03T21:10:29.600Z" + } + VaultUsage: + description: The details of the number of Keys and KeyVersions usage in a Vault. + properties: + keyCount: + description: The number of keys in this vault that persist on a hardware security module (HSM), across all compartments, excluding keys in a `DELETED` state. + format: int32 + minimum: 0 + type: integer + keyVersionCount: + description: The number of key versions in this vault that persist on a hardware security module (HSM), across all compartments, excluding key versions in a `DELETED` state. + format: int32 + minimum: 0 + type: integer + softwareKeyCount: + description: The number of keys in this vault that persist on the server, across all compartments, excluding keys in a `DELETED` state. + format: int32 + minimum: 0 + type: integer + softwareKeyVersionCount: + description: The number of key versions in this vault that persist on the server, across all compartments, excluding key versions in a `DELETED` state. + format: int32 + minimum: 0 + type: integer + required: + - keyCount + - keyVersionCount + type: object + x-example: | + { + "keyCount": 3, + "keyVersionCount": 19, + "softwareKeyCount": 2, + "softwareKeyVersionCount": 4, + } + VerifyDataDetails: + description: The details of the message that you want to verify. + properties: + keyId: + description: The OCID of the key used to sign the message. + maxLength: 255 + minLength: 1 + type: string + keyVersionId: + description: The OCID of the key version used to sign the message. + maxLength: 255 + minLength: 1 + type: string + message: + description: The base64-encoded binary data object denoting the message or message digest to sign. You can have a message up to 4096 bytes in size. To sign a larger message, provide the message digest. + type: string + messageType: + default: RAW + description: | + Denotes whether the value of the message parameter is a raw message or a message digest. + The default value, `RAW`, indicates a message. To indicate a message digest, use `DIGEST`. + enum: + - RAW + - DIGEST + type: string + signature: + description: | + The base64-encoded binary data object denoting the cryptographic signature generated for the message. + type: string + signingAlgorithm: + description: | + The algorithm to use to sign the message or message digest. + For RSA keys, supported signature schemes include PKCS #1 and RSASSA-PSS, along with + different hashing algorithms. + For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. + When you pass a message digest for signing, ensure that you specify the same hashing algorithm + as used when creating the message digest. + enum: + - SHA_224_RSA_PKCS_PSS + - SHA_256_RSA_PKCS_PSS + - SHA_384_RSA_PKCS_PSS + - SHA_512_RSA_PKCS_PSS + - SHA_224_RSA_PKCS1_V1_5 + - SHA_256_RSA_PKCS1_V1_5 + - SHA_384_RSA_PKCS1_V1_5 + - SHA_512_RSA_PKCS1_V1_5 + - ECDSA_SHA_256 + - ECDSA_SHA_384 + - ECDSA_SHA_512 + type: string + required: + - signature + - message + - keyId + - keyVersionId + - signingAlgorithm + type: object + VerifiedData: + description: The response to a request to verify the message. + properties: + isSignatureValid: + description: A Boolean value that indicates whether the signature was verified. + type: boolean + required: + - isSignatureValid + type: object + x-example: | + { + "isSignatureValid": true + } + WrappingKey: + description: The public RSA wrapping key associated with the vault + properties: + compartmentId: + description: The OCID of the compartment that contains this key. + maxLength: 255 + minLength: 1 + type: string + id: + description: The OCID of the key. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: | + The key's current lifecycle state. + + Example: `ENABLED` + enum: + - CREATING + - ENABLING + - ENABLED + - DISABLING + - DISABLED + - DELETING + - DELETED + - PENDING_DELETION + - SCHEDULING_DELETION + - CANCELLING_DELETION + - UPDATING + - BACKUP_IN_PROGRESS + - RESTORING + type: string + publicKey: + description: | + The public key, in PEM format, to use to wrap the key material before importing it. + type: string + timeCreated: + description: | + The date and time the key was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + + Example: `2018-04-03T21:10:29.600Z` + format: date-time + type: string + vaultId: + description: The OCID of the vault that contains this key. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - timeCreated + - lifecycleState + - vaultId + - publicKey + type: object + x-example: | + { + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5ltpneskcfy7lr4a6wfauxuwrwed5b3xea", + "id": "ocid1.key.oc1.iad.examplefaafqw.exampletn3m2p4cvb6nv7oer2p3nliijfw4qyuguvmrfauxr622ife7urnqa", + "lifecycleState": "ENABLED", + "timeCreated": "2018-04-04T00:33:59.874Z", + "vaultId": "ocid1.vault.oc1.iad.examplevaaeuk.examplettv5i3qbkp22g3cvbjqy7c7sqlywv25eajvnvcfauxpdgga6gct4a" + "publicKey":"-----BEGIN PUBLIC KEY----- ..... -----END PUBLIC KEY-----" + } + Error: + description: The desciption of Error message. + properties: + code: + description: | + A short error code that defines the error, meant for programmatic parsing. See + [API Errors](/Content/API/References/apierrors.htm). + type: string + message: + description: A human-readable error string. + type: string + required: + - code + - message + type: object + KeyShape: + description: The cryptographic properties of a key. + properties: + algorithm: + description: The algorithm used by a key's key versions to encrypt or decrypt. Only AES algorithm is supported for `External` keys. + enum: + - AES + - RSA + - ECDSA + type: string + curveId: + description: Supported curve IDs for ECDSA keys. + enum: + - NIST_P256 + - NIST_P384 + - NIST_P521 + type: string + length: + description: | + The length of the key in bytes, expressed as an integer. Supported values include the following: + - AES: 16, 24, or 32 + - RSA: 256, 384, or 512 + - ECDSA: 32, 48, or 66 + type: integer + required: + - algorithm + - length + type: object + x-example: | + { + "algorithm": "AES", + "length": 16 + } + HsmClusterSummary: + description: An object which encapsulates the details of a given HSM Cluster. + properties: + compartmentId: + description: The OCID of the compartment that contains a particular HSMCluster resource. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only the string type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + A user-friendly name for a HSMCluster resource. It does not have to be unique, and it is changeable. + Avoid entering confidential information. + maxLength: 100 + minLength: 1 + type: string + dnsName: + description: DNS name for the HSMCluster -- this will contain information about the region as well. + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of a HSMCluster resource. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: | + A HSMCluster resource's current lifecycle state. + + Example: `ACTIVE` + type: string + x-obmcs-enumref: '#/definitions/HsmCluster/lifecycleState' + timeCreated: + description: | + The date and time a dedicated KMS resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + + Example: `2023-04-03T21:10:29.600Z` + format: date-time + type: string + timeOfDeletion: + description: | + An optional property indicating when to delete the resource, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time a dedicated KMS resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + + Example: `2023-04-03T21:10:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - displayName + - lifecycleState + - timeCreated + - timeUpdated + - dnsName + type: object + x-example: | + [ + { + "id": "ocid1.hsm.oc1.iad.examplevaaeuk.examplettv5i3qbkp22g3cvbnqy7c7sqlywv25eajvnvcfauxpdgga6gct4a", + "displayName": "Hsm Cluster 1", + "compartmentId": "ocid1.tenancy.oc1..examplerti4wjo6cvbxq4iusld5ltpneskcfy7lr4a6wfauxuwrwed5b3xea", + "lifecycleState": "ACTIVE", + "dnsName":"https://exampleaaacu2-hsmcluster.kms.us-ashburn-1.oraclecloud.com", + "timeCreated": "2023-04-03T20:35:12.023Z", + "timeUpdated": "2023-04-03T20:35:12.023Z", + "definedTags": { }, + "freeformTags": { } + }, + { + "id": "ocid1.hsm.oc1.iad.examplevaaeuk.examplettv5i3qbkp22g3cvb123jqy7c7sqlywv25eajvnvcfauxpdgga6gct4a", + "displayName": "Hsm Cluster 0", + "compartmentId": "ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5lggneskcfy7lr4a6wfauxuwrwed5b3xea", + "lifecycleState": "ACTIVE", + "dnsName":"https://exampleaaacu3-hsmcluster.kms.us-ashburn-1.oraclecloud.com", + "timeCreated": "2023-04-03T18:20:50.352Z", + "timeUpdated": "2023-04-03T20:35:12.023Z", + "definedTags": { }, + "freeformTags": { } + } + ] + HsmPartitionSummary: + description: An object which encapsulates the details of a given HSM. + properties: + compartmentId: + description: The OCID of the compartment that contains a particular HSM resource. + maxLength: 255 + minLength: 1 + type: string + hsmClusterId: + description: The OCID of the HSMCluster that contains a particular HSM resource. + maxLength: 255 + minLength: 1 + type: string + id: + description: The OCID of the HSM resource. Each HSM resource will have a unique OCID identifier. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: | + A HSMCluster resource's current lifecycle state. + + Example: `ACTIVE` + type: string + x-obmcs-enumref: '#/definitions/HsmPartition/lifecycleState' + portInformation: + description: Details of a single portInformation item include the PortNumber (an integer used as an identifier) and the PortType (refers to either an enum value of Managementutility,Clientutility, or null) + items: + $ref: '#/components/schemas/PortInformation' + type: array + timeCreated: + description: | + The date and time an HSM was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + + Example: `2018-04-03T21:10:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time an HSM was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + + Example: `2018-04-03T21:10:29.600Z` + format: date-time + type: string + required: + - id + - hsmClusterId + - lifecycleState + - compartmentId + - portInformation + - timeCreated + - timeUpdated + type: object + PortInformation: + description: Details of a single portInformation item include the PortNumber (an integer used as an identifier) and the PortType (this refers to either an enum value of Management Utility, Client Utility, or null) + properties: + portNumber: + description: The port number is a unique identifier which is typically used as the loadbalancer listener. + type: integer + portType: + description: Port type associated for the port number. The two port type enums are `CLIENTUTILITY` and `MANAGEMENTUTILITY`. The CLIENTUTILITY enum corresponds to a port which is used by the client daemon. The MANAGEMENTUTILITY enum corresponds to a port used by user management utility. + enum: + - CLIENTUTILITY + - MANAGEMENTUTILITY + type: string + required: + - portNumber + - portType + type: object + ExternalKeyReferenceDetails: + description: Key reference data to be returned to the customer as a response. + properties: + externalKeyId: + description: ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM. + maxLength: 255 + minLength: 1 + type: string + externalKeyVersionId: + description: Key version ID associated with the external key. + maxLength: 255 + minLength: 1 + type: string + required: + - externalKeyId + - externalKeyVersionId + type: object + AutoKeyRotationDetails: + description: The details of auto rotation schedule for the Key being create updated or imported. + properties: + lastRotationMessage: + description: | + The last execution status message of auto key rotation. + type: string + lastRotationStatus: + description: The status of last execution of auto key rotation. + enum: + - SUCCESS + - FAILED + - IN_PROGRESS + type: string + rotationIntervalInDays: + description: 'The interval of auto key rotation. For auto key rotation the interval should between 60 day and 365 days (1 year). Note: User must specify this parameter when creating a new schedule.' + format: int32 + maximum: 365 + minimum: 60 + type: integer + timeOfLastRotation: + description: 'A property indicating Last rotation Date. Example: `2023-04-04T00:00:00Z`.' + format: date-time + type: string + timeOfNextRotation: + description: 'A property indicating Next estimated scheduled Time, as per the interval, expressed as date YYYY-MM-DD String. Example: `2023-04-04T00:00:00Z`. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z. ' + format: date-time + type: string + timeOfScheduleStart: + description: 'A property indicating scheduled start date expressed as date YYYY-MM-DD String. Example: `2023-04-04T00:00:00Z. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z . Note : Today’s date will be used if not specified by customer.' + format: date-time + type: string + type: object + x-example: | + { + "rotationIntervalInDays": "60", + "timeOfScheduleStart": "2023-04-04T00:00:00Z" + "timeOfNextRotation": "2023-06-04T00:00:00Z", + "timeOfLastRotation": "2023-02-04T00:00:00Z", + "lastRotationStatus": "SUCCESS", + "lastRotationMessage": "Rotation Completed" + } + ExternalKeyReference: + description: A reference to the key on external key manager. + properties: + externalKeyId: + description: ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM + maxLength: 255 + minLength: 1 + type: string + required: + - externalKeyId + type: object + KeyReplicaDetails: + description: | + Key replica details + properties: + replicationId: + description: | + ReplicationId associated with a key operation + maxLength: 255 + minLength: 1 + type: string + type: object + BackupLocation: + description: Backup upload location + discriminator: + propertyName: destination + properties: + destination: + description: | + 'Backup location destination: + BUCKET - Uploading or downloading backup via object store bucket + PRE_AUTHENTICATED_REQUEST_URI - Uploading or downloading backup via a PreAuthenticated object store URI' + enum: + - BUCKET + - PRE_AUTHENTICATED_REQUEST_URI + type: string + required: + - destination + type: object + WrappedImportKey: + description: The details of the wrapped import Key. + properties: + keyMaterial: + description: The key material to import, wrapped by the vault's RSA public wrapping key and base64-encoded. + type: string + wrappingAlgorithm: + description: | + The wrapping mechanism to use during key import. + `RSA_OAEP_AES_SHA256` invokes the RSA AES key wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped + by the vault's RSA public wrapping key, creating a wrapped temporary AES key. The temporary AES key is also used to wrap the private key material. + The wrapped temporary AES key and the wrapped exportable key material are concatenated, producing concatenated blob output that jointly represents them. + `RSA_OAEP_SHA256` means that the exportable key material is wrapped by the vault's RSA public wrapping key. + enum: + - RSA_OAEP_SHA256 + - RSA_OAEP_AES_SHA256 + type: string + required: + - keyMaterial + - wrappingAlgorithm + type: object + KeyVersionReplicaDetails: + description: | + KeyVersion replica details + properties: + replicationId: + description: | + ReplicationId associated with a key version operation + maxLength: 255 + minLength: 1 + type: string + type: object + ReplicaDetails: + description: Details of replication status + properties: + region: + description: | + The replica region + maxLength: 255 + minLength: 1 + type: string + status: + description: Replication status associated with a replicationId + enum: + - REPLICATING + - REPLICATED + type: string + type: object + ExternalKeyManagerMetadataSummary: + description: Summary about metadata of external key manager to be returned to the customer as a response. + properties: + externalVaultEndpointUrl: + description: URL of the vault on external key manager. + maxLength: 255 + minLength: 1 + type: string + oauthMetadataSummary: + $ref: '#/components/schemas/OauthMetadataSummary' + privateEndpointId: + description: OCID of the private endpoint. + maxLength: 255 + minLength: 1 + type: string + vendor: + description: Vendor of the external key manager. + maxLength: 255 + minLength: 1 + type: string + required: + - externalVaultEndpointUrl + - privateEndpointId + type: object + ExternalKeyManagerMetadata: + description: Metadata required for accessing External Key manager + properties: + externalVaultEndpointUrl: + description: URI of the vault on external key manager. + maxLength: 255 + minLength: 1 + type: string + oauthMetadata: + $ref: '#/components/schemas/OauthMetadata' + privateEndpointId: + description: OCID of private endpoint created by customer. + maxLength: 255 + minLength: 1 + type: string + required: + - oauthMetadata + - externalVaultEndpointUrl + - privateEndpointId + type: object + VaultReplicaDetails: + description: | + Vault replica details + properties: + replicationId: + description: | + ReplicationId associated with a vault operation + maxLength: 255 + minLength: 1 + type: string + type: object + ReplicaVaultMetadata: + description: Metadata for the replica vault, needed if different from primary vault + discriminator: + propertyName: vaultType + properties: + vaultType: + description: | + The type of vault. Each type of vault stores keys with different + degrees of isolation and has different options and pricing. + enum: + - EXTERNAL + type: string + required: + - vaultType + type: object + OauthMetadataSummary: + description: Summary about authorization to be returned to the customer as a response. + properties: + clientAppId: + description: ID of the client app created in IDP. + maxLength: 255 + minLength: 1 + type: string + idcsAccountNameUrl: + description: Base URL of the IDCS account where confidential client app is created. + maxLength: 255 + minLength: 1 + type: string + required: + - idcsAccountNameUrl + - clientAppId + type: object + OauthMetadata: + description: Authorization details required to get access token from IDP for accessing protected resources. + properties: + clientAppId: + description: ID of the client app created in IDP. + maxLength: 255 + minLength: 1 + type: string + clientAppSecret: + description: Secret of the client app created in IDP. + format: password + maxLength: 255 + minLength: 1 + type: string + idcsAccountNameUrl: + description: Base URL of the IDCS account where confidential client app is created. + maxLength: 255 + minLength: 1 + type: string + required: + - idcsAccountNameUrl + - clientAppId + - clientAppSecret + type: object + ListEkmsPrivateEndpointsResponse: + type: object + properties: + ekms_private_endpoints: + type: array + items: + $ref: '#/components/schemas/EkmsPrivateEndpointSummary' + ListKeysResponse: + type: object + properties: + keys: + type: array + items: + $ref: '#/components/schemas/KeySummary' + ListKeyVersionsResponse: + type: object + properties: + key_versions: + type: array + items: + $ref: '#/components/schemas/KeyVersionSummary' + ListVaultsResponse: + type: object + properties: + vaults: + type: array + items: + $ref: '#/components/schemas/VaultSummary' + ListVaultReplicasResponse: + type: object + properties: + vault_replicas: + type: array + items: + $ref: '#/components/schemas/VaultReplicaSummary' + responses: + '400': + description: Bad Request + 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' + '401': + description: Unauthorized + 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' + '404': + description: Not Found + 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' + '409': + description: Conflict + 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' + '412': + description: Precondition Failed + 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' + '429': + description: Too many requests. User-rate limit exceeded. + 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 + retry-after: + description: | + If the request gets throttled, time in seconds to retry the request. + schema: + type: integer + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '500': + description: Internal Server 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' + DefaultError: + description: An error has occurred. + 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' + parameters: + RequestIdHeader: + description: | + Unique identifier for the request. If provided, the returned request ID + will include this value. Otherwise, a random request ID will be + generated by the service. + in: header + name: opc-request-id + required: false + schema: + type: string + CompartmentIdQueryParam: + description: The OCID of the compartment. + in: query + name: compartmentId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + PaginationLimitQueryParam: + description: | + The maximum number of items to return in a paginated "List" call. + in: query + name: limit + required: false + schema: + type: integer + minimum: 1 + maximum: 1000 + PaginationTokenQueryParam: + description: | + The value of the `opc-next-page` response header + from the previous "List" call. + in: query + name: page + required: false + schema: + type: string + minLength: 1 + maxLength: 512 + SortOrderQueryParam: + description: | + The sort order to use, either ascending (`ASC`) or descending (`DESC`). + in: query + name: sortOrder + required: false + schema: + type: string + enum: + - ASC + - DESC + SortByQueryParam: + description: | + The field to sort by. You can specify only one sort order. The default + order for `TIMECREATED` is descending. The default order for `DISPLAYNAME` + is ascending. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + RetryTokenHeader: + description: | + A token that uniquely identifies a request so it can be retried in case + of a timeout or server error without risk of executing that same action + again. Retry tokens expire after 24 hours, but can be invalidated + before then due to conflicting operations (e.g., if a resource has been + deleted and purged from the system, then a retry of the original + creation request may be rejected). + in: header + name: opc-retry-token + required: false + schema: + type: string + minLength: 1 + maxLength: 64 + 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 + EkmsPrivateEndpointIdentifierPathParam: + description: Unique EKMS private endpoint identifier. + in: path + name: ekmsPrivateEndpointId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + HsmClusterIdPathParam: + description: The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster. + in: path + name: hsmClusterId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + HsmPartitionIdPathParam: + description: The OCID of the HSM Partition. This is a unique identifier which each hsmPartition will have. + in: path + name: hsmPartitionId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ProtectionModeQueryParam: + description: | + A key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A + protection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are + performed inside the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's + RSA wrapping key which persists on the HSM. All cryptographic operations that use a key with a protection mode of + `SOFTWARE` are performed on the server. + A protection mode of `EXTERNAL` mean that the key persists on the customer's external key manager which is hosted externally outside of oracle. + Oracle only hold a reference to that key. All cryptographic operations that use a key with a protection mode of `EXTERNAL` are performed by external key manager. + in: query + name: protectionMode + required: false + schema: + type: string + enum: + - HSM + - SOFTWARE + - EXTERNAL + default: HSM + KeyAlgorithmQueryParam: + description: | + The algorithm used by a key's key versions to encrypt or decrypt data. Currently, support includes AES, RSA, and ECDSA algorithms. + in: query + name: algorithm + required: false + schema: + type: string + enum: + - AES + - RSA + - ECDSA + KeyLengthQueryParam: + description: | + The length of the key in bytes, expressed as an integer. Supported values include 16, 24, or 32. + in: query + name: length + required: false + schema: + type: integer + KeyCurveQueryParam: + description: | + The curve ID of the keys. (This pertains only to ECDSA keys.) + in: query + name: curveId + required: false + schema: + type: string + enum: + - NIST_P256 + - NIST_P384 + - NIST_P521 + ContentLengthHeader: + description: The content length of the body. + in: header + name: content-length + required: true + schema: + type: integer + format: int64 + OptionalContentMD5Header: + description: | + The base64-encoded MD5 hash value of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.15. + If the Content-MD5 header is present, Key Management performs an integrity check on the body of the HTTP request by computing the MD5 + hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes don't match, the object is rejected and + a response with 400 Unmatched Content MD5 error is returned, along with the message: "The computed MD5 of the request body (ACTUAL_MD5) + does not match the Content-MD5 header (HEADER_MD5)." + in: header + name: content-md5 + schema: + type: string + KeyIdPathParam: + description: The OCID of the key. + in: path + name: keyId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + KeyVersionIdPathParam: + description: The OCID of the key version. + in: path + name: keyVersionId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ReplicationIdPathParam: + description: | + replicationId associated with an operation on a resource + in: path + name: replicationId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + VaultIdPathParam: + description: The OCID of the vault. + in: path + name: vaultId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + x-stackQL-resources: + ekms_private_endpoints: + id: oci.kms.ekms_private_endpoints + name: ekms_private_endpoints + title: Ekms Private Endpoints + methods: + list: + operation: + $ref: '#/paths/~120180608~1ekmsPrivateEndpoints/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.ekms_private_endpoints + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListEkmsPrivateEndpointsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"ekms_private_endpoints\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~120180608~1ekmsPrivateEndpoints/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~120180608~1ekmsPrivateEndpoints~1{ekmsPrivateEndpointId}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~120180608~1ekmsPrivateEndpoints~1{ekmsPrivateEndpointId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~120180608~1ekmsPrivateEndpoints~1{ekmsPrivateEndpointId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ekms_private_endpoints/methods/get' + - $ref: '#/components/x-stackQL-resources/ekms_private_endpoints/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/ekms_private_endpoints/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/ekms_private_endpoints/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/ekms_private_endpoints/methods/delete' + replace: [] + hsm_clusters: + id: oci.kms.hsm_clusters + name: hsm_clusters + title: Hsm Clusters + methods: + list: + operation: + $ref: '#/paths/~120180608~1hsmClusters/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~120180608~1hsmClusters/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~120180608~1hsmClusters~1{hsmClusterId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~120180608~1hsmClusters~1{hsmClusterId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + cancel_hsm_cluster_deletion: + operation: + $ref: '#/paths/~120180608~1hsmClusters~1{hsmClusterId}~1actions~1cancelDeletion/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~120180608~1hsmClusters~1{hsmClusterId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + download_certificate_signing_request: + operation: + $ref: '#/paths/~120180608~1hsmClusters~1{hsmClusterId}~1actions~1downloadCertificateSigningRequest/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + schedule_hsm_cluster_deletion: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~120180608~1hsmClusters~1{hsmClusterId}~1actions~1scheduleDeletion/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + upload_partition_certificates: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~120180608~1hsmClusters~1{hsmClusterId}~1actions~1uploadPartitionCertificates/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/hsm_clusters/methods/get' + - $ref: '#/components/x-stackQL-resources/hsm_clusters/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/hsm_clusters/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/hsm_clusters/methods/update' + delete: [] + replace: [] + hsm_partitions: + id: oci.kms.hsm_partitions + name: hsm_partitions + title: Hsm Partitions + methods: + list: + operation: + $ref: '#/paths/~120180608~1hsmClusters~1{hsmClusterId}~1hsmPartitions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~120180608~1hsmClusters~1{hsmClusterId}~1hsmPartitions~1{hsmPartitionId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/hsm_partitions/methods/get' + - $ref: '#/components/x-stackQL-resources/hsm_partitions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + pre_co_user_credentials: + id: oci.kms.pre_co_user_credentials + name: pre_co_user_credentials + title: Pre Co User Credentials + methods: + get: + operation: + $ref: '#/paths/~120180608~1hsmClusters~1{hsmClusterId}~1preCoUserCredentials/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pre_co_user_credentials/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + vaults: + id: oci.kms.vaults + name: vaults + title: Vaults + methods: + list: + operation: + $ref: '#/paths/~120180608~1vaults/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.vaults + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVaultsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"vaults\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~120180608~1vaults/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + restore_vault_from_file: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~120180608~1vaults~1actions~1restoreFromFile/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + restore_vault_from_object_store: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~120180608~1vaults~1actions~1restoreFromObjectStore/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~120180608~1vaults~1{vaultId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~120180608~1vaults~1{vaultId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + backup_vault: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~120180608~1vaults~1{vaultId}~1actions~1backup/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + cancel_vault_deletion: + operation: + $ref: '#/paths/~120180608~1vaults~1{vaultId}~1actions~1cancelDeletion/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~120180608~1vaults~1{vaultId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + delete_vault_replica: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~120180608~1vaults~1{vaultId}~1actions~1deleteReplica/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + schedule_vault_deletion: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~120180608~1vaults~1{vaultId}~1actions~1scheduleDeletion/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/vaults/methods/get' + - $ref: '#/components/x-stackQL-resources/vaults/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/vaults/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/vaults/methods/update' + delete: [] + replace: [] + vault_replicas: + id: oci.kms.vault_replicas + name: vault_replicas + title: Vault Replicas + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~120180608~1vaults~1{vaultId}~1actions~1createReplica/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + list: + operation: + $ref: '#/paths/~120180608~1vaults~1{vaultId}~1actions~1listReplicas/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.vault_replicas + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVaultReplicasResponse' + transform: + body: |- + {{- $wrapped := printf "{\"vault_replicas\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/vault_replicas/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/vault_replicas/methods/create' + update: [] + delete: [] + replace: [] + vault_usages: + id: oci.kms.vault_usages + name: vault_usages + title: Vault Usages + methods: + get: + operation: + $ref: '#/paths/~120180608~1vaults~1{vaultId}~1usage/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/vault_usages/methods/get' + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://kms.{region}.oraclecloud.com + variables: + region: + default: us-ashburn-1 + description: OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. + x-stackQL-envVar: OCI_REGION +x-stackQL-config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: opc-next-page + location: header diff --git a/providers/src/oci/v00.00.00000/services/load_balancer.yaml b/providers/src/oci/v00.00.00000/services/load_balancer.yaml new file mode 100644 index 00000000..ff7786ec --- /dev/null +++ b/providers/src/oci/v00.00.00000/services/load_balancer.yaml @@ -0,0 +1,11316 @@ +openapi: 3.0.0 +info: + title: load_balancer API + description: oci load_balancer API + version: '20170115' +paths: + /loadBalancerHealths: + get: + description: Lists the summary health statuses for all load balancers in the specified compartment. + operationId: ListLoadBalancerHealths + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: | + For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. + For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + + Example: `50` + in: query + name: limit + required: false + schema: + type: integer + format: int64 + default: 10 + - description: | + For list pagination. The value of the `opc-next-page` response header from the previous "List" call. + For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + + Example: `3` + in: query + name: page + required: false + schema: + type: string + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancers to return health status information for. + in: query + name: compartmentId + required: true + schema: + type: string + responses: + '200': + description: The health status information was retrieved. + 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/ListLoadBalancerHealthsResponse' + '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/DefaultError' + summary: ListLoadBalancerHealths + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancerHealths + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /loadBalancerPolicies: + get: + description: Lists the available load balancer policies. + operationId: ListPolicies + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer policies to list. + in: query + name: compartmentId + required: true + schema: + type: string + - description: | + For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. + For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + + Example: `50` + in: query + name: limit + required: false + schema: + type: integer + format: int64 + default: 16 + - description: | + For list pagination. The value of the `opc-next-page` response header from the previous "List" call. + For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + + Example: `3` + in: query + name: page + required: false + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListPoliciesResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListPolicies + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancerPolicies?compartmentId=<compartment_OCID> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /loadBalancerProtocols: + get: + description: Lists all supported traffic protocols. + operationId: ListProtocols + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer protocols to list. + in: query + name: compartmentId + required: true + schema: + type: string + - description: | + For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. + For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + + Example: `50` + in: query + name: limit + required: false + schema: + type: integer + format: int64 + default: 16 + - description: | + For list pagination. The value of the `opc-next-page` response header from the previous "List" call. + For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + + Example: `3` + in: query + name: page + required: false + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListProtocolsResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListProtocols + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancerProtocols?compartmentId=<compartment_OCID> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /loadBalancerShapes: + get: + description: Lists the valid load balancer shapes. + operationId: ListShapes + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer shapes to list. + in: query + name: compartmentId + required: true + schema: + type: string + - description: | + For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. + For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + + Example: `50` + in: query + name: limit + required: false + schema: + type: integer + format: int64 + default: 16 + - description: | + For list pagination. The value of the `opc-next-page` response header from the previous "List" call. + For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + + Example: `3` + in: query + name: page + required: false + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListShapesResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListShapes + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancerShapes?compartmentId=<compartment_OCID> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /loadBalancerWorkRequests/{workRequestId}: + get: + description: Gets the details of a work request. + operationId: GetWorkRequest + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request to retrieve. + in: path + name: workRequestId + required: true + schema: + type: string + responses: + '200': + description: The work request is being retrieved. + 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/WorkRequest' + '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/DefaultError' + summary: GetWorkRequest + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancerWorkRequests/<work_request_OCID> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /loadBalancers: + get: + description: Lists all load balancers in the specified compartment. + operationId: ListLoadBalancers + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: | + For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. + For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + + Example: `50` + in: query + name: limit + required: false + schema: + type: integer + format: int64 + default: 10 + - description: | + For list pagination. The value of the `opc-next-page` response header from the previous "List" call. + For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + + Example: `3` + in: query + name: page + required: false + schema: + type: string + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancers to list. + in: query + name: compartmentId + required: true + schema: + type: string + - description: | + The level of detail to return for each result. Can be `full` or `simple`. + + Example: `full` + in: query + name: detail + required: false + schema: + type: string + default: full + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/FilterByLifecycleStateQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListLoadBalancersResponse' + '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/DefaultError' + summary: ListLoadBalancers + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancers?compartmentId=<compartment_OCID> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + post: + description: | + Creates a new load balancer in the specified compartment. For general information about load balancers, + see [Overview of the Load Balancing Service](/Content/Balance/Concepts/balanceoverview.htm). + + For the purposes of access control, you must provide the OCID of the compartment where you want + the load balancer to reside. Notice that the load balancer doesn't have to be in the same compartment as the VCN + or backend set. If you're not sure which compartment to use, put the load balancer in the same compartment as the VCN. + For information about access control and compartments, see + [Overview of the IAM Service](/Content/Identity/Concepts/overview.htm). + + You must specify a display name for the load balancer. It does not have to be unique, and you can change it. + + For information about Availability Domains, see + [Regions and Availability Domains](/Content/General/Concepts/regions.htm). + To get a list of Availability Domains, use the `ListAvailabilityDomains` operation + in the Identity and Access Management Service API. + + All Oracle Cloud Infrastructure resources, including load balancers, get an Oracle-assigned, + unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID + in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, + or by viewing the resource in the Console. Fore more information, see + [Resource Identifiers](/Content/General/Concepts/identifiers.htm). + + After you send your request, the new object's state will temporarily be PROVISIONING. Before using the + object, first make sure its state has changed to RUNNING. + + When you create a load balancer, the system assigns an IP address. + To get the IP address, use the [GetLoadBalancer](#/en/loadbalancer/20170115/LoadBalancer/GetLoadBalancer) operation. + operationId: CreateLoadBalancer + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateLoadBalancerDetails' + description: The configuration details for creating a load balancer. + required: true + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: CreateLoadBalancer + tags: + - loadBalancer + x-example: | + POST /20170115/loadBalancers + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "example_load_balancer", + "shapeName": "flexible", + "shapeDetails": { + "minimumBandwidthInMbps": 10, + "maximumBandwidthInMbps": 100 + }, + "isPrivate": true, + "ipMode": "IPV4", + isDeleteProtectionEnabled: true, + + "listeners": { + "exampleListener": { + "defaultBackendSetName": "example_backend_set", + "port": 80, + "protocol": "HTTP", + "pathRouteSetName": "example_path_route_set", + "sslConfiguration": { + "protocols": ["TLSv1.1", "TLSv1.2"], + "cipherSuiteName" : "example_cipher_suite", + "serverOrderPreference" : "ENABLED", + "certificateName": "example_certificate_bundle", + "verifyPeerCertificate": true, + "verifyDepth": 3 + }, + "connectionConfiguration": { + "idleTimeout": 1200 + } + } + }, + "hostnames": { + "example_hostname_001": { + "name": "example_hostname_001", + "hostname": "app.example.com" + }, + "example_hostname_002": { + "name": "example_hostname_002", + "hostname": "app.example.*" + } + }, + "backendSets": { + "example_backend_set": { + "policy": "LEAST_CONNECTIONS", + "backends": [ + { + "ipAddress": "10.0.0.3", + "port": 8080, + "weight": 3, + "backup": false, + "drain": false, + "offline": false + }, + { + "ipAddress": "10.0.0.4", + "port": 8080, + "weight": 1, + "backup": false, + "drain": false, + "offline": false + } + ], + "healthChecker": { + "protocol": "HTTP", + "isForcePlainText": false, + "urlPath": "/healthcheck", + "port": 8080, + "returnCode": 200, + "retries": 3, + "timeoutInMillis": 3000, + "intervalInMillis": 10000, + "responseBodyRegex": "^((?!false).|\s)*$" + }, + "sslConfiguration": { + "protocols": ["TLSv1.1", "TLSv1.2"], + "cipherSuiteName" : "example_cipher_suite", + "serverOrderPreference" : "ENABLED", + "certificateName": "example_certificate_bundle", + "verifyPeerCertificate": true, + "verifyDepth": 3 + }, + "sessionPersistenceConfiguration": { + "cookieName": "example_cookie", + "disableFallback": false + } + }, + }, + "certificates": { + "example_certificate_bundle": { + "passphrase": "<passphrase>", + "privateKey": "<private_key>", + "publicCertificate": "<public_certificate>", + "caCertificate": "<ca_certificate>", + "certificateName": "example_certificate_bundle" + } + }, + "sslCipherSuites": { + "example_cipher_suite": { + "ciphers": [ + "ECDHE-ECDSA-AES128-GCM-SHA256", + "ECDHE-ECDSA-AES128-SHA256", + "ECDHE-RSA-AES128-GCM-SHA256" + ], + "name": "example_cipher_suite" + } + }, + "pathRouteSets": { + "example_path_route_set": { + "pathRoutes": [ + { + "path": "/example/video/123", + "pathMatchType": { + "matchType": "EXACT_MATCH" + }, + "backendSetName": "example_backend_set" + } + ] + } + }, + "ruleSets": { + "example_rule_set": { + "items": [ + { + "action": "ADD_REQUEST_HEADER", + "header": "example_header_name", + "value": "example_value" + }, + { + "action": "EXTEND_HTTP_REQUEST_HEADER_VALUE", + "header": "example_header_name2", + "prefix": "example_prefix_value", + "suffix": "example_suffix_value" + } + ] + } + } + }, + "subnetIds": [ + "ocid1.subnet.oc1.phx.<unique_ID>" + ] + } + /loadBalancers/{loadBalancerId}: + delete: + description: Stops a load balancer and removes it from service. + operationId: DeleteLoadBalancer + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to delete. + in: path + name: loadBalancerId + required: true + schema: + type: string + responses: + '204': + description: The request to delete the load balancer was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: DeleteLoadBalancer + tags: + - loadBalancer + x-example: | + DELETE /20170115/loadBalancers/<load_balancer_OCID> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + get: + description: Gets the specified load balancer's configuration information. + operationId: GetLoadBalancer + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to retrieve. + in: path + name: loadBalancerId + required: true + schema: + type: string + responses: + '200': + description: The configuration information is being retrieved. + 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/LoadBalancer' + '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/DefaultError' + summary: GetLoadBalancer + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancers/<load_balancer_OCID> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: Updates a load balancer's configuration. + operationId: UpdateLoadBalancer + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - $ref: '#/components/parameters/RetryTokenHeader' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to update. + in: path + name: loadBalancerId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateLoadBalancerDetails' + description: The details for updating a load balancer's configuration. + required: true + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: UpdateLoadBalancer + tags: + - loadBalancer + x-example: | + PUT /20170115/loadBalancers/<load_balancer_OCID> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + { + "displayName": "example_load_balancer", + } + /loadBalancers/{loadBalancerId}/backendSets: + get: + description: Lists all backend sets associated with a given load balancer. + operationId: ListBackendSets + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend sets to retrieve. + in: path + name: loadBalancerId + required: true + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListBackendSetsResponse' + '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/DefaultError' + summary: ListBackendSets + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancers/<load_balancer_OCID>/backendSets + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + post: + description: Adds a backend set to a load balancer. + operationId: CreateBackendSet + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - $ref: '#/components/parameters/RetryTokenHeader' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer on which to add a backend set. + in: path + name: loadBalancerId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBackendSetDetails' + description: The details for adding a backend set. + required: true + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: CreateBackendSet + tags: + - loadBalancer + x-example: | + POST /20170115/loadBalancers/<load_balancer_OCID>/backendSets + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + { + "name": "example_backend_set", + "policy": "LEAST_CONNECTIONS", + "backends": [ + { + "ipAddress": "10.0.0.3", + "port": 8080, + "weight": 3, + "backup": false, + "drain": false, + "offline": false + }, + { + "ipAddress": "10.0.0.4", + "port": 8080, + "weight": 1, + "backup": false, + "drain": false, + "offline": false + } + ], + "healthChecker": { + "protocol": "HTTP", + "isForcePlainText": false, + "urlPath": "/healthcheck", + "port": 8080, + "returnCode": 200, + "retries": 3, + "timeoutInMillis": 3000, + "intervalInMillis": 10000, + "responseBodyRegex": "^((?!false).|\s)*$" + }, + "sslConfiguration": { + "protocols": ["TLSv1.1", "TLSv1.2"], + "cipherSuiteName" : "example_cipher_suite", + "serverOrderPreference" : "ENABLED", + "certificateName": "example_certificate_bundle", + "verifyDepth": "3", + "verifyPeerCertificate": true + }, + "sessionPersistenceConfiguration": { + "cookieName": "example_cookie", + "disableFallback": false + } + } + /loadBalancers/{loadBalancerId}/backendSets/{backendSetName}: + delete: + description: | + Deletes the specified backend set. Note that deleting a backend set removes its backend servers from the load balancer. + + Before you can delete a backend set, you must remove it from any active listeners. + operationId: DeleteBackendSet + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the backend set to delete. + + Example: `example_backend_set` + in: path + name: backendSetName + required: true + schema: + type: string + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: DeleteBackendSet + tags: + - loadBalancer + x-example: | + DELETE /20170115/loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + get: + description: Gets the specified backend set's configuration information. + operationId: GetBackendSet + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the backend set to retrieve. + + Example: `example_backend_set` + in: path + name: backendSetName + required: true + schema: + type: string + responses: + '200': + description: The backend set information is being retrieved. + 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/BackendSet' + '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/DefaultError' + summary: GetBackendSet + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: Updates a backend set. + operationId: UpdateBackendSet + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - $ref: '#/components/parameters/RetryTokenHeader' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the backend set to update. + + Example: `example_backend_set` + in: path + name: backendSetName + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBackendSetDetails' + description: The details to update a backend set. + required: true + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: UpdateBackendSet + tags: + - loadBalancer + x-example: | + PUT /20170115/loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + { + "policy": "LEAST_CONNECTIONS", + "backends": [ + { + "ipAddress": "10.0.0.3", + "port": 8080, + "weight": 3, + "backup": false, + "drain": false, + "offline": false + }, + { + "ipAddress": "10.0.0.4", + "port": 8080, + "weight": 1, + "backup": false, + "drain": false, + "offline": false + } + ], + "healthChecker": { + "protocol": "HTTP", + "isForcePlainText": false, + "urlPath": "/healthcheck", + "port": 8080, + "returnCode": 200, + "retries": 3, + "timeoutInMillis": 3000, + "intervalInMillis": 10000, + "responseBodyRegex": "^((?!false).|\s)*$" + }, + "sslConfiguration": { + "protocols": ["TLSv1.1", "TLSv1.2"], + "cipherSuiteName" : "example_cipher_suite", + "serverOrderPreference" : "ENABLED", + "certificateName": "example_certificate_bundle", + "verifyDepth": "3", + "verifyPeerCertificate": true + }, + "sessionPersistenceConfiguration": { + "cookieName": "example_cookie", + "disableFallback": false + } + } + /loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends: + get: + description: Lists the backend servers for a given load balancer and backend set. + operationId: ListBackends + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and servers. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the backend set associated with the backend servers. + + Example: `example_backend_set` + in: path + name: backendSetName + required: true + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListBackendsResponse' + '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/DefaultError' + summary: ListBackends + tags: + - loadBalancer + x-example: | + GET /loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name>/backends + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + post: + description: Adds a backend server to a backend set. + operationId: CreateBackend + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - $ref: '#/components/parameters/RetryTokenHeader' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and servers. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the backend set to add the backend server to. + + Example: `example_backend_set` + in: path + name: backendSetName + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBackendDetails' + description: The details to add a backend server to a backend set. + required: true + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: CreateBackend + tags: + - loadBalancer + x-example: | + POST /20170115/loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name>/backends + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + { + "ipAddress": "10.0.0.3", + "port": 8080, + "weight": 3, + "backup": false, + "drain": false, + "offline": false + } + /loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends/{backendName}: + delete: + description: Removes a backend server from a given load balancer and backend set. + operationId: DeleteBackend + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and server. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the backend set associated with the backend server. + + Example: `example_backend_set` + in: path + name: backendSetName + required: true + schema: + type: string + - description: | + The IP address and port of the backend server to remove. + + Example: `10.0.0.3:8080` + in: path + name: backendName + required: true + schema: + type: string + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: DeleteBackend + tags: + - loadBalancer + x-example: | + DELETE /20170115/loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name>/backends/<backend_name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + get: + description: Gets the specified backend server's configuration information. + operationId: GetBackend + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and server. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the backend set that includes the backend server. + + Example: `example_backend_set` + in: path + name: backendSetName + required: true + schema: + type: string + - description: | + The IP address and port of the backend server to retrieve. + + Example: `10.0.0.3:8080` + in: path + name: backendName + required: true + schema: + type: string + responses: + '200': + description: The backend server information is being retrieved. + 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/Backend' + '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/DefaultError' + summary: GetBackend + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name>/backends/<backend_name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: Updates the configuration of a backend server within the specified backend set. + operationId: UpdateBackend + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - $ref: '#/components/parameters/RetryTokenHeader' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and server. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the backend set associated with the backend server. + + Example: `example_backend_set` + in: path + name: backendSetName + required: true + schema: + type: string + - description: | + The IP address and port of the backend server to update. + + Example: `10.0.0.3:8080` + in: path + name: backendName + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBackendDetails' + description: Details for updating a backend server. + required: true + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: UpdateBackend + tags: + - loadBalancer + x-example: | + PUT /20170115/loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name>/backends/<backend_name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + { + "weight": 3, + "backup": false, + "drain": false, + "offline": false + } + /loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends/{backendName}/health: + get: + description: Gets the current health status of the specified backend server. + operationId: GetBackendHealth + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend server health status to be retrieved. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the backend set associated with the backend server to retrieve the health status for. + + Example: `example_backend_set` + in: path + name: backendSetName + required: true + schema: + type: string + - description: | + The IP address and port of the backend server to retrieve the health status for. + + Example: `10.0.0.3:8080` + in: path + name: backendName + required: true + schema: + type: string + responses: + '200': + description: The health status information was retrieved. + 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/BackendHealth' + '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/DefaultError' + summary: BackendHealth + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name>/backends/<backend_name>/health + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/health: + get: + description: Gets the health status for the specified backend set. + operationId: GetBackendSetHealth + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set health status to be retrieved. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the backend set to retrieve the health status for. + + Example: `example_backend_set` + in: path + name: backendSetName + required: true + schema: + type: string + responses: + '200': + description: The health status information was retrieved. + 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/BackendSetHealth' + '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/DefaultError' + summary: BackendSetHealth + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name>/health + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/healthChecker: + get: + description: Gets the health check policy information for a given load balancer and backend set. + operationId: GetHealthChecker + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the health check policy to be retrieved. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the backend set associated with the health check policy to be retrieved. + + Example: `example_backend_set` + in: path + name: backendSetName + required: true + schema: + type: string + responses: + '200': + description: The health check policy information is being retrieved. + 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/HealthChecker' + '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/DefaultError' + summary: GetHealthChecker + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name>/healthChecker + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: Updates the health check policy for a given load balancer and backend set. + operationId: UpdateHealthChecker + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - $ref: '#/components/parameters/RetryTokenHeader' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the health check policy to be updated. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the backend set associated with the health check policy to be retrieved. + + Example: `example_backend_set` + in: path + name: backendSetName + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateHealthCheckerDetails' + description: The health check policy configuration details. + required: true + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: UpdateHealthChecker + tags: + - loadBalancer + x-example: | + PUT /20170115/loadBalancers/<load_balancer_OCID>/backendSets/<backend_set_name>/healthChecker + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + { + "protocol": "HTTP", + "isForcePlainText": false, + "urlPath": "/healthcheck", + "port": 8080, + "returnCode": 200, + "retries": 3, + "timeoutInMillis": 3000, + "intervalInMillis": 10000, + "responseBodyRegex": "^((?!false).|\s)*$" + } + /loadBalancers/{loadBalancerId}/certificates: + get: + description: Lists all SSL certificates bundles associated with a given load balancer. + operationId: ListCertificates + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the certificate bundles + to be listed. + in: path + name: loadBalancerId + required: true + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListCertificatesResponse' + '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/DefaultError' + summary: ListCertificates + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancers/<load_balancer_OCID>/certificates + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + post: + description: Creates an asynchronous request to add an SSL certificate bundle. + operationId: CreateCertificate + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - $ref: '#/components/parameters/RetryTokenHeader' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer on which to add the certificate bundle. + in: path + name: loadBalancerId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCertificateDetails' + description: The details of the certificate bundle to add. + required: true + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: CreateCertificate + tags: + - loadBalancer + x-example: | + POST /20170115/loadBalancers/<load_balancer_OCID>/certificates + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "passphrase": "<passphrase>", + "privateKey": "<private_key>", + "publicCertificate": "<public_certificate>", + "caCertificate": "<ca_certificate>", + "certificateName": "example_certificate_bundle" + } + /loadBalancers/{loadBalancerId}/certificates/{certificateName}: + delete: + description: Deletes an SSL certificate bundle from a load balancer. + operationId: DeleteCertificate + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the certificate bundle + to be deleted. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the certificate bundle to delete. + + Example: `example_certificate_bundle` + in: path + name: certificateName + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + pattern: ^[a-zA-Z0-9_.-]*$ + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: DeleteCertificate + tags: + - loadBalancer + x-example: | + DELETE /20170115/loadBalancers/<load_balancer_OCID>/certificates/<certificate_name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /loadBalancers/{loadBalancerId}/changeCompartment: + post: + description: | + Moves a load balancer into a different compartment within the same tenancy. For information about moving resources + between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeLoadBalancerCompartment + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - $ref: '#/components/parameters/RetryTokenHeader' + - description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the load balancer to move. + in: path + name: loadBalancerId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeLoadBalancerCompartmentDetails' + description: The configuration details for moving a load balancer to a different compartment. + required: true + responses: + '204': + description: The request to move the load balancer to a different compartment was accepted for processing. + 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 work request. + schema: + type: string + '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/DefaultError' + summary: ChangeLoadBalancerCompartment + tags: + - loadBalancer + x-example: | + POST /20170115/loadBalancers/<load_balancer_OCID>/changeCompartment + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>" + } + x-related-resource: '#/definitions/LoadBalancer' + /loadBalancers/{loadBalancerId}/health: + get: + description: Gets the health status for the specified load balancer. + operationId: GetLoadBalancerHealth + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to return health status for. + in: path + name: loadBalancerId + required: true + schema: + type: string + responses: + '200': + description: The health status information was retrieved. + 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/LoadBalancerHealth' + '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/DefaultError' + summary: LoadBalancerHealth + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancers/<load_balancer_OCID>/health + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /loadBalancers/{loadBalancerId}/hostnames: + get: + description: Lists all hostname resources associated with the specified load balancer. + operationId: ListHostnames + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the hostnames + to retrieve. + in: path + name: loadBalancerId + required: true + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListHostnamesResponse' + '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/DefaultError' + summary: ListHostnames + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancers/<load_balancer_OCID>/hostnames + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + post: + description: | + Adds a hostname resource to the specified load balancer. For more information, see + [Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm). + operationId: CreateHostname + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - $ref: '#/components/parameters/RetryTokenHeader' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to add the hostname to. + in: path + name: loadBalancerId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateHostnameDetails' + description: The details of the hostname resource to add to the specified load balancer. + required: true + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: CreateHostname + tags: + - loadBalancer + x-example: | + POST /20170115/loadBalancers/<load_balancer_OCID>/hostnames + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "name": "example_hostname_001", + "hostname": "app.example.com" + } + /loadBalancers/{loadBalancerId}/hostnames/{name}: + delete: + description: | + Deletes a hostname resource from the specified load balancer. + operationId: DeleteHostname + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the hostname to delete. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the hostname resource to delete. + + Example: `example_hostname_001` + in: path + name: name + required: true + schema: + type: string + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: DeleteHostname + tags: + - loadBalancer + x-example: | + DELETE /20170115/loadBalancers/<load_balancer_OCID>/hostnames/<name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + get: + description: Gets the specified hostname resource's configuration information. + operationId: GetHostname + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the hostname resource to retrieve. + + Example: `example_hostname_001` + in: path + name: name + required: true + schema: + type: string + responses: + '200': + description: The hostname information is being retrieved. + 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/Hostname' + '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/DefaultError' + summary: GetHostname + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancers/<load_balancer_OCID>/hostnames/<name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Overwrites an existing hostname resource on the specified load balancer. Use this operation to change a + virtual hostname. + operationId: UpdateHostname + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - $ref: '#/components/parameters/RetryTokenHeader' + - description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the virtual hostname + to update. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the hostname resource to update. + + Example: `example_hostname_001` + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateHostnameDetails' + description: The configuration details to update a virtual hostname. + required: true + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: UpdateHostname + tags: + - loadBalancer + x-example: | + PUT /20170115/loadBalancers/<load_balancer_OCID>/hostnames/<name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "hostname": "app.example.com" + } + /loadBalancers/{loadBalancerId}/listeners: + post: + description: Adds a listener to a load balancer. + operationId: CreateListener + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - $ref: '#/components/parameters/RetryTokenHeader' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer on which to add a listener. + in: path + name: loadBalancerId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateListenerDetails' + description: Details to add a listener. + required: true + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: CreateListener + tags: + - loadBalancer + x-example: | + POST /20170115/loadBalancers/<load_balancer_OCID>/listeners + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + { + "defaultBackendSetName": "example_backend_set", + "port": 80, + "protocol": "HTTP", + "hostnameNames": [ + "example_hostname_001", + "example_hostname_002" + ], + "pathRouteSetName": "example_path_route_set", + "sslConfiguration": { + "protocols": ["TLSv1.1", "TLSv1.2"], + "cipherSuiteName" : "example_cipher_suite", + "serverOrderPreference" : "ENABLED", + "certificateName": "example_certificate_bundle", + "verifyPeerCertificate": true + "verifyDepth": 3, + } + "connectionConfiguration": { + "idleTimeout": 1200 + } + "name": "example_listener" + } + /loadBalancers/{loadBalancerId}/listeners/{listenerName}: + delete: + description: Deletes a listener from a load balancer. + operationId: DeleteListener + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the listener to delete. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the listener to delete. + + Example: `example_listener` + in: path + name: listenerName + required: true + schema: + type: string + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: DeleteListener + tags: + - loadBalancer + x-example: | + DELETE /20170115/loadBalancers/<load_balancer_OCID>/listeners/<listener_name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: Updates a listener for a given load balancer. + operationId: UpdateListener + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - $ref: '#/components/parameters/RetryTokenHeader' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the listener to update. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the listener to update. + + Example: `example_listener` + in: path + name: listenerName + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateListenerDetails' + description: Details to update a listener. + required: true + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: UpdateListener + tags: + - loadBalancer + x-example: | + PUT /20170115/loadBalancers/<load_balancer_OCID>/listeners/<listener_name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + { + "defaultBackendSetName": "example_backend_set", + "port": 80, + "protocol": "HTTP", + "hostnameNames": [ + "example_hostname_001", + "example_hostname_002" + ], + "pathRouteSetName": "example_path_route_set", + "sslConfiguration": { + "protocols": ["TLSv1.1", "TLSv1.2"], + "cipherSuiteName" : "example_cipher_suite", + "serverOrderPreference" : "ENABLED", + "certificateName": "example_certificate_bundle", + "verifyPeerCertificate": true + "verifyDepth": 3, + } + "connectionConfiguration": { + "idleTimeout": 1200 + } + } + /loadBalancers/{loadBalancerId}/listeners/{listenerName}/rules: + get: + description: | + Lists all of the rules from all of the rule sets associated with the specified listener. The response organizes + the rules in the following order: + + * Access control rules + * Allow method rules + * Request header rules + * Response header rules + operationId: ListListenerRules + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the listener. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the listener the rules are associated with. + Example: `example_listener` + in: path + name: listenerName + required: true + schema: + type: string + responses: + '200': + description: The list of rules was retrieved. + 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/ListListenerRulesResponse' + '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/DefaultError' + summary: ListListenerRules + tags: + - loadBalancer + x-example: | + GET /20170115//loadBalancers/<load_balancer_OCID>/listeners/<listener_name>/rules + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /loadBalancers/{loadBalancerId}/networkSecurityGroups: + put: + description: Updates the network security groups associated with the specified load balancer. + operationId: UpdateNetworkSecurityGroups + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - $ref: '#/components/parameters/RetryTokenHeader' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to update the NSGs for. + in: path + name: loadBalancerId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateNetworkSecurityGroupsDetails' + description: The details for updating the NSGs associated with the specified load balancer. + required: true + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: UpdateNetworkSecurityGroups + tags: + - loadBalancer + x-example: | + PUT /20170115/loadBalancers/<load_balancer_OCID>/networkSecurityGroups + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + { + "networkSecurityGroupIds": [ + "ocid1.networksecuritygroup.oc1.phx.<unique_ID1>", + "ocid1.networksecuritygroup.oc1.phx.<unique_ID2>" + ] + } + x-related-resource: '#/definitions/NetworkSecurityGroups' + /loadBalancers/{loadBalancerId}/pathRouteSets: + get: + deprecated: true + description: Lists all path route sets associated with the specified load balancer. + operationId: ListPathRouteSets + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the path route sets + to retrieve. + in: path + name: loadBalancerId + required: true + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListPathRouteSetsResponse' + '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/DefaultError' + summary: ListPathRouteSets + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancers/<load_balancer_OCID>/pathRouteSets + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + post: + deprecated: true + description: | + Adds a path route set to a load balancer. For more information, see + [Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm). + operationId: CreatePathRouteSet + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - $ref: '#/components/parameters/RetryTokenHeader' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to add the path route set to. + in: path + name: loadBalancerId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePathRouteSetDetails' + description: The details of the path route set to add. + required: true + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: CreatePathRouteSet + tags: + - loadBalancer + x-example: | + POST /20170115/loadBalancers/<load_balancer_OCID>/pathRouteSets + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + { + "name": "example_path_route_set", + "pathRoutes": [ + { + "path": "/example/video/123", + "pathMatchType": { + "matchType": "EXACT_MATCH" + }, + "backendSetName": "example_backend_set" + } + ] + } + /loadBalancers/{loadBalancerId}/pathRouteSets/{pathRouteSetName}: + delete: + deprecated: true + description: | + Deletes a path route set from the specified load balancer. + + To delete a path route rule from a path route set, use the + [UpdatePathRouteSet](#/en/loadbalancer/20170115/PathRouteSet/UpdatePathRouteSet) operation. + operationId: DeletePathRouteSet + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the path route set to delete. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the path route set to delete. + + Example: `example_path_route_set` + in: path + name: pathRouteSetName + required: true + schema: + type: string + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: DeletePathRouteSet + tags: + - loadBalancer + x-example: | + DELETE /20170115/loadBalancers/<load_balancer_OCID>/pathRouteSets/<path_route_set_name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + get: + deprecated: true + description: Gets the specified path route set's configuration information. + operationId: GetPathRouteSet + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the path route set to retrieve. + + Example: `example_path_route_set` + in: path + name: pathRouteSetName + required: true + schema: + type: string + responses: + '200': + description: The path route set information is being retrieved. + 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/PathRouteSet' + '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/DefaultError' + summary: GetPathRouteSet + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancers/<load_balancer_OCID>/pathRouteSets/<path_route_set_name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + deprecated: true + description: | + Overwrites an existing path route set on the specified load balancer. Use this operation to add, delete, or alter + path route rules in a path route set. + + To add a new path route rule to a path route set, the `pathRoutes` in the + [UpdatePathRouteSetDetails](#/en/loadbalancer/20170115/requests/UpdatePathRouteSetDetails) object must include + both the new path route rule to add and the existing path route rules to retain. + operationId: UpdatePathRouteSet + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - $ref: '#/components/parameters/RetryTokenHeader' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the path route set to update. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the path route set to update. + + Example: `example_path_route_set` + in: path + name: pathRouteSetName + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePathRouteSetDetails' + description: The configuration details to update a path route set. + required: true + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: UpdatePathRouteSet + tags: + - loadBalancer + x-example: | + PUT /20170115/loadBalancers/<load_balancer_OCID>/pathRouteSets/<path_route_set_name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + { + "pathRoutes": [ + { + "path": "/example/video/123", + "pathMatchType": { + "matchType": "EXACT_MATCH" + }, + "backendSetName": "example_backend_set" + } + ] + } + /loadBalancers/{loadBalancerId}/routingPolicies: + get: + description: Lists all routing policies associated with the specified load balancer. + operationId: ListRoutingPolicies + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the routing policies. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. + For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + + Example: `50` + in: query + name: limit + required: false + schema: + type: integer + format: int64 + default: 10 + - description: | + For list pagination. The value of the `opc-next-page` response header from the previous "List" call. + For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + + Example: `3` + in: query + name: page + required: false + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListRoutingPoliciesResponse' + '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/DefaultError' + summary: ListRoutingPolicies + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancers/<load_balancer_OCID>/routingPolicies + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + post: + description: | + Adds a routing policy to a load balancer. For more information, see + [Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm). + operationId: CreateRoutingPolicy + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - $ref: '#/components/parameters/RetryTokenHeader' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to add the routing policy rule list to. + in: path + name: loadBalancerId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateRoutingPolicyDetails' + description: The details of the routing policy rules to add. + required: true + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: CreateRoutingPolicy + tags: + - loadBalancer + x-example: | + POST /20170115/loadBalancers/<load_balancer_OCID>/routingPolicies + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + { + "name": "example_routing_rules", + "conditionLanguageVersion": "V1", + "rules": [ + { + "name": "HR_mobile_user_rule", + "condition" : "all(http.request.headers[(i 'user-agent')] eq (i 'mobile'), http.request.url.query[(i 'department')] eq (i 'HR'))", + "actions": [{ + "name": "FORWARD_TO_BACKENDSET", + "backendSetName": "backendSetForHRMobileUsers" + }] + }, + { + "name": "Documents_rule", + "condition" : "any(http.request.url.path eq (i '/documents'), http.request.headers[(i 'host')] eq (i 'doc.myapp.com'))", + "actions": [{ + "name": "FORWARD_TO_BACKENDSET", + "backendSetName": "backendSetForDocuments" + }] + } + ] + } + /loadBalancers/{loadBalancerId}/routingPolicies/{routingPolicyName}: + delete: + description: | + Deletes a routing policy from the specified load balancer. + + To delete a routing rule from a routing policy, use the + [UpdateRoutingPolicy](#/en/loadbalancer/20170115/RoutingPolicies/UpdateRoutingPolicy) operation. + operationId: DeleteRoutingPolicy + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the routing policy to delete. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the routing policy to delete. + + Example: `example_routing_policy` + in: path + name: routingPolicyName + required: true + schema: + type: string + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: DeleteRoutingPolicy + tags: + - loadBalancer + x-example: | + DELETE /20170115/loadBalancers/<load_balancer_OCID>/routingPolicies/<routing_policy_name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + get: + description: Gets the specified routing policy. + operationId: GetRoutingPolicy + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the routing policy to retrieve. + + Example: `example_routing_policy` + in: path + name: routingPolicyName + required: true + schema: + type: string + responses: + '200': + description: The routing policy requested. + 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/RoutingPolicy' + '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/DefaultError' + summary: GetRoutingPolicy + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancers/<load_balancer_OCID>/routingPolicies/<routing_policy_name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Overwrites an existing routing policy on the specified load balancer. Use this operation to add, delete, or alter + routing policy rules in a routing policy. + + To add a new routing rule to a routing policy, the body must include both the new routing rule to add and the existing rules to retain. + operationId: UpdateRoutingPolicy + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - $ref: '#/components/parameters/RetryTokenHeader' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the routing policy to update. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the routing policy to update. + + Example: `example_routing_policy_name` + in: path + name: routingPolicyName + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateRoutingPolicyDetails' + description: The configuration details needed to update a routing policy. + required: true + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: UpdateRoutingPolicy + tags: + - loadBalancer + x-example: | + PUT /20170115/loadBalancers/<load_balancer_OCID>/routingPolicies/<routing_policy_name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + { + "rules": [ + { + "name": "HR_mobile_user_rule", + "condition": "all(http.request.headers[(i 'user-agent')] eq (i 'mobile'), http.request.url.query[(i 'department')] eq (i 'HR'))", + "actions": [{ + "name": "FORWARD_TO_BACKENDSET", + "backendSetName": "backendSetForHRMobileUsers" + }] + } + ] + } + /loadBalancers/{loadBalancerId}/ruleSets: + get: + description: Lists all rule sets associated with the specified load balancer. + operationId: ListRuleSets + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer. + in: path + name: loadBalancerId + required: true + schema: + type: string + responses: + '200': + description: The set of rules is being retrieved. + 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/ListRuleSetsResponse' + '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/DefaultError' + summary: ListRuleSets + tags: + - loadBalancer + x-example: | + GET /20170115//loadBalancers/<load_balancer_OCID>/ruleSets + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + post: + description: | + Creates a new rule set associated with the specified load balancer. For more information, see + [Managing Rule Sets](/Content/Balance/Tasks/managingrulesets.htm). + operationId: CreateRuleSet + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - $ref: '#/components/parameters/RetryTokenHeader' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer. + in: path + name: loadBalancerId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateRuleSetDetails' + description: The configuration details for the rule set to create. + required: true + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: CreateRuleSet + tags: + - loadBalancer + x-example: | + POST /20170115//loadBalancers/<load_balancer_OCID>/ruleSets + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + { + "name": "example_rule_set", + "items": [ + { + "action": "ADD_REQUEST_HEADER", + "header": "example_header_name", + "value": "example_value" + }, + { + "action": "EXTEND_HTTP_REQUEST_HEADER_VALUE", + "header": "example_header_name2", + "prefix": "example_prefix_value", + "suffix": "example_suffix_value" + } + ] + } + /loadBalancers/{loadBalancerId}/ruleSets/{ruleSetName}: + delete: + description: | + Deletes a rule set from the specified load balancer. + + To delete a rule from a rule set, use the + [UpdateRuleSet](#/en/loadbalancer/20170115/RuleSet/UpdateRuleSet) operation. + operationId: DeleteRuleSet + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the rule set to delete. + + Example: `example_rule_set` + in: path + name: ruleSetName + required: true + schema: + type: string + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: DeleteRuleSet + tags: + - loadBalancer + x-example: | + DELETE /20170115/loadBalancers/<load_balancer_OCID>/ruleSets/<rule_set_name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + get: + description: Gets the specified set of rules. + operationId: GetRuleSet + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the rule set to retrieve. + + Example: `example_rule_set` + in: path + name: ruleSetName + required: true + schema: + type: string + responses: + '200': + description: The rule set is being retrieved. + 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/RuleSet' + '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/DefaultError' + summary: GetRuleSet + tags: + - loadBalancer + x-example: | + GET /20170115//loadBalancers/<load_balancer_OCID>/ruleSets/<rule_set_name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Overwrites an existing set of rules on the specified load balancer. Use this operation to add or alter + the rules in a rule set. + + To add a new rule to a set, the body must include both the new rule to add and the existing rules to retain. + operationId: UpdateRuleSet + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - $ref: '#/components/parameters/RetryTokenHeader' + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer. + in: path + name: loadBalancerId + required: true + schema: + type: string + - description: | + The name of the rule set to update. + + Example: `example_rule_set` + in: path + name: ruleSetName + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateRuleSetDetails' + description: The configuration details to update a set of rules. + required: true + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: UpdateRuleSet + tags: + - loadBalancer + x-example: | + PUT /20170115/loadBalancers/<load_balancer_OCID>/ruleSets/<rule_set_name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + { + "items": [ + { + "action": "ADD_REQUEST_HEADER", + "header": "example_header_name", + "value": "example_value" + }, + { + "action": "EXTEND_HTTP_REQUEST_HEADER_VALUE", + "header": "example_header_name2", + "prefix": "example_prefix_value", + "suffix": "example_suffix_value" + } + ] + } + /loadBalancers/{loadBalancerId}/sslCipherSuites: + get: + description: Lists all SSL cipher suites associated with the specified load balancer. + operationId: ListSSLCipherSuites + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/LoadBalancerIdPathParam' + responses: + '200': + description: The list is being retrieved. + 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/ListSSLCipherSuitesResponse' + '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/DefaultError' + summary: ListSSLCipherSuites + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancers/<load_balancer_OCID>/sslCipherSuites + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + post: + description: Creates a custom SSL cipher suite. + operationId: CreateSSLCipherSuite + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/LoadBalancerIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateSSLCipherSuiteDetails' + description: The details of the SSL cipher suite to add. + required: true + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: CreateSSLCipherSuite + tags: + - loadBalancer + x-example: | + POST /20170115/loadBalancers/<load_balancer_OCID>/sslCipherSuites + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "ciphers": ["ECDHE-RSA-AES256-GCM-SHA384", "ECDHE-ECDSA-AES256-GCM-SHA384", "ECDHE-RSA-AES128-GCM-SHA256"], + "name": "example_cipher_suite" + } + /loadBalancers/{loadBalancerId}/sslCipherSuites/{name}: + delete: + description: Deletes an SSL cipher suite from a load balancer. + operationId: DeleteSSLCipherSuite + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/LoadBalancerIdPathParam' + - description: | + The name of the SSL cipher suite to delete. + + example: `example_cipher_suite` + in: path + name: name + required: true + schema: + type: string + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: DeleteSSLCipherSuite + tags: + - loadBalancer + x-example: | + DELETE /20170115/loadBalancers/<load_balancer_OCID>/sslCipherSuites/<name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + get: + description: Gets the specified SSL cipher suite's configuration information. + operationId: GetSSLCipherSuite + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/LoadBalancerIdPathParam' + - description: | + The name of the SSL cipher suite to retrieve. + + example: `example_cipher_suite` + in: path + name: name + required: true + schema: + type: string + responses: + '200': + description: The SSL cipher suite's configuration information is being retrieved. + 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/SSLCipherSuite' + '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/DefaultError' + summary: GetSSLCipherSuite + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancers/<load_balancer_OCID>/sslCipherSuites/<name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: Updates an existing SSL cipher suite for the specified load balancer. + operationId: UpdateSSLCipherSuite + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/LoadBalancerIdPathParam' + - description: | + The name of the SSL cipher suite to update. + + example: `example_cipher_suite` + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSSLCipherSuiteDetails' + description: The configuration details to update an SSL cipher suite. + required: true + responses: + '204': + description: The request was accepted for processing. + 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](/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + '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/DefaultError' + summary: UpdateSSLCipherSuite + tags: + - loadBalancer + x-example: | + PUT /20170115/loadBalancers/<load_balancer_OCID>/sslCipherSuites/<name> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "ciphers": ['ECDHE-ECDSA-AES128-GCM-SHA256','ECDHE-RSA-AES128-GCM-SHA256'] + } + /loadBalancers/{loadBalancerId}/updateShape: + put: + description: | + Update the shape of a load balancer. The new shape can be larger or smaller compared to existing shape of the + LB. The service will try to perform this operation in the least disruptive way to existing connections, but + there is a possibility that they might be lost during the LB resizing process. The new shape becomes effective + as soon as the related work request completes successfully, i.e. when reshaping to a larger shape, the LB will + start accepting larger bandwidth and when reshaping to a smaller one, the LB will be accepting smaller + bandwidth. + operationId: UpdateLoadBalancerShape + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - $ref: '#/components/parameters/RetryTokenHeader' + - description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the load balancer whose shape will be updated. + in: path + name: loadBalancerId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateLoadBalancerShapeDetails' + description: The details for updating a load balancer's shape. This contains the new, desired shape. + required: true + responses: + '204': + description: The request to change the load balancer to a different shape was accepted for processing. + 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 work request. + schema: + type: string + '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/DefaultError' + summary: UpdateLoadBalancerShape + tags: + - loadBalancer + x-example: | + PUT /20170115/loadBalancers/<load_balancer_OCID>/updateShape + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + { + "shapeName": "Flexible", + "shapeDetails": { + "minimumBandwidthInMbps": 150, + "maximumBandwidthInMbps": 1500 + } + } + x-related-resource: '#/definitions/LoadBalancer' + /loadBalancers/{loadBalancerId}/workRequests: + get: + description: Lists the work requests for a given load balancer. + operationId: ListWorkRequests + parameters: + - description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + default: '' + - description: | + For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. + For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + + Example: `50` + in: query + name: limit + required: false + schema: + type: integer + format: int64 + default: 100 + - description: | + For list pagination. The value of the `opc-next-page` response header from the previous "List" call. + For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + + Example: `3` + in: query + name: page + required: false + schema: + type: string + - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the work requests to retrieve. + in: path + name: loadBalancerId + required: true + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListWorkRequestsResponse' + '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/DefaultError' + summary: ListWorkRequests + tags: + - loadBalancer + x-example: | + GET /20170115/loadBalancers/<load_balancer_OCID>/workRequests + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> +components: + schemas: + LoadBalancerHealthSummary: + description: A health status summary for the specified load balancer. + properties: + loadBalancerId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer the health status is associated with. + type: string + status: + description: | + The overall health status of the load balancer. + + * **OK:** All backend sets associated with the load balancer return a status of `OK`. + + * **WARNING:** At least one of the backend sets associated with the load balancer returns a status of `WARNING`, + no backend sets return a status of `CRITICAL`, and the load balancer life cycle state is `ACTIVE`. + + * **CRITICAL:** One or more of the backend sets associated with the load balancer return a status of `CRITICAL`. + + * **UNKNOWN:** If any one of the following conditions is true: + + * The load balancer life cycle state is not `ACTIVE`. + + * No backend sets are defined for the load balancer. + + * More than half of the backend sets associated with the load balancer return a status of `UNKNOWN`, none of the backend + sets return a status of `WARNING` or `CRITICAL`, and the load balancer life cycle state is `ACTIVE`. + + * The system could not retrieve metrics for any reason. + enum: + - OK + - WARNING + - CRITICAL + - UNKNOWN + type: string + required: + - loadBalancerId + - status + type: object + x-example: | + { + "loadBalancerId": "ocid1.loadbalancer.oc1.phx.<unique_ID>", + "status": "OK" + } + LoadBalancerPolicy: + description: | + A policy that determines how traffic is distributed among backend servers. + For more information on load balancing policies, see + [How Load Balancing Policies Work](/Content/Balance/Reference/lbpolicies.htm). + properties: + name: + description: | + The name of a load balancing policy. + + Example: 'LEAST_CONNECTIONS' + type: string + required: + - name + type: object + x-example: | + { + "name": "LEAST_CONNECTIONS" + } + LoadBalancerProtocol: + description: A protocol that defines the type of traffic accepted by a listener. + properties: + name: + description: | + The name of a protocol. + + Example: 'HTTP' + type: string + required: + - name + type: object + x-example: | + { + "name": "HTTP" + } + LoadBalancerShape: + description: | + A shape is a template that determines the total pre-provisioned bandwidth (ingress plus egress) for the + load balancer. + + Note that the pre-provisioned maximum capacity applies to aggregated connections, not to a single client + attempting to use the full bandwidth. + properties: + name: + description: | + The name of the shape. + + Example: `100Mbps` + type: string + required: + - name + type: object + x-example: | + { + "name": "100Mbps" + } + WorkRequest: + description: | + Many of the API requests you use to create and configure load balancing do not take effect immediately. + In these cases, the request spawns an asynchronous work flow to fulfill the request. WorkRequest objects provide visibility + for in-progress work flows. + For more information about work requests, see [Viewing the State of a Work Request](/Content/Balance/Tasks/viewingworkrequest.htm). + properties: + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer. + type: string + errorDetails: + items: + $ref: '#/components/schemas/WorkRequestError' + type: array + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. + type: string + lifecycleState: + description: | + The current state of the work request. + enum: + - ACCEPTED + - IN_PROGRESS + - FAILED + - SUCCEEDED + type: string + loadBalancerId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer with which the work request + is associated. + type: string + message: + description: | + A collection of data, related to the load balancer provisioning process, that helps with debugging in the event of failure. + Possible data elements include: + + - workflow name + - event ID + - work request ID + - load balancer ID + - workflow completion message + type: string + timeAccepted: + description: | + The date and time the work request was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeFinished: + description: | + The date and time the work request was completed, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + type: + description: | + The type of action the work request represents. + + Example: `CreateListener` + type: string + required: + - errorDetails + - id + - lifecycleState + - loadBalancerId + - message + - timeAccepted + - type + type: object + x-example: | + { + "id": "ocid1.loadbalancerworkrequest.oc1.phx.<unique_ID>", + "loadBalancerId": "ocid1.loadbalancer.oc1.phx.<unique_ID>", + "type": "CreateListener", + "lifecycleState": "SUCCEEDED", + "message": "OK", + "timeAccepted": "2018-02-12T23:46:06.346Z", + "timeFinished": "2018-02-12T23:46:06.346Z", + "errorDetails": [ ] + } + LoadBalancer: + description: | + The properties that define a load balancer. For more information, see + [Managing a Load Balancer](/Content/Balance/Tasks/managingloadbalancer.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + + For information about endpoints and signing API requests, see + [About the API](/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see + [SDKS and Other Tools](/Content/API/Concepts/sdks.htm). + properties: + backendSets: + additionalProperties: + $ref: '#/components/schemas/BackendSet' + type: object + certificates: + additionalProperties: + $ref: '#/components/schemas/Certificate' + type: object + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + A user-friendly name. It does not have to be unique, and it is changeable. + + Example: `example_load_balancer` + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + hostnames: + additionalProperties: + $ref: '#/components/schemas/Hostname' + type: object + id: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer. + type: string + ipAddresses: + description: | + An array of IP addresses. + items: + $ref: '#/components/schemas/IpAddress' + type: array + uniqueItems: true + ipMode: + default: IPV4 + description: | + Whether the load balancer has an IPv4 or IPv6 IP address. + + If "IPV4", the service assigns an IPv4 address and the load balancer supports IPv4 traffic. + + If "IPV6", the service assigns an IPv6 address and the load balancer supports IPv6 traffic. + + Example: "ipMode":"IPV6" + enum: + - IPV4 + - IPV6 + type: string + isDeleteProtectionEnabled: + description: | + Whether or not the load balancer has delete protection enabled. + + If "true", the loadbalancer will be protected against deletion if configured to accept traffic. + + If "false", the loadbalancer will not be protected against deletion. + + Delete protection is not be enabled unless this field is set to "true". + Example: `true` + type: boolean + isPrivate: + description: | + Whether the load balancer has a VCN-local (private) IP address. + + If "true", the service assigns a private IP address to the load balancer. + + If "false", the service assigns a public IP address to the load balancer. + + A public load balancer is accessible from the internet, depending on your VCN's + [security list rules](/Content/Network/Concepts/securitylists.htm). For more information about public and + private load balancers, see [How Load Balancing Works](/Content/Balance/Concepts/balanceoverview.htm#how-load-balancing-works). + + Example: `true` + type: boolean + isRequestIdEnabled: + description: | + Whether or not the load balancer has the Request Id feature enabled for HTTP listeners. + + If "true", the load balancer will attach a unique request id header to every request + passed through from the load balancer to load balancer backends. This same request id + header also will be added to the response the lb received from the backend handling + the request before the load balancer returns the response to the requestor. The name + of the unique request id header is set the by value of requestIdHeader. + + If "false", the loadbalancer not add this unique request id header to either the request + passed through to the load balancer backends nor to the reponse returned to the user. + + Example: `true` + type: boolean + lifecycleState: + description: | + The current state of the load balancer. + enum: + - CREATING + - FAILED + - ACTIVE + - DELETING + - DELETED + type: string + listeners: + additionalProperties: + $ref: '#/components/schemas/Listener' + type: object + networkSecurityGroupIds: + description: | + An array of NSG [OCIDs](/Content/General/Concepts/identifiers.htm) associated with the load + balancer. + + During the load balancer's creation, the service adds the new load balancer to the specified NSGs. + + The benefits of associating the load balancer with NSGs include: + + * NSGs define network security rules to govern ingress and egress traffic for the load balancer. + + * The network security rules of other resources can reference the NSGs associated with the load balancer + to ensure access. + + Example: ["ocid1.nsg.oc1.phx.unique_ID"] + items: + maxLength: 256 + minLength: 1 + type: string + minItems: 0 + type: array + pathRouteSets: + additionalProperties: + $ref: '#/components/schemas/PathRouteSet' + type: object + requestIdHeader: + description: | + If isRequestIdEnabled is true then this field contains the name of the header field + that contains the unique request id that is attached to every request from + the load balancer to the load balancer backends and to every response from the load + balancer. + + If a request to the load balancer already contains a header with same name as specified + in requestIdHeader then the load balancer will not change the value of that field. + + If this field is set to "" this field defaults to X-Request-Id. + maxLength: 255 + pattern: ^(X-(-?[a-zA-Z_0-9])*)?$ + type: string + routingPolicies: + additionalProperties: + $ref: '#/components/schemas/RoutingPolicy' + type: object + ruleSets: + additionalProperties: + $ref: '#/components/schemas/RuleSet' + type: object + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Multiple key-value pairs of the tag. + + Example: {"value":"42","mode":"audit", "usagetype" : "zpr"} + (opaque JSON object) + type: string + description: | + Key-value pair representing a max egress count and ZPR tag attributes + + Example: `{"MaxEgressCount": {"value":"42","mode":"audit", "usagetype" : "zpr"}}` + type: object + description: | + Extended Defined tags for ZPR for this resource. Each key is predefined and scoped to a namespace. + + Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit", "usagetype" : "zpr"}}}` + type: object + shapeDetails: + $ref: '#/components/schemas/ShapeDetails' + shapeName: + description: | + A template that determines the total pre-provisioned bandwidth (ingress plus egress). + To get a list of available shapes, use the [ListShapes](#/en/loadbalancer/20170115/LoadBalancerShape/ListShapes) + operation. + + Example: `100Mbps` + type: string + sslCipherSuites: + additionalProperties: + $ref: '#/components/schemas/SSLCipherSuite' + type: object + subnetIds: + description: An array of subnet [OCIDs](/Content/General/Concepts/identifiers.htm). + items: + type: string + type: array + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined 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. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + System tags can be viewed by users, but can only be created by the system. + + Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + timeCreated: + description: | + The date and time the load balancer was created, in the format defined by RFC3339. + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - lifecycleState + - displayName + - shapeName + - timeCreated + type: object + x-example: | + { + "id": "ocid1.loadbalancer.oc1.phx.<unique_ID>", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "example_load_balancer", + "lifecycleState": "ACTIVE", + "ipMode": "IPV6" + "timeCreated": "2016-08-25T21:10:29.600Z", + "ipAddresses": [ + { + "ipAddress": "192.168.0.3", + "isPublic": false + } + ], + "shapeName": "Flexible", + "shapeDetails": { + "minimumBandwidthInMbps": 100, + "maximumBandwidthInMbps": 1000 + } + "isPrivate": true, + "isDeleteProtectionEnabled": true, + "isRequestIdEnabled": true, + "requestIdHeader": "X-Request-Id", + "listeners": { + "exampleListener": { + "defaultBackendSetName": "example_backend_set", + "port": 80, + "protocol": "HTTP", + "pathRouteSetName": "example_path_route_set", + "sslConfiguration": { + "protocols": ["TLSv1.1", "TLSv1.2"], + "cipherSuiteName" : "example_cipher_suite", + "serverOrderPreference" : "ENABLED", + "certificateName": "example_certificate_bundle", + "verifyPeerCertificate": true, + "verifyDepth": 3 + }, + "connectionConfiguration": { + "idleTimeout": 1200 + } + } + }, + "hostnames": { + "example_hostname_001: { + "name": "example_hostname_001", + "hostname": "app.example.com" + }, + "example_hostname_002: { + "name": "example_hostname_002", + "hostname": "app.example.*" + } + } + "backendSets": { + "example_backend_set": { + "policy": "LEAST_CONNECTIONS", + "backends": [ + { + "ipAddress": "10.0.0.3", + "port": 8080, + "weight": 3, + "backup": false, + "drain": false, + "offline": false + }, + { + "ipAddress": "10.0.0.4", + "port": 8080, + "weight": 1, + "backup": false, + "drain": false, + "offline": false + } + ], + "healthChecker": { + "protocol": "HTTP", + "isForcePlainText": false, + "urlPath": "/healthcheck", + "port": 8080, + "returnCode": 200, + "retries": 3, + "timeoutInMillis": 3000, + "intervalInMillis": 10000, + "responseBodyRegex": "^((?!false).|\s)*$" + }, + "sslConfiguration": { + "protocols": ["TLSv1.1", "TLSv1.2"], + "cipherSuiteName" : "example_cipher_suite", + "serverOrderPreference" : "ENABLED", + "certificateName": "example_certificate_bundle", + "verifyPeerCertificate": true, + "verifyDepth": 3 + }, + "sessionPersistenceConfiguration": { + "cookieName": "example_cookie", + "disableFallback": false + } + }, + }, + "subnetIds": [ + "ocid1.subnet.oc1.phx.<unique_ID>" + ], + "sslCipherSuites": { + "example_cipher_suite": { + "ciphers": [ + "ECDHE-ECDSA-AES128-GCM-SHA256", + "ECDHE-ECDSA-AES128-SHA256", + "ECDHE-RSA-AES128-GCM-SHA256" + ], + "name": "example_cipher_suite" + } + }, + "certificates": { + "example_certificate_bundle": { + "passphrase": "<passphrase>", + "privateKey": "<private_key>", + "publicCertificate": "<public_certificate>", + "caCertificate": "<ca_certificate>", + "certificateName": "example_certificate_bundle" + } + }, + "pathRouteSets": { + "example_path_route_set": { + "pathRoutes": [ + { + "path": "/example/video/123", + "pathMatchType": { + "matchType": "EXACT_MATCH" + }, + "backendSetName": "example_backend_set" + } + ] + } + } + } + CreateLoadBalancerDetails: + description: | + The configuration details for creating a load balancer. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + backendSets: + additionalProperties: + $ref: '#/components/schemas/BackendSetDetails' + type: object + certificates: + additionalProperties: + $ref: '#/components/schemas/CertificateDetails' + type: object + compartmentId: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which to create the load balancer. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + A user-friendly name. It does not have to be unique, and it is changeable. + Avoid entering confidential information. + + Example: `example_load_balancer` + maxLength: 1024 + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + hostnames: + additionalProperties: + $ref: '#/components/schemas/HostnameDetails' + type: object + ipMode: + default: IPV4 + description: | + Whether the load balancer has an IPv4 or IPv6 IP address. + + If "IPV4", the service assigns an IPv4 address and the load balancer supports IPv4 traffic. + + If "IPV6", the service assigns an IPv6 address and the load balancer supports IPv6 traffic. + + Example: "ipMode":"IPV6" + enum: + - IPV4 + - IPV6 + type: string + ipv6SubnetCidr: + description: | + Applies to IPV6 LB creation only. + + Used to disambiguate which subnet prefix should be used to create an IPv6 LB. + + Example: "2002::1234:abcd:ffff:c0a8:101/64" + maxLength: 255 + minLength: 1 + type: string + isDeleteProtectionEnabled: + default: false + description: | + Whether or not the load balancer has delete protection enabled. + + If "true", the loadbalancer will be protected against deletion if configured to accept traffic. + + If "false", the loadbalancer will not be protected against deletion. + + Delete protection will not be enabled unless a value of "true" is provided. + Example: `true` + type: boolean + isPrivate: + default: false + description: | + Whether the load balancer has a VCN-local (private) IP address. + + If "true", the service assigns a private IP address to the load balancer. + + If "false", the service assigns a public IP address to the load balancer. + + A public load balancer is accessible from the internet, depending on your VCN's + [security list rules](/Content/Network/Concepts/securitylists.htm). For more information about public and + private load balancers, see [How Load Balancing Works](/Content/Balance/Concepts/balanceoverview.htm#how-load-balancing-works). + + Example: `true` + type: boolean + isRequestIdEnabled: + default: false + description: | + Whether or not the load balancer has the Request Id feature enabled for HTTP listeners. + + If "true", the load balancer will attach a unique request id header to every request + passed through from the load balancer to load balancer backends. This same request id + header also will be added to the response the lb received from the backend handling + the request before the load balancer returns the response to the requestor. The name + of the unique request id header is set the by value of requestIdHeader. + + If "false", the loadbalancer not add this unique request id header to either the request + passed through to the load balancer backends nor to the reponse returned to the user. + + New load balancers have the Request Id feature disabled unless isRequestIdEnabled is set to true. + + Example: `true` + type: boolean + listeners: + additionalProperties: + $ref: '#/components/schemas/ListenerDetails' + type: object + networkSecurityGroupIds: + description: | + An array of NSG [OCIDs](/Content/General/Concepts/identifiers.htm) associated with this load balancer. + + During the load balancer's creation, the service adds the new load balancer to the specified NSGs. + + The benefits of using NSGs with the load balancer include: + + * NSGs define network security rules to govern ingress and egress traffic for the load balancer. + + * The network security rules of other resources can reference the NSGs associated with the load balancer + to ensure access. + + Example: `["ocid1.nsg.oc1.phx.unique_ID"]` + items: + maxLength: 256 + minLength: 1 + type: string + maxItems: 5 + minItems: 0 + type: array + pathRouteSets: + additionalProperties: + $ref: '#/components/schemas/PathRouteSetDetails' + type: object + requestIdHeader: + default: X-Request-Id + description: | + If isRequestIdEnabled is true then this field contains the name of the header field + that contains the unique request id that is attached to every request from + the load balancer to the load balancer backends and to every response from the load + balancer. + + If a request to the load balancer already contains a header with same name as specified + in requestIdHeader then the load balancer will not change the value of that field. + + If isRequestIdEnabled is false then this field is ignored. + + If this field is not set or is set to "" then this field defaults to X-Request-Id + + **Notes:** + * Unless the header name is "" it must start with "X-" prefix. + * Setting the header name to "" will set it to the default: X-Request-Id. + maxLength: 255 + pattern: ^(X-(-?[a-zA-Z_0-9])*)?$ + type: string + reservedIps: + description: | + An array of reserved Ips. + items: + $ref: '#/components/schemas/ReservedIP' + maxItems: 2 + minItems: 0 + type: array + ruleSets: + additionalProperties: + $ref: '#/components/schemas/RuleSetDetails' + type: object + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Multiple key-value pairs of the tag. + + Example: {"value":"42","mode":"audit", "usagetype" : "zpr"} + (opaque JSON object) + type: string + description: | + Key-value pair representing a max egress count and ZPR tag attributes + + Example: `{"MaxEgressCount": {"value":"42","mode":"audit", "usagetype" : "zpr"}}` + type: object + description: | + Extended Defined tags for ZPR for this resource. Each key is predefined and scoped to a namespace. + + Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit", "usagetype" : "zpr"}}}` + type: object + shapeDetails: + $ref: '#/components/schemas/ShapeDetails' + shapeName: + description: | + A template that determines the total pre-provisioned bandwidth (ingress plus egress). + To get a list of available shapes, use the [ListShapes](#/en/loadbalancer/20170115/LoadBalancerShape/ListShapes) + operation. + + Example: `flexible` + NOTE: After May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape + allowed would be `Flexible` + type: string + sslCipherSuites: + additionalProperties: + $ref: '#/components/schemas/SSLCipherSuiteDetails' + type: object + subnetIds: + description: An array of subnet [OCIDs](/Content/General/Concepts/identifiers.htm). + items: + maxLength: 255 + minLength: 1 + type: string + type: array + required: + - compartmentId + - displayName + - shapeName + - subnetIds + type: object + x-example: | + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "example_load_balancer", + "shapeName": "Flexible", + "shapeDetails": { + "minimumBandwidthInMbps": 100, + "maximumBandwidthInMbps": 1000 + } + "isPrivate": true, + "ipMode": "IPV6", + "reservedIps":[{ + "id": "ocid1.floatingip.oc1.phx.<unique_ID>" + }] + "listeners": { + "exampleListener": { + "defaultBackendSetName": "example_backend_set", + "port": 80, + "protocol": "HTTP", + "pathRouteSetName": "example_path_route_set", + "sslConfiguration": { + "protocols": ["TLSv1.1", "TLSv1.2"], + "cipherSuiteName" : "example_cipher_suite", + "serverOrderPreference" : "ENABLED", + "certificateName": "example_certificate_bundle", + "verifyPeerCertificate": true, + "verifyDepth": 3 + }, + "connectionConfiguration": { + "idleTimeout": 1200 + } + } + }, + "hostnames": { + "example_hostname_001: { + "name": "example_hostname_001", + "hostname": "app.example.com" + }, + "example_hostname_002: { + "name": "example_hostname_002", + "hostname": "app.example.*" + } + } + "backendSets": { + "example_backend_set": { + "policy": "LEAST_CONNECTIONS", + "backends": [ + { + "ipAddress": "10.0.0.3", + "port": 8080, + "weight": 3, + "backup": false, + "drain": false, + "offline": false + }, + { + "ipAddress": "10.0.0.4", + "port": 8080, + "weight": 1, + "backup": false, + "drain": false, + "offline": false + } + ], + "healthChecker": { + "protocol": "HTTP", + "isForcePlainText": false, + "urlPath": "/healthcheck", + "port": 8080, + "returnCode": 200, + "retries": 3, + "timeoutInMillis": 3000, + "intervalInMillis": 10000, + "responseBodyRegex": "^((?!false).|\s)*$" + }, + "sslConfiguration": { + "protocols": ["TLSv1.1", "TLSv1.2"], + "cipherSuiteName" : "example_cipher_suite", + "serverOrderPreference" : "ENABLED", + "certificateName": "example_certificate_bundle", + "verifyPeerCertificate": true, + "verifyDepth": 3 + }, + "sessionPersistenceConfiguration": { + "cookieName": "example_cookie", + "disableFallback": false + } + }, + }, + "sslCipherSuites": { + "example_cipher_suite": { + "ciphers": [ + "ECDHE-ECDSA-AES128-GCM-SHA256", + "ECDHE-ECDSA-AES128-SHA256", + "ECDHE-RSA-AES128-GCM-SHA256" + ], + "name": "example_cipher_suite" + } + }, + "certificates": { + "example_certificate_bundle": { + "passphrase": "<passphrase>", + "privateKey": "<private_key>", + "publicCertificate": "<public_certificate>", + "caCertificate": "<ca_certificate>", + "certificateName": "example_certificate_bundle" + } + }, + "pathRouteSets": { + "example_path_route_set": { + "pathRoutes": [ + { + "path": "/example/video/123", + "pathMatchType": { + "matchType": "EXACT_MATCH" + }, + "backendSetName": "example_backend_set" + } + ] + } + }, + "isRequestIdEnabled": true, + "requestIdHeader": "X-Request-Id", + "ruleSets": { + "example_rule_set": { + "items": [ + { + "action": "ADD_REQUEST_HEADER", + "header": "example_header_name", + "value": "example_value" + }, + { + "action": "EXTEND_HTTP_REQUEST_HEADER_VALUE", + "header": "example_header_name2", + "prefix": "example_prefix_value", + "suffix": "example_suffix_value" + } + ] + } + } + }, + "networkSecurityGroupIds": [ + "ocid1.nsg.oc1.phx.<unique_ID>" + ], + "subnetIds": [ + "ocid1.subnet.oc1.phx.<unique_ID>" + ] + } + UpdateLoadBalancerDetails: + description: | + Configuration details to update a load balancer. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + The user-friendly display name for the load balancer. It does not have to be unique, and it is changeable. + Avoid entering confidential information. + + Example: `example_load_balancer` + maxLength: 1024 + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + ipMode: + default: IPV4 + description: | + Whether the load balancer has an IPv4 or IPv6 IP address. + + If "IPV4", the service assigns an IPv4 address and the load balancer supports IPv4 traffic. + + If "IPV6", the service assigns an IPv6 address and the load balancer supports IPv6 traffic. + + Example: "ipMode":"IPV6" + enum: + - IPV4 + - IPV6 + type: string + isDeleteProtectionEnabled: + description: | + Whether or not the load balancer has delete protection enabled. + + If "true", the loadbalancer will be protected against deletion if configured to accept traffic. + + If "false", the loadbalancer will not be protected against deletion. + + If null or unset, the value for delete protection will not be changed. + + Example: `true` + type: boolean + isRequestIdEnabled: + description: | + Whether or not the load balancer has the Request Id feature enabled for HTTP listeners. + + If "true", the load balancer will attach a unique request id header to every request + passed through from the load balancer to load balancer backends. This same request id + header also will be added to the response the lb received from the backend handling + the request before the load balancer returns the response to the requestor. The name + of the unique request id header is set the by value of requestIdHeader. + + If "false", the loadbalancer not add this unique request id header to either the request + passed through to the load balancer backends nor to the reponse returned to the user. + + New load balancers have the Request Id feature enabled unless isRequestIdEnabled is set to False. + + Example: `true` + type: boolean + x-default-description: when unspecified, the current value of this field will be preserved + requestIdHeader: + description: | + If isRequestIdEnabled is true then this field contains the name of the header field + that contains the unique request id that is attached to every request from + the load balancer to the load balancer backends and to every response from the load + balancer. + + If a request to the load balancer already contains a header with same name as specified + in requestIdHeader then the load balancer will not change the value of that field. + + If isRequestIdEnabled is false then this field is ignored. + + **Notes:** + * Unless the header name is "" it must start with "X-" prefix. + * Setting the header name to "" will set it to the default: X-Request-Id. + maxLength: 255 + pattern: ^(X-(-?[a-zA-Z_0-9])*)?$ + type: string + x-default-description: when unspecified, the current value of this field will be preserved + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Multiple key-value pairs of the tag. + + Example: {"value":"42","mode":"audit", "usagetype" : "zpr"} + (opaque JSON object) + type: string + description: | + Key-value pair representing a max egress count and ZPR tag attributes + + Example: `{"MaxEgressCount": {"value":"42","mode":"audit", "usagetype" : "zpr"}}` + type: object + description: | + Extended Defined tags for ZPR for this resource. Each key is predefined and scoped to a namespace. + + Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit", "usagetype" : "zpr"}}}` + type: object + type: object + x-example: | + { + "isDeleteProtectionEnabled": true, + "isRequestIdEnabled": true, + "requestIdHeader": "X-Request-Id", + "ipMode": "IPV6" + "displayName": "example_load_balancer" + } + BackendSet: + description: | + The configuration of a load balancer backend set. + For more information on backend set configuration, see + [Managing Backend Sets](/Content/Balance/Tasks/managingbackendsets.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + backendMaxConnections: + description: | + The maximum number of simultaneous connections the load balancer can make to any backend + in the backend set unless the backend has its own maxConnections setting. If this is not + set or set to 0 then the number of simultaneous connections the load balancer can make + to any backend in the backend set unless the backend has its own maxConnections setting + is unlimited. + + Example: `300` + format: int32 + type: integer + backends: + items: + $ref: '#/components/schemas/Backend' + type: array + uniqueItems: true + healthChecker: + $ref: '#/components/schemas/HealthChecker' + name: + description: | + A friendly name for the backend set. It must be unique and it cannot be changed. + + Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot + contain spaces. Avoid entering confidential information. + + Example: `example_backend_set` + type: string + policy: + description: | + The load balancer policy for the backend set. To get a list of available policies, use the + [ListPolicies](#/en/loadbalancer/20170115/LoadBalancerPolicy/ListPolicies) operation. + + Example: `LEAST_CONNECTIONS` + type: string + sessionPersistenceConfiguration: + $ref: '#/components/schemas/SessionPersistenceConfigurationDetails' + sslConfiguration: + $ref: '#/components/schemas/SSLConfiguration' + required: + - backends + - healthChecker + - name + - policy + type: object + x-example: | + { + "name": "example_backend_set", + "policy": "LEAST_CONNECTIONS", + "backends": [ + { + "ipAddress": "10.0.0.3", + "port": 8080, + "weight": 3, + "backup": false, + "drain": false, + "offline": false + }, + { + "ipAddress": "10.0.0.4", + "port": 8080, + "weight": 1, + "backup": false, + "drain": false, + "offline": false + } + ], + "backendMaxConnections": 300, + "healthChecker": { + "protocol": "HTTP", + "isForcePlainText": false, + "urlPath": "/healthcheck", + "port": 8080, + "returnCode": 200, + "retries": 3, + "timeoutInMillis": 3000, + "intervalInMillis": 10000, + "responseBodyRegex": "^((?!false).|\s)*$" + }, + "sslConfiguration": { + "protocols": ["TLSv1.1", "TLSv1.2"], + "cipherSuiteName" : "example_cipher_suite", + "serverOrderPreference" : "ENABLED", + "certificateName": "example_certificate_bundle", + "verifyPeerCertificate": true, + "verifyDepth": 3 + }, + "sessionPersistenceConfiguration": { + "cookieName": "example_cookie", + "disableFallback": false + } + } + CreateBackendSetDetails: + description: | + The configuration details for creating a backend set in a load balancer. + For more information on backend set configuration, see + [Managing Backend Sets](/Content/Balance/Tasks/managingbackendsets.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + backendMaxConnections: + description: | + The maximum number of simultaneous connections the load balancer can make to any backend + in the backend set unless the backend has its own maxConnections setting. If this is not + set or set to 0 then the number of simultaneous connections the load balancer can make + to any backend in the backend set unless the backend has its own maxConnections setting + is unlimited. + + If setting backendMaxConnections to some value other than 0 then that value must be greater + or equal to 256. + + Example: `300` + format: int32 + maximum: 65535 + minimum: 0 + type: integer + backends: + items: + $ref: '#/components/schemas/BackendDetails' + type: array + uniqueItems: true + healthChecker: + $ref: '#/components/schemas/HealthCheckerDetails' + name: + description: | + A friendly name for the backend set. It must be unique and it cannot be changed. + + Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot + contain spaces. Avoid entering confidential information. + + Example: `example_backend_set` + maxLength: 32 + minLength: 1 + type: string + policy: + description: | + The load balancer policy for the backend set. To get a list of available policies, use the + [ListPolicies](#/en/loadbalancer/20170115/LoadBalancerPolicy/ListPolicies) operation. + + Example: `LEAST_CONNECTIONS` + type: string + sessionPersistenceConfiguration: + $ref: '#/components/schemas/SessionPersistenceConfigurationDetails' + sslConfiguration: + $ref: '#/components/schemas/SSLConfigurationDetails' + required: + - healthChecker + - name + - policy + type: object + x-example: | + { + "name": "example_backend_set", + "policy": "LEAST_CONNECTIONS", + "backends": [ + { + "ipAddress": "10.0.0.3", + "port": 8080, + "weight": 3, + "backup": false, + "drain": false, + "offline": false + }, + { + "ipAddress": "10.0.0.4", + "port": 8080, + "weight": 1, + "backup": false, + "drain": false, + "offline": false + } + ], + "backendMaxConnections": 300, + "healthChecker": { + "protocol": "HTTP", + "isForcePlainText": false, + "urlPath": "/healthcheck", + "port": 8080, + "returnCode": 200, + "retries": 3, + "timeoutInMillis": 3000, + "intervalInMillis": 10000, + "responseBodyRegex": "^((?!false).|\s)*$" + }, + "sslConfiguration": { + "protocols": ["TLSv1.1", "TLSv1.2"], + "cipherSuiteName" : "example_cipher_suite", + "serverOrderPreference" : "ENABLED", + "certificateName": "example_certificate_bundle", + "verifyPeerCertificate": true, + "verifyDepth": 3 + }, + "sessionPersistenceConfiguration": { + "cookieName": "example_cookie", + "disableFallback": false + } + } + UpdateBackendSetDetails: + description: | + The configuration details for updating a load balancer backend set. + For more information on backend set configuration, see + [Managing Backend Sets](/Content/Balance/Tasks/managingbackendsets.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + backendMaxConnections: + description: | + The maximum number of simultaneous connections the load balancer can make to any backend + in the backend set unless the backend has its own maxConnections setting. If this is not + set or set to 0 then the number of simultaneous connections the load balancer can make + to any backend in the backend set unless the backend has its own maxConnections setting + is unlimited. + + If setting backendMaxConnections to some value other than 0 then that value must be greater + or equal to 256. + + Example: `300` + format: int32 + maximum: 65535 + minimum: 0 + type: integer + backends: + items: + $ref: '#/components/schemas/BackendDetails' + type: array + uniqueItems: true + healthChecker: + $ref: '#/components/schemas/HealthCheckerDetails' + policy: + description: | + The load balancer policy for the backend set. To get a list of available policies, use the + [ListPolicies](#/en/loadbalancer/20170115/LoadBalancerPolicy/ListPolicies) operation. + + Example: `LEAST_CONNECTIONS` + type: string + sessionPersistenceConfiguration: + $ref: '#/components/schemas/SessionPersistenceConfigurationDetails' + sslConfiguration: + $ref: '#/components/schemas/SSLConfigurationDetails' + required: + - policy + - backends + - healthChecker + type: object + x-example: | + { + "policy": "LEAST_CONNECTIONS", + "backends": [ + { + "ipAddress": "10.0.0.3", + "port": 8080, + "weight": 3, + "backup": false, + "drain": false, + "offline": false + }, + { + "ipAddress": "10.0.0.4", + "port": 8080, + "weight": 1, + "backup": false, + "drain": false, + "offline": false + } + ], + "backendMaxConnections": 300, + "healthChecker": { + "protocol": "HTTP", + "isForcePlainText": true, + "urlPath": "/healthcheck", + "port": 8080, + "returnCode": 200, + "retries": 3, + "timeoutInMillis": 3000, + "intervalInMillis": 10000, + "responseBodyRegex": "^((?!false).|\s)*$" + }, + "sslConfiguration": { + "certificateName": "example_certificate_bundle", + "verifyDepth": "3", + "verifyPeerCertificate": true + }, + "sessionPersistenceConfiguration": { + "cookieName": "example_cookie", + "disableFallback": false + } + } + Backend: + description: | + The configuration of a backend server that is a member of a load balancer backend set. + For more information, see [Managing Backend Servers](/Content/Balance/Tasks/managingbackendservers.htm). + properties: + backup: + default: false + description: | + Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress + traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy. + + **Note:** You cannot add a backend server marked as `backup` to a backend set that uses the IP Hash policy. + + Example: `false` + type: boolean + drain: + default: false + description: | + Whether the load balancer should drain this server. Servers marked "drain" receive no new + incoming traffic. + + Example: `false` + type: boolean + ipAddress: + description: | + The IP address of the backend server. + + Example: `10.0.0.3` + type: string + maxConnections: + description: | + The maximum number of simultaneous connections the load balancer can make to the backend. + If this is not set or set to 0 then the maximum number of simultaneous connections the + load balancer can make to the backend is unlimited. + + Example: `300` + format: int32 + type: integer + name: + description: | + A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. + + Example: `10.0.0.3:8080` + readOnly: true + type: string + offline: + default: false + description: | + Whether the load balancer should treat this server as offline. Offline servers receive no incoming + traffic. + + Example: `false` + type: boolean + port: + description: | + The communication port for the backend server. + + Example: `8080` + format: int32 + type: integer + weight: + description: | + The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger + proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections + as a server weighted '1'. + For more information on load balancing policies, see + [How Load Balancing Policies Work](/Content/Balance/Reference/lbpolicies.htm). + + Example: `3` + format: int32 + type: integer + required: + - backup + - drain + - ipAddress + - name + - offline + - port + - weight + type: object + x-example: | + { + "name": "example_backend", + "ipAddress": "10.0.0.3", + "port": 8080, + "weight": 3, + "maxConnections": 300, + "backup": false, + "drain": false, + "offline": false + } + CreateBackendDetails: + description: | + The configuration details for creating a backend server in a backend set. + For more information on backend server configuration, see + [Managing Backend Servers](/Content/Balance/Tasks/managingbackendservers.htm). + properties: + backup: + default: false + description: | + Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress + traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy. + + **Note:** You cannot add a backend server marked as `backup` to a backend set that uses the IP Hash policy. + + Example: `false` + type: boolean + drain: + default: false + description: | + Whether the load balancer should drain this server. Servers marked "drain" receive no new + incoming traffic. + + Example: `false` + type: boolean + ipAddress: + description: | + The IP address of the backend server. + + Example: `10.0.0.3` + type: string + maxConnections: + description: | + The maximum number of simultaneous connections the load balancer can make to the backend. + If this is not set or set to 0 then the maximum number of simultaneous connections the + load balancer can make to the backend is unlimited. + + If setting maxConnections to some value other than 0 then that value must be greater + or equal to 256. + + Example: `300` + format: int32 + maximum: 65535 + minimum: 0 + type: integer + offline: + default: false + description: | + Whether the load balancer should treat this server as offline. Offline servers receive no incoming + traffic. + + Example: `false` + type: boolean + port: + description: | + The communication port for the backend server. + + Example: `8080` + format: int32 + maximum: 65535 + minimum: 1 + type: integer + weight: + description: | + The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger + proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections + as a server weighted '1'. + For more information on load balancing policies, see + [How Load Balancing Policies Work](/Content/Balance/Reference/lbpolicies.htm). + + Example: `3` + format: int32 + type: integer + required: + - ipAddress + - port + type: object + x-example: | + { + "ipAddress": "10.0.0.3", + "port": 8080, + "weight": 3, + "maxConnections": 300, + "backup": false, + "drain": false, + "offline": false + } + UpdateBackendDetails: + description: The configuration details for updating a backend server. + properties: + backup: + default: false + description: | + Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress + traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy. + + **Note:** You cannot add a backend server marked as `backup` to a backend set that uses the IP Hash policy. + + Example: `false` + type: boolean + drain: + default: false + description: | + Whether the load balancer should drain this server. Servers marked "drain" receive no new + incoming traffic. + + Example: `false` + type: boolean + maxConnections: + description: | + The maximum number of simultaneous connections the load balancer can make to the backend. + If this is not set or set to 0 then the maximum number of simultaneous connections the + load balancer can make to the backend is unlimited. + + If setting maxConnections to some value other than 0 then that value must be greater + or equal to 256. + + Example: `300` + format: int32 + maximum: 65535 + minimum: 0 + type: integer + offline: + default: false + description: | + Whether the load balancer should treat this server as offline. Offline servers receive no incoming + traffic. + + Example: `false` + type: boolean + weight: + description: | + The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger + proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections + as a server weighted '1'. + For more information on load balancing policies, see + [How Load Balancing Policies Work](/Content/Balance/Reference/lbpolicies.htm). + + Example: `3` + format: int32 + type: integer + required: + - weight + - backup + - drain + - offline + type: object + x-example: | + { + "weight": 3, + "maxConnections": 300, + "backup": false, + "drain": false, + "offline": false + } + BackendHealth: + description: | + The health status of the specified backend server as reported by the primary and standby load balancers. + properties: + healthCheckResults: + description: | + A list of the most recent health check results returned for the specified backend server. + items: + $ref: '#/components/schemas/HealthCheckResult' + type: array + status: + description: | + The general health status of the specified backend server as reported by the primary and standby load balancers. + + * **OK:** Both health checks returned `OK`. + + * **WARNING:** One health check returned `OK` and one did not. + + * **CRITICAL:** Neither health check returned `OK`. + + * **UNKNOWN:** One or both health checks returned `UNKNOWN`, or the system was unable to retrieve metrics at this time. + enum: + - OK + - WARNING + - CRITICAL + - UNKNOWN + type: string + required: + - status + - healthCheckResults + type: object + x-example: | + { + "status": "OK", + "healthCheckResults": [ + { + "subnetId": "ocid1.subnet.oc1.phx.<unique_ID>", + "sourceIpAddress": "192.168.0.7", + "timestamp": "2018-02-09T21:58:11.417Z", + "healthCheckStatus": "OK" + } + ] + } + BackendSetHealth: + description: | + The health status details for a backend set. + + This object does not explicitly enumerate backend servers with a status of `OK`. However, they are included in the + `totalBackendCount` sum. + properties: + criticalStateBackendNames: + description: | + A list of backend servers that are currently in the `CRITICAL` health state. The list identifies each backend server by + IP address and port. + + Example: `10.0.0.4:8080` + items: + type: string + type: array + status: + description: | + Overall health status of the backend set. + + * **OK:** All backend servers in the backend set return a status of `OK`. + + * **WARNING:** Half or more of the backend set's backend servers return a status of `OK` and at least one backend + server returns a status of `WARNING`, `CRITICAL`, or `UNKNOWN`. + + * **CRITICAL:** Fewer than half of the backend set's backend servers return a status of `OK`. + + * **UNKNOWN:** More than half of the backend set's backend servers return a status of `UNKNOWN`, the system was + unable to retrieve metrics, or the backend set does not have a listener attached. + enum: + - OK + - WARNING + - CRITICAL + - UNKNOWN + type: string + totalBackendCount: + description: | + The total number of backend servers in this backend set. + + Example: `7` + type: integer + unknownStateBackendNames: + description: | + A list of backend servers that are currently in the `UNKNOWN` health state. The list identifies each backend server by + IP address and port. + + Example: `10.0.0.5:8080` + items: + type: string + type: array + warningStateBackendNames: + description: | + A list of backend servers that are currently in the `WARNING` health state. The list identifies each backend server by + IP address and port. + + Example: `10.0.0.3:8080` + items: + type: string + type: array + required: + - status + - warningStateBackendNames + - criticalStateBackendNames + - unknownStateBackendNames + - totalBackendCount + type: object + x-example: | + { + "status": "WARNING", + "warningStateBackendNames": [ + "10.0.0.3:8080" + ], + "criticalStateBackendNames": [ + "10.0.0.4:8080" + ], + "unknownStateBackendNames": [ + "10.0.0.5:8080" + ], + "totalBackendCount": 7 + } + HealthChecker: + description: | + The health check policy configuration. + For more information, see [Editing Health Check Policies](/Content/Balance/Tasks/editinghealthcheck.htm). + properties: + intervalInMillis: + description: | + The interval between health checks, in milliseconds. The default is 10000 (10 seconds). + + Example: `10000` + format: int32 + type: integer + isForcePlainText: + default: false + description: | + Specifies if health checks should always be done using plain text instead of depending on + whether or not the associated backend set is using SSL. + + If "true", health checks will be done using plain text even if the associated backend set is configured + to use SSL. + + If "false", health checks will be done using SSL encryption if the associated backend set is configured + to use SSL. If the backend set is not so configured the health checks will be done using plain text. + + Example: `false` + type: boolean + port: + description: | + The backend server port against which to run the health check. If the port is not specified, the load balancer uses the + port information from the `Backend` object. + + Example: `8080` + example: '0' + format: int32 + type: integer + protocol: + description: | + The protocol the health check must use; either HTTP or TCP. + + Example: `HTTP` + type: string + responseBodyRegex: + description: | + A regular expression for parsing the response body from the backend server. + + Example: `^((?!false).|\s)*$` + type: string + retries: + description: | + The number of retries to attempt before a backend server is considered "unhealthy". This number also applies + when recovering a server to the "healthy" state. Defaults to 3. + + Example: `3` + format: int32 + type: integer + returnCode: + description: | + The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, + you can use common HTTP status codes such as "200". + + Example: `200` + example: '0' + format: int32 + type: integer + timeoutInMillis: + description: | + The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply + returns within this timeout period. Defaults to 3000 (3 seconds). + + Example: `3000` + format: int32 + type: integer + urlPath: + description: | + The path against which to run the health check. + + Example: `/healthcheck` + type: string + required: + - port + - protocol + - responseBodyRegex + - returnCode + type: object + x-example: | + { + "protocol": "HTTP", + "isForcePlainText": false, + "urlPath": "/healthcheck", + "port": 8080, + "returnCode": 200, + "retries": 3, + "timeoutInMillis": 3000, + "intervalInMillis": 10000, + "responseBodyRegex": "^((?!false).|\s)*$" + } + UpdateHealthCheckerDetails: + description: The health checker's configuration details. + properties: + intervalInMillis: + description: | + The interval between health checks, in milliseconds. + + Example: `10000` + format: int32 + maximum: 1800000 + minimum: 1000 + type: integer + isForcePlainText: + default: false + description: | + Specifies if health checks should always be done using plain text instead of depending on + whether or not the associated backend set is using SSL. + + If "true", health checks will be done using plain text even if the associated backend set is configured + to use SSL. + + If "false", health checks will be done using SSL encryption if the associated backend set is configured + to use SSL. If the backend set is not so configured the health checks will be done using plain text. + + Example: `true` + type: boolean + port: + description: | + The backend server port against which to run the health check. + + Example: `8080` + format: int32 + maximum: 65535 + minimum: 0 + type: integer + protocol: + description: | + The protocol the health check must use; either HTTP or TCP. + + Example: `HTTP` + type: string + responseBodyRegex: + description: | + A regular expression for parsing the response body from the backend server. + + Example: `^((?!false).|\s)*$` + maxLength: 255 + type: string + retries: + description: | + The number of retries to attempt before a backend server is considered "unhealthy". This number also applies + when recovering a server to the "healthy" state. + + Example: `3` + format: int32 + type: integer + returnCode: + description: | + The status code a healthy backend server should return. + + Example: `200` + format: int32 + type: integer + timeoutInMillis: + description: | + The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply + returns within this timeout period. + + Example: `3000` + format: int32 + maximum: 600000 + minimum: 1 + type: integer + urlPath: + description: | + The path against which to run the health check. + + Example: `/healthcheck` + maxLength: 1024 + type: string + required: + - protocol + - port + - returnCode + - retries + - timeoutInMillis + - intervalInMillis + - responseBodyRegex + type: object + x-example: | + { + "protocol": "HTTP", + "urlPath": "/healthcheck", + "port": 8080, + "returnCode": 200, + "retries": 3, + "timeoutInMillis": 3000, + "intervalInMillis": 10000, + "responseBodyRegex": "^((?!false).|\s)*$" + } + Certificate: + description: | + The configuration details of a certificate bundle. + For more information on SSL certficate configuration, see + [Managing SSL Certificates](/Content/Balance/Tasks/managingcertificates.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + caCertificate: + description: | + The Certificate Authority certificate, or any interim certificate, that you received from your SSL certificate provider. + + Example: + + -----BEGIN CERTIFICATE----- + MIIEczCCA1ugAwIBAgIBADANBgkqhkiG9w0BAQQFAD..AkGA1UEBhMCR0Ix + EzARBgNVBAgTClNvbWUtU3RhdGUxFDASBgNVBAoTC0..0EgTHRkMTcwNQYD + VQQLEy5DbGFzcyAxIFB1YmxpYyBQcmltYXJ5IENlcn..XRpb24gQXV0aG9y + aXR5MRQwEgYDVQQDEwtCZXN0IENBIEx0ZDAeFw0wMD..TUwMTZaFw0wMTAy + ... + -----END CERTIFICATE----- + type: string + certificateName: + description: | + A friendly name for the certificate bundle. It must be unique and it cannot be changed. + Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. + Certificate bundle names cannot contain spaces. Avoid entering confidential information. + + Example: `example_certificate_bundle` + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9_.-]*$ + type: string + publicCertificate: + description: | + The public certificate, in PEM format, that you received from your SSL certificate provider. + + Example: + + -----BEGIN CERTIFICATE----- + MIIC2jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwG + A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxETAPBgNVBAoTCEZyYW5rNERE + MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdl + YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIw + ... + -----END CERTIFICATE----- + type: string + required: + - caCertificate + - certificateName + - publicCertificate + type: object + x-example: | + { + "certificateName": "example_certificate_bundle", + "publicCertificate": "<public_certificate>", + "caCertificate": "<ca_certificate>", + } + CreateCertificateDetails: + description: | + The configuration details for adding a certificate bundle to a listener. + For more information on SSL certficate configuration, see + [Managing SSL Certificates](/Content/Balance/Tasks/managingcertificates.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + caCertificate: + description: | + The Certificate Authority certificate, or any interim certificate, that you received from your SSL certificate provider. + + Example: + + -----BEGIN CERTIFICATE----- + MIIEczCCA1ugAwIBAgIBADANBgkqhkiG9w0BAQQFAD..AkGA1UEBhMCR0Ix + EzARBgNVBAgTClNvbWUtU3RhdGUxFDASBgNVBAoTC0..0EgTHRkMTcwNQYD + VQQLEy5DbGFzcyAxIFB1YmxpYyBQcmltYXJ5IENlcn..XRpb24gQXV0aG9y + aXR5MRQwEgYDVQQDEwtCZXN0IENBIEx0ZDAeFw0wMD..TUwMTZaFw0wMTAy + ... + -----END CERTIFICATE----- + type: string + certificateName: + description: | + A friendly name for the certificate bundle. It must be unique and it cannot be changed. + Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. + Certificate bundle names cannot contain spaces. Avoid entering confidential information. + + Example: `example_certificate_bundle` + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9_.-]*$ + type: string + passphrase: + description: | + A passphrase for encrypted private keys. This is needed only if you created your certificate with a passphrase. + type: string + privateKey: + description: | + The SSL private key for your certificate, in PEM format. + + Example: + + -----BEGIN RSA PRIVATE KEY----- + jO1O1v2ftXMsawM90tnXwc6xhOAT1gDBC9S8DKeca..JZNUgYYwNS0dP2UK + tmyN+XqVcAKw4HqVmChXy5b5msu8eIq3uc2NqNVtR..2ksSLukP8pxXcHyb + +sEwvM4uf8qbnHAqwnOnP9+KV9vds6BaH1eRA4CHz..n+NVZlzBsTxTlS16 + /Umr7wJzVrMqK5sDiSu4WuaaBdqMGfL5hLsTjcBFD..Da2iyQmSKuVD4lIZ + ... + -----END RSA PRIVATE KEY----- + type: string + publicCertificate: + description: | + The public certificate, in PEM format, that you received from your SSL certificate provider. + + Example: + + -----BEGIN CERTIFICATE----- + MIIC2jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbM..QswCQYDVQQGEwJKU + A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxE..TAPBgNVBAoTCEZyY + MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWB..gNVBAMTD0ZyYW5rN + YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmc..mFuazRkZC5jb20wH + ... + -----END CERTIFICATE----- + type: string + required: + - certificateName + type: object + x-example: | + { + "passphrase": "<passphrase>", + "privateKey": "<private_key>", + "publicCertificate": "<public_certificate>", + "caCertificate": "<ca_certificate>", + "certificateName": "example_certificate_bundle" + } + ChangeLoadBalancerCompartmentDetails: + description: | + The configuration details for moving a load balancer to a different compartment. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the load balancer to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + x-example: | + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>" + } + LoadBalancerHealth: + description: | + The health status details for the specified load balancer. + + This object does not explicitly enumerate backend sets with a status of `OK`. However, they are included in the + `totalBackendSetCount` sum. + properties: + criticalStateBackendSetNames: + description: | + A list of backend sets that are currently in the `CRITICAL` health state. The list identifies each backend set by the + friendly name you assigned when you created it. + + Example: `example_backend_set` + items: + type: string + type: array + status: + description: | + The overall health status of the load balancer. + + * **OK:** All backend sets associated with the load balancer return a status of `OK`. + + * **WARNING:** At least one of the backend sets associated with the load balancer returns a status of `WARNING`, + no backend sets return a status of `CRITICAL`, and the load balancer life cycle state is `ACTIVE`. + + * **CRITICAL:** One or more of the backend sets associated with the load balancer return a status of `CRITICAL`. + + * **UNKNOWN:** If any one of the following conditions is true: + + * The load balancer life cycle state is not `ACTIVE`. + + * No backend sets are defined for the load balancer. + + * More than half of the backend sets associated with the load balancer return a status of `UNKNOWN`, none of the backend + sets return a status of `WARNING` or `CRITICAL`, and the load balancer life cycle state is `ACTIVE`. + + * The system could not retrieve metrics for any reason. + enum: + - OK + - WARNING + - CRITICAL + - UNKNOWN + type: string + totalBackendSetCount: + description: | + The total number of backend sets associated with this load balancer. + + Example: `4` + type: integer + unknownStateBackendSetNames: + description: | + A list of backend sets that are currently in the `UNKNOWN` health state. The list identifies each backend set by the + friendly name you assigned when you created it. + + Example: `example_backend_set2` + items: + type: string + type: array + warningStateBackendSetNames: + description: | + A list of backend sets that are currently in the `WARNING` health state. The list identifies each backend set by the + friendly name you assigned when you created it. + + Example: `example_backend_set3` + items: + type: string + type: array + required: + - status + - warningStateBackendSetNames + - criticalStateBackendSetNames + - unknownStateBackendSetNames + - totalBackendSetCount + type: object + x-example: | + { + "status": "CRITICAL", + "warningStateBackendSetNames": [ + "example_backend_set3" + ], + "criticalStateBackendSetNames": [ + "example_backend_set" + ], + "unknownStateBackendSetNames": [ + "example_backend_set2" + ], + "totalBackendSetCount": 4 + } + Hostname: + description: | + A hostname resource associated with a load balancer for use by one or more listeners. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + hostname: + description: | + A virtual hostname. For more information about virtual hostname string construction, see + [Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm#routing). + + Example: `app.example.com` + type: string + name: + description: | + A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential + information. + + Example: `example_hostname_001` + type: string + required: + - name + - hostname + type: object + x-example: | + { + "name": "example_hostname_001", + "hostname": "app.example.com" + } + CreateHostnameDetails: + description: | + The details of the hostname resource to add to a load balancer. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + hostname: + description: | + A virtual hostname. For more information about virtual hostname string construction, see + [Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm#routing). + + Example: `app.example.com` + type: string + name: + description: | + A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential + information. + + Example: `example_hostname_001` + type: string + required: + - name + - hostname + type: object + x-example: | + { + "name": "example_hostname_001", + "hostname": "app.example.com" + } + UpdateHostnameDetails: + description: | + The configuration details for updating a virtual hostname. + For more information on virtual hostnames, see + [Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm). + properties: + hostname: + description: | + The virtual hostname to update. For more information about virtual hostname string construction, see + [Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm#routing). + + Example: `app.example.com` + type: string + type: object + x-example: | + { + "hostname": "app.example.com" + } + CreateListenerDetails: + description: | + The configuration details for adding a listener to a backend set. + For more information on listener configuration, see + [Managing Load Balancer Listeners](/Content/Balance/Tasks/managinglisteners.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + connectionConfiguration: + $ref: '#/components/schemas/ConnectionConfiguration' + defaultBackendSetName: + description: | + The name of the associated backend set. + + Example: `example_backend_set` + maxLength: 32 + minLength: 1 + type: string + hostnameNames: + description: An array of hostname resource names. + items: + maxLength: 16 + minLength: 1 + type: string + type: array + name: + description: | + A friendly name for the listener. It must be unique and it cannot be changed. + Avoid entering confidential information. + + Example: `example_listener` + maxLength: 255 + minLength: 1 + type: string + pathRouteSetName: + description: | + Deprecated. Please use `routingPolicies` instead. + + The name of the set of path-based routing rules, [PathRouteSet](#/en/loadbalancer/20170115/PathRouteSet/), + applied to this listener's traffic. + + Example: `example_path_route_set` + maxLength: 32 + minLength: 1 + type: string + port: + description: | + The communication port for the listener. + + Example: `80` + format: int32 + maximum: 65535 + minimum: 1 + type: integer + protocol: + description: | + The protocol on which the listener accepts connection requests. + To get a list of valid protocols, use the [ListProtocols](#/en/loadbalancer/20170115/LoadBalancerProtocol/ListProtocols) + operation. + + Example: `HTTP` + type: string + routingPolicyName: + description: | + The name of the routing policy applied to this listener's traffic. + + Example: `example_routing_policy` + maxLength: 32 + minLength: 1 + pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ + type: string + ruleSetNames: + description: | + The names of the [rule sets](#/en/loadbalancer/20170115/RuleSet/) to apply to the listener. + + Example: ["example_rule_set"] + items: + maxLength: 32 + minLength: 1 + pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ + type: string + type: array + sslConfiguration: + $ref: '#/components/schemas/SSLConfigurationDetails' + required: + - defaultBackendSetName + - name + - port + - protocol + type: object + x-example: | + { + "defaultBackendSetName": "example_backend_set", + "port": 80, + "protocol": "HTTP", + "hostnameNames": [ + "example_hostname_001", + "example_hostname_002" + ], + "pathRouteSetName": "example_path_route_set", + "sslConfiguration": { + "protocols": ["TLSv1.1", "TLSv1.2"], + "cipherSuiteName" : "example_cipher_suite", + "serverOrderPreference" : "ENABLED", + "certificateName": "example_certificate_bundle", + "verifyPeerCertificate": true, + "verifyDepth": 3 + }, + "connectionConfiguration": { + "idleTimeout": 1200 + }, + "name": "example_listener" + } + UpdateListenerDetails: + description: The configuration details for updating a listener. + properties: + connectionConfiguration: + $ref: '#/components/schemas/ConnectionConfiguration' + defaultBackendSetName: + description: | + The name of the associated backend set. + + Example: `example_backend_set` + maxLength: 32 + minLength: 1 + type: string + hostnameNames: + description: An array of hostname resource names. + items: + maxLength: 16 + minLength: 1 + type: string + type: array + pathRouteSetName: + description: | + Deprecated. Please use `routingPolicies` instead. + + The name of the set of path-based routing rules, [PathRouteSet](#/en/loadbalancer/20170115/PathRouteSet/), + applied to this listener's traffic. + + Example: `example_path_route_set` + maxLength: 32 + minLength: 1 + type: string + port: + description: | + The communication port for the listener. + + Example: `80` + format: int32 + maximum: 65535 + minimum: 1 + type: integer + protocol: + description: | + The protocol on which the listener accepts connection requests. + To get a list of valid protocols, use the [ListProtocols](#/en/loadbalancer/20170115/LoadBalancerProtocol/ListProtocols) + operation. + + Example: `HTTP` + type: string + routingPolicyName: + description: | + The name of the routing policy applied to this listener's traffic. + + Example: `example_routing_policy` + maxLength: 32 + minLength: 1 + pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ + type: string + ruleSetNames: + description: | + The names of the [rule sets](#/en/loadbalancer/20170115/RuleSet/) to apply to the listener. + + Example: ["example_rule_set"] + items: + maxLength: 32 + minLength: 1 + pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ + type: string + type: array + sslConfiguration: + $ref: '#/components/schemas/SSLConfigurationDetails' + required: + - defaultBackendSetName + - port + - protocol + type: object + x-example: | + { + "defaultBackendSetName": "example_backend_set", + "port": 80, + "protocol": "HTTP", + "hostnameNames": [ + "example_hostname_001", + "example_hostname_002" + ], + "pathRouteSetName": "example_path_route_set", + "sslConfiguration": { + "protocols": ["TLSv1.1", "TLSv1.2"], + "cipherSuiteName" : "example_cipher_suite", + "serverOrderPreference" : "ENABLED", + "certificateName": "example_certificate_bundle", + "verifyPeerCertificate": true + "verifyDepth": 3, + } + "connectionConfiguration": { + "idleTimeout": 1200 + } + } + ListenerRuleSummary: + description: | + The attributes of a rule associated with the specified listener, and the name of the rule set that the rule + belongs to. + properties: + rule: + $ref: '#/components/schemas/Rule' + ruleSetName: + description: | + The name of the rule set that the rule belongs to. + example: example_rule_set + type: string + type: object + x-example: | + { + "rule": { + "action": "ADD_REQUEST_HEADER", + "header": "example_header_name", + "value": "example_value" + }, + "ruleSetName": "example_rule_set" + } + UpdateNetworkSecurityGroupsDetails: + description: |- + An object representing an updated list of network security groups (NSGs) that overwrites the existing list of NSGs. + * If the load balancer has no NSGs configured, it uses the NSGs in this list. + * If the load balancer has a list of NSGs configured, this list replaces the existing list. + * If the load balancer has a list of NSGs configured and this list is empty, the operation removes all of the load balancer's NSG associations. + properties: + networkSecurityGroupIds: + description: | + An array of NSG [OCIDs](/Content/General/Concepts/identifiers.htm) associated with the load + balancer. + + During the load balancer's creation, the service adds the new load balancer to the specified NSGs. + + The benefits of associating the load balancer with NSGs include: + + * NSGs define network security rules to govern ingress and egress traffic for the load balancer. + + * The network security rules of other resources can reference the NSGs associated with the load balancer + to ensure access. + items: + maxLength: 256 + minLength: 1 + type: string + maxItems: 5 + minItems: 0 + type: array + type: object + x-example: | + { + "networkSecurityGroupIds": [ + "ocid1.networksecuritygroup.oc1.phx.<unique_ID1>", + "ocid1.networksecuritygroup.oc1.phx.<unique_ID2>" + ] + } + PathRouteSet: + description: | + A named set of path route rules. For more information, see + [Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + name: + description: | + The unique name for this set of path route rules. Avoid entering confidential information. + + Example: `example_path_route_set` + maxLength: 32 + minLength: 1 + type: string + pathRoutes: + description: The set of path route rules. + items: + $ref: '#/components/schemas/PathRoute' + maxItems: 20 + minItems: 0 + type: array + required: + - name + - pathRoutes + type: object + x-example: | + { + "name": "example_path_route_set", + "pathRoutes": [ + { + "path": "/example/video/123", + "pathMatchType": { + "matchType": "EXACT_MATCH" + }, + "backendSetName": "example_backend_set" + } + ] + } + CreatePathRouteSetDetails: + description: | + A named set of path route rules to add to the load balancer. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + name: + description: | + The name for this set of path route rules. It must be unique and it cannot be changed. Avoid entering + confidential information. + + Example: `example_path_route_set` + maxLength: 32 + minLength: 1 + type: string + pathRoutes: + description: The set of path route rules. + items: + $ref: '#/components/schemas/PathRoute' + maxItems: 20 + minItems: 1 + type: array + required: + - name + - pathRoutes + type: object + x-example: | + { + "name": "example_path_route_set", + "pathRoutes": [ + { + "path": "/example/video/123", + "pathMatchType": { + "matchType": "EXACT_MATCH" + }, + "backendSetName": "example_backend_set" + } + ] + } + UpdatePathRouteSetDetails: + description: An updated set of path route rules that overwrites the existing set of rules. + properties: + pathRoutes: + description: The set of path route rules. + items: + $ref: '#/components/schemas/PathRoute' + maxItems: 20 + minItems: 0 + type: array + required: + - pathRoutes + type: object + x-example: | + { + "pathRoutes": [ + { + "path": "/example/video/123", + "pathMatchType": { + "matchType": "EXACT_MATCH" + }, + "backendSetName": "example_backend_set" + } + ] + } + RoutingPolicy: + description: | + A named ordered list of routing rules that is applied to a listener. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + conditionLanguageVersion: + description: | + The version of the language in which `condition` of `rules` are composed. + enum: + - V1 + type: string + name: + description: | + The unique name for this list of routing rules. Avoid entering confidential information. + + Example: `example_routing_policy` + maxLength: 32 + minLength: 1 + pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ + type: string + rules: + description: The ordered list of routing rules. + items: + $ref: '#/components/schemas/RoutingRule' + maxItems: 100 + minItems: 1 + type: array + required: + - name + - conditionLanguageVersion + - rules + type: object + x-example: | + { + "name": "example_routing_rules", + "conditionLanguageVersion": "V1", + "rules": [ + { + "name": "HR_mobile_user_rule", + "condition" : "all(http.request.headers[(i 'user-agent')] eq (i 'mobile'), http.request.url.query['department'] eq 'HR')", + "actions": [{ + "name": "FORWARD_TO_BACKENDSET", + "backendSetName": "backendSetForHRMobileUsers" + }] + }, + { + "name": "Documents_rule", + "condition" : "any(http.request.url.path eq (i '/documents'), http.request.headers[(i 'host')] eq 'doc.myapp.com')", + "actions": [{ + "name": "FORWARD_TO_BACKENDSET", + "backendSetName": "backendSetForDocuments" + }] + } + ] + } + CreateRoutingPolicyDetails: + description: | + An ordered list of routing rules. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + conditionLanguageVersion: + description: | + The version of the language in which `condition` of `rules` are composed. + enum: + - V1 + type: string + name: + description: | + The name for this list of routing rules. It must be unique and it cannot be changed. Avoid entering + confidential information. + + Example: `example_routing_rules` + maxLength: 32 + minLength: 1 + pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ + type: string + rules: + description: The list of routing rules. + items: + $ref: '#/components/schemas/RoutingRule' + maxItems: 100 + minItems: 1 + type: array + required: + - name + - conditionLanguageVersion + - rules + type: object + x-example: | + { + "name": "example_routing_rules", + "conditionLanguageVersion": "V1", + "rules": [ + { + "name": "HR_mobile_user_rule", + "condition": "all(http.request.headers[(i 'user-agent')] eq (i 'mobile'), http.request.url.query[(i 'department')] eq (i 'HR'))" , + "actions": [{ + "name": "FORWARD_TO_BACKENDSET", + "backendSetName": "backendSetForHRMobileUsers" + }] + }, + { + "name": "Documents_rule", + "condition": "any(http.request.url.path eq (i '/documents'), http.request.headers[(i 'host')] eq (i 'doc.myapp.com'))", + "actions": [{ + "name": "FORWARD_TO_BACKENDSET", + "backendSetName": "backendSetForDocuments" + }] + } + ] + } + UpdateRoutingPolicyDetails: + description: An updated list of routing rules that overwrites the existing list of routing rules. + properties: + conditionLanguageVersion: + description: | + The version of the language in which `condition` of `rules` are composed. + enum: + - V1 + type: string + rules: + description: The list of routing rules. + items: + $ref: '#/components/schemas/RoutingRule' + maxItems: 100 + minItems: 1 + type: array + required: + - rules + type: object + x-example: | + { + "conditionLanguageVersion": "V1", + "rules": [ + { + "name": "HR_mobile_user_rule", + "condition": "all(http.request.headers[(i 'user-agent')] eq (i 'mobile'), http.request.url.query[(i 'department')] eq (i 'HR'))" , + "actions": [{ + "name": "FORWARD_TO_BACKENDSET", + "backendSetName": "backendSetForHRMobileUsers" + }] + }, + { + "name": "Cookie_rule", + "condition": "any(http.request.cookies['myCookie'] eq 'myCookieVal', http.request.headers[(i 'customHeader')] eq (i 'headerVal'))" , + "actions": [{ + "name": "FORWARD_TO_BACKENDSET", + "backendSetName": "backendSetForlargeimages" + }] + } + ] + } + RuleSet: + description: | + A named set of rules associated with a load balancer. Rules are objects that represent actions to apply to a listener, + such as adding, altering, or removing HTTP headers. For more information, see + [Managing Rule Sets](/Content/Balance/Tasks/managingrulesets.htm). + properties: + items: + description: An array of rules that compose the rule set. + items: + $ref: '#/components/schemas/Rule' + type: array + name: + description: | + The name for this set of rules. It must be unique and it cannot be changed. Avoid entering + confidential information. + + Example: `example_rule_set` + type: string + required: + - name + - items + type: object + x-example: | + { + "name": "example_rule_set", + "items": [ + { + "action": "ADD_REQUEST_HEADER", + "header": "example_header_name", + "value": "example_value" + }, + { + "action": "EXTEND_HTTP_REQUEST_HEADER_VALUE", + "header": "example_header_name2", + "prefix": "example_prefix_value", + "suffix": "example_suffix_value" + } + ] + } + CreateRuleSetDetails: + description: A named set of rules to add to the load balancer. + properties: + items: + description: An array of rules that compose the rule set. + items: + $ref: '#/components/schemas/Rule' + type: array + name: + description: | + The name for this set of rules. It must be unique and it cannot be changed. Avoid entering + confidential information. + + Example: `example_rule_set` + maxLength: 32 + minLength: 1 + pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ + type: string + required: + - name + - items + type: object + x-example: | + { + "name": "example_rule_set", + "items": [ + { + "action": "ADD_REQUEST_HEADER", + "header": "example_header_name", + "value": "example_value" + }, + { + "action": "EXTEND_HTTP_REQUEST_HEADER_VALUE", + "header": "example_header_name2", + "prefix": "example_prefix_value", + "suffix": "example_suffix_value" + } + ] + } + UpdateRuleSetDetails: + description: An updated set of rules that overwrites the existing set of rules. + properties: + items: + description: An array of rules that compose the rule set. + items: + $ref: '#/components/schemas/Rule' + type: array + required: + - items + type: object + x-example: | + { + "items": [ + { + "action": "ADD_REQUEST_HEADER", + "header": "example_header_name", + "value": "example_value" + }, + { + "action": "EXTEND_HTTP_REQUEST_HEADER_VALUE", + "header": "example_header_name2", + "prefix": "example_prefix_value", + "suffix": "example_suffix_value" + } + ] + } + SSLCipherSuite: + description: | + The configuration details of an SSL cipher suite. + + The algorithms that compose a cipher suite help you secure Transport Layer Security (TLS) or Secure Socket Layer + (SSL) network connections. A cipher suite defines the list of security algorithms your load balancer uses to + negotiate with peers while sending and receiving information. The cipher suites you use affect the security + level, performance, and compatibility of your data traffic. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + + Oracle created the following predefined cipher suites that you can specify when you define a resource's + [SSL configuration](/api/#/en/loadbalancer/20170115/datatypes/SSLConfigurationDetails). You can [create custom + cipher suites](/api/#/en/loadbalancer/20170115/SSLCipherSuite/CreateSSLCipherSuite) if the predefined cipher + suites do not meet your requirements. + + + * __oci-default-ssl-cipher-suite-v1__ + + "DHE-RSA-AES128-GCM-SHA256" + "DHE-RSA-AES128-SHA256" + "DHE-RSA-AES256-GCM-SHA384" + "DHE-RSA-AES256-SHA256" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-RSA-AES128-SHA256" + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES256-SHA384" + + * __oci-modern-ssl-cipher-suite-v1__ + + "AES128-GCM-SHA256" + "AES128-SHA256" + "AES256-GCM-SHA384" + "AES256-SHA256" + "DHE-RSA-AES128-GCM-SHA256" + "DHE-RSA-AES128-SHA256" + "DHE-RSA-AES256-GCM-SHA384" + "DHE-RSA-AES256-SHA256" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-SHA256" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-SHA384" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-RSA-AES128-SHA256" + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES256-SHA384" + + * __oci-compatible-ssl-cipher-suite-v1__ + + "AES128-GCM-SHA256" + "AES128-SHA" + "AES128-SHA256" + "AES256-GCM-SHA384" + "AES256-SHA" + "AES256-SHA256" + "DHE-RSA-AES128-GCM-SHA256" + "DHE-RSA-AES128-SHA256" + "DHE-RSA-AES256-GCM-SHA384" + "DHE-RSA-AES256-SHA256" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-SHA" + "ECDHE-ECDSA-AES128-SHA256" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-SHA" + "ECDHE-ECDSA-AES256-SHA384" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-RSA-AES128-SHA" + "ECDHE-RSA-AES128-SHA256" + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES256-SHA" + "ECDHE-RSA-AES256-SHA384" + + * __oci-wider-compatible-ssl-cipher-suite-v1__ + + "AES128-GCM-SHA256" + "AES128-SHA" + "AES128-SHA256" + "AES256-GCM-SHA384" + "AES256-SHA" + "AES256-SHA256" + "CAMELLIA128-SHA" + "CAMELLIA256-SHA" + "DES-CBC3-SHA" + "DH-DSS-AES128-GCM-SHA256" + "DH-DSS-AES128-SHA" + "DH-DSS-AES128-SHA256" + "DH-DSS-AES256-GCM-SHA384" + "DH-DSS-AES256-SHA" + "DH-DSS-AES256-SHA256" + "DH-DSS-CAMELLIA128-SHA" + "DH-DSS-CAMELLIA256-SHA" + "DH-DSS-DES-CBC3-SHAv" + "DH-DSS-SEED-SHA" + "DH-RSA-AES128-GCM-SHA256" + "DH-RSA-AES128-SHA" + "DH-RSA-AES128-SHA256" + "DH-RSA-AES256-GCM-SHA384" + "DH-RSA-AES256-SHA" + "DH-RSA-AES256-SHA256" + "DH-RSA-CAMELLIA128-SHA" + "DH-RSA-CAMELLIA256-SHA" + "DH-RSA-DES-CBC3-SHA" + "DH-RSA-SEED-SHA" + "DHE-DSS-AES128-GCM-SHA256" + "DHE-DSS-AES128-SHA" + "DHE-DSS-AES128-SHA256" + "DHE-DSS-AES256-GCM-SHA384" + "DHE-DSS-AES256-SHA" + "DHE-DSS-AES256-SHA256" + "DHE-DSS-CAMELLIA128-SHA" + "DHE-DSS-CAMELLIA256-SHA" + "DHE-DSS-DES-CBC3-SHA" + "DHE-DSS-SEED-SHA" + "DHE-RSA-AES128-GCM-SHA256" + "DHE-RSA-AES128-SHA" + "DHE-RSA-AES128-SHA256" + "DHE-RSA-AES256-GCM-SHA384" + "DHE-RSA-AES256-SHA" + "DHE-RSA-AES256-SHA256" + "DHE-RSA-CAMELLIA128-SHA" + "DHE-RSA-CAMELLIA256-SHA" + "DHE-RSA-DES-CBC3-SHA" + "DHE-RSA-SEED-SHA" + "ECDH-ECDSA-AES128-GCM-SHA256" + "ECDH-ECDSA-AES128-SHA" + "ECDH-ECDSA-AES128-SHA256" + "ECDH-ECDSA-AES256-GCM-SHA384" + "ECDH-ECDSA-AES256-SHA" + "ECDH-ECDSA-AES256-SHA384" + "ECDH-ECDSA-DES-CBC3-SHA" + "ECDH-ECDSA-RC4-SHA" + "ECDH-RSA-AES128-GCM-SHA256" + "ECDH-RSA-AES128-SHA" + "ECDH-RSA-AES128-SHA256" + "ECDH-RSA-AES256-GCM-SHA384" + "ECDH-RSA-AES256-SHA" + "ECDH-RSA-AES256-SHA384" + "ECDH-RSA-DES-CBC3-SHA" + "ECDH-RSA-RC4-SHA" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-SHA" + "ECDHE-ECDSA-AES128-SHA256" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-SHA" + "ECDHE-ECDSA-AES256-SHA384" + "ECDHE-ECDSA-DES-CBC3-SHA" + "ECDHE-ECDSA-RC4-SHA" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-RSA-AES128-SHA" + "ECDHE-RSA-AES128-SHA256" + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES256-SHA" + "ECDHE-RSA-AES256-SHA384" + "ECDHE-RSA-DES-CBC3-SHA" + "ECDHE-RSA-RC4-SHA" + "IDEA-CBC-SHA" + "KRB5-DES-CBC3-MD5" + "KRB5-DES-CBC3-SHA" + "KRB5-IDEA-CBC-MD5" + "KRB5-IDEA-CBC-SHA" + "KRB5-RC4-MD5" + "KRB5-RC4-SHA" + "PSK-3DES-EDE-CBC-SHA" + "PSK-AES128-CBC-SHA" + "PSK-AES256-CBC-SHA" + "PSK-RC4-SHA" + "RC4-MD5" + "RC4-SHA" + "SEED-SHA" + + * __oci-default-http2-ssl-cipher-suite-v1__ + + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "DHE-RSA-AES256-GCM-SHA384" + "DHE-RSA-AES128-GCM-SHA256" + + * __oci-default-http2-tls-13-ssl-cipher-suite-v1__ + + "TLS_AES_128_GCM_SHA256" + "TLS_AES_256_GCM_SHA384" + "TLS_CHACHA20_POLY1305_SHA256" + + * __oci-default-http2-tls-12-13-ssl-cipher-suite-v1__ + + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "DHE-RSA-AES256-GCM-SHA384" + "DHE-RSA-AES128-GCM-SHA256" + "TLS_AES_128_GCM_SHA256" + "TLS_AES_256_GCM_SHA384" + "TLS_CHACHA20_POLY1305_SHA256" + + * __oci-tls-13-recommended-ssl-cipher-suite-v1__ + + "TLS_AES_128_GCM_SHA256" + "TLS_AES_256_GCM_SHA384" + "TLS_CHACHA20_POLY1305_SHA256" + + * __oci-tls-12-13-wider-ssl-cipher-suite-v1__ + + "TLS_AES_128_GCM_SHA256" + "TLS_AES_256_GCM_SHA384" + "TLS_CHACHA20_POLY1305_SHA256" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-SHA256" + "ECDHE-RSA-AES128-SHA256" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-SHA384" + "ECDHE-RSA-AES256-SHA384" + "AES128-GCM-SHA256" + "AES128-SHA256" + "AES256-GCM-SHA384" + "AES256-SHA256" + + * __oci-tls-11-12-13-wider-ssl-cipher-suite-v1__ + "TLS_AES_128_GCM_SHA256" + "TLS_AES_256_GCM_SHA384" + "TLS_CHACHA20_POLY1305_SHA256" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-SHA256" + "ECDHE-RSA-AES128-SHA256" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-SHA384" + "ECDHE-RSA-AES256-SHA384" + "AES128-GCM-SHA256" + "AES128-SHA256" + "AES256-GCM-SHA384" + "AES256-SHA256" + "ECDHE-ECDSA-AES128-SHA" + "ECDHE-RSA-AES128-SHA" + "ECDHE-RSA-AES256-SHA" + "ECDHE-ECDSA-AES256-SHA" + "AES128-SHA" + "AES256-SHA" + properties: + ciphers: + description: | + A list of SSL ciphers the load balancer must support for HTTPS or SSL connections. + + The following ciphers are valid values for this property: + + * __TLSv1.3 ciphers__ + + "TLS_AES_128_GCM_SHA256" + "TLS_AES_256_GCM_SHA384" + "TLS_CHACHA20_POLY1305_SHA256" + "TLS_AES_128_CCM_SHA256" + "TLS_AES_128_CCM_8_SHA256" + + * __TLSv1.2 ciphers__ + + "AES128-GCM-SHA256" + "AES128-SHA256" + "AES256-GCM-SHA384" + "AES256-SHA256" + "DH-DSS-AES128-GCM-SHA256" + "DH-DSS-AES128-SHA256" + "DH-DSS-AES256-GCM-SHA384" + "DH-DSS-AES256-SHA256" + "DH-RSA-AES128-GCM-SHA256" + "DH-RSA-AES128-SHA256" + "DH-RSA-AES256-GCM-SHA384" + "DH-RSA-AES256-SHA256" + "DHE-DSS-AES128-GCM-SHA256" + "DHE-DSS-AES128-SHA256" + "DHE-DSS-AES256-GCM-SHA384" + "DHE-DSS-AES256-SHA256" + "DHE-RSA-AES128-GCM-SHA256" + "DHE-RSA-AES128-SHA256" + "DHE-RSA-AES256-GCM-SHA384" + "DHE-RSA-AES256-SHA256" + "ECDH-ECDSA-AES128-GCM-SHA256" + "ECDH-ECDSA-AES128-SHA256" + "ECDH-ECDSA-AES256-GCM-SHA384" + "ECDH-ECDSA-AES256-SHA384" + "ECDH-RSA-AES128-GCM-SHA256" + "ECDH-RSA-AES128-SHA256" + "ECDH-RSA-AES256-GCM-SHA384" + "ECDH-RSA-AES256-SHA384" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-SHA256" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-SHA384" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-RSA-AES128-SHA256" + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES256-SHA384" + + * __TLSv1 ciphers also supported by TLSv1.2__ + + "AES128-SHA" + "AES256-SHA" + "CAMELLIA128-SHA" + "CAMELLIA256-SHA" + "DES-CBC3-SHA" + "DH-DSS-AES128-SHA" + "DH-DSS-AES256-SHA" + "DH-DSS-CAMELLIA128-SHA" + "DH-DSS-CAMELLIA256-SHA" + "DH-DSS-DES-CBC3-SHAv" + "DH-DSS-SEED-SHA" + "DH-RSA-AES128-SHA" + "DH-RSA-AES256-SHA" + "DH-RSA-CAMELLIA128-SHA" + "DH-RSA-CAMELLIA256-SHA" + "DH-RSA-DES-CBC3-SHA" + "DH-RSA-SEED-SHA" + "DHE-DSS-AES128-SHA" + "DHE-DSS-AES256-SHA" + "DHE-DSS-CAMELLIA128-SHA" + "DHE-DSS-CAMELLIA256-SHA" + "DHE-DSS-DES-CBC3-SHA" + "DHE-DSS-SEED-SHA" + "DHE-RSA-AES128-SHA" + "DHE-RSA-AES256-SHA" + "DHE-RSA-CAMELLIA128-SHA" + "DHE-RSA-CAMELLIA256-SHA" + "DHE-RSA-DES-CBC3-SHA" + "DHE-RSA-SEED-SHA" + "ECDH-ECDSA-AES128-SHA" + "ECDH-ECDSA-AES256-SHA" + "ECDH-ECDSA-DES-CBC3-SHA" + "ECDH-ECDSA-RC4-SHA" + "ECDH-RSA-AES128-SHA" + "ECDH-RSA-AES256-SHA" + "ECDH-RSA-DES-CBC3-SHA" + "ECDH-RSA-RC4-SHA" + "ECDHE-ECDSA-AES128-SHA" + "ECDHE-ECDSA-AES256-SHA" + "ECDHE-ECDSA-DES-CBC3-SHA" + "ECDHE-ECDSA-RC4-SHA" + "ECDHE-RSA-AES128-SHA" + "ECDHE-RSA-AES256-SHA" + "ECDHE-RSA-DES-CBC3-SHA" + "ECDHE-RSA-RC4-SHA" + "IDEA-CBC-SHA" + "KRB5-DES-CBC3-MD5" + "KRB5-DES-CBC3-SHA" + "KRB5-IDEA-CBC-MD5" + "KRB5-IDEA-CBC-SHA" + "KRB5-RC4-MD5" + "KRB5-RC4-SHA" + "PSK-3DES-EDE-CBC-SHA" + "PSK-AES128-CBC-SHA" + "PSK-AES256-CBC-SHA" + "PSK-RC4-SHA" + "RC4-MD5" + "RC4-SHA" + "SEED-SHA" + + example: `["ECDHE-RSA-AES256-GCM-SHA384","ECDHE-ECDSA-AES256-GCM-SHA384","ECDHE-RSA-AES128-GCM-SHA256"]` + items: + type: string + minItems: 1 + type: array + name: + description: | + A friendly name for the SSL cipher suite. It must be unique and it cannot be changed. + + **Note:** The name of your user-defined cipher suite must not be the same as any of Oracle's predefined or + reserved SSL cipher suite names: + + * oci-default-ssl-cipher-suite-v1 + * oci-modern-ssl-cipher-suite-v1 + * oci-compatible-ssl-cipher-suite-v1 + * oci-wider-compatible-ssl-cipher-suite-v1 + * oci-customized-ssl-cipher-suite + * oci-default-http2-ssl-cipher-suite-v1 + * oci-default-http2-tls-13-ssl-cipher-suite-v1 + * oci-default-http2-tls-12-13-ssl-cipher-suite-v1 + * oci-tls-13-recommended-ssl-cipher-suite-v1 + * oci-tls-12-13-wider-ssl-cipher-suite-v1 + * oci-tls-11-12-13-wider-ssl-cipher-suite-v1 + + example: `example_cipher_suite` + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]*$ + type: string + required: + - name + - ciphers + type: object + x-example: | + { + "ciphers" : ['ECDHE-RSA-AES256-GCM-SHA384','ECDHE-ECDSA-AES256-GCM-SHA384','ECDHE-RSA-AES128-GCM-SHA256'], + "name": "example_cipher_suite" + } + CreateSSLCipherSuiteDetails: + description: | + The configuration details of an SSL cipher suite. + + The algorithms that compose a cipher suite help you secure Transport Layer Security (TLS) or Secure Socket Layer + (SSL) network connections. A cipher suite defines the list of security algorithms your load balancer uses to + negotiate with peers while sending and receiving information. The cipher suites you use affect the security + level, performance, and compatibility of your data traffic. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + + Oracle created the following predefined cipher suites that you can specify when you define a resource's + [SSL configuration](/api/#/en/loadbalancer/20170115/datatypes/SSLConfigurationDetails). You can [create custom + cipher suites](/api/#/en/loadbalancer/20170115/SSLCipherSuite/CreateSSLCipherSuite) if the predefined cipher + suites do not meet your requirements. + + + * __oci-default-ssl-cipher-suite-v1__ + + "DHE-RSA-AES128-GCM-SHA256" + "DHE-RSA-AES128-SHA256" + "DHE-RSA-AES256-GCM-SHA384" + "DHE-RSA-AES256-SHA256" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-RSA-AES128-SHA256" + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES256-SHA384" + + * __oci-modern-ssl-cipher-suite-v1__ + + "AES128-GCM-SHA256" + "AES128-SHA256" + "AES256-GCM-SHA384" + "AES256-SHA256" + "DHE-RSA-AES128-GCM-SHA256" + "DHE-RSA-AES128-SHA256" + "DHE-RSA-AES256-GCM-SHA384" + "DHE-RSA-AES256-SHA256" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-SHA256" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-SHA384" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-RSA-AES128-SHA256" + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES256-SHA384" + + * __oci-compatible-ssl-cipher-suite-v1__ + + "AES128-GCM-SHA256" + "AES128-SHA" + "AES128-SHA256" + "AES256-GCM-SHA384" + "AES256-SHA" + "AES256-SHA256" + "DHE-RSA-AES128-GCM-SHA256" + "DHE-RSA-AES128-SHA256" + "DHE-RSA-AES256-GCM-SHA384" + "DHE-RSA-AES256-SHA256" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-SHA" + "ECDHE-ECDSA-AES128-SHA256" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-SHA" + "ECDHE-ECDSA-AES256-SHA384" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-RSA-AES128-SHA" + "ECDHE-RSA-AES128-SHA256" + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES256-SHA" + "ECDHE-RSA-AES256-SHA384" + + * __oci-wider-compatible-ssl-cipher-suite-v1__ + + "AES128-GCM-SHA256" + "AES128-SHA" + "AES128-SHA256" + "AES256-GCM-SHA384" + "AES256-SHA" + "AES256-SHA256" + "CAMELLIA128-SHA" + "CAMELLIA256-SHA" + "DES-CBC3-SHA" + "DH-DSS-AES128-GCM-SHA256" + "DH-DSS-AES128-SHA" + "DH-DSS-AES128-SHA256" + "DH-DSS-AES256-GCM-SHA384" + "DH-DSS-AES256-SHA" + "DH-DSS-AES256-SHA256" + "DH-DSS-CAMELLIA128-SHA" + "DH-DSS-CAMELLIA256-SHA" + "DH-DSS-DES-CBC3-SHAv" + "DH-DSS-SEED-SHA" + "DH-RSA-AES128-GCM-SHA256" + "DH-RSA-AES128-SHA" + "DH-RSA-AES128-SHA256" + "DH-RSA-AES256-GCM-SHA384" + "DH-RSA-AES256-SHA" + "DH-RSA-AES256-SHA256" + "DH-RSA-CAMELLIA128-SHA" + "DH-RSA-CAMELLIA256-SHA" + "DH-RSA-DES-CBC3-SHA" + "DH-RSA-SEED-SHA" + "DHE-DSS-AES128-GCM-SHA256" + "DHE-DSS-AES128-SHA" + "DHE-DSS-AES128-SHA256" + "DHE-DSS-AES256-GCM-SHA384" + "DHE-DSS-AES256-SHA" + "DHE-DSS-AES256-SHA256" + "DHE-DSS-CAMELLIA128-SHA" + "DHE-DSS-CAMELLIA256-SHA" + "DHE-DSS-DES-CBC3-SHA" + "DHE-DSS-SEED-SHA" + "DHE-RSA-AES128-GCM-SHA256" + "DHE-RSA-AES128-SHA" + "DHE-RSA-AES128-SHA256" + "DHE-RSA-AES256-GCM-SHA384" + "DHE-RSA-AES256-SHA" + "DHE-RSA-AES256-SHA256" + "DHE-RSA-CAMELLIA128-SHA" + "DHE-RSA-CAMELLIA256-SHA" + "DHE-RSA-DES-CBC3-SHA" + "DHE-RSA-SEED-SHA" + "ECDH-ECDSA-AES128-GCM-SHA256" + "ECDH-ECDSA-AES128-SHA" + "ECDH-ECDSA-AES128-SHA256" + "ECDH-ECDSA-AES256-GCM-SHA384" + "ECDH-ECDSA-AES256-SHA" + "ECDH-ECDSA-AES256-SHA384" + "ECDH-ECDSA-DES-CBC3-SHA" + "ECDH-ECDSA-RC4-SHA" + "ECDH-RSA-AES128-GCM-SHA256" + "ECDH-RSA-AES128-SHA" + "ECDH-RSA-AES128-SHA256" + "ECDH-RSA-AES256-GCM-SHA384" + "ECDH-RSA-AES256-SHA" + "ECDH-RSA-AES256-SHA384" + "ECDH-RSA-DES-CBC3-SHA" + "ECDH-RSA-RC4-SHA" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-SHA" + "ECDHE-ECDSA-AES128-SHA256" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-SHA" + "ECDHE-ECDSA-AES256-SHA384" + "ECDHE-ECDSA-DES-CBC3-SHA" + "ECDHE-ECDSA-RC4-SHA" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-RSA-AES128-SHA" + "ECDHE-RSA-AES128-SHA256" + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES256-SHA" + "ECDHE-RSA-AES256-SHA384" + "ECDHE-RSA-DES-CBC3-SHA" + "ECDHE-RSA-RC4-SHA" + "IDEA-CBC-SHA" + "KRB5-DES-CBC3-MD5" + "KRB5-DES-CBC3-SHA" + "KRB5-IDEA-CBC-MD5" + "KRB5-IDEA-CBC-SHA" + "KRB5-RC4-MD5" + "KRB5-RC4-SHA" + "PSK-3DES-EDE-CBC-SHA" + "PSK-AES128-CBC-SHA" + "PSK-AES256-CBC-SHA" + "PSK-RC4-SHA" + "RC4-MD5" + "RC4-SHA" + "SEED-SHA" + + * __oci-default-http2-ssl-cipher-suite-v1__ + + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "DHE-RSA-AES256-GCM-SHA384" + "DHE-RSA-AES128-GCM-SHA256" + + * __oci-default-http2-tls-13-ssl-cipher-suite-v1__ + + "TLS_AES_128_GCM_SHA256" + "TLS_AES_256_GCM_SHA384" + "TLS_CHACHA20_POLY1305_SHA256" + + * __oci-default-http2-tls-12-13-ssl-cipher-suite-v1__ + + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "DHE-RSA-AES256-GCM-SHA384" + "DHE-RSA-AES128-GCM-SHA256" + "TLS_AES_128_GCM_SHA256" + "TLS_AES_256_GCM_SHA384" + "TLS_CHACHA20_POLY1305_SHA256" + + * __oci-tls-13-recommended-ssl-cipher-suite-v1__ + + "TLS_AES_128_GCM_SHA256" + "TLS_AES_256_GCM_SHA384" + "TLS_CHACHA20_POLY1305_SHA256" + + * __oci-tls-12-13-wider-ssl-cipher-suite-v1__ + + "TLS_AES_128_GCM_SHA256" + "TLS_AES_256_GCM_SHA384" + "TLS_CHACHA20_POLY1305_SHA256" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-SHA256" + "ECDHE-RSA-AES128-SHA256" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-SHA384" + "ECDHE-RSA-AES256-SHA384" + "AES128-GCM-SHA256" + "AES128-SHA256" + "AES256-GCM-SHA384" + "AES256-SHA256" + + * __oci-tls-11-12-13-wider-ssl-cipher-suite-v1__ + "TLS_AES_128_GCM_SHA256" + "TLS_AES_256_GCM_SHA384" + "TLS_CHACHA20_POLY1305_SHA256" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-SHA256" + "ECDHE-RSA-AES128-SHA256" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-SHA384" + "ECDHE-RSA-AES256-SHA384" + "AES128-GCM-SHA256" + "AES128-SHA256" + "AES256-GCM-SHA384" + "AES256-SHA256" + "ECDHE-ECDSA-AES128-SHA" + "ECDHE-RSA-AES128-SHA" + "ECDHE-RSA-AES256-SHA" + "ECDHE-ECDSA-AES256-SHA" + "AES128-SHA" + "AES256-SHA" + properties: + ciphers: + description: | + A list of SSL ciphers the load balancer must support for HTTPS or SSL connections. + + The following ciphers are valid values for this property: + + * __TLSv1.3 ciphers__ + + "TLS_AES_128_GCM_SHA256" + "TLS_AES_256_GCM_SHA384" + "TLS_CHACHA20_POLY1305_SHA256" + "TLS_AES_128_CCM_SHA256" + "TLS_AES_128_CCM_8_SHA256" + + * __TLSv1.2 ciphers__ + + "AES128-GCM-SHA256" + "AES128-SHA256" + "AES256-GCM-SHA384" + "AES256-SHA256" + "DH-DSS-AES128-GCM-SHA256" + "DH-DSS-AES128-SHA256" + "DH-DSS-AES256-GCM-SHA384" + "DH-DSS-AES256-SHA256" + "DH-RSA-AES128-GCM-SHA256" + "DH-RSA-AES128-SHA256" + "DH-RSA-AES256-GCM-SHA384" + "DH-RSA-AES256-SHA256" + "DHE-DSS-AES128-GCM-SHA256" + "DHE-DSS-AES128-SHA256" + "DHE-DSS-AES256-GCM-SHA384" + "DHE-DSS-AES256-SHA256" + "DHE-RSA-AES128-GCM-SHA256" + "DHE-RSA-AES128-SHA256" + "DHE-RSA-AES256-GCM-SHA384" + "DHE-RSA-AES256-SHA256" + "ECDH-ECDSA-AES128-GCM-SHA256" + "ECDH-ECDSA-AES128-SHA256" + "ECDH-ECDSA-AES256-GCM-SHA384" + "ECDH-ECDSA-AES256-SHA384" + "ECDH-RSA-AES128-GCM-SHA256" + "ECDH-RSA-AES128-SHA256" + "ECDH-RSA-AES256-GCM-SHA384" + "ECDH-RSA-AES256-SHA384" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-SHA256" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-SHA384" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-RSA-AES128-SHA256" + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES256-SHA384" + + * __TLSv1 ciphers also supported by TLSv1.2__ + + "AES128-SHA" + "AES256-SHA" + "CAMELLIA128-SHA" + "CAMELLIA256-SHA" + "DES-CBC3-SHA" + "DH-DSS-AES128-SHA" + "DH-DSS-AES256-SHA" + "DH-DSS-CAMELLIA128-SHA" + "DH-DSS-CAMELLIA256-SHA" + "DH-DSS-DES-CBC3-SHAv" + "DH-DSS-SEED-SHA" + "DH-RSA-AES128-SHA" + "DH-RSA-AES256-SHA" + "DH-RSA-CAMELLIA128-SHA" + "DH-RSA-CAMELLIA256-SHA" + "DH-RSA-DES-CBC3-SHA" + "DH-RSA-SEED-SHA" + "DHE-DSS-AES128-SHA" + "DHE-DSS-AES256-SHA" + "DHE-DSS-CAMELLIA128-SHA" + "DHE-DSS-CAMELLIA256-SHA" + "DHE-DSS-DES-CBC3-SHA" + "DHE-DSS-SEED-SHA" + "DHE-RSA-AES128-SHA" + "DHE-RSA-AES256-SHA" + "DHE-RSA-CAMELLIA128-SHA" + "DHE-RSA-CAMELLIA256-SHA" + "DHE-RSA-DES-CBC3-SHA" + "DHE-RSA-SEED-SHA" + "ECDH-ECDSA-AES128-SHA" + "ECDH-ECDSA-AES256-SHA" + "ECDH-ECDSA-DES-CBC3-SHA" + "ECDH-ECDSA-RC4-SHA" + "ECDH-RSA-AES128-SHA" + "ECDH-RSA-AES256-SHA" + "ECDH-RSA-DES-CBC3-SHA" + "ECDH-RSA-RC4-SHA" + "ECDHE-ECDSA-AES128-SHA" + "ECDHE-ECDSA-AES256-SHA" + "ECDHE-ECDSA-DES-CBC3-SHA" + "ECDHE-ECDSA-RC4-SHA" + "ECDHE-RSA-AES128-SHA" + "ECDHE-RSA-AES256-SHA" + "ECDHE-RSA-DES-CBC3-SHA" + "ECDHE-RSA-RC4-SHA" + "IDEA-CBC-SHA" + "KRB5-DES-CBC3-MD5" + "KRB5-DES-CBC3-SHA" + "KRB5-IDEA-CBC-MD5" + "KRB5-IDEA-CBC-SHA" + "KRB5-RC4-MD5" + "KRB5-RC4-SHA" + "PSK-3DES-EDE-CBC-SHA" + "PSK-AES128-CBC-SHA" + "PSK-AES256-CBC-SHA" + "PSK-RC4-SHA" + "RC4-MD5" + "RC4-SHA" + "SEED-SHA" + + example: `["ECDHE-RSA-AES256-GCM-SHA384","ECDHE-ECDSA-AES256-GCM-SHA384","ECDHE-RSA-AES128-GCM-SHA256"]` + items: + type: string + minItems: 1 + type: array + name: + description: | + A friendly name for the SSL cipher suite. It must be unique and it cannot be changed. + + **Note:** The name of your user-defined cipher suite must not be the same as any of Oracle's predefined or + reserved SSL cipher suite names: + + * oci-default-ssl-cipher-suite-v1 + * oci-modern-ssl-cipher-suite-v1 + * oci-compatible-ssl-cipher-suite-v1 + * oci-wider-compatible-ssl-cipher-suite-v1 + * oci-customized-ssl-cipher-suite + * oci-default-http2-ssl-cipher-suite-v1 + * oci-default-http2-tls-13-ssl-cipher-suite-v1 + * oci-default-http2-tls-12-13-ssl-cipher-suite-v1 + * oci-tls-13-recommended-ssl-cipher-suite-v1 + * oci-tls-12-13-wider-ssl-cipher-suite-v1 + * oci-tls-11-12-13-wider-ssl-cipher-suite-v1 + + example: `example_cipher_suite` + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]*$ + type: string + required: + - name + - ciphers + type: object + x-example: | + { + "ciphers" : [ + "ECDHE-RSA-AES256-GCM-SHA384", + "ECDHE-ECDSA-AES256-GCM-SHA384", + "ECDHE-RSA-AES128-GCM-SHA256" + ], + "name": "example_cipher_suite" + } + UpdateSSLCipherSuiteDetails: + description: | + The configuration details for updating an SSL cipher suite. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + ciphers: + description: | + A list of SSL ciphers the load balancer must support for HTTPS or SSL connections. + + The following ciphers are valid values for this property: + + * __TLSv1.3 ciphers__ + + "TLS_AES_128_GCM_SHA256" + "TLS_AES_256_GCM_SHA384" + "TLS_CHACHA20_POLY1305_SHA256" + "TLS_AES_128_CCM_SHA256" + "TLS_AES_128_CCM_8_SHA256" + + * __TLSv1.2 ciphers__ + + "AES128-GCM-SHA256" + "AES128-SHA256" + "AES256-GCM-SHA384" + "AES256-SHA256" + "DH-DSS-AES128-GCM-SHA256" + "DH-DSS-AES128-SHA256" + "DH-DSS-AES256-GCM-SHA384" + "DH-DSS-AES256-SHA256" + "DH-RSA-AES128-GCM-SHA256" + "DH-RSA-AES128-SHA256" + "DH-RSA-AES256-GCM-SHA384" + "DH-RSA-AES256-SHA256" + "DHE-DSS-AES128-GCM-SHA256" + "DHE-DSS-AES128-SHA256" + "DHE-DSS-AES256-GCM-SHA384" + "DHE-DSS-AES256-SHA256" + "DHE-RSA-AES128-GCM-SHA256" + "DHE-RSA-AES128-SHA256" + "DHE-RSA-AES256-GCM-SHA384" + "DHE-RSA-AES256-SHA256" + "ECDH-ECDSA-AES128-GCM-SHA256" + "ECDH-ECDSA-AES128-SHA256" + "ECDH-ECDSA-AES256-GCM-SHA384" + "ECDH-ECDSA-AES256-SHA384" + "ECDH-RSA-AES128-GCM-SHA256" + "ECDH-RSA-AES128-SHA256" + "ECDH-RSA-AES256-GCM-SHA384" + "ECDH-RSA-AES256-SHA384" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-SHA256" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-SHA384" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-RSA-AES128-SHA256" + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES256-SHA384" + + * __TLSv1 ciphers also supported by TLSv1.2__ + + "AES128-SHA" + "AES256-SHA" + "CAMELLIA128-SHA" + "CAMELLIA256-SHA" + "DES-CBC3-SHA" + "DH-DSS-AES128-SHA" + "DH-DSS-AES256-SHA" + "DH-DSS-CAMELLIA128-SHA" + "DH-DSS-CAMELLIA256-SHA" + "DH-DSS-DES-CBC3-SHAv" + "DH-DSS-SEED-SHA" + "DH-RSA-AES128-SHA" + "DH-RSA-AES256-SHA" + "DH-RSA-CAMELLIA128-SHA" + "DH-RSA-CAMELLIA256-SHA" + "DH-RSA-DES-CBC3-SHA" + "DH-RSA-SEED-SHA" + "DHE-DSS-AES128-SHA" + "DHE-DSS-AES256-SHA" + "DHE-DSS-CAMELLIA128-SHA" + "DHE-DSS-CAMELLIA256-SHA" + "DHE-DSS-DES-CBC3-SHA" + "DHE-DSS-SEED-SHA" + "DHE-RSA-AES128-SHA" + "DHE-RSA-AES256-SHA" + "DHE-RSA-CAMELLIA128-SHA" + "DHE-RSA-CAMELLIA256-SHA" + "DHE-RSA-DES-CBC3-SHA" + "DHE-RSA-SEED-SHA" + "ECDH-ECDSA-AES128-SHA" + "ECDH-ECDSA-AES256-SHA" + "ECDH-ECDSA-DES-CBC3-SHA" + "ECDH-ECDSA-RC4-SHA" + "ECDH-RSA-AES128-SHA" + "ECDH-RSA-AES256-SHA" + "ECDH-RSA-DES-CBC3-SHA" + "ECDH-RSA-RC4-SHA" + "ECDHE-ECDSA-AES128-SHA" + "ECDHE-ECDSA-AES256-SHA" + "ECDHE-ECDSA-DES-CBC3-SHA" + "ECDHE-ECDSA-RC4-SHA" + "ECDHE-RSA-AES128-SHA" + "ECDHE-RSA-AES256-SHA" + "ECDHE-RSA-DES-CBC3-SHA" + "ECDHE-RSA-RC4-SHA" + "IDEA-CBC-SHA" + "KRB5-DES-CBC3-MD5" + "KRB5-DES-CBC3-SHA" + "KRB5-IDEA-CBC-MD5" + "KRB5-IDEA-CBC-SHA" + "KRB5-RC4-MD5" + "KRB5-RC4-SHA" + "PSK-3DES-EDE-CBC-SHA" + "PSK-AES128-CBC-SHA" + "PSK-AES256-CBC-SHA" + "PSK-RC4-SHA" + "RC4-MD5" + "RC4-SHA" + "SEED-SHA" + + example: `["ECDHE-RSA-AES256-GCM-SHA384","ECDHE-ECDSA-AES256-GCM-SHA384","ECDHE-RSA-AES128-GCM-SHA256"]` + items: + type: string + minItems: 1 + type: array + required: + - ciphers + type: object + x-example: | + { + "ciphers": [ + "ECDHE-ECDSA-AES128-GCM-SHA256", + "ECDHE-RSA-AES128-GCM-SHA256" + ] + } + UpdateLoadBalancerShapeDetails: + properties: + shapeDetails: + $ref: '#/components/schemas/ShapeDetails' + shapeName: + description: | + The new shape name for the load balancer. + + Allowed values are : + * 10Mbps + * 100Mbps + * 400Mbps + * 8000Mbps + * Flexible + + Example: `flexible` + + * NOTE: Fixed shapes 10Mbps, 100Mbps, 400Mbps, 8000Mbps will be deprecated after May 2023. This api + * will only support `Flexible` shape after that date. + type: string + required: + - shapeName + type: object + x-example: | + { + "shapeName": "Flexible", + "shapeDetails": { + "minimumBandwidthInMbps": 150, + "maximumBandwidthInMbps": 1500 + } + } + Error: + properties: + code: + description: | + A short error code that defines the error, meant for programmatic parsing. See + [API Errors](/Content/API/References/apierrors.htm). + type: string + message: + description: | + A human-readable error string. + type: string + required: + - code + - message + x-example: | + { + "code" : "400", + "message" : "LimitExceeded" + } + type: object + WorkRequestError: + description: An object returned in the event of a work request error. + properties: + errorCode: + enum: + - BAD_INPUT + - INTERNAL_ERROR + type: string + message: + description: A human-readable error string. + type: string + required: + - errorCode + - message + type: object + x-example: | + { + "errorCode" : "BAD_INPUT", + "message" : "Default Listener on port '80' refer to VIP 'private-vip' twice" + } + IpAddress: + description: A load balancer IP address. + properties: + ipAddress: + description: | + An IP address. + + Example: `192.168.0.3` + type: string + isPublic: + description: | + Whether the IP address is public or private. + + If "true", the IP address is public and accessible from the internet. + + If "false", the IP address is private and accessible only from within the associated VCN. + type: boolean + reservedIp: + $ref: '#/components/schemas/ReservedIP' + required: + - ipAddress + x-example: | + { + "reservedIp": { + "id": "ocid1.publicip.oc1.phx.amaasavayhrfkyyamqzspkfppv5vsvbtlkyxq6cu2b34pv575empq7nv6zvp" + }, + "ipAddress": "192.168.0.3", + "isPublic": false + } + type: object + Listener: + description: | + The listener's configuration. + For more information on backend set configuration, see + [Managing Load Balancer Listeners](/Content/Balance/Tasks/managinglisteners.htm). + properties: + connectionConfiguration: + $ref: '#/components/schemas/ConnectionConfiguration' + defaultBackendSetName: + description: | + The name of the associated backend set. + + Example: `example_backend_set` + type: string + hostnameNames: + description: An array of hostname resource names. + items: + maxLength: 16 + minLength: 1 + type: string + type: array + name: + description: | + A friendly name for the listener. It must be unique and it cannot be changed. + + Example: `example_listener` + type: string + pathRouteSetName: + description: | + Deprecated. Please use `routingPolicies` instead. + + The name of the set of path-based routing rules, [PathRouteSet](#/en/loadbalancer/20170115/PathRouteSet/), + applied to this listener's traffic. + + Example: `example_path_route_set` + maxLength: 32 + minLength: 1 + type: string + port: + description: | + The communication port for the listener. + + Example: `80` + example: '0' + format: int32 + type: integer + protocol: + description: | + The protocol on which the listener accepts connection requests. + To get a list of valid protocols, use the [ListProtocols](#/en/loadbalancer/20170115/LoadBalancerProtocol/ListProtocols) + operation. + + Example: `HTTP` + type: string + routingPolicyName: + description: | + The name of the routing policy applied to this listener's traffic. + + Example: `example_routing_policy_name` + maxLength: 32 + minLength: 1 + pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ + type: string + ruleSetNames: + description: | + The names of the [rule sets](#/en/loadbalancer/20170115/RuleSet/) to apply to the listener. + + Example: ["example_rule_set"] + items: + maxLength: 32 + minLength: 1 + pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ + type: string + type: array + sslConfiguration: + $ref: '#/components/schemas/SSLConfiguration' + required: + - defaultBackendSetName + - name + - port + - protocol + type: object + x-example: | + { + "defaultBackendSetName": "example_backend_set", + "port": 80, + "protocol": "HTTP", + "hostnameNames": [ + "example_hostname_001", + "example_hostname_002" + ], + "pathRouteSetName": "example_path_route_set", + "sslConfiguration": { + "protocols": ["TLSv1.1", "TLSv1.2"], + "cipherSuiteName" : "example_cipher_suite", + "serverOrderPreference" : "ENABLED", + "certificateName": "example_certificate_bundle", + "verifyPeerCertificate": true + "verifyDepth": 3, + } + "connectionConfiguration": { + "idleTimeout": 1200 + } + "name": "example_listener" + } + ShapeDetails: + description: | + The configuration details to update load balancer to a different shape. + properties: + maximumBandwidthInMbps: + description: | + Bandwidth in Mbps that determines the maximum bandwidth (ingress plus egress) that the load balancer can + achieve. This bandwidth cannot be always guaranteed. For a guaranteed bandwidth use the minimumBandwidthInMbps + parameter. + + The values must be between minimumBandwidthInMbps and 8000 (8Gbps). + + Example: `1500` + format: int32 + maximum: 8000 + minimum: 10 + type: integer + minimumBandwidthInMbps: + description: | + Bandwidth in Mbps that determines the total pre-provisioned bandwidth (ingress plus egress). + The values must be between 10 and the maximumBandwidthInMbps. + + Example: `150` + format: int32 + maximum: 8000 + minimum: 10 + type: integer + required: + - minimumBandwidthInMbps + - maximumBandwidthInMbps + type: object + x-example: | + { + "minimumBandwidthInMbps": 150, + "maximumBandwidthInMbps": 1500 + } + BackendSetDetails: + description: | + The configuration details for a load balancer backend set. + For more information on backend set configuration, see + [Managing Backend Sets](/Content/Balance/Tasks/managingbackendsets.htm). + properties: + backendMaxConnections: + description: | + The maximum number of simultaneous connections the load balancer can make to any backend + in the backend set unless the backend has its own maxConnections setting. If this is not + set or set to 0 then the number of simultaneous connections the load balancer can make + to any backend in the backend set unless the backend has its own maxConnections setting + is unlimited. + + If setting backendMaxConnections to some value other than 0 then that value must be greater + or equal to 256. + + Example: `300` + format: int32 + maximum: 65535 + minimum: 0 + type: integer + backends: + items: + $ref: '#/components/schemas/BackendDetails' + type: array + uniqueItems: true + healthChecker: + $ref: '#/components/schemas/HealthCheckerDetails' + policy: + description: | + The load balancer policy for the backend set. To get a list of available policies, use the + [ListPolicies](#/en/loadbalancer/20170115/LoadBalancerPolicy/ListPolicies) operation. + + Example: `LEAST_CONNECTIONS` + type: string + sessionPersistenceConfiguration: + $ref: '#/components/schemas/SessionPersistenceConfigurationDetails' + sslConfiguration: + $ref: '#/components/schemas/SSLConfigurationDetails' + required: + - healthChecker + - policy + type: object + x-example: | + { + "policy": "LEAST_CONNECTIONS", + "backends": [ + { + "ipAddress": "10.0.0.3", + "port": 8080, + "weight": 3, + "backup": false, + "drain": false, + "offline": false + }, + { + "ipAddress": "10.0.0.4", + "port": 8080, + "weight": 1, + "backup": false, + "drain": false, + "offline": false + } + ], + "backendMaxConnections": 300, + "healthChecker": { + "protocol": "HTTP", + "isForcePlainText": false, + "urlPath": "/healthcheck", + "port": 8080, + "returnCode": 200, + "retries": 3, + "timeoutInMillis": 3000, + "intervalInMillis": 10000, + "responseBodyRegex": "^((?!false).|\s)*$" + }, + "sslConfiguration": { + "protocols": ["TLSv1.1", "TLSv1.2"], + "cipherSuiteName" : "example_cipher_suite", + "serverOrderPreference" : "ENABLED", + "certificateName": "example_certificate_bundle", + "verifyPeerCertificate": true, + "verifyDepth": 3 + }, + "sessionPersistenceConfiguration": { + "cookieName": "example_cookie", + "disableFallback": false + } + } + CertificateDetails: + description: | + The configuration details for a certificate bundle. + For more information on SSL certficate configuration, see + [Managing SSL Certificates](/Content/Balance/Tasks/managingcertificates.htm). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + caCertificate: + description: | + The Certificate Authority certificate, or any interim certificate, that you received from your SSL certificate provider. + + Example: + + -----BEGIN CERTIFICATE----- + MIIEczCCA1ugAwIBAgIBADANBgkqhkiG9w0BAQQFAD..AkGA1UEBhMCR0Ix + EzARBgNVBAgTClNvbWUtU3RhdGUxFDASBgNVBAoTC0..0EgTHRkMTcwNQYD + VQQLEy5DbGFzcyAxIFB1YmxpYyBQcmltYXJ5IENlcn..XRpb24gQXV0aG9y + aXR5MRQwEgYDVQQDEwtCZXN0IENBIEx0ZDAeFw0wMD..TUwMTZaFw0wMTAy + ... + -----END CERTIFICATE----- + type: string + certificateName: + description: | + A friendly name for the certificate bundle. It must be unique and it cannot be changed. + Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. + Certificate bundle names cannot contain spaces. Avoid entering confidential information. + + Example: `example_certificate_bundle` + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9_.-]*$ + type: string + passphrase: + description: | + A passphrase for encrypted private keys. This is needed only if you created your certificate with a passphrase. + type: string + privateKey: + description: | + The SSL private key for your certificate, in PEM format. + + Example: + + -----BEGIN RSA PRIVATE KEY----- + jO1O1v2ftXMsawM90tnXwc6xhOAT1gDBC9S8DKeca..JZNUgYYwNS0dP2UK + tmyN+XqVcAKw4HqVmChXy5b5msu8eIq3uc2NqNVtR..2ksSLukP8pxXcHyb + +sEwvM4uf8qbnHAqwnOnP9+KV9vds6BaH1eRA4CHz..n+NVZlzBsTxTlS16 + /Umr7wJzVrMqK5sDiSu4WuaaBdqMGfL5hLsTjcBFD..Da2iyQmSKuVD4lIZ + ... + -----END RSA PRIVATE KEY----- + type: string + publicCertificate: + description: | + The public certificate, in PEM format, that you received from your SSL certificate provider. + + Example: + + -----BEGIN CERTIFICATE----- + MIIC2jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwG + A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxETAPBgNVBAoTCEZyYW5rNERE + MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdl + YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIw + ... + -----END CERTIFICATE----- + type: string + required: + - certificateName + type: object + x-example: | + { + "passphrase": "<passphrase>", + "privateKey": "<private_key>", + "publicCertificate": "<public_certificate>", + "caCertificate": "<ca_certificate>", + "certificateName": "example_certificate_bundle", + } + HostnameDetails: + description: The details of a hostname resource associated with a load balancer. + properties: + hostname: + description: | + A virtual hostname. For more information about virtual hostname string construction, see + [Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm#routing). + + Example: `app.example.com` + type: string + name: + description: | + The name of the hostname resource. + + Example: `example_hostname_001` + type: string + required: + - name + - hostname + type: object + ListenerDetails: + description: The listener's configuration details. + properties: + connectionConfiguration: + $ref: '#/components/schemas/ConnectionConfiguration' + defaultBackendSetName: + description: | + The name of the associated backend set. + + Example: `example_backend_set` + maxLength: 32 + minLength: 1 + type: string + hostnameNames: + description: An array of hostname resource names. + items: + maxLength: 16 + minLength: 1 + type: string + type: array + pathRouteSetName: + description: | + Deprecated. Please use `routingPolicies` instead. + + The name of the set of path-based routing rules, [PathRouteSet](#/en/loadbalancer/20170115/PathRouteSet/), + applied to this listener's traffic. + + Example: `example_path_route_set` + maxLength: 32 + minLength: 1 + type: string + port: + description: | + The communication port for the listener. + + Example: `80` + format: int32 + maximum: 65535 + minimum: 1 + type: integer + protocol: + description: | + The protocol on which the listener accepts connection requests. + To get a list of valid protocols, use the [ListProtocols](#/en/loadbalancer/20170115/LoadBalancerProtocol/ListProtocols) + operation. + + Example: `HTTP` + type: string + routingPolicyName: + description: | + The name of the routing policy applied to this listener's traffic. + + Example: `example_routing_policy` + maxLength: 32 + minLength: 1 + pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ + type: string + ruleSetNames: + description: | + The names of the [rule sets](#/en/loadbalancer/20170115/RuleSet/) to apply to the listener. + + Example: ["example_rule_set"] + items: + maxLength: 32 + minLength: 1 + pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ + type: string + type: array + sslConfiguration: + $ref: '#/components/schemas/SSLConfigurationDetails' + required: + - defaultBackendSetName + - port + - protocol + type: object + x-example: | + { + "defaultBackendSetName": "example_backend_set", + "port": 80, + "protocol": "HTTP", + "pathRouteSetName": "example_path_route_set", + "sslConfiguration": { + "protocols": ["TLSv1.1", "TLSv1.2"], + "cipherSuiteName" : "example_cipher_suite", + "serverOrderPreference" : "ENABLED", + "certificateName": "example_certificate_bundle", + "verifyPeerCertificate": true + "verifyDepth": 3, + } + "connectionConfiguration": { + "idleTimeout": 1200 + } + } + PathRouteSetDetails: + description: A set of path route rules. + properties: + pathRoutes: + description: The set of path route rules. + items: + $ref: '#/components/schemas/PathRoute' + maxItems: 20 + minItems: 1 + type: array + required: + - pathRoutes + type: object + x-example: | + { + "pathRoutes": [ + { + "path": "/example/video/123", + "pathMatchType": { + "matchType": "EXACT_MATCH" + }, + "backendSetName": "example_backend_set" + } + ] + } + ReservedIP: + properties: + id: + description: | + Ocid of the Reserved IP/Public Ip created with VCN. + + Reserved IPs are IPs which already registered using VCN API. + + Create a reserved Public IP and then while creating the load balancer pass the ocid of the reserved IP in this + field reservedIp to attach the Ip to Load balancer. Load balancer will be configured to listen to traffic on this IP. + + Reserved IPs will not be deleted when the Load balancer is deleted. They will be unattached from the Load balancer. + + Example: "ocid1.publicip.oc1.phx.unique_ID" + + IPV6 example: "ocid1.ipv6.oc1.phx.unique_ID" + type: string + type: object + RuleSetDetails: + description: The rules that compose a rule set. + properties: + items: + description: An array of rules that compose the rule set. + items: + $ref: '#/components/schemas/Rule' + type: array + required: + - items + type: object + x-example: | + { + "items": [ + { + "action": "ADD_REQUEST_HEADER", + "header": "example_header_name", + "value": "example_value" + }, + { + "action": "EXTEND_HTTP_REQUEST_HEADER_VALUE", + "header": "example_header_name2", + "prefix": "example_prefix_value", + "suffix": "example_suffix_value" + } + ] + } + SSLCipherSuiteDetails: + description: | + The configuration details of an SSL cipher suite. + + The algorithms that compose a cipher suite help you secure Transport Layer Security (TLS) or Secure Socket Layer + (SSL) network connections. A cipher suite defines the list of security algorithms your load balancer uses to + negotiate with peers while sending and receiving information. The cipher suites you use affect the security + level, performance, and compatibility of your data traffic. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + + Oracle created the following predefined cipher suites that you can specify when you define a resource's + [SSL configuration](/api/#/en/loadbalancer/20170115/datatypes/SSLConfigurationDetails). You can [create custom + cipher suites](/api/#/en/loadbalancer/20170115/SSLCipherSuite/CreateSSLCipherSuite) if the predefined cipher + suites do not meet your requirements. + + + * __oci-default-ssl-cipher-suite-v1__ + + "DHE-RSA-AES128-GCM-SHA256" + "DHE-RSA-AES128-SHA256" + "DHE-RSA-AES256-GCM-SHA384" + "DHE-RSA-AES256-SHA256" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-RSA-AES128-SHA256" + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES256-SHA384" + + * __oci-modern-ssl-cipher-suite-v1__ + + "AES128-GCM-SHA256" + "AES128-SHA256" + "AES256-GCM-SHA384" + "AES256-SHA256" + "DHE-RSA-AES128-GCM-SHA256" + "DHE-RSA-AES128-SHA256" + "DHE-RSA-AES256-GCM-SHA384" + "DHE-RSA-AES256-SHA256" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-SHA256" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-SHA384" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-RSA-AES128-SHA256" + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES256-SHA384" + + * __oci-compatible-ssl-cipher-suite-v1__ + + "AES128-GCM-SHA256" + "AES128-SHA" + "AES128-SHA256" + "AES256-GCM-SHA384" + "AES256-SHA" + "AES256-SHA256" + "DHE-RSA-AES128-GCM-SHA256" + "DHE-RSA-AES128-SHA256" + "DHE-RSA-AES256-GCM-SHA384" + "DHE-RSA-AES256-SHA256" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-SHA" + "ECDHE-ECDSA-AES128-SHA256" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-SHA" + "ECDHE-ECDSA-AES256-SHA384" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-RSA-AES128-SHA" + "ECDHE-RSA-AES128-SHA256" + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES256-SHA" + "ECDHE-RSA-AES256-SHA384" + + * __oci-wider-compatible-ssl-cipher-suite-v1__ + + "AES128-GCM-SHA256" + "AES128-SHA" + "AES128-SHA256" + "AES256-GCM-SHA384" + "AES256-SHA" + "AES256-SHA256" + "CAMELLIA128-SHA" + "CAMELLIA256-SHA" + "DES-CBC3-SHA" + "DH-DSS-AES128-GCM-SHA256" + "DH-DSS-AES128-SHA" + "DH-DSS-AES128-SHA256" + "DH-DSS-AES256-GCM-SHA384" + "DH-DSS-AES256-SHA" + "DH-DSS-AES256-SHA256" + "DH-DSS-CAMELLIA128-SHA" + "DH-DSS-CAMELLIA256-SHA" + "DH-DSS-DES-CBC3-SHAv" + "DH-DSS-SEED-SHA" + "DH-RSA-AES128-GCM-SHA256" + "DH-RSA-AES128-SHA" + "DH-RSA-AES128-SHA256" + "DH-RSA-AES256-GCM-SHA384" + "DH-RSA-AES256-SHA" + "DH-RSA-AES256-SHA256" + "DH-RSA-CAMELLIA128-SHA" + "DH-RSA-CAMELLIA256-SHA" + "DH-RSA-DES-CBC3-SHA" + "DH-RSA-SEED-SHA" + "DHE-DSS-AES128-GCM-SHA256" + "DHE-DSS-AES128-SHA" + "DHE-DSS-AES128-SHA256" + "DHE-DSS-AES256-GCM-SHA384" + "DHE-DSS-AES256-SHA" + "DHE-DSS-AES256-SHA256" + "DHE-DSS-CAMELLIA128-SHA" + "DHE-DSS-CAMELLIA256-SHA" + "DHE-DSS-DES-CBC3-SHA" + "DHE-DSS-SEED-SHA" + "DHE-RSA-AES128-GCM-SHA256" + "DHE-RSA-AES128-SHA" + "DHE-RSA-AES128-SHA256" + "DHE-RSA-AES256-GCM-SHA384" + "DHE-RSA-AES256-SHA" + "DHE-RSA-AES256-SHA256" + "DHE-RSA-CAMELLIA128-SHA" + "DHE-RSA-CAMELLIA256-SHA" + "DHE-RSA-DES-CBC3-SHA" + "DHE-RSA-SEED-SHA" + "ECDH-ECDSA-AES128-GCM-SHA256" + "ECDH-ECDSA-AES128-SHA" + "ECDH-ECDSA-AES128-SHA256" + "ECDH-ECDSA-AES256-GCM-SHA384" + "ECDH-ECDSA-AES256-SHA" + "ECDH-ECDSA-AES256-SHA384" + "ECDH-ECDSA-DES-CBC3-SHA" + "ECDH-ECDSA-RC4-SHA" + "ECDH-RSA-AES128-GCM-SHA256" + "ECDH-RSA-AES128-SHA" + "ECDH-RSA-AES128-SHA256" + "ECDH-RSA-AES256-GCM-SHA384" + "ECDH-RSA-AES256-SHA" + "ECDH-RSA-AES256-SHA384" + "ECDH-RSA-DES-CBC3-SHA" + "ECDH-RSA-RC4-SHA" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-SHA" + "ECDHE-ECDSA-AES128-SHA256" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-SHA" + "ECDHE-ECDSA-AES256-SHA384" + "ECDHE-ECDSA-DES-CBC3-SHA" + "ECDHE-ECDSA-RC4-SHA" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-RSA-AES128-SHA" + "ECDHE-RSA-AES128-SHA256" + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES256-SHA" + "ECDHE-RSA-AES256-SHA384" + "ECDHE-RSA-DES-CBC3-SHA" + "ECDHE-RSA-RC4-SHA" + "IDEA-CBC-SHA" + "KRB5-DES-CBC3-MD5" + "KRB5-DES-CBC3-SHA" + "KRB5-IDEA-CBC-MD5" + "KRB5-IDEA-CBC-SHA" + "KRB5-RC4-MD5" + "KRB5-RC4-SHA" + "PSK-3DES-EDE-CBC-SHA" + "PSK-AES128-CBC-SHA" + "PSK-AES256-CBC-SHA" + "PSK-RC4-SHA" + "RC4-MD5" + "RC4-SHA" + "SEED-SHA" + + * __oci-default-http2-ssl-cipher-suite-v1__ + + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "DHE-RSA-AES256-GCM-SHA384" + "DHE-RSA-AES128-GCM-SHA256" + + * __oci-default-http2-tls-13-ssl-cipher-suite-v1__ + + "TLS_AES_128_GCM_SHA256" + "TLS_AES_256_GCM_SHA384" + "TLS_CHACHA20_POLY1305_SHA256" + + * __oci-default-http2-tls-12-13-ssl-cipher-suite-v1__ + + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "DHE-RSA-AES256-GCM-SHA384" + "DHE-RSA-AES128-GCM-SHA256" + "TLS_AES_128_GCM_SHA256" + "TLS_AES_256_GCM_SHA384" + "TLS_CHACHA20_POLY1305_SHA256" + + * __oci-tls-13-recommended-ssl-cipher-suite-v1__ + + "TLS_AES_128_GCM_SHA256" + "TLS_AES_256_GCM_SHA384" + "TLS_CHACHA20_POLY1305_SHA256" + + * __oci-tls-12-13-wider-ssl-cipher-suite-v1__ + + "TLS_AES_128_GCM_SHA256" + "TLS_AES_256_GCM_SHA384" + "TLS_CHACHA20_POLY1305_SHA256" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-SHA256" + "ECDHE-RSA-AES128-SHA256" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-SHA384" + "ECDHE-RSA-AES256-SHA384" + "AES128-GCM-SHA256" + "AES128-SHA256" + "AES256-GCM-SHA384" + "AES256-SHA256" + + * __oci-tls-11-12-13-wider-ssl-cipher-suite-v1__ + "TLS_AES_128_GCM_SHA256" + "TLS_AES_256_GCM_SHA384" + "TLS_CHACHA20_POLY1305_SHA256" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-SHA256" + "ECDHE-RSA-AES128-SHA256" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-SHA384" + "ECDHE-RSA-AES256-SHA384" + "AES128-GCM-SHA256" + "AES128-SHA256" + "AES256-GCM-SHA384" + "AES256-SHA256" + "ECDHE-ECDSA-AES128-SHA" + "ECDHE-RSA-AES128-SHA" + "ECDHE-RSA-AES256-SHA" + "ECDHE-ECDSA-AES256-SHA" + "AES128-SHA" + "AES256-SHA" + properties: + ciphers: + description: | + A list of SSL ciphers the load balancer must support for HTTPS or SSL connections. + + The following ciphers are valid values for this property: + + * __TLSv1.3 ciphers__ + + "TLS_AES_128_GCM_SHA256" + "TLS_AES_256_GCM_SHA384" + "TLS_CHACHA20_POLY1305_SHA256" + "TLS_AES_128_CCM_SHA256" + "TLS_AES_128_CCM_8_SHA256" + + * __TLSv1.2 ciphers__ + + "AES128-GCM-SHA256" + "AES128-SHA256" + "AES256-GCM-SHA384" + "AES256-SHA256" + "DH-DSS-AES128-GCM-SHA256" + "DH-DSS-AES128-SHA256" + "DH-DSS-AES256-GCM-SHA384" + "DH-DSS-AES256-SHA256" + "DH-RSA-AES128-GCM-SHA256" + "DH-RSA-AES128-SHA256" + "DH-RSA-AES256-GCM-SHA384" + "DH-RSA-AES256-SHA256" + "DHE-DSS-AES128-GCM-SHA256" + "DHE-DSS-AES128-SHA256" + "DHE-DSS-AES256-GCM-SHA384" + "DHE-DSS-AES256-SHA256" + "DHE-RSA-AES128-GCM-SHA256" + "DHE-RSA-AES128-SHA256" + "DHE-RSA-AES256-GCM-SHA384" + "DHE-RSA-AES256-SHA256" + "ECDH-ECDSA-AES128-GCM-SHA256" + "ECDH-ECDSA-AES128-SHA256" + "ECDH-ECDSA-AES256-GCM-SHA384" + "ECDH-ECDSA-AES256-SHA384" + "ECDH-RSA-AES128-GCM-SHA256" + "ECDH-RSA-AES128-SHA256" + "ECDH-RSA-AES256-GCM-SHA384" + "ECDH-RSA-AES256-SHA384" + "ECDHE-ECDSA-AES128-GCM-SHA256" + "ECDHE-ECDSA-AES128-SHA256" + "ECDHE-ECDSA-AES256-GCM-SHA384" + "ECDHE-ECDSA-AES256-SHA384" + "ECDHE-RSA-AES128-GCM-SHA256" + "ECDHE-RSA-AES128-SHA256" + "ECDHE-RSA-AES256-GCM-SHA384" + "ECDHE-RSA-AES256-SHA384" + + * __TLSv1 ciphers also supported by TLSv1.2__ + + "AES128-SHA" + "AES256-SHA" + "CAMELLIA128-SHA" + "CAMELLIA256-SHA" + "DES-CBC3-SHA" + "DH-DSS-AES128-SHA" + "DH-DSS-AES256-SHA" + "DH-DSS-CAMELLIA128-SHA" + "DH-DSS-CAMELLIA256-SHA" + "DH-DSS-DES-CBC3-SHAv" + "DH-DSS-SEED-SHA" + "DH-RSA-AES128-SHA" + "DH-RSA-AES256-SHA" + "DH-RSA-CAMELLIA128-SHA" + "DH-RSA-CAMELLIA256-SHA" + "DH-RSA-DES-CBC3-SHA" + "DH-RSA-SEED-SHA" + "DHE-DSS-AES128-SHA" + "DHE-DSS-AES256-SHA" + "DHE-DSS-CAMELLIA128-SHA" + "DHE-DSS-CAMELLIA256-SHA" + "DHE-DSS-DES-CBC3-SHA" + "DHE-DSS-SEED-SHA" + "DHE-RSA-AES128-SHA" + "DHE-RSA-AES256-SHA" + "DHE-RSA-CAMELLIA128-SHA" + "DHE-RSA-CAMELLIA256-SHA" + "DHE-RSA-DES-CBC3-SHA" + "DHE-RSA-SEED-SHA" + "ECDH-ECDSA-AES128-SHA" + "ECDH-ECDSA-AES256-SHA" + "ECDH-ECDSA-DES-CBC3-SHA" + "ECDH-ECDSA-RC4-SHA" + "ECDH-RSA-AES128-SHA" + "ECDH-RSA-AES256-SHA" + "ECDH-RSA-DES-CBC3-SHA" + "ECDH-RSA-RC4-SHA" + "ECDHE-ECDSA-AES128-SHA" + "ECDHE-ECDSA-AES256-SHA" + "ECDHE-ECDSA-DES-CBC3-SHA" + "ECDHE-ECDSA-RC4-SHA" + "ECDHE-RSA-AES128-SHA" + "ECDHE-RSA-AES256-SHA" + "ECDHE-RSA-DES-CBC3-SHA" + "ECDHE-RSA-RC4-SHA" + "IDEA-CBC-SHA" + "KRB5-DES-CBC3-MD5" + "KRB5-DES-CBC3-SHA" + "KRB5-IDEA-CBC-MD5" + "KRB5-IDEA-CBC-SHA" + "KRB5-RC4-MD5" + "KRB5-RC4-SHA" + "PSK-3DES-EDE-CBC-SHA" + "PSK-AES128-CBC-SHA" + "PSK-AES256-CBC-SHA" + "PSK-RC4-SHA" + "RC4-MD5" + "RC4-SHA" + "SEED-SHA" + + example: `["ECDHE-RSA-AES256-GCM-SHA384","ECDHE-ECDSA-AES256-GCM-SHA384","ECDHE-RSA-AES128-GCM-SHA256"]` + items: + type: string + minItems: 1 + type: array + name: + description: | + A friendly name for the SSL cipher suite. It must be unique and it cannot be changed. + + **Note:** The name of your user-defined cipher suite must not be the same as any of Oracle's predefined or + reserved SSL cipher suite names: + + * oci-default-ssl-cipher-suite-v1 + * oci-modern-ssl-cipher-suite-v1 + * oci-compatible-ssl-cipher-suite-v1 + * oci-wider-compatible-ssl-cipher-suite-v1 + * oci-customized-ssl-cipher-suite + * oci-default-http2-ssl-cipher-suite-v1 + * oci-default-http2-tls-13-ssl-cipher-suite-v1 + * oci-default-http2-tls-12-13-ssl-cipher-suite-v1 + * oci-tls-13-recommended-ssl-cipher-suite-v1 + * oci-tls-12-13-wider-ssl-cipher-suite-v1 + * oci-tls-11-12-13-wider-ssl-cipher-suite-v1 + + example: `example_cipher_suite` + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]*$ + type: string + required: + - name + - ciphers + type: object + x-example: | + { + "ciphers" : ['ECDHE-RSA-AES256-GCM-SHA384','ECDHE-ECDSA-AES256-GCM-SHA384','ECDHE-RSA-AES128-GCM-SHA256'], + "name": "example_cipher_suite" + } + SessionPersistenceConfigurationDetails: + description: | + The configuration details for implementing session persistence based on a user-specified cookie name (application + cookie stickiness). + + Session persistence enables the Load Balancing service to direct any number of requests that originate from a single + logical client to a single backend web server. For more information, see + [Session Persistence](/Content/Balance/Reference/sessionpersistence.htm). + + To disable application cookie stickiness on a running load balancer, use the + [UpdateBackendSet](#/en/loadbalancer/20170115/BackendSet/UpdateBackendSet) operation and specify `null` for the + `SessionPersistenceConfigurationDetails` object. + + Example: `SessionPersistenceConfigurationDetails: null` + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + cookieName: + description: | + The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify + that any cookie set by the backend causes the session to persist. + + Example: `example_cookie` + maxLength: 4096 + minLength: 1 + type: string + disableFallback: + default: false + description: | + Whether the load balancer is prevented from directing traffic from a persistent session client to + a different backend server if the original server is unavailable. Defaults to false. + + Example: `false` + type: boolean + required: + - cookieName + type: object + x-example: | + { + "cookieName": "example_cookie", + "disableFallback": false + } + SSLConfiguration: + description: | + A listener's SSL handling configuration. + + To use SSL, a listener must be associated with a [certificate bundle](#/en/loadbalancer/20170115/Certificate/). + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + certificateIds: + description: | + Ids for OCI certificates service certificates. Currently only a single Id may be passed. + + Example: `[ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]` + example: 'true' + items: + maxLength: 255 + minLength: 1 + type: string + type: array + uniqueItems: true + certificateName: + description: | + A friendly name for the certificate bundle. It must be unique and it cannot be changed. + Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. + Certificate bundle names cannot contain spaces. Avoid entering confidential information. + + Example: `example_certificate_bundle` + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9_.-]*$ + type: string + cipherSuiteName: + default: oci-default-ssl-cipher-suite-v1 + description: | + The name of the cipher suite to use for HTTPS or SSL connections. + + If this field is not specified, the default is `oci-default-ssl-cipher-suite-v1`. + + **Notes:** + + * You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher + suite. Clients cannot perform an SSL handshake if there is an incompatible configuration. + * You must ensure compatibility between the ciphers configured in the cipher suite and the configured + certificates. For example, RSA-based ciphers require RSA certificates and ECDSA-based ciphers require ECDSA + certificates. + * If the cipher configuration is not modified after load balancer creation, the `GET` operation returns + `oci-default-ssl-cipher-suite-v1` as the value of this field in the SSL configuration for existing listeners + that predate this feature. + * If the cipher configuration was modified using Oracle operations after load balancer creation, the `GET` + operation returns `oci-customized-ssl-cipher-suite` as the value of this field in the SSL configuration for + existing listeners that predate this feature. + * The `GET` operation returns `oci-wider-compatible-ssl-cipher-suite-v1` as the value of this field in the SSL + configuration for existing backend sets that predate this feature. + * If the `GET` operation on a listener returns `oci-customized-ssl-cipher-suite` as the value of this field, + you must specify an appropriate predefined or custom cipher suite name when updating the resource. + * The `oci-customized-ssl-cipher-suite` Oracle reserved cipher suite name is not accepted as valid input for + this field. + + example: `example_cipher_suite` + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]*$ + type: string + protocols: + default: TLSv1.2 + description: | + A list of SSL protocols the load balancer must support for HTTPS or SSL connections. + + The load balancer uses SSL protocols to establish a secure connection between a client and a server. A secure + connection ensures that all data passed between the client and the server is private. + + The Load Balancing service supports the following protocols: + + * TLSv1 + * TLSv1.1 + * TLSv1.2 + * TLSv1.3 + + If this field is not specified, TLSv1.2 is the default. + + **Warning:** All SSL listeners created on a given port must use the same set of SSL protocols. + + **Notes:** + + * The handshake to establish an SSL connection fails if the client supports none of the specified protocols. + * You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher + suite. + * For all existing load balancer listeners and backend sets that predate this feature, the `GET` operation + displays a list of SSL protocols currently used by those resources. + + example: `["TLSv1.1", "TLSv1.2"]` + items: + type: string + type: array + serverOrderPreference: + default: ENABLED + description: | + When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client + ciphers. + + **Note:** This configuration is applicable only when the load balancer is acting as an SSL/HTTPS server. This + field is ignored when the `SSLConfiguration` object is associated with a backend set. + enum: + - ENABLED + - DISABLED + example: ENABLED + type: string + trustedCertificateAuthorityIds: + description: | + Ids for OCI certificates service CA or CA bundles for the load balancer to trust. + + Example: `[ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]` + example: 'true' + items: + maxLength: 255 + minLength: 1 + type: string + type: array + uniqueItems: true + verifyDepth: + description: | + The maximum depth for peer certificate chain verification. + + Example: `3` + format: int32 + type: integer + verifyPeerCertificate: + default: false + description: | + Whether the load balancer listener should verify peer certificates. + + Example: `true` + example: 'true' + type: boolean + required: + - verifyDepth + - verifyPeerCertificate + type: object + x-example: | + [ + { + "protocols": ["TLSv1.1", "TLSv1.2"], + "cipherSuiteName" : "example_cipher_suite", + "serverOrderPreference" : "ENABLED", + "certificateName": "example_certificate_bundle", + "verifyPeerCertificate": true + "verifyDepth": 3, + }, + { + "certificateIds": [ "example_certificate_id" ], + "trustedCertificateAuthorityIds": [ "example_certificate_authority_id", "example_certificate_bundle_id"] + "verifyPeerCertificate": true + "verifyDepth": 3, + } + ] + BackendDetails: + description: The load balancing configuration details of a backend server. + properties: + backup: + default: false + description: | + Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress + traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy. + + **Note:** You cannot add a backend server marked as `backup` to a backend set that uses the IP Hash policy. + + Example: `false` + type: boolean + drain: + default: false + description: | + Whether the load balancer should drain this server. Servers marked "drain" receive no new + incoming traffic. + + Example: `false` + type: boolean + ipAddress: + description: | + The IP address of the backend server. + + Example: `10.0.0.3` + type: string + maxConnections: + description: | + The maximum number of simultaneous connections the load balancer can make to the backend. + If this is not set or set to 0 then the maximum number of simultaneous connections the + load balancer can make to the backend is unlimited. + + If setting maxConnections to some value other than 0 then that value must be greater + or equal to 256. + + Example: `300` + format: int32 + maximum: 65535 + minimum: 0 + type: integer + offline: + default: false + description: | + Whether the load balancer should treat this server as offline. Offline servers receive no incoming + traffic. + + Example: `false` + type: boolean + port: + description: | + The communication port for the backend server. + + Example: `8080` + format: int32 + maximum: 65535 + minimum: 1 + type: integer + weight: + description: | + The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger + proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections + as a server weighted '1'. + For more information on load balancing policies, see + [How Load Balancing Policies Work](/Content/Balance/Reference/lbpolicies.htm). + + Example: `3` + format: int32 + type: integer + required: + - ipAddress + - port + type: object + x-example: | + { + "ipAddress": "10.0.0.3", + "port": 8080, + "weight": 3, + "maxConections": 300, + "backup": false, + "drain": false, + "offline": false + } + HealthCheckerDetails: + description: The health check policy's configuration details. + properties: + intervalInMillis: + description: | + The interval between health checks, in milliseconds. + + Example: `10000` + format: int32 + maximum: 1800000 + minimum: 1000 + type: integer + isForcePlainText: + default: false + description: | + Specifies if health checks should always be done using plain text instead of depending on + whether or not the associated backend set is using SSL. + + If "true", health checks will be done using plain text even if the associated backend set is configured + to use SSL. + + If "false", health checks will be done using SSL encryption if the associated backend set is configured + to use SSL. If the backend set is not so configured the health checks will be done using plain text. + + Example: `false` + type: boolean + port: + description: | + The backend server port against which to run the health check. If the port is not specified, the load balancer uses the + port information from the `Backend` object. + + Example: `8080` + format: int32 + maximum: 65535 + minimum: 0 + type: integer + protocol: + description: | + The protocol the health check must use; either HTTP or TCP. + + Example: `HTTP` + type: string + responseBodyRegex: + description: | + A regular expression for parsing the response body from the backend server. + + Example: `^((?!false).|\s)*$` + maxLength: 255 + type: string + retries: + description: | + The number of retries to attempt before a backend server is considered "unhealthy". This number also applies + when recovering a server to the "healthy" state. + + Example: `3` + format: int32 + type: integer + returnCode: + description: | + The status code a healthy backend server should return. + + Example: `200` + format: int32 + type: integer + timeoutInMillis: + description: | + The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply + returns within this timeout period. + + Example: `3000` + format: int32 + maximum: 600000 + minimum: 1 + type: integer + urlPath: + description: | + The path against which to run the health check. + + Example: `/healthcheck` + maxLength: 1024 + type: string + required: + - protocol + type: object + x-example: | + { + "protocol": "HTTP", + "urlPath": "/healthcheck", + "port": 8080, + "returnCode": 200, + "retries": 3, + "timeoutInMillis": 3000, + "intervalInMillis": 10000, + "responseBodyRegex": "^((?!false).|\s)*$" + } + SSLConfigurationDetails: + description: | + The load balancer's SSL handling configuration details. + + **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. + properties: + certificateIds: + description: | + Ids for OCI certificates service certificates. Currently only a single Id may be passed. + + Example: `[ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]` + example: 'true' + items: + maxLength: 255 + minLength: 1 + type: string + type: array + uniqueItems: true + certificateName: + description: | + A friendly name for the certificate bundle. It must be unique and it cannot be changed. + Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. + Certificate bundle names cannot contain spaces. Avoid entering confidential information. + + Example: `example_certificate_bundle` + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9_.-]*$ + type: string + cipherSuiteName: + default: oci-default-ssl-cipher-suite-v1 + description: | + The name of the cipher suite to use for HTTPS or SSL connections. + + If this field is not specified, the default is `oci-default-ssl-cipher-suite-v1`. + + **Notes:** + + * You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher + suite. Clients cannot perform an SSL handshake if there is an incompatible configuration. + * You must ensure compatibility between the ciphers configured in the cipher suite and the configured + certificates. For example, RSA-based ciphers require RSA certificates and ECDSA-based ciphers require ECDSA + certificates. + * If the cipher configuration is not modified after load balancer creation, the `GET` operation returns + `oci-default-ssl-cipher-suite-v1` as the value of this field in the SSL configuration for existing listeners + that predate this feature. + * If the cipher configuration was modified using Oracle operations after load balancer creation, the `GET` + operation returns `oci-customized-ssl-cipher-suite` as the value of this field in the SSL configuration for + existing listeners that predate this feature. + * The `GET` operation returns `oci-wider-compatible-ssl-cipher-suite-v1` as the value of this field in the SSL + configuration for existing backend sets that predate this feature. + * If the `GET` operation on a listener returns `oci-customized-ssl-cipher-suite` as the value of this field, + you must specify an appropriate predefined or custom cipher suite name when updating the resource. + * The `oci-customized-ssl-cipher-suite` Oracle reserved cipher suite name is not accepted as valid input for + this field. + + example: `example_cipher_suite` + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]*$ + type: string + protocols: + default: TLSv1.2 + description: | + A list of SSL protocols the load balancer must support for HTTPS or SSL connections. + + The load balancer uses SSL protocols to establish a secure connection between a client and a server. A secure + connection ensures that all data passed between the client and the server is private. + + The Load Balancing service supports the following protocols: + + * TLSv1 + * TLSv1.1 + * TLSv1.2 + * TLSv1.3 + + If this field is not specified, TLSv1.2 is the default. + + **Warning:** All SSL listeners created on a given port must use the same set of SSL protocols. + + **Notes:** + + * The handshake to establish an SSL connection fails if the client supports none of the specified protocols. + * You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher + suite. + * For all existing load balancer listeners and backend sets that predate this feature, the `GET` operation + displays a list of SSL protocols currently used by those resources. + + example: `["TLSv1.1", "TLSv1.2"]` + items: + type: string + type: array + serverOrderPreference: + default: ENABLED + description: | + When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client + ciphers. + + **Note:** This configuration is applicable only when the load balancer is acting as an SSL/HTTPS server. This + field is ignored when the `SSLConfiguration` object is associated with a backend set. + enum: + - ENABLED + - DISABLED + example: ENABLED + type: string + trustedCertificateAuthorityIds: + description: | + Ids for OCI certificates service CA or CA bundles for the load balancer to trust. + + Example: `[ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]` + example: 'true' + items: + maxLength: 255 + minLength: 1 + type: string + type: array + uniqueItems: true + verifyDepth: + description: | + The maximum depth for peer certificate chain verification. + + Example: `3` + format: int32 + type: integer + verifyPeerCertificate: + default: false + description: | + Whether the load balancer listener should verify peer certificates. + + Example: `true` + type: boolean + type: object + x-example: | + { + "protocols": ["TLSv1.1", "TLSv1.2"], + "cipherSuiteName" : "example_cipher_suite", + "serverOrderPreference" : "ENABLED", + "certificateName": "example_certificate_bundle", + "verifyPeerCertificate": true + "verifyDepth": 3, + } + HealthCheckResult: + description: | + Information about a single backend server health check result reported by a load balancer. + properties: + healthCheckStatus: + description: | + The result of the most recent health check. + enum: + - OK + - INVALID_STATUS_CODE + - TIMED_OUT + - REGEX_MISMATCH + - CONNECT_FAILED + - IO_ERROR + - OFFLINE + - UNKNOWN + type: string + sourceIpAddress: + description: | + The IP address of the health check status report provider. This identifier helps you differentiate same-subnet + load balancers that report health check status. + + Example: `10.0.0.7` + type: string + subnetId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet hosting the load balancer that reported this health check status. + type: string + timestamp: + description: | + The date and time the data was retrieved, in the format defined by RFC3339. + + Example: `2017-06-02T18:28:11+00:00` + format: date-time + type: string + required: + - subnetId + - sourceIpAddress + - timestamp + - healthCheckStatus + type: object + x-example: | + { + "subnetId": "ocid1.subnet.oc1.phx.<unique_ID>", + "sourceIpAddress": "192.168.0.7", + "timestamp": "2018-02-09T21:58:11.417Z", + "healthCheckStatus": "OK" + } + ConnectionConfiguration: + description: | + Configuration details for the connection between the client and backend servers. + properties: + backendTcpProxyProtocolOptions: + description: | + An array that represents the PPV2 Options that can be enabled on TCP Listeners. + Example: ["PP2_TYPE_AUTHORITY"] + items: + enum: + - PP2_TYPE_AUTHORITY + maxLength: 64 + minLength: 1 + type: string + type: array + uniqueItems: true + backendTcpProxyProtocolVersion: + description: | + The backend TCP Proxy Protocol version. + + Example: `1` + format: int32 + maximum: 2 + minimum: 1 + type: integer + idleTimeout: + description: | + The maximum idle time, in seconds, allowed between two successive receive or two successive send operations + between the client and backend servers. A send operation does not reset the timer for receive operations. A + receive operation does not reset the timer for send operations. + + For more information, see [Connection Configuration](/Content/Balance/Reference/connectionreuse.htm#ConnectionConfiguration). + + Example: `1200` + format: int64 + minimum: 1 + type: integer + required: + - idleTimeout + type: object + x-example: | + { + "backendTcpProxyProtocolVersion": 2, + "backendTcpProxyProtocolOptions": ["PP2_TYPE_AUTHORITY"], + "idleTimeout": 1200 + } + Rule: + description: An object that represents an action to apply to a listener. + discriminator: + propertyName: action + properties: + action: + enum: + - ADD_HTTP_REQUEST_HEADER + - EXTEND_HTTP_REQUEST_HEADER_VALUE + - REMOVE_HTTP_REQUEST_HEADER + - ADD_HTTP_RESPONSE_HEADER + - EXTEND_HTTP_RESPONSE_HEADER_VALUE + - REMOVE_HTTP_RESPONSE_HEADER + - ALLOW + - CONTROL_ACCESS_USING_HTTP_METHODS + - REDIRECT + - HTTP_HEADER + - IP_BASED_MAX_CONNECTIONS + type: string + required: + - action + type: object + x-example: | + { + "action": "ADD_HTTP_REQUEST_HEADER", + "header": "example_header_name", + "value": "example_value" + } + PathRoute: + description: | + A "path route rule" to evaluate an incoming URI path, and then route a matching request to the specified backend set. + + Path route rules apply only to HTTP and HTTPS requests. They have no effect on TCP requests. + properties: + backendSetName: + description: | + The name of the target backend set for requests where the incoming URI matches the specified path. + + Example: `example_backend_set` + maxLength: 32 + minLength: 1 + type: string + path: + description: | + The path string to match against the incoming URI path. + + * Path strings are case-insensitive. + + * Asterisk (*) wildcards are not supported. + + * Regular expressions are not supported. + + Example: `/example/video/123` + maxLength: 2048 + minLength: 1 + type: string + pathMatchType: + $ref: '#/components/schemas/PathMatchType' + required: + - path + - pathMatchType + - backendSetName + type: object + x-example: | + { + "path": "/example/video/123", + "pathMatchType": { + "matchType": "EXACT_MATCH" + }, + "backendSetName": "example_backend_set" + } + RoutingRule: + description: | + A routing rule examines an incoming request, routing matching requests to the specified backend set. + Routing rules apply only to HTTP and HTTPS requests. They have no effect on TCP requests. + properties: + actions: + description: | + A list of actions to be applied when conditions of the routing rule are met. + items: + $ref: '#/components/schemas/Action' + maxItems: 1 + minItems: 1 + type: array + condition: + description: | + A routing rule to evaluate defined conditions against the incoming HTTP request and perform an action. + maxLength: 4096 + minLength: 1 + type: string + name: + description: | + A unique name for the routing policy rule. Avoid entering confidential information. + maxLength: 32 + minLength: 1 + pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ + type: string + required: + - name + - condition + - actions + type: object + x-example: | + { + "name": "Cookie_rule", + "condition" : "any(http.request.cookies['myCookie'] eq 'myCookieVal', http.request.headers[(i 'customHeader')] eq 'headerVal')", + "actions": [{ + "name": "FORWARD_TO_BACKENDSET", + "backendSetName": "backendSetForThumbnails" + }] + } + PathMatchType: + description: The type of matching to apply to incoming URIs. + properties: + matchType: + description: | + Specifies how the load balancing service compares a [PathRoute](#/en/loadbalancer/20170115/requests/PathRoute) + object's `path` string against the incoming URI. + + * **EXACT_MATCH** - Looks for a `path` string that exactly matches the incoming URI path. + + * **FORCE_LONGEST_PREFIX_MATCH** - Looks for the `path` string with the best, longest match of the beginning + portion of the incoming URI path. + + * **PREFIX_MATCH** - Looks for a `path` string that matches the beginning portion of the incoming URI path. + + * **SUFFIX_MATCH** - Looks for a `path` string that matches the ending portion of the incoming URI path. + + For a full description of how the system handles `matchType` in a path route set containing multiple rules, see + [Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm). + enum: + - EXACT_MATCH + - FORCE_LONGEST_PREFIX_MATCH + - PREFIX_MATCH + - SUFFIX_MATCH + type: string + required: + - matchType + type: object + x-example: | + { + "matchType": "EXACT_MATCH" + } + Action: + description: An entity that represents an action to apply for a routing rule. + discriminator: + propertyName: name + properties: + name: + enum: + - FORWARD_TO_BACKENDSET + type: string + required: + - name + type: object + x-example: | + { + "name": "FORWARD_TO_BACKENDSET", + "backendSetName" : "backendSetToHandleSomeCriteria" + } + ListLoadBalancerHealthsResponse: + type: object + properties: + load_balancer_healths: + type: array + items: + $ref: '#/components/schemas/LoadBalancerHealthSummary' + ListPoliciesResponse: + type: object + properties: + policies: + type: array + items: + $ref: '#/components/schemas/LoadBalancerPolicy' + ListProtocolsResponse: + type: object + properties: + protocols: + type: array + items: + $ref: '#/components/schemas/LoadBalancerProtocol' + ListShapesResponse: + type: object + properties: + shapes: + type: array + items: + $ref: '#/components/schemas/LoadBalancerShape' + ListLoadBalancersResponse: + type: object + properties: + load_balancers: + type: array + items: + $ref: '#/components/schemas/LoadBalancer' + ListBackendSetsResponse: + type: object + properties: + backend_sets: + type: array + items: + $ref: '#/components/schemas/BackendSet' + ListBackendsResponse: + type: object + properties: + backends: + type: array + items: + $ref: '#/components/schemas/Backend' + ListCertificatesResponse: + type: object + properties: + certificates: + type: array + items: + $ref: '#/components/schemas/Certificate' + ListHostnamesResponse: + type: object + properties: + hostnames: + type: array + items: + $ref: '#/components/schemas/Hostname' + ListListenerRulesResponse: + type: object + properties: + listener_rules: + type: array + items: + $ref: '#/components/schemas/ListenerRuleSummary' + ListPathRouteSetsResponse: + type: object + properties: + path_route_sets: + type: array + items: + $ref: '#/components/schemas/PathRouteSet' + ListRoutingPoliciesResponse: + type: object + properties: + routing_policies: + type: array + items: + $ref: '#/components/schemas/RoutingPolicy' + ListRuleSetsResponse: + type: object + properties: + rule_sets: + type: array + items: + $ref: '#/components/schemas/RuleSet' + ListSSLCipherSuitesResponse: + type: object + properties: + sslcipher_suites: + type: array + items: + $ref: '#/components/schemas/SSLCipherSuite' + ListWorkRequestsResponse: + type: object + properties: + work_requests: + type: array + items: + $ref: '#/components/schemas/WorkRequest' + responses: + '400': + description: Bad Request + 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: + '*/*': + schema: + $ref: '#/components/schemas/Error' + '401': + description: Unauthorized + 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: + '*/*': + schema: + $ref: '#/components/schemas/Error' + '404': + description: Not Found + 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: + '*/*': + schema: + $ref: '#/components/schemas/Error' + '409': + description: Conflict + 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: + '*/*': + schema: + $ref: '#/components/schemas/Error' + '429': + description: Too Many Requests + 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: + '*/*': + schema: + $ref: '#/components/schemas/Error' + '500': + description: Internal Server 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: + '*/*': + schema: + $ref: '#/components/schemas/Error' + DefaultError: + description: An error has occurred. + 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: + '*/*': + schema: + $ref: '#/components/schemas/Error' + parameters: + SortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. + Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + SortOrderQueryParam: + description: | + The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. + in: query + name: sortOrder + required: false + schema: + type: string + enum: + - ASC + - DESC + FilterByDisplayNameQueryParam: + description: | + A filter to return only resources that match the given display name exactly. + + Example: `example_load_balancer` + in: query + name: displayName + required: false + schema: + type: string + FilterByLifecycleStateQueryParam: + description: | + A filter to return only resources that match the given lifecycle state. + + Example: `SUCCEEDED` + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/LoadBalancer/lifecycleState' + schema: + type: string + RetryTokenHeader: + description: | + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations (e.g., if a resource + has been deleted and purged from the system, then a retry of the original creation request + may be rejected). + in: header + name: opc-retry-token + schema: + type: string + minLength: 1 + maxLength: 64 + RequestIdHeader: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about + a particular request, please provide the request ID. + in: header + name: opc-request-id + schema: + type: string + LoadBalancerIdPathParam: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the associated load balancer. + in: path + name: loadBalancerId + required: true + schema: + type: string + x-stackQL-resources: + load_balancer_healths: + id: oci.load_balancer.load_balancer_healths + name: load_balancer_healths + title: Load Balancer Healths + methods: + list: + operation: + $ref: '#/paths/~1loadBalancerHealths/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.load_balancer_healths + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListLoadBalancerHealthsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"load_balancer_healths\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1health/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/load_balancer_healths/methods/get' + - $ref: '#/components/x-stackQL-resources/load_balancer_healths/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + policies: + id: oci.load_balancer.policies + name: policies + title: Policies + methods: + list: + operation: + $ref: '#/paths/~1loadBalancerPolicies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.policies + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListPoliciesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"policies\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/policies/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + protocols: + id: oci.load_balancer.protocols + name: protocols + title: Protocols + methods: + list: + operation: + $ref: '#/paths/~1loadBalancerProtocols/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.protocols + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListProtocolsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"protocols\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/protocols/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + shapes: + id: oci.load_balancer.shapes + name: shapes + title: Shapes + methods: + list: + operation: + $ref: '#/paths/~1loadBalancerShapes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.shapes + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListShapesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"shapes\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/shapes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + work_requests: + id: oci.load_balancer.work_requests + name: work_requests + title: Work Requests + methods: + get: + operation: + $ref: '#/paths/~1loadBalancerWorkRequests~1{workRequestId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + list: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1workRequests/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.work_requests + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListWorkRequestsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"work_requests\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/work_requests/methods/get' + - $ref: '#/components/x-stackQL-resources/work_requests/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + load_balancers: + id: oci.load_balancer.load_balancers + name: load_balancers + title: Load Balancers + methods: + list: + operation: + $ref: '#/paths/~1loadBalancers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.load_balancers + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListLoadBalancersResponse' + transform: + body: |- + {{- $wrapped := printf "{\"load_balancers\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}/put' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/get' + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/delete' + replace: [] + backend_sets: + id: oci.load_balancer.backend_sets + name: backend_sets + title: Backend Sets + methods: + list: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1backendSets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.backend_sets + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListBackendSetsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"backend_sets\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1backendSets/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1backendSets~1{backendSetName}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1backendSets~1{backendSetName}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1backendSets~1{backendSetName}/put' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/backend_sets/methods/get' + - $ref: '#/components/x-stackQL-resources/backend_sets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/backend_sets/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/backend_sets/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/backend_sets/methods/delete' + replace: [] + backends: + id: oci.load_balancer.backends + name: backends + title: Backends + methods: + list: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1backendSets~1{backendSetName}~1backends/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.backends + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListBackendsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"backends\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1backendSets~1{backendSetName}~1backends/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1backendSets~1{backendSetName}~1backends~1{backendName}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1backendSets~1{backendSetName}~1backends~1{backendName}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1backendSets~1{backendSetName}~1backends~1{backendName}/put' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/backends/methods/get' + - $ref: '#/components/x-stackQL-resources/backends/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/backends/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/backends/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/backends/methods/delete' + replace: [] + backend_healths: + id: oci.load_balancer.backend_healths + name: backend_healths + title: Backend Healths + methods: + get: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1backendSets~1{backendSetName}~1backends~1{backendName}~1health/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/backend_healths/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + backend_set_healths: + id: oci.load_balancer.backend_set_healths + name: backend_set_healths + title: Backend Set Healths + methods: + get: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1backendSets~1{backendSetName}~1health/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/backend_set_healths/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + health_checkers: + id: oci.load_balancer.health_checkers + name: health_checkers + title: Health Checkers + methods: + get: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1backendSets~1{backendSetName}~1healthChecker/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1backendSets~1{backendSetName}~1healthChecker/put' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/health_checkers/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/health_checkers/methods/update' + delete: [] + replace: [] + certificates: + id: oci.load_balancer.certificates + name: certificates + title: Certificates + methods: + list: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1certificates/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.certificates + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListCertificatesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"certificates\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1certificates/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1certificates~1{certificateName}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/certificates/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/certificates/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/certificates/methods/delete' + replace: [] + hostnames: + id: oci.load_balancer.hostnames + name: hostnames + title: Hostnames + methods: + list: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1hostnames/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.hostnames + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListHostnamesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"hostnames\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1hostnames/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1hostnames~1{name}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1hostnames~1{name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1hostnames~1{name}/put' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/hostnames/methods/get' + - $ref: '#/components/x-stackQL-resources/hostnames/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/hostnames/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/hostnames/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/hostnames/methods/delete' + replace: [] + listeners: + id: oci.load_balancer.listeners + name: listeners + title: Listeners + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1listeners/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1listeners~1{listenerName}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1listeners~1{listenerName}/put' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/listeners/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/listeners/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/listeners/methods/delete' + replace: [] + listener_rules: + id: oci.load_balancer.listener_rules + name: listener_rules + title: Listener Rules + methods: + list: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1listeners~1{listenerName}~1rules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.listener_rules + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListListenerRulesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"listener_rules\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/listener_rules/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + network_security_groups: + id: oci.load_balancer.network_security_groups + name: network_security_groups + title: Network Security Groups + methods: + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1networkSecurityGroups/put' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/network_security_groups/methods/update' + delete: [] + replace: [] + path_route_sets: + id: oci.load_balancer.path_route_sets + name: path_route_sets + title: Path Route Sets + methods: + list: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1pathRouteSets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.path_route_sets + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListPathRouteSetsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"path_route_sets\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1pathRouteSets/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1pathRouteSets~1{pathRouteSetName}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1pathRouteSets~1{pathRouteSetName}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1pathRouteSets~1{pathRouteSetName}/put' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/path_route_sets/methods/get' + - $ref: '#/components/x-stackQL-resources/path_route_sets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/path_route_sets/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/path_route_sets/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/path_route_sets/methods/delete' + replace: [] + routing_policies: + id: oci.load_balancer.routing_policies + name: routing_policies + title: Routing Policies + methods: + list: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1routingPolicies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.routing_policies + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListRoutingPoliciesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"routing_policies\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1routingPolicies/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1routingPolicies~1{routingPolicyName}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1routingPolicies~1{routingPolicyName}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1routingPolicies~1{routingPolicyName}/put' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/routing_policies/methods/get' + - $ref: '#/components/x-stackQL-resources/routing_policies/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/routing_policies/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/routing_policies/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/routing_policies/methods/delete' + replace: [] + rule_sets: + id: oci.load_balancer.rule_sets + name: rule_sets + title: Rule Sets + methods: + list: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1ruleSets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.rule_sets + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListRuleSetsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"rule_sets\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1ruleSets/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1ruleSets~1{ruleSetName}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1ruleSets~1{ruleSetName}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1ruleSets~1{ruleSetName}/put' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rule_sets/methods/get' + - $ref: '#/components/x-stackQL-resources/rule_sets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/rule_sets/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/rule_sets/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/rule_sets/methods/delete' + replace: [] + ssl_cipher_suites: + id: oci.load_balancer.ssl_cipher_suites + name: ssl_cipher_suites + title: Ssl Cipher Suites + methods: + list: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1sslCipherSuites/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.sslcipher_suites + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListSSLCipherSuitesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"sslcipher_suites\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1sslCipherSuites/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1sslCipherSuites~1{name}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1sslCipherSuites~1{name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1sslCipherSuites~1{name}/put' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ssl_cipher_suites/methods/get' + - $ref: '#/components/x-stackQL-resources/ssl_cipher_suites/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/ssl_cipher_suites/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/ssl_cipher_suites/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/ssl_cipher_suites/methods/delete' + replace: [] + load_balancer_shapes: + id: oci.load_balancer.load_balancer_shapes + name: load_balancer_shapes + title: Load Balancer Shapes + methods: + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1loadBalancers~1{loadBalancerId}~1updateShape/put' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/load_balancer_shapes/methods/update' + delete: [] + replace: [] +servers: + - url: https://iaas.{region}.oraclecloud.com/20170115 + variables: + region: + default: us-ashburn-1 + description: OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. + x-stackQL-envVar: OCI_REGION +x-stackQL-config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: opc-next-page + location: header diff --git a/providers/src/oci/v00.00.00000/services/logging.yaml b/providers/src/oci/v00.00.00000/services/logging.yaml new file mode 100644 index 00000000..1aeb354e --- /dev/null +++ b/providers/src/oci/v00.00.00000/services/logging.yaml @@ -0,0 +1,3874 @@ +openapi: 3.0.0 +info: + title: logging API + description: oci logging API + version: '20200531' +paths: + /logGroups: + get: + description: Lists all log groups for the specified compartment or tenancy. + operationId: ListLogGroups + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' + - $ref: '#/components/parameters/DisplayNameQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The list is being retrieved. + 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-previous-page: + description: | + For list pagination. When this header appears in the response, previous pages + of results exist. 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/ListLogGroupsResponse' + '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/DefaultError' + summary: Lists all log groups in the specified compartment. + tags: + - loggingManagement + post: + description: | + Create a new log group with a unique display name. This call fails + if the log group is already created with the same displayName in the compartment. + operationId: CreateLogGroup + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateLogGroupDetails' + description: Details to create log group. + required: true + responses: + '202': + $ref: '#/components/responses/202' + '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/DefaultError' + summary: Creates new log group. + tags: + - loggingManagement + x-related-resource: '#/definitions/LogGroup' + /logGroups/{logGroupId}: + delete: + description: Deletes the specified log group. + operationId: DeleteLogGroup + parameters: + - $ref: '#/components/parameters/LogGroupIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '202': + $ref: '#/components/responses/202' + '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/DefaultError' + summary: Deletes the log group configuration with the log group OCID. + tags: + - loggingManagement + x-related-resource: '#/definitions/LogGroup' + get: + description: Get the specified log group's information. + operationId: GetLogGroup + parameters: + - $ref: '#/components/parameters/LogGroupIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: Log group was retrieved. + 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/LogGroup' + '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/DefaultError' + summary: Gets the log group's configuration for the log group OCID. + tags: + - loggingManagement + put: + description: | + Updates the existing log group with the associated configuration. This call + fails if the log group does not exist. + operationId: UpdateLogGroup + parameters: + - $ref: '#/components/parameters/LogGroupIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateLogGroupDetails' + description: LogGroup config parameters to update. + required: true + responses: + '202': + $ref: '#/components/responses/202' + '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/DefaultError' + summary: Updates the existing log group configuration. + tags: + - loggingManagement + x-related-resource: '#/definitions/LogGroup' + /logGroups/{logGroupId}/actions/changeCompartment: + post: + description: | + Moves a log group into a different compartment within the same tenancy. When provided, the If-Match is checked against the resource ETag values. + For information about moving resources between compartments, see [Moving Resources Between Compartments](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeLogGroupCompartment + parameters: + - $ref: '#/components/parameters/LogGroupIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeLogGroupCompartmentDetails' + description: Request to change the compartment of a given resource. + required: true + responses: + '202': + $ref: '#/components/responses/202' + '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/DefaultError' + summary: Change the compartment to which this LogGroup belongs. + tags: + - loggingManagement + x-example: | + POST /20190909/logGroups/<id>/actions/changeCompartment + Host: filestorage.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca" + } + x-related-resource: '#/definitions/LogGroup' + /logGroups/{logGroupId}/logs: + get: + description: Lists the specified log group's log objects. + operationId: ListLogs + parameters: + - $ref: '#/components/parameters/LogGroupIdPathParam' + - $ref: '#/components/parameters/LogTypeQueryParam' + - $ref: '#/components/parameters/ServiceQueryParam' + - $ref: '#/components/parameters/ResourceQueryParam' + - $ref: '#/components/parameters/DisplayNameQueryParam' + - $ref: '#/components/parameters/LogLifecycleStateQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The list is being retrieved. + 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-previous-page: + description: | + For list pagination. When this header appears in the response, previous pages + of results exist. 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/ListLogsResponse' + '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/DefaultError' + summary: Lists all log objects for the specified log group OCID belonging to a compartment or tenancy. + tags: + - loggingManagement + post: + description: | + Creates a log within the specified log group. This call fails if a log group has already been created + with the same displayName or (service, resource, category) triplet. + operationId: CreateLog + parameters: + - $ref: '#/components/parameters/LogGroupIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateLogDetails' + description: Log object configuration details. + required: true + responses: + '202': + $ref: '#/components/responses/202' + '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/DefaultError' + summary: Creates a new log object. + tags: + - loggingManagement + x-related-resource: '#/definitions/Log' + /logGroups/{logGroupId}/logs/{logId}: + delete: + description: Deletes the log object in a log group. + operationId: DeleteLog + parameters: + - $ref: '#/components/parameters/LogGroupIdPathParam' + - $ref: '#/components/parameters/LogIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '202': + $ref: '#/components/responses/202' + '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/DefaultError' + summary: Deletes the log object in a log group. + tags: + - loggingManagement + x-related-resource: '#/definitions/Log' + get: + description: | + Gets the log object configuration for the log object OCID. + operationId: GetLog + parameters: + - $ref: '#/components/parameters/LogGroupIdPathParam' + - $ref: '#/components/parameters/LogIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The log object was retrieved. + 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/Log' + '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/DefaultError' + summary: Gets the log object configuration for the log object OCID. + tags: + - loggingManagement + put: + description: | + Updates the existing log object with the associated configuration. This call + fails if the log object does not exist. + operationId: UpdateLog + parameters: + - $ref: '#/components/parameters/LogGroupIdPathParam' + - $ref: '#/components/parameters/LogIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateLogDetails' + description: Log config parameters to update. + required: true + responses: + '202': + $ref: '#/components/responses/202' + '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/DefaultError' + summary: Updates the existing log object configuration. + tags: + - loggingManagement + x-related-resource: '#/definitions/Log' + /logGroups/{logGroupId}/logs/{logId}/actions/changeLogGroup: + post: + description: | + Moves a log into a different log group within the same tenancy. When provided, the If-Match is checked against the ETag values of the resource. + operationId: ChangeLogLogGroup + parameters: + - $ref: '#/components/parameters/LogGroupIdPathParam' + - $ref: '#/components/parameters/LogIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeLogLogGroupDetails' + description: Request to change the log group of a given log. + required: true + responses: + '202': + $ref: '#/components/responses/202' + '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/DefaultError' + summary: Change the LogGroup to which this log belongs to. + tags: + - loggingManagement + x-related-resource: '#/definitions/Log' + /logSavedSearches: + get: + description: | + Lists LogSavedSearches for this compartment. + operationId: ListLogSavedSearches + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/LogSavedSearchIdQueryParam' + - $ref: '#/components/parameters/NameQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: Successfully retrieved list of LogSavedSearch summary entities. + 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-previous-page: + description: | + For list pagination. When this header appears in the response, previous pages + of results exist. 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/LogSavedSearchSummaryCollection' + '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/DefaultError' + summary: Lists LogSavedSearches for this compartment. + tags: + - loggingManagement + x-related-resource: '#/definitions/LogSavedSearch' + post: + description: | + Creates a new LogSavedSearch. + operationId: CreateLogSavedSearch + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateLogSavedSearchDetails' + description: Specification of the saved search to create. + required: true + responses: + '200': + description: Successfully created LogSavedSearch. + 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/LogSavedSearch' + '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/DefaultError' + summary: Creates a new LogSavedSearch. + tags: + - loggingManagement + x-related-resource: '#/definitions/LogSavedSearch' + /logSavedSearches/{logSavedSearchId}: + delete: + description: Deletes the specified LogSavedSearch. + operationId: DeleteLogSavedSearch + parameters: + - $ref: '#/components/parameters/LogSavedSearchIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '204': + description: The LogSavedSearch was 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 + '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/DefaultError' + summary: Deletes a LogSavedSearch. + tags: + - loggingManagement + x-related-resource: '#/definitions/LogSavedSearch' + get: + description: Retrieves a LogSavedSearch. + operationId: GetLogSavedSearch + parameters: + - $ref: '#/components/parameters/LogSavedSearchIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: Successfully retrieved LogSavedSearch. + 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/LogSavedSearch' + '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/DefaultError' + summary: Retrieves a LogSavedSearch. + tags: + - loggingManagement + put: + description: | + Updates an existing LogSavedSearch. + operationId: UpdateLogSavedSearch + parameters: + - $ref: '#/components/parameters/LogSavedSearchIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateLogSavedSearchDetails' + description: Updates to the saved search. + required: true + responses: + '200': + description: The saved search with updates applied. + 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/LogSavedSearch' + '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/DefaultError' + summary: Updates a LogSavedSearch. + tags: + - loggingManagement + x-related-resource: '#/definitions/LogSavedSearch' + /logSavedSearches/{logSavedSearchId}/actions/changeCompartment: + post: + description: | + Moves a saved search into a different compartment within the same tenancy. For information about moving + resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeLogSavedSearchCompartment + parameters: + - $ref: '#/components/parameters/LogSavedSearchIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeLogSavedSearchCompartmentDetails' + description: Contains details indicating which compartment the resource should move to. + required: true + responses: + '204': + description: The provided SavedSearch compartment changed successfully. + 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 + '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/DefaultError' + summary: Moves a LogSavedSearch into a different compartment. When provided, the If-Match is checked against the ETag values of the resource. + tags: + - loggingManagement + x-related-resource: '#/definitions/LogSavedSearch' + /unifiedAgentConfigurations: + get: + description: Lists all unified agent configurations in the specified compartment. + operationId: ListUnifiedAgentConfigurations + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/LogIdQueryParam' + - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' + - $ref: '#/components/parameters/UnifiedAgentConfigGroupIdQueryParam' + - $ref: '#/components/parameters/DisplayNameQueryParam' + - $ref: '#/components/parameters/LogLifecycleStateQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The list is being retrieved. + 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-previous-page: + description: | + For list pagination. When this header appears in the response, previous pages + of results exist. 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/UnifiedAgentConfigurationCollection' + '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/DefaultError' + summary: Lists all unified agent configurations in the specified compartment. + tags: + - loggingManagement + x-related-resource: '#/definitions/UnifiedAgentConfiguration' + post: + description: Create unified agent configuration registration. + operationId: CreateUnifiedAgentConfiguration + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateUnifiedAgentConfigurationDetails' + description: Unified agent configuration creation object. + required: true + responses: + '202': + $ref: '#/components/responses/202' + '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/DefaultError' + summary: Post unified agent configuration. + tags: + - loggingManagement + x-related-resource: '#/definitions/UnifiedAgentConfiguration' + /unifiedAgentConfigurations/{unifiedAgentConfigurationId}: + delete: + description: Delete unified agent configuration. + operationId: DeleteUnifiedAgentConfiguration + parameters: + - $ref: '#/components/parameters/UnifiedAgentConfigurationIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + $ref: '#/components/responses/202' + '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/DefaultError' + summary: Delete unified agent configuration. + tags: + - loggingManagement + x-related-resource: '#/definitions/UnifiedAgentConfiguration' + get: + description: Get the unified agent configuration for an ID. + operationId: GetUnifiedAgentConfiguration + parameters: + - $ref: '#/components/parameters/UnifiedAgentConfigurationIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: Unified agent configuration. + 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/UnifiedAgentConfiguration' + '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/DefaultError' + summary: Get the unified agent configuration. + tags: + - loggingManagement + put: + description: | + Update an existing unified agent configuration. This call + fails if the log group does not exist. + operationId: UpdateUnifiedAgentConfiguration + parameters: + - $ref: '#/components/parameters/UnifiedAgentConfigurationIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateUnifiedAgentConfigurationDetails' + description: | + Unified agent configuration to update. Empty group associations list doesn't modify the list, null value for group association clears all the previous associations. + required: true + responses: + '202': + $ref: '#/components/responses/202' + '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/DefaultError' + summary: Updates an existing unified agent configuration. + tags: + - loggingManagement + x-related-resource: '#/definitions/UnifiedAgentConfiguration' + /unifiedAgentConfigurations/{unifiedAgentConfigurationId}/actions/changeCompartment: + post: + description: | + Moves the unified agent configuration into a different compartment within the same tenancy. When provided, the If-Match is checked against the ETag values of the resource. + For information about moving resources between compartments, see [Moving Resources Between Compartments](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeUnifiedAgentConfigurationCompartment + parameters: + - $ref: '#/components/parameters/UnifiedAgentConfigurationIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeUnifiedAgentConfigurationCompartmentDetails' + description: Request to change the compartment of a given resource. + required: true + responses: + '202': + $ref: '#/components/responses/202' + '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/DefaultError' + summary: Change the unified agent configuration compartment. + tags: + - loggingManagement + x-related-resource: '#/definitions/UnifiedAgentConfiguration' + /v2/registry/services: + get: + description: Lists all services that support logging. + operationId: ListServices + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: success + 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-previous-page: + description: | + For list pagination. When this header appears in the response, previous pages + of results exist. 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/ListServicesResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Lists all services that support logging. + tags: + - loggingManagement + /workRequests: + get: + description: | + Lists the work requests in a compartment. + operationId: ListWorkRequests + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/WorkRequestStatusFilterQueryParam' + - $ref: '#/components/parameters/OcidQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/WorkRequestSortByQueryParam' + responses: + '200': + description: List of work requests + 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-previous-page: + description: | + For list pagination. When this header appears in the response, previous pages + of results exist. 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/ListWorkRequestsResponse' + '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/DefaultError' + summary: List the work requests. + tags: + - loggingManagement + x-related-resource: '#/definitions/WorkRequest' + /workRequests/{workRequestId}: + delete: + description: | + Cancel a work request that has not started yet. + operationId: DeleteWorkRequest + parameters: + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '202': + $ref: '#/components/responses/202' + '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/DefaultError' + summary: Cancel a work request. + tags: + - loggingManagement + x-related-resource: '#/definitions/WorkRequest' + get: + description: Gets the details of the work request with the given ID. + operationId: GetWorkRequest + parameters: + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The work request details. + 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 + retry-after: + description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. + schema: + type: number + format: integer + content: + application/json: + schema: + $ref: '#/components/schemas/WorkRequest' + '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/DefaultError' + summary: Get the Work Request Details. + tags: + - loggingManagement + x-related-resource: '#/definitions/WorkRequest' + /workRequests/{workRequestId}/errors: + get: + description: | + Return a list of errors for a given work request. + operationId: ListWorkRequestErrors + parameters: + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + responses: + '200': + description: List of work request errors. + 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/ListWorkRequestErrorsResponse' + '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/DefaultError' + summary: Lists work request errors. + tags: + - loggingManagement + x-related-resource: '#/definitions/WorkRequestError' + /workRequests/{workRequestId}/logs: + get: + description: | + Return a list of logs for a given work request. + operationId: ListWorkRequestLogs + parameters: + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + responses: + '200': + description: List of work request logs. + 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/ListWorkRequestLogsResponse' + '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/DefaultError' + summary: Lists work request logs. + tags: + - loggingManagement + x-related-resource: '#/definitions/WorkRequestLog' +components: + schemas: + LogGroupSummary: + description: Log group configuration summary. + properties: + compartmentId: + description: The OCID of the compartment that the resource belongs to. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: Description for this resource. + maxLength: 400 + minLength: 1 + type: string + displayName: + description: | + The user-friendly display name. This must be unique within the enclosing resource, + and it's changeable. Avoid entering confidential information. + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the resource. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The log group object state. + enum: + - CREATING + - ACTIVE + - UPDATING + - INACTIVE + - DELETING + - FAILED + type: string + x-obmcs-top-level-enum: '#/definitions/LogGroupLifecycleState' + timeCreated: + description: Time the resource was created. + format: date-time + readOnly: true + type: string + timeLastModified: + description: Time the resource was last modified. + format: date-time + readOnly: true + type: string + required: + - id + - compartmentId + - displayName + type: object + CreateLogGroupDetails: + description: The details to create a log group. + properties: + compartmentId: + description: The OCID of the compartment that the resource belongs to. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: Description for this resource. + maxLength: 400 + minLength: 1 + type: string + displayName: + description: | + The user-friendly display name. This must be unique within the enclosing resource, + and it's changeable. Avoid entering confidential information. + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + required: + - compartmentId + - displayName + type: object + LogGroup: + description: Represents a LogGroup object. + properties: + compartmentId: + description: The OCID of the compartment that the resource belongs to. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: Description for this resource. + maxLength: 400 + minLength: 1 + type: string + displayName: + description: | + The user-friendly display name. This must be unique within the enclosing resource, + and it's changeable. Avoid entering confidential information. + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the resource. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The log group object state. + enum: + - CREATING + - ACTIVE + - UPDATING + - INACTIVE + - DELETING + - FAILED + type: string + x-obmcs-top-level-enum: '#/definitions/LogGroupLifecycleState' + timeCreated: + description: Time the resource was created. + format: date-time + readOnly: true + type: string + timeLastModified: + description: Time the resource was last modified. + format: date-time + readOnly: true + type: string + required: + - id + - compartmentId + - displayName + type: object + UpdateLogGroupDetails: + description: The details to update a log group. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: Description for this resource. + maxLength: 400 + minLength: 1 + type: string + displayName: + description: | + The user-friendly display name. This must be unique within the enclosing resource, + and it's changeable. Avoid entering confidential information. + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + type: object + ChangeLogGroupCompartmentDetails: + description: Contains details indicating which compartment the resource should move to. + properties: + compartmentId: + description: The compartment into which the resource should be moved. + maxLength: 255 + minLength: 1 + type: string + type: object + LogSummary: + description: Log object configuration summary. + properties: + compartmentId: + description: The OCID of the compartment that the resource belongs to. + maxLength: 255 + minLength: 1 + type: string + configuration: + $ref: '#/components/schemas/Configuration' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + The user-friendly display name. This must be unique within the enclosing resource, + and it's changeable. Avoid entering confidential information. + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the resource. + maxLength: 255 + minLength: 1 + type: string + isEnabled: + default: true + description: Whether or not this resource is currently enabled. + type: boolean + lifecycleState: + description: The pipeline state. + enum: + - CREATING + - ACTIVE + - UPDATING + - INACTIVE + - DELETING + - FAILED + type: string + x-obmcs-top-level-enum: '#/definitions/LogLifecycleState' + logGroupId: + description: Log group OCID. + maxLength: 255 + minLength: 1 + type: string + logType: + default: CUSTOM + description: The logType that the log object is for, whether custom or service. + enum: + - CUSTOM + - SERVICE + type: string + retentionDuration: + description: Log retention duration in 30-day increments (30, 60, 90 and so on until 180). + format: int32 + type: integer + timeCreated: + description: Time the resource was created. + format: date-time + readOnly: true + type: string + timeLastModified: + description: Time the resource was last modified. + format: date-time + readOnly: true + type: string + required: + - id + - logGroupId + - displayName + - logType + - lifecycleState + type: object + CreateLogDetails: + description: The details to create a log object. + properties: + configuration: + $ref: '#/components/schemas/Configuration' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + The user-friendly display name. This must be unique within the enclosing resource, + and it's changeable. Avoid entering confidential information. + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + isEnabled: + default: true + description: Whether or not this resource is currently enabled. + type: boolean + logType: + default: CUSTOM + description: The logType that the log object is for, whether custom or service. + enum: + - CUSTOM + - SERVICE + type: string + retentionDuration: + description: Log retention duration in 30-day increments (30, 60, 90 and so on until 180). + format: int32 + type: integer + required: + - displayName + - logType + type: object + Log: + description: Represents a log object. + properties: + compartmentId: + description: The OCID of the compartment that the resource belongs to. + maxLength: 255 + minLength: 1 + type: string + configuration: + $ref: '#/components/schemas/Configuration' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + The user-friendly display name. This must be unique within the enclosing resource, + and it's changeable. Avoid entering confidential information. + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the resource. + maxLength: 255 + minLength: 1 + type: string + isEnabled: + default: true + description: Whether or not this resource is currently enabled. + type: boolean + lifecycleState: + description: The pipeline state. + enum: + - CREATING + - ACTIVE + - UPDATING + - INACTIVE + - DELETING + - FAILED + type: string + x-obmcs-top-level-enum: '#/definitions/LogLifecycleState' + logGroupId: + description: Log group OCID. + maxLength: 255 + minLength: 1 + type: string + logType: + default: CUSTOM + description: The logType that the log object is for, whether custom or service. + enum: + - CUSTOM + - SERVICE + type: string + retentionDuration: + description: Log retention duration in 30-day increments (30, 60, 90 and so on until 180). + format: int32 + type: integer + tenancyId: + description: The OCID of the tenancy. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: Time the resource was created. + format: date-time + readOnly: true + type: string + timeLastModified: + description: Time the resource was last modified. + format: date-time + readOnly: true + type: string + required: + - id + - logGroupId + - displayName + - logType + - lifecycleState + type: object + UpdateLogDetails: + description: Update log object properties. + properties: + configuration: + $ref: '#/components/schemas/UpdateConfigurationDetails' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + displayName: + description: | + The user-friendly display name. This must be unique within the enclosing resource, + and it's changeable. Avoid entering confidential information. + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + isEnabled: + default: true + description: Whether or not this resource is currently enabled. + type: boolean + retentionDuration: + description: Log retention duration in 30-day increments (30, 60, 90 and so on until 180). + format: int32 + type: integer + type: object + ChangeLogLogGroupDetails: + description: Contains details indicating which log group the log should move to. + properties: + targetLogGroupId: + description: Log group OCID. + maxLength: 255 + minLength: 1 + type: string + type: object + LogSavedSearchSummaryCollection: + description: | + A collection of LogSavedSearchSummary items. + properties: + items: + description: The Saved Seach Summaries + items: + $ref: '#/components/schemas/LogSavedSearchSummary' + type: array + required: + - items + type: object + CreateLogSavedSearchDetails: + description: | + A LogSavedSearch that can be used to save and share a given search result. + properties: + compartmentId: + description: The OCID of the compartment that the resource belongs to. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: Description for this resource. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + name: + description: | + The user-friendly display name. This must be unique within the enclosing resource, + and it's changeable. Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + query: + description: | + The search query that is saved. + maxLength: 4096 + minLength: 1 + type: string + required: + - compartmentId + - name + - query + type: object + LogSavedSearch: + description: | + A LogSavedSearch that can be used to save and share a given search result. + properties: + compartmentId: + description: The OCID of the compartment that the resource belongs to. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: Description for this resource. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the resource. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: | + The state of the LogSavedSearch + enum: + - CREATING + - ACTIVE + - UPDATING + - INACTIVE + - DELETING + - FAILED + type: string + x-obmcs-top-level-enum: '#/definitions/LogSavedSearchLifecycleState' + name: + description: | + The user-friendly display name. This must be unique within the enclosing resource, + and it's changeable. Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + query: + description: | + The search query that is saved. + maxLength: 4096 + minLength: 1 + type: string + timeCreated: + description: Time the resource was created. + format: date-time + readOnly: true + type: string + timeLastModified: + description: Time the resource was last modified. + format: date-time + readOnly: true + type: string + required: + - id + - compartmentId + - name + - query + type: object + UpdateLogSavedSearchDetails: + description: | + The update details to update a LogSavedSearch. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: Description for this resource. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + name: + description: | + The user-friendly display name. This must be unique within the enclosing resource, + and it's changeable. Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + query: + description: | + The search query that is saved. + maxLength: 4096 + minLength: 1 + type: string + type: object + ChangeLogSavedSearchCompartmentDetails: + description: Contains details indicating which compartment the resource should move to. + properties: + compartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + UnifiedAgentConfigurationCollection: + description: Results of a UnifiedAgentConfiguration search. Contains UnifiedAgentConfigurationSummary items. + properties: + items: + description: List of UnifiedAgentConfigurationSummary. + items: + $ref: '#/components/schemas/UnifiedAgentConfigurationSummary' + type: array + required: + - items + type: object + CreateUnifiedAgentConfigurationDetails: + description: Unified Agent configuration creation object. + properties: + compartmentId: + description: The OCID of the compartment that the resource belongs to. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: Description for this resource. + maxLength: 400 + minLength: 1 + type: string + displayName: + description: | + The user-friendly display name. This must be unique within the enclosing resource, + and it's changeable. Avoid entering confidential information. + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + groupAssociation: + $ref: '#/components/schemas/GroupAssociationDetails' + isEnabled: + default: true + description: Whether or not this resource is currently enabled. + type: boolean + serviceConfiguration: + $ref: '#/components/schemas/UnifiedAgentServiceConfigurationDetails' + required: + - isEnabled + - compartmentId + - serviceConfiguration + type: object + UnifiedAgentConfiguration: + description: Top Unified Agent configuration object. + properties: + compartmentId: + description: The OCID of the compartment that the resource belongs to. + maxLength: 255 + minLength: 1 + type: string + configurationState: + description: State of unified agent service configuration. + enum: + - VALID + - INVALID + type: string + x-obmcs-top-level-enum: '#/definitions/UnifiedAgentServiceConfigurationStates' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: Description for this resource. + maxLength: 400 + minLength: 1 + type: string + displayName: + description: | + The user-friendly display name. This must be unique within the enclosing resource, + and it's changeable. Avoid entering confidential information. + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + groupAssociation: + $ref: '#/components/schemas/GroupAssociationDetails' + id: + description: The OCID of the resource. + maxLength: 255 + minLength: 1 + type: string + isEnabled: + default: true + description: Whether or not this resource is currently enabled. + type: boolean + lifecycleState: + description: The pipeline state. + enum: + - CREATING + - ACTIVE + - UPDATING + - INACTIVE + - DELETING + - FAILED + type: string + x-obmcs-top-level-enum: '#/definitions/LogLifecycleState' + serviceConfiguration: + $ref: '#/components/schemas/UnifiedAgentServiceConfigurationDetails' + timeCreated: + description: Time the resource was created. + format: date-time + readOnly: true + type: string + timeLastModified: + description: Time the resource was last modified. + format: date-time + readOnly: true + type: string + required: + - serviceConfiguration + - id + - compartmentId + - displayName + - lifecycleState + - groupAssociation + - isEnabled + - configurationState + type: object + UpdateUnifiedAgentConfigurationDetails: + description: Update Object for the Unified Agent configuration. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: Description for this resource. + maxLength: 400 + minLength: 1 + type: string + displayName: + description: | + The user-friendly display name. This must be unique within the enclosing resource, + and it's changeable. Avoid entering confidential information. + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + groupAssociation: + $ref: '#/components/schemas/GroupAssociationDetails' + isEnabled: + default: true + description: Whether or not this resource is currently enabled. + type: boolean + serviceConfiguration: + $ref: '#/components/schemas/UnifiedAgentServiceConfigurationDetails' + required: + - displayName + - isEnabled + - serviceConfiguration + type: object + ChangeUnifiedAgentConfigurationCompartmentDetails: + description: Contains details indicating which compartment the resource should move to. + properties: + compartmentId: + description: The OCID the compartment into which the resource should be moved. + maxLength: 255 + minLength: 1 + type: string + type: object + ServiceSummary: + description: Summary of services that are integrated with public logging. + properties: + endpoint: + description: Service endpoint. + maxLength: 255 + minLength: 1 + type: string + id: + description: Service ID. + maxLength: 64 + minLength: 1 + type: string + name: + description: User-friendly service name. + maxLength: 64 + minLength: 1 + type: string + namespace: + description: Apollo project namespace, if any. + maxLength: 64 + minLength: 1 + type: string + resourceTypes: + description: Type of resource that a service provides. + items: + $ref: '#/components/schemas/ResourceType' + type: array + servicePrincipalName: + description: Service ID as set in Service Principal. + maxLength: 64 + minLength: 1 + type: string + tenantId: + description: Tenant OCID. + maxLength: 255 + minLength: 1 + type: string + required: + - tenantId + - servicePrincipalName + - endpoint + - name + - resourceTypes + type: object + WorkRequestSummary: + description: A summary of a work request. + properties: + compartmentId: + description: The OCID of the work request's compartment. + example: ocid1.compartment.oc1..exampleuniqueID + type: string + id: + description: The OCID of the work request. + example: ocid1.publicloggingworkrequest.oc1.iad.exampleuniqueID + type: string + operationType: + description: The type of work the work request is doing. + enum: + - CREATE_LOG + - UPDATE_LOG + - DELETE_LOG + - MOVE_LOG + - CREATE_LOG_GROUP + - UPDATE_LOG_GROUP + - DELETE_LOG_GROUP + - MOVE_LOG_GROUP + - CREATE_CONFIGURATION + - UPDATE_CONFIGURATION + - DELETE_CONFIGURATION + - MOVE_CONFIGURATION + example: LOG_CREATE + type: string + x-obmcs-top-level-enum: '#/definitions/OperationTypes' + percentComplete: + description: Percentage of the request completed. + example: 100 + format: float + type: number + resources: + description: The resources this work request affects. + items: + $ref: '#/components/schemas/WorkRequestResource' + type: array + status: + description: The current status of the work request. + enum: + - ACCEPTED + - IN_PROGRESS + - FAILED + - SUCCEEDED + - CANCELLING + - CANCELED + example: SUCCEEDED + type: string + x-obmcs-top-level-enum: '#/definitions/OperationStatus' + timeAccepted: + description: The time the work request was accepted. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + timeFinished: + description: The time the work request was finished. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + timeStarted: + description: The time the work request was started. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + type: object + WorkRequest: + description: A work request. + properties: + compartmentId: + description: The work request's compartment OCID. + example: ocid1.compartment.oc1..exampleuniqueID + type: string + id: + description: The work request OCID. + example: ocid1.publicloggingworkrequest.oc1.iad.exampleuniqueID + type: string + operationType: + description: The type of work the work request is doing. + enum: + - CREATE_LOG + - UPDATE_LOG + - DELETE_LOG + - MOVE_LOG + - CREATE_LOG_GROUP + - UPDATE_LOG_GROUP + - DELETE_LOG_GROUP + - MOVE_LOG_GROUP + - CREATE_CONFIGURATION + - UPDATE_CONFIGURATION + - DELETE_CONFIGURATION + - MOVE_CONFIGURATION + example: LOG_CREATE + type: string + x-obmcs-top-level-enum: '#/definitions/OperationTypes' + percentComplete: + description: Percentage of the request completed. + example: 100 + format: float + type: number + resources: + description: The resources this work request affects. + items: + $ref: '#/components/schemas/WorkRequestResource' + type: array + status: + description: The current status of the work request. + enum: + - ACCEPTED + - IN_PROGRESS + - FAILED + - SUCCEEDED + - CANCELLING + - CANCELED + example: SUCCEEDED + type: string + x-obmcs-top-level-enum: '#/definitions/OperationStatus' + timeAccepted: + description: The time the work request was accepted. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + timeFinished: + description: The time the work request was finished. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + timeStarted: + description: The time the work request was started. + example: '2017-07-21T16:11:29Z' + format: date-time + type: string + required: + - operationType + - status + - id + - compartmentId + - percentComplete + - resources + - timeAccepted + type: object + x-example: | + { + "operationType":"CREATE_LOG", + "status":"SUCCEEDED", + "id":"ocid1.publicloggingworkrequest.oc1.phx.exampleunique_ID", + "compartmentId":"ocid1.tenancy.oc1..exampleuniqueID", + "percentComplete":100.0, + "reources":[], + "timeAccepted":"2019-05-07T00:50:03.248Z", + "timeStarted":"2019-05-07T00:50:03.374Z", + "timeFinished":"2019-05-07T00:52:05.704Z" + } + WorkRequestError: + description: An error encountered while executing a work request. + properties: + code: + description: | + A machine-usable code for the error that occured. Error codes are listed at + https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm. + type: string + message: + description: A human readable description of the issue encountered. + type: string + timestamp: + description: The time the error occured. An RFC3339-formatted date and time string. + format: date-time + type: string + required: + - code + - message + - timestamp + type: object + WorkRequestLog: + description: A log message from the execution of a work request. + properties: + message: + description: Human-readable log message. + type: string + timestamp: + description: The time the log message was written. An RFC3339-formatted date and time string. + format: date-time + type: string + required: + - message + - timestamp + type: object + Error: + description: An error has occurred. + properties: + code: + description: A short error code that defines the error, meant for programmatic parsing. + type: string + message: + description: A human-readable error string. + type: string + required: + - code + - message + type: object + Configuration: + description: Log object configuration. + properties: + archiving: + $ref: '#/components/schemas/Archiving' + compartmentId: + description: The OCID of the compartment that the resource belongs to. + maxLength: 255 + minLength: 1 + type: string + source: + $ref: '#/components/schemas/Source' + required: + - source + type: object + UpdateConfigurationDetails: + description: The updatable configuration properties. + properties: + archiving: + $ref: '#/components/schemas/Archiving' + source: + $ref: '#/components/schemas/SourceUpdateDetails' + required: + - source + type: object + LogSavedSearchSummary: + description: | + A summary of a LogSavedSearch that can be used to save and share a given search result. + properties: + compartmentId: + description: The OCID of the compartment that the resource belongs to. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: Description for this resource. + maxLength: 400 + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the resource. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: | + The state of the LogSavedSearch + enum: + - CREATING + - ACTIVE + - UPDATING + - INACTIVE + - DELETING + - FAILED + type: string + x-obmcs-top-level-enum: '#/definitions/LogSavedSearchLifecycleState' + name: + description: | + The user-friendly display name. This must be unique within the enclosing resource, + and it's changeable. Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + query: + description: | + The search query that is saved. + maxLength: 4096 + minLength: 1 + type: string + timeCreated: + description: Time the resource was created. + format: date-time + readOnly: true + type: string + timeLastModified: + description: Time the resource was last modified. + format: date-time + readOnly: true + type: string + required: + - id + - compartmentId + - name + type: object + UnifiedAgentConfigurationSummary: + description: Unified Agent configuration summary object returned by the list API. + properties: + compartmentId: + description: The OCID of the compartment that the resource belongs to. + maxLength: 255 + minLength: 1 + type: string + configurationState: + description: State of unified agent service configuration. + enum: + - VALID + - INVALID + type: string + x-obmcs-top-level-enum: '#/definitions/UnifiedAgentServiceConfigurationStates' + configurationType: + description: Type of Unified Agent service configuration. + enum: + - LOGGING + type: string + x-obmcs-top-level-enum: '#/definitions/UnifiedAgentServiceConfigurationTypes' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: Description for this resource. + maxLength: 400 + minLength: 1 + type: string + displayName: + description: | + The user-friendly display name. This must be unique within the enclosing resource, + and it's changeable. Avoid entering confidential information. + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the resource. + maxLength: 255 + minLength: 1 + type: string + isEnabled: + default: true + description: Whether or not this resource is currently enabled. + type: boolean + lifecycleState: + description: The pipeline state. + enum: + - CREATING + - ACTIVE + - UPDATING + - INACTIVE + - DELETING + - FAILED + type: string + x-obmcs-top-level-enum: '#/definitions/LogLifecycleState' + timeCreated: + description: Time the resource was created. + format: date-time + readOnly: true + type: string + timeLastModified: + description: Time the resource was last modified. + format: date-time + readOnly: true + type: string + required: + - id + - compartmentId + - displayName + - configurationType + - lifecycleState + - isEnabled + - configurationState + type: object + GroupAssociationDetails: + description: Groups using the configuration. + properties: + groupList: + description: list of group/dynamic group ids associated with this configuration. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + type: object + UnifiedAgentServiceConfigurationDetails: + description: Top level Unified Agent service configuration object. + discriminator: + propertyName: configurationType + properties: + configurationType: + description: Type of Unified Agent service configuration. + enum: + - LOGGING + type: string + x-obmcs-top-level-enum: '#/definitions/UnifiedAgentServiceConfigurationTypes' + required: + - configurationType + type: object + ResourceType: + description: Type of resource that a service provides. + properties: + categories: + description: Categories for resources. + items: + $ref: '#/components/schemas/Category' + type: array + name: + description: Resource type name. + maxLength: 255 + minLength: 1 + type: string + type: object + WorkRequestResource: + description: A resource created or operated on by a work request. + properties: + actionType: + description: | + The way in which this resource is affected by the work tracked in the work request. + A resource being created, updated, or deleted will remain in the IN_PROGRESS state until + work is complete for that resource, at which point it will transition to CREATED, UPDATED, + or DELETED, respectively. + enum: + - CREATED + - UPDATED + - DELETED + - IN_PROGRESS + - RELATED + type: string + x-obmcs-top-level-enum: '#/definitions/ActionTypes' + entityType: + description: The resource type the work request affects. + type: string + entityUri: + description: The URI path that the user can do a GET on to access the resource metadata. + type: string + identifier: + description: The resource identifier the work request affects. + type: string + required: + - actionType + - entityType + - identifier + type: object + Archiving: + description: Log archiving configuration. + properties: + isEnabled: + default: false + description: True if archiving enabled. This field is now deprecated, you should use Service Connector Hub to enable archiving. + type: boolean + type: object + Source: + description: The source the log object comes from. + discriminator: + propertyName: sourceType + properties: + sourceType: + description: | + The log source. + * **OCISERVICE:** Oracle Service. + enum: + - OCISERVICE + type: string + required: + - sourceType + type: object + SourceUpdateDetails: + description: Source updated configuration. + properties: + parameters: + additionalProperties: + type: string + description: Log category parameters are stored here. The resource for a service log can't be updated. + type: object + type: object + Category: + description: Categories for resources. + properties: + displayName: + description: Category display name. Avoid entering confidential information. + maxLength: 64 + minLength: 0 + type: string + name: + description: Category name. + maxLength: 64 + minLength: 1 + type: string + parameters: + description: Parameters the category supports. + items: + $ref: '#/components/schemas/Parameter' + type: array + type: object + Parameter: + description: Parameters that a resource category supports. + properties: + name: + description: Parameter name. + maxLength: 64 + minLength: 1 + type: string + pattern: + description: Java regex pattern to validate a parameter value. + maxLength: 255 + minLength: 1 + type: string + rqsType: + description: Parameter rqsType if applicable. + maxLength: 255 + minLength: 1 + type: string + type: + description: Parameter type. + enum: + - integer + - string + - boolean + - ENUM_STRING + - RQS_FILTER + type: string + required: + - name + - type + type: object + ListLogGroupsResponse: + type: object + properties: + log_groups: + type: array + items: + $ref: '#/components/schemas/LogGroupSummary' + ListLogsResponse: + type: object + properties: + logs: + type: array + items: + $ref: '#/components/schemas/LogSummary' + ListServicesResponse: + type: object + properties: + services: + type: array + items: + $ref: '#/components/schemas/ServiceSummary' + ListWorkRequestsResponse: + type: object + properties: + work_requests: + type: array + items: + $ref: '#/components/schemas/WorkRequestSummary' + ListWorkRequestErrorsResponse: + type: object + properties: + work_request_errors: + type: array + items: + $ref: '#/components/schemas/WorkRequestError' + ListWorkRequestLogsResponse: + type: object + properties: + work_request_logs: + type: array + items: + $ref: '#/components/schemas/WorkRequestLog' + responses: + '202': + description: Accepted + 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 of the work request. + schema: + type: string + '400': + description: Bad Request + 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' + '401': + description: Unauthorized + 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' + '404': + description: NotAuthorizedOrNotFound + 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' + '409': + description: Conflict + 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' + '412': + description: NoEtagMatch + 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' + '429': + description: Too many requests + 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' + '500': + description: Internal Server 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' + DefaultError: + description: An error has occurred. + 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' + parameters: + CompartmentIdQueryParam: + description: | + Compartment OCID to list resources in. See compartmentIdInSubtree + for nested compartments traversal. + in: query + name: compartmentId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + CompartmentIdInSubtreeQueryParam: + description: Specifies whether or not nested compartments should be traversed. Defaults to false. + in: query + name: isCompartmentIdInSubtree + schema: + type: boolean + default: false + DisplayNameQueryParam: + description: Resource name. + in: query + name: displayName + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + PaginationTokenQueryParam: + description: | + For list pagination. The value of the `opc-next-page` or `opc-previous-page` response header from the previous "List" call. + For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + in: query + name: page + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 512 + PaginationLimitQueryParam: + description: | + When setting the page limit, specifies the maximum number of unfiltered records that can be fetched from the data store in one request. Filtering happens after the records are retrieved. Subsequent pages might include results that match the query criteria. + in: query + name: limit + schema: + type: integer + minimum: 1 + maximum: 1000 + default: 100 + SortByQueryParam: + description: | + The field to sort by (one column only). Default sort order is + ascending exception of `timeCreated` and `timeLastModified` columns (descending). + in: query + name: sortBy + required: false + x-default-description: 'null' + schema: + type: string + enum: + - timeCreated + - displayName + SortOrderQueryParam: + description: | + The sort order to use, whether 'asc' or 'desc'. + in: query + name: sortOrder + required: false + x-default-description: 'null' + schema: + type: string + enum: + - ASC + - DESC + RequestIdHeader: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about + a particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + RetryTokenHeader: + description: | + A token that uniquely identifies a request so it can be retried in case + of a timeout or server error, without risk of executing that same action + again. Retry tokens expire after 24 hours, but can be invalidated + before then due to conflicting operations (e.g., if a resource has been + deleted and purged from the system, then a retry of the original + creation request may be rejected). + in: header + name: opc-retry-token + required: false + schema: + type: string + minLength: 1 + maxLength: 64 + LogGroupIdPathParam: + description: OCID of a log group to work with. + in: path + name: logGroupId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + 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 + LogTypeQueryParam: + description: The logType that the log object is for, whether custom or service. + in: query + name: logType + required: false + x-default-description: 'null' + schema: + type: string + enum: + - CUSTOM + - SERVICE + ServiceQueryParam: + description: Service that created the log object, which is a field of LogSummary.Configuration.Source. + in: query + name: sourceService + required: false + x-default-description: 'null' + schema: + type: string + ResourceQueryParam: + description: Log object resource, which is a field of LogSummary.Configuration.Source. + in: query + name: sourceResource + required: false + x-default-description: 'null' + schema: + type: string + LogLifecycleStateQueryParam: + description: Lifecycle state of the log object + in: query + name: lifecycleState + x-default-description: 'null' + x-obmcs-top-level-enum: '#/definitions/LogLifecycleState' + schema: + type: string + enum: + - CREATING + - ACTIVE + - UPDATING + - INACTIVE + - DELETING + - FAILED + LogIdPathParam: + description: OCID of a log to work with. + in: path + name: logId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + LogSavedSearchIdQueryParam: + description: | + OCID of the LogSavedSearch. + in: query + name: logSavedSearchId + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + default: null + NameQueryParam: + description: Resource name. + in: query + name: name + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + LogSavedSearchIdPathParam: + description: | + OCID of the logSavedSearch. + in: path + name: logSavedSearchId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + LogIdQueryParam: + description: | + Custom log OCID to list resources with the log as destination. + in: query + name: logId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + UnifiedAgentConfigGroupIdQueryParam: + description: The OCID of a group or a dynamic group. + in: query + name: groupId + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + UnifiedAgentConfigurationIdPathParam: + description: The OCID of the Unified Agent configuration. + in: path + name: unifiedAgentConfigurationId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + WorkRequestStatusFilterQueryParam: + description: Filter results by work request status. + in: query + name: status + required: false + x-default-description: 'null' + x-obmcs-top-level-enum: '#/definitions/OperationStatus' + schema: + type: string + enum: + - ACCEPTED + - IN_PROGRESS + - FAILED + - SUCCEEDED + - CANCELLING + - CANCELED + OcidQueryParam: + description: | + Filter results by [OCID](/iaas/Content/API/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type. + in: query + name: id + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + WorkRequestSortByQueryParam: + description: | + Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. + in: query + name: sortBy + required: false + x-default-description: 'null' + schema: + type: string + enum: + - operationType + - status + - timeAccepted + WorkRequestIdPathParam: + description: The asynchronous request ID. + in: path + name: workRequestId + required: true + schema: + type: string + x-stackQL-resources: + log_groups: + id: oci.logging.log_groups + name: log_groups + title: Log Groups + methods: + list: + operation: + $ref: '#/paths/~1logGroups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.log_groups + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListLogGroupsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"log_groups\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1logGroups/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1logGroups~1{logGroupId}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1logGroups~1{logGroupId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1logGroups~1{logGroupId}/put' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1logGroups~1{logGroupId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/log_groups/methods/get' + - $ref: '#/components/x-stackQL-resources/log_groups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/log_groups/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/log_groups/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/log_groups/methods/delete' + replace: [] + logs: + id: oci.logging.logs + name: logs + title: Logs + methods: + list: + operation: + $ref: '#/paths/~1logGroups~1{logGroupId}~1logs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.logs + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListLogsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"logs\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1logGroups~1{logGroupId}~1logs/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1logGroups~1{logGroupId}~1logs~1{logId}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1logGroups~1{logGroupId}~1logs~1{logId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1logGroups~1{logGroupId}~1logs~1{logId}/put' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_log_log_group: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1logGroups~1{logGroupId}~1logs~1{logId}~1actions~1changeLogGroup/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/logs/methods/get' + - $ref: '#/components/x-stackQL-resources/logs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/logs/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/logs/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/logs/methods/delete' + replace: [] + log_saved_searches: + id: oci.logging.log_saved_searches + name: log_saved_searches + title: Log Saved Searches + methods: + list: + operation: + $ref: '#/paths/~1logSavedSearches/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1logSavedSearches/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1logSavedSearches~1{logSavedSearchId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1logSavedSearches~1{logSavedSearchId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1logSavedSearches~1{logSavedSearchId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1logSavedSearches~1{logSavedSearchId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/log_saved_searches/methods/get' + - $ref: '#/components/x-stackQL-resources/log_saved_searches/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/log_saved_searches/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/log_saved_searches/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/log_saved_searches/methods/delete' + replace: [] + unified_agent_configurations: + id: oci.logging.unified_agent_configurations + name: unified_agent_configurations + title: Unified Agent Configurations + methods: + list: + operation: + $ref: '#/paths/~1unifiedAgentConfigurations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1unifiedAgentConfigurations/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1unifiedAgentConfigurations~1{unifiedAgentConfigurationId}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1unifiedAgentConfigurations~1{unifiedAgentConfigurationId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1unifiedAgentConfigurations~1{unifiedAgentConfigurationId}/put' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1unifiedAgentConfigurations~1{unifiedAgentConfigurationId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/unified_agent_configurations/methods/get' + - $ref: '#/components/x-stackQL-resources/unified_agent_configurations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/unified_agent_configurations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/unified_agent_configurations/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/unified_agent_configurations/methods/delete' + replace: [] + services: + id: oci.logging.services + name: services + title: Services + methods: + list: + operation: + $ref: '#/paths/~1v2~1registry~1services/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.services + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListServicesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"services\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/services/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + work_requests: + id: oci.logging.work_requests + name: work_requests + title: Work Requests + methods: + list: + operation: + $ref: '#/paths/~1workRequests/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.work_requests + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListWorkRequestsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"work_requests\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1workRequests~1{workRequestId}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1workRequests~1{workRequestId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/work_requests/methods/get' + - $ref: '#/components/x-stackQL-resources/work_requests/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/work_requests/methods/delete' + replace: [] + work_request_errors: + id: oci.logging.work_request_errors + name: work_request_errors + title: Work Request Errors + methods: + list: + operation: + $ref: '#/paths/~1workRequests~1{workRequestId}~1errors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.work_request_errors + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListWorkRequestErrorsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"work_request_errors\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/work_request_errors/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + work_request_logs: + id: oci.logging.work_request_logs + name: work_request_logs + title: Work Request Logs + methods: + list: + operation: + $ref: '#/paths/~1workRequests~1{workRequestId}~1logs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.work_request_logs + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListWorkRequestLogsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"work_request_logs\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/work_request_logs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://logging.{region}.oci.oraclecloud.com/20200531 + variables: + region: + default: us-ashburn-1 + description: OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. + x-stackQL-envVar: OCI_REGION +x-stackQL-config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: opc-next-page + location: header diff --git a/providers/src/oci/v00.00.00000/services/monitoring.yaml b/providers/src/oci/v00.00.00000/services/monitoring.yaml new file mode 100644 index 00000000..4bdc85a7 --- /dev/null +++ b/providers/src/oci/v00.00.00000/services/monitoring.yaml @@ -0,0 +1,4991 @@ +openapi: 3.0.0 +info: + title: monitoring API + description: oci monitoring API + version: '20180401' +paths: + /alarmSuppressions: + get: + description: | + Lists alarm suppressions for the specified alarm. For more information, see + [Listing Alarm Suppressions](/iaas/Content/Monitoring/Tasks/list-alarm-suppression.htm). + + For important limits information, see + [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). + + This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. + Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, + or transactions, per second (TPS) for a given tenancy. + operationId: ListAlarmSuppressions + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/AlarmIdQueryParam' + - $ref: '#/components/parameters/FilterByAlarmSuppressionDisplayNameQueryParam' + - $ref: '#/components/parameters/FilterByAlarmSuppressionLifecycleStateQueryParam' + - $ref: '#/components/parameters/AlarmSuppressionLevelQueryParam' + - $ref: '#/components/parameters/AlarmSuppressionCompartmentIdQueryParam' + - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' + - $ref: '#/components/parameters/AlarmSuppressionTargetTypeQueryParam' + - $ref: '#/components/parameters/IsAllSuppressionsQueryParam' + - $ref: '#/components/parameters/AlarmSuppressionSortByQueryParam' + - $ref: '#/components/parameters/AlarmSuppressionSortOrderQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + responses: + '200': + description: alarm suppression items + headers: + opc-next-page: + description: | + For list pagination. When this header appears in the response, next page of results remains. + For important details about how pagination works, see + [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + schema: + type: string + opc-previous-page: + description: | + For list pagination. When this header appears in the response, previous pages of results remains. + 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/AlarmSuppressionCollection' + '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/DefaultError' + summary: List Alarm Suppressions + tags: + - monitoring + x-example: | + GET /20180401/alarmSuppressions?alarmId=<alarm_OCID> + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + post: + description: | + Creates a new alarm suppression at the specified level (alarm-wide or dimension-specific). + For more information, see + [Suppressing a Single Alarm](/iaas/Content/Monitoring/Tasks/create-alarm-suppression.htm) and + [Suppressing Multiple Alarms](/iaas/Content/Monitoring/Tasks/create-alarm-suppression-multiple.htm). + + For important limits information, see + [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). + + This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. + Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, + or transactions, per second (TPS) for a given tenancy. + operationId: CreateAlarmSuppression + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAlarmSuppressionDetails' + description: | + The details of the alarm suppression to be created + required: true + responses: + '200': + description: | + Successfully created alarm suppression. + 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/AlarmSuppression' + '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/DefaultError' + summary: Creates a new alarm suppression + tags: + - monitoring + x-example: | + POST /20180401/alarmSuppressions + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "alarmSuppressionTarget" : { + "targetType" : "ALARM", + "alarmId" : "<alarm_OCID>" + }, + "level": "DIMENSION", + "displayName": "Suppression for monthly downtime of resource ABC", + "description": "Suppression for monthly downtime of resource ABC, for support ticket IT-ABC", + "dimensions": {"resourceId": <resource_OCID>} + "timeSuppressFrom": "2023-03-04T05:00:00.600Z", + "timeSuppressUntil": "2023-03-31T17:00:00.000Z", + "suppressionConditions": [{ + "conditionType": "RECURRENCE", + "suppressionRecurrence":"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;BYMINUTE=00;BYSECOND=00", + "suppressionDuration":"PT1H" + }] + } + /alarmSuppressions/{alarmSuppressionId}: + delete: + description: | + Deletes the specified alarm suppression. For more information, see + [Removing a Suppression from a Single Alarm](/iaas/Content/Monitoring/Tasks/delete-alarm-suppression.htm) and + [Removing a Suppression from Multiple Alarms](/iaas/Content/Monitoring/Tasks/delete-alarm-suppression-multiple.htm). + + For important limits information, see + [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). + + This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. + Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, + or transactions, per second (TPS) for a given tenancy. + operationId: DeleteAlarmSuppression + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/AlarmSuppressionIdPathParam' + responses: + '204': + description: Successfully deleted the alarm suppression. + 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 + '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/DefaultError' + tags: + - monitoring + x-example: | + DELETE /20180401/alarmSuppressions/<alarmSuppression_OCID> + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AlarmSuppression' + get: + description: | + Gets the specified alarm suppression. For more information, see + [Getting an Alarm-wide Suppression](/iaas/Content/Monitoring/Tasks/get-alarm-suppression.htm). + + For important limits information, see + [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). + + This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. + Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, + or transactions, per second (TPS) for a given tenancy. + operationId: GetAlarmSuppression + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/AlarmSuppressionIdPathParam' + responses: + '200': + description: | + Successfully retrieved alarm suppression. + 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/AlarmSuppression' + '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/DefaultError' + tags: + - monitoring + x-example: | + GET /20180401/alarmSuppressions/<alarmSuppression_OCID> + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /alarms: + get: + description: | + Lists the alarms for the specified compartment. + For more information, see + [Listing Alarms](/iaas/Content/Monitoring/Tasks/list-alarm.htm). + For important limits information, see + [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). + + This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. + Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, + or transactions, per second (TPS) for a given tenancy. + operationId: ListAlarms + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/FilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' + responses: + '200': + description: Successfully retrieved alarms for listing. + 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/ListAlarmsResponse' + '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/DefaultError' + tags: + - monitoring + x-example: | + Sample 1: List all alarms in a compartment, sorted by display name + + GET /20180401/alarms?compartmentId=<compartment_OCID>&sortBy=displayName + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + Sample 2: List the alarm named "CPU" in a compartment + + GET /20180401/alarms?compartmentId=<compartment_OCID>&displayName=CPU + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + post: + description: | + Creates a new alarm in the specified compartment. + For more information, see + [Creating an Alarm](/iaas/Content/Monitoring/Tasks/create-alarm.htm). + For important limits information, see + [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). + + This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. + Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, + or transactions, per second (TPS) for a given tenancy. + operationId: CreateAlarm + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAlarmDetails' + description: Document for creating an alarm. + required: true + responses: + '200': + description: Successfully created alarm. + 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/Alarm' + '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/DefaultError' + summary: | + Creates a new alarm in the specified compartment. + tags: + - monitoring + x-example: | + Sample 1: Single condition + + POST /20180401/alarms + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "body": "CPU utilization has reached high values.", + "compartmentId": "<compartment_OCID>", + "destinations": [ "<topic_OCID>" ], + "displayName": "High CPU Utilization", + "isEnabled": true, + "isNotificationsPerMetricDimensionEnabled": true, + "messageFormat": "ONS_OPTIMIZED", + "metricCompartmentId": "<compartment_OCID>", + "namespace": "oci_computeagent", + "pendingDuration": "PT5M", + "query": "CpuUtilization[1m]{availabilityDomain = \"cumS:PHX-AD-1"\}.groupBy(availabilityDomain).percentile(0.9) > 85", + "repeatNotificationDuration": "PT2H", + "severity": "WARNING", + "suppression": + { + "description": "System Maintenance", + "timeSuppressFrom": "2023-02-04T05:00:00.600Z", + "timeSuppressUntil": "2023-02-04T07:00:00.600Z" + } + } + + Sample 2: Multiple conditions, with dynamic variables and a five-minute evaluation slack duration + + POST /20180401/alarms + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "alarmSummary": "test summary with severity = {{severity}} and query = {{{query}}}", + "body": "{{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}", + "compartmentId": "<compartment_OCID>", + "destinations": [ "<topic_OCID>" ], + "displayName": "High CPU Utilization", + "evaluationSlackDuration": "PT5M", + "isEnabled": true, + "isNotificationsPerMetricDimensionEnabled": true, + "messageFormat": "ONS_OPTIMIZED", + "metricCompartmentId": "<compartment_OCID>", + "namespace": "oci_computeagent", + "notificationTitle": "Sample title with severity {{severity}}", + "overrides": + [ + {"body": "95% CPU utilization", "query": "CPUUtilization[1m].mean()>95", "severity": "CRITICAL"}, + {"body": "80% CPU utilization", "query": "CPUUtilization[1m].mean()>80", "severity": "WARNING"} + ], + "pendingDuration": "PT5M", + "query": "CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.groupBy(availabilityDomain).percentile(0.9) > 85", + "repeatNotificationDuration": "PT2H", + "ruleName": "BASE", + "severity": "INFO" + } + + Sample 3: Event-based alarm + + POST /20180401/alarms + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "body": "Database instance terminated.", + "compartmentId": "<compartment_OCID>", + "destinations": [ "<topic_OCID>" ], + "displayName": "Database instance shutdown", + "isEnabled": true, + "isNotificationsPerMetricDimensionEnabled": true, + "messageFormat": "ONS_OPTIMIZED", + "metricCompartmentId": "<compartment_OCID>", + "namespace": "oci_database", + "pendingDuration": "PT1M", + "query": "DatabaseInstance.Shutdown[1m].groupBy(availabilityDomain).count() > 0", + "repeatNotificationDuration": "PT0M", + "severity": "INFO" + } + /alarms/status: + get: + description: | + List the status of each alarm in the specified compartment. + Status is collective, across all metric streams in the alarm. + To list alarm status for each metric stream, use [RetrieveDimensionStates](#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates). + Optionally filter by resource or status value. + + For more information, see + [Listing Alarm Statuses](/iaas/Content/Monitoring/Tasks/list-alarm-status.htm). + For important limits information, see + [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). + + This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. + Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, + or transactions, per second (TPS) for a given tenancy. + operationId: ListAlarmsStatus + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ResourceIdQueryParam' + - $ref: '#/components/parameters/ServiceNameQueryParam' + - $ref: '#/components/parameters/EntityIdQueryParam' + - $ref: '#/components/parameters/StatusQueryParam' + responses: + '200': + description: | + Successfully retrieved alarms status for listing. + 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/ListAlarmsStatusResponse' + '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/DefaultError' + tags: + - monitoring + x-example: | + GET /20180401/alarms/status?compartmentId=<compartment_OCID>&resourceId=<resource_OCID> + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-client-retries-enabled: true + /alarms/{alarmId}: + delete: + description: | + Deletes the specified alarm. + For more information, see + [Deleting an Alarm](/iaas/Content/Monitoring/Tasks/delete-alarm.htm). + For important limits information, see + [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). + + This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. + Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, + or transactions, per second (TPS) for a given tenancy. + operationId: DeleteAlarm + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/AlarmIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '204': + description: Successfully deleted the alarm. + 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 + '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/DefaultError' + summary: | + Deletes an alarm. + tags: + - monitoring + x-example: | + DELETE /20180401/alarms/<alarm_OCID> + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Alarm' + get: + description: | + Gets the specified alarm. + For more information, see + [Getting an Alarm](/iaas/Content/Monitoring/Tasks/get-alarm.htm). + For important limits information, see + [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). + + This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. + Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, + or transactions, per second (TPS) for a given tenancy. + operationId: GetAlarm + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/AlarmIdPathParam' + responses: + '200': + description: Successfully retrieved alarm. + 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/Alarm' + '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/DefaultError' + tags: + - monitoring + x-example: | + GET /20180401/alarms/<alarm_OCID> + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the specified alarm. + For more information, see + [Updating an Alarm](/iaas/Content/Monitoring/Tasks/update-alarm.htm). + For important limits information, see + [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). + + This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. + Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, + or transactions, per second (TPS) for a given tenancy. + operationId: UpdateAlarm + parameters: + - $ref: '#/components/parameters/AlarmIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAlarmDetails' + description: Document for updating an alarm. + required: true + responses: + '200': + description: Successfully updated alarm. + 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/Alarm' + '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/DefaultError' + summary: | + Updates an alarm. + tags: + - monitoring + x-example: | + Sample 1: Updating displayName + + PUT /20180401/alarms/<alarm_OCID> + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName": "System Down" + } + + Sample 2: Removing an override (AlarmOverride) + + PUT /20180401/alarms/<alarm_OCID> + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "overrides": [] + } + /alarms/{alarmId}/actions/changeCompartment: + post: + description: | + Moves an alarm into a different compartment within the same tenancy. + For more information, see + [Moving an Alarm](/iaas/Content/Monitoring/Tasks/change-compartment-alarm.htm). + operationId: ChangeAlarmCompartment + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/AlarmIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeAlarmCompartmentDetails' + description: The configuration details for moving an alarm. + required: true + responses: + '204': + description: Successfully changed compartment for the specified alarm. + 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 + '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/DefaultError' + tags: + - monitoring + x-example: | + POST /20180401/alarms/<alarm_OCID>/actions/changeCompartment + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "<compartment_OCID>" + } + x-related-resource: '#/definitions/Alarm' + /alarms/{alarmId}/actions/removeSuppression: + post: + description: | + Removes any existing suppression for the specified alarm. + For more information, see + [Removing a Suppression from a Single Alarm](/iaas/Content/Monitoring/Tasks/delete-alarm-suppression.htm) and + [Removing a Suppression from Multiple Alarms](/iaas/Content/Monitoring/Tasks/delete-alarm-suppression-multiple.htm). + For important limits information, see + [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). + + This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. + Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, + or transactions, per second (TPS) for a given tenancy. + operationId: RemoveAlarmSuppression + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/AlarmIdPathParam' + responses: + '200': + description: Successfully removed suppression for the specified alarm. + 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 + '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/DefaultError' + summary: | + Removes any existing suppression for the specified alarm. + tags: + - monitoring + x-example: | + POST /20180401/alarms/<alarm_OCID>/actions/removeSuppression + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Suppression' + /alarms/{alarmId}/actions/retrieveDimensionStates: + post: + description: | + Lists the current alarm status of each metric stream, where status is derived from the metric stream's last associated transition. + Optionally filter by status value and one or more dimension key-value pairs. + + For more information, see + [Listing Metric Stream Status in an Alarm](/iaas/Content/Monitoring/Tasks/list-alarm-status-metric-stream.htm). + + For important limits information, see + [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). + + This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. + Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, + or transactions, per second (TPS) for a given tenancy. + operationId: RetrieveDimensionStates + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/AlarmIdPathParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RetrieveDimensionStatesDetails' + description: | + The configuration details for retrieving the current alarm status of each metric stream. + responses: + '200': + description: Successfully retrieved alarm state entries. + 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/AlarmDimensionStatesCollection' + '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/DefaultError' + tags: + - monitoring + x-example: | + POST /20211201/alarms/<alarm_OCID>/actions/retrieveDimensionStates + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "dimensionFilters": + { + "availabilityDomain": "phx-ad-1", + "resourceId": "ocid1.instance.region1.phx.exampleuniqueID" + }, + "status": "FIRING" + + } + x-related-resource: '#/definitions/AlarmDimensionStatesCollection' + /alarms/{alarmId}/actions/summarizeAlarmSuppressionHistory: + post: + description: | + Returns history of suppressions for the specified alarm, including both dimension-specific and and alarm-wide suppressions. For more information, see + [Getting Suppression History for an Alarm](/iaas/Content/Monitoring/Tasks/summarize-alarm-suppression-history.htm). + + For important limits information, see + [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). + + This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. + Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, + or transactions, per second (TPS) for a given tenancy. + operationId: SummarizeAlarmSuppressionHistory + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/AlarmIdPathParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SummarizeAlarmSuppressionHistoryDetails' + description: summarize history details + responses: + '200': + description: Alarm suppression history was successfully retrieved. + headers: + opc-next-page: + description: | + For list pagination. When this header appears in the response, next page of results remains. + For important details about how pagination works, see + [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + schema: + type: string + opc-previous-page: + description: | + For list pagination. When this header appears in the response, previous pages of results remains. + 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/AlarmSuppressionHistoryItemCollection' + '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/DefaultError' + tags: + - monitoring + x-example: | + POST /20180401/alarms/<alarm_OCID>/actions/summarizeAlarmSuppressionHistory + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "dimensions": {"resourceId": <resource_OCID>} + "timeSuppressFromGreaterThanOrEqualTo": "2023-03-04T05:00:00.600Z", + "timeSuppressFromLessThan": "2023-03-04T07:00:00.600Z" + } + x-related-resource: '#/definitions/AlarmSuppression' + /alarms/{alarmId}/history: + get: + description: | + Get the history of the specified alarm. + For more information, see + [Getting History of an Alarm](/iaas/Content/Monitoring/Tasks/get-alarm-history.htm). + For important limits information, see + [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). + + This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. + Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, + or transactions, per second (TPS) for a given tenancy. + operationId: GetAlarmHistory + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/AlarmIdPathParam' + - $ref: '#/components/parameters/AlarmHistoryTypeParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/FilterByAlarmHistoryTimeStampFromParam' + - $ref: '#/components/parameters/FilterByAlarmHistoryTimeStampUntilParam' + responses: + '200': + description: Successfully retrieved alarm history. + 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/AlarmHistoryCollection' + '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/DefaultError' + tags: + - monitoring + x-example: | + GET /20180401/alarms/<alarm_OCID>/history + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AlarmHistoryCollection' + /metrics: + post: + description: | + Publishes raw metric data points to the Monitoring service. + For a data point to be posted, its timestamp must be near current time (less than two hours in the past and less than 10 minutes in the future). + + For more information about publishing metrics, see + [Publishing Custom Metrics](/iaas/Content/Monitoring/Tasks/publishingcustommetrics.htm) + and + [Custom Metrics Walkthrough](/iaas/Content/Monitoring/Tasks/custom-metrics-walkthrough.htm). + For information about developing a metric-posting client, see + [Developer Guide](/iaas/Content/API/Concepts/devtoolslanding.htm). + For an example client, see + [MonitoringMetricPostExample.java](https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/MonitoringMetricPostExample.java). + For important limits information, see + [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). + + Per-call limits information follows. + + * Dimensions per metric group*. Maximum: 20. Minimum: 1. + * Unique metric streams*. Maximum: 50. + * Transactions Per Second (TPS) per-tenancy limit for this operation: 50. + + *A metric group is the combination of a given metric, metric namespace, and tenancy for the purpose of determining limits. + A dimension is a qualifier provided in a metric definition. + A metric stream is an individual set of aggregated data for a metric with zero or more dimension values. + For more information about metric-related concepts, see + [Monitoring Concepts](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#concepts). + + **Note:** The endpoints for this operation differ from other Monitoring operations. Replace the string `telemetry` with `telemetry-ingestion` in the endpoint, as in the following example: + + https://telemetry-ingestion.eu-frankfurt-1.oraclecloud.com + operationId: PostMetricData + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/EncodingHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PostMetricDataDetails' + description: | + An array of metric objects containing raw metric data points to be posted to the Monitoring service. + required: true + responses: + '200': + description: | + Successfully posted metrics to the Monitoring service. + This response means that the request passed the partial or full input validation requirements + determined by the BatchAtomicity parameter value. The default value of NON_ATOMIC requires a + partial pass: at least one metric object in the request must pass input validation, and any + objects that failed validation are identified in the returned summary, along with their error + messages. A value of ATOMIC requires a full pass: all metric objects in the request must + pass input validation. + 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/PostMetricDataResponseDetails' + '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/DefaultError' + summary: | + Publishes raw metric data points to the Monitoring service. + tags: + - monitoring + x-related-resource: '#/definitions/MetricData' + /metrics/actions/listMetrics: + post: + description: | + Returns metric definitions that match the criteria specified in the request. Compartment OCID required. + For more information, see + [Listing Metric Definitions](/iaas/Content/Monitoring/Tasks/list-metric.htm). + For information about metrics, see + [Metrics Overview](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#MetricsOverview). + For important limits information, see + [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). + + Transactions Per Second (TPS) per-tenancy limit for this operation: 10. + operationId: ListMetrics + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ListMetricsDetails' + description: The dimensions used to filter metrics. + required: true + responses: + '200': + description: | + The metric definitions were successfully retrieved. + 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/ListMetricsResponse' + '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/DefaultError' + summary: List metrics based on matching criteria. + tags: + - monitoring + x-example: | + Sample 1: List all namespaces + + POST /20180401/metrics/actions/listMetrics?compartmentId=<compartment_OCID> + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "groupBy":["namespace"] + } + + Sample 2: List all resource groups in a namespace + + POST /20180401/metrics/actions/listMetrics?compartmentId=<compartment_OCID> + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "groupBy":["resourceGroup"], + "namespace":"my_namespace" + } + + Sample 3: List all metrics in a namespace for a specific resource group + + POST /20180401/metrics/actions/listMetrics?compartmentId=<compartment_OCID> + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "groupBy":["name"], + "namespace": "my_namespace", + "resourceGroup": "my_resourcegroup" + } + x-related-resource: '#/definitions/Metric' + /metrics/actions/summarizeMetricsData: + post: + description: | + Returns aggregated data that match the criteria specified in the request. Compartment OCID required. + For more information, see + [Querying Metric Data](/iaas/Content/Monitoring/Tasks/query-metric-landing.htm) + and + [Creating a Query](/iaas/Content/Monitoring/Tasks/query-metric.htm). + For important limits information, see + [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). + + Transactions Per Second (TPS) per-tenancy limit for this operation: 10. + operationId: SummarizeMetricsData + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SummarizeMetricsDataDetails' + description: The dimensions used to filter for metrics. + required: true + responses: + '200': + description: | + The metric data was successfully retrieved. + Results are not paginated. + 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/SummarizeMetricsDataResponse' + '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/DefaultError' + summary: Summarizes and returns metrics data filtered using the provided query expression and compartmentId. + tags: + - monitoring + x-example: | + POST /20180401/metrics/actions/summarizeMetricsData?compartmentId=<compartment_OCID> + Host: telemetry.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "namespace": "oci_computeagent", + "query": "CpuUtilization[1m]{resourceId = \"<instance_OCID>\"}.max()", + "startTime": "2023-03-10T22:19:26.789Z", + "endTime": "2023-03-10T22:28:26.789Z" + } + x-related-resource: '#/definitions/MetricData' +components: + schemas: + AlarmSuppressionCollection: + description: | + Collection of property summaries for alarm suppressions. + properties: + items: + description: | + List of property summaries for alarm suppressions. + items: + $ref: '#/components/schemas/AlarmSuppressionSummary' + type: array + required: + - items + type: object + CreateAlarmSuppressionDetails: + description: | + The configuration details for creating an alarm suppression. + properties: + alarmSuppressionTarget: + $ref: '#/components/schemas/AlarmSuppressionTarget' + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only String types are currently supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing predefined tags' keys and values scoped to a namespace + Example: `{"CostCenter": "42"}` + type: object + description: | + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: | + Human-readable reason for this alarm suppression. + It does not have to be unique, and it's changeable. + Avoid entering confidential information. + + Oracle recommends including tracking information for the event or associated work, + such as a ticket number. + + Example: `Planned outage due to change IT-1234.` + type: string + dimensions: + additionalProperties: + type: string + description: | + A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. + If you specify {"availabilityDomain": "phx-ad-1"} + and the alarm state entry corresponds to the set {"availabilityDomain": "phx-ad-1" and "resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}, + then this alarm will be included for suppression. + + This is required only when the value of level is `DIMENSION`. If required, the value cannot be an empty object. + Only a single value is allowed per key. No grouping of multiple values is allowed under the same key. + Maximum characters (after serialization): 4000. This maximum satisfies typical use cases. + The response for an exceeded maximum is `HTTP 400` with an "dimensions values are too long" message. + type: object + displayName: + description: A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information. + type: string + freeformTags: + additionalProperties: + type: string + description: | + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{"Department": "Finance"}` + type: object + level: + description: | + The level of this alarm suppression. + `ALARM` indicates a suppression of the entire alarm, regardless of dimension. + `DIMENSION` indicates a suppression configured for specified dimensions. + + Defaut: `DIMENSION` + type: string + x-obmcs-enumref: '#/definitions/AlarmSuppression/level' + suppressionConditions: + description: | + Array of all preconditions for alarm suppression. + Example: `[{ + conditionType: "RECURRENCE", + suppressionRecurrence: "FRQ=DAILY;BYHOUR=10", + suppressionDuration: "PT1H" + }]` + items: + $ref: '#/components/schemas/SuppressionCondition' + maxItems: 1 + minItems: 1 + type: array + timeSuppressFrom: + description: | + The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. + + Example: `2023-02-01T01:02:29.600Z` + format: date-time + type: string + timeSuppressUntil: + description: | + The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. + + Example: `2023-02-01T02:02:29.600Z` + format: date-time + type: string + required: + - alarmSuppressionTarget + - displayName + - timeSuppressFrom + - timeSuppressUntil + type: object + AlarmSuppression: + description: | + The configuration details for an alarm suppression. + properties: + alarmSuppressionTarget: + $ref: '#/components/schemas/AlarmSuppressionTarget' + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm suppression. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only String types are currently supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing predefined tags' keys and values scoped to a namespace + Example: `{"CostCenter": "42"}` + type: object + description: | + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: | + Human-readable reason for this alarm suppression. + It does not have to be unique, and it's changeable. + Avoid entering confidential information. + + Oracle recommends including tracking information for the event or associated work, + such as a ticket number. + + Example: `Planned outage due to change IT-1234.` + type: string + dimensions: + additionalProperties: + type: string + description: | + Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs. + + Example: `{"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}` + type: object + displayName: + description: A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information. + type: string + freeformTags: + additionalProperties: + type: string + description: | + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{"Department": "Finance"}` + type: object + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the alarm suppression. + type: string + level: + description: | + The level of this alarm suppression. + `ALARM` indicates a suppression of the entire alarm, regardless of dimension. + `DIMENSION` indicates a suppression configured for specified dimensions. + enum: + - ALARM + - DIMENSION + type: string + lifecycleState: + description: | + The current lifecycle state of the alarm suppression. + + Example: `DELETED` + enum: + - ACTIVE + - DELETED + type: string + suppressionConditions: + description: | + Array of all preconditions for alarm suppression. + Example: `[{ + conditionType: "RECURRENCE", + suppressionRecurrence: "FRQ=DAILY;BYHOUR=10", + suppressionDuration: "PT1H" + }]` + items: + $ref: '#/components/schemas/SuppressionCondition' + maxItems: 1 + minItems: 1 + type: array + timeCreated: + description: | + The date and time the alarm suppression was created. Format defined by RFC3339. + + Example: `2018-02-01T01:02:29.600Z` + format: date-time + type: string + timeSuppressFrom: + description: | + The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. + + Example: `2018-02-01T01:02:29.600Z` + format: date-time + type: string + timeSuppressUntil: + description: | + The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. + + Example: `2018-02-01T02:02:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. + + Example: `2018-02-03T01:02:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - alarmSuppressionTarget + - level + - displayName + - timeSuppressFrom + - timeSuppressUntil + - lifecycleState + - timeCreated + - timeUpdated + type: object + AlarmSummary: + description: | + A summary of properties for the specified alarm. + For information about alarms, see + [Alarms Overview](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#AlarmsOverview). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + + For information about endpoints and signing API requests, see + [About the API](/iaas/Content/API/Concepts/usingapi.htm). + For information about available SDKs and tools, see + [SDKS and Other Tools](/iaas/Content/API/Concepts/sdks.htm). + properties: + alarmSummary: + description: | + Customizable alarm summary (`alarmSummary` [alarm message parameter](/iaas/Content/Monitoring/alarm-message-format.htm)). + Optionally include [dynamic variables](/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). + The alarm summary appears within the body of the alarm message and in responses to + [ListAlarmStatus](#/en/monitoring/latest/AlarmStatusSummary/ListAlarmsStatus) + [GetAlarmHistory](#/en/monitoring/latest/AlarmHistoryCollection/GetAlarmHistory) and + [RetrieveDimensionStates](#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates). + type: string + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only String types are currently supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing predefined tags' keys and values scoped to a namespace + Example: `{"CostCenter": "42"}` + type: object + description: | + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + destinations: + description: | + A list of destinations for alarm notifications. + Each destination is represented by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) + of a related resource, such as a [topic](#/en/notification/latest/NotificationTopic). + Supported destination services: Notifications, Streaming. + Limit: One destination per supported destination service. + items: + type: string + minItems: 1 + type: array + displayName: + description: | + A user-friendly name for the alarm. It does not have to be unique, and it's changeable. + + This value determines the title of each alarm notification. + + Example: `High CPU Utilization` + maxLength: 255 + minLength: 1 + type: string + evaluationSlackDuration: + description: | + Customizable slack period to wait for metric ingestion before evaluating the alarm. + Specify a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` + for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. + For more information about the slack period, see + [About the Internal Reset Period](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#reset). + type: string + freeformTags: + additionalProperties: + type: string + description: | + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{"Department": "Finance"}` + type: object + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the alarm. + maxLength: 255 + minLength: 1 + type: string + isEnabled: + description: | + Whether the alarm is enabled. + + Example: `true` + type: boolean + isNotificationsPerMetricDimensionEnabled: + description: | + Whether the alarm sends a separate message for each metric stream. + See [Creating an Alarm That Splits Messages by Metric Stream](/iaas/Content/Monitoring/Tasks/create-alarm-split.htm). + Example: `true` + type: boolean + lifecycleState: + description: | + The current lifecycle state of the alarm. + type: string + x-obmcs-enumref: '#/definitions/Alarm/lifecycleState' + metricCompartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric + being evaluated by the alarm. + maxLength: 255 + minLength: 1 + type: string + namespace: + description: | + The source service or application emitting the metric that is evaluated by the alarm. + + Example: `oci_computeagent` + maxLength: 255 + minLength: 1 + type: string + notificationTitle: + description: | + Customizable notification title (`title` [alarm message parameter](/iaas/Content/Monitoring/alarm-message-format.htm)). + Optionally include [dynamic variables](/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). + The notification title appears as the subject line in a formatted email message and as the title in a Slack message. + type: string + notificationVersion: + description: | + The version of the alarm notification to be delivered. Allowed value: `1.X` + The value must start with a number (up to four digits), followed by a period and an uppercase X. + type: string + overrides: + description: | + A set of overrides that control evaluations of the alarm. + + Each override can specify values for query, severity, body, and pending duration. + When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position `0`), + and then evaluates the alarm's base values (`ruleName` value of `BASE`). + items: + $ref: '#/components/schemas/AlarmOverride' + maxItems: 2 + type: array + query: + description: | + The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of + the Monitoring service interprets results for each returned time series as Boolean values, + where zero represents false and a non-zero value represents true. A true value means that the trigger + rule condition has been met. The query must specify a metric, statistic, interval, and trigger + rule (threshold or absence). Supported values for interval depend on the specified time range. More + interval values are supported for smaller time ranges. Supported grouping functions: `grouping()`, `groupBy()`. + For information about writing MQL expressions, see + [Editing the MQL Expression for a Query](/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). + For details about MQL, see + [Monitoring Query Language (MQL) Reference](/iaas/Content/Monitoring/Reference/mql.htm). + For available dimensions, review the metric definition for the supported service. See + [Supported Services](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices). + + Example of threshold alarm: + + ----- + + CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85 + + ----- + + Example of absence alarm: + + ----- + + CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent() + + ----- + maxLength: 255 + minLength: 1 + type: string + resourceGroup: + description: | + Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. + A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). + + Example: `frontend-fleet` + maxLength: 255 + minLength: 1 + type: string + ruleName: + description: | + Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. + Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](#/en/monitoring/latest/datatypes/AlarmOverride). + type: string + severity: + description: | + The perceived type of response required when the alarm is in the "FIRING" state. + + Example: `CRITICAL` + enum: + - CRITICAL + - ERROR + - WARNING + - INFO + type: string + suppression: + $ref: '#/components/schemas/Suppression' + required: + - id + - displayName + - compartmentId + - metricCompartmentId + - namespace + - query + - severity + - destinations + - isEnabled + - lifecycleState + type: object + x-example: | + Sample: Multiple conditions, with dynamic variables and a five-minute evaluation slack duration + + { + "alarmSummary": "test summary with severity = {{severity}} and query = {{{query}}}", + "compartmentId": "<compartment_OCID>", + "destinations": [ "<topic_OCID>" ], + "displayName": "High CPU Utilization", + "evaluationSlackDuration": "PT5M", + "id": "ocid1.alarm.oc1..exampleuniqueID", + "isEnabled": true, + "isNotificationsPerMetricDimensionEnabled": true, + "lifecycleState": "ACTIVE", + "metricCompartmentId": "<compartment_OCID>", + "namespace": "oci_computeagent", + "notificationTitle": "Sample title with severity {{severity}}", + "overrides": + [ + {"body": "95% CPU utilization", "query": "CPUUtilization[1m].mean()>95", "severity": "CRITICAL"}, + {"body": "80% CPU utilization", "query": "CPUUtilization[1m].mean()>80", "severity": "WARNING"} + ], + "query": "CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.groupBy(availabilityDomain).percentile(0.9) > 85", + "ruleName": "BASE", + "severity": "INFO" + } + CreateAlarmDetails: + description: | + The configuration details for creating an alarm. + properties: + alarmSummary: + description: | + Customizable alarm summary (`alarmSummary` [alarm message parameter](/iaas/Content/Monitoring/alarm-message-format.htm)). + Optionally include [dynamic variables](/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). + The alarm summary appears within the body of the alarm message and in responses to + [ListAlarmStatus](#/en/monitoring/latest/AlarmStatusSummary/ListAlarmsStatus) + [GetAlarmHistory](#/en/monitoring/latest/AlarmHistoryCollection/GetAlarmHistory) and + [RetrieveDimensionStates](#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates). + type: string + body: + description: | + The human-readable content of the delivered alarm notification. + Optionally include [dynamic variables](/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). + Oracle recommends providing guidance + to operators for resolving the alarm condition. Consider adding links to standard runbook + practices. Avoid entering confidential information. + + Example: `High CPU usage alert. Follow runbook instructions for resolution.` + maxLength: 1000 + minLength: 1 + type: string + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only String types are currently supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing predefined tags' keys and values scoped to a namespace + Example: `{"CostCenter": "42"}` + type: object + description: | + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + destinations: + description: | + A list of destinations for alarm notifications. + Each destination is represented by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) + of a related resource, such as a [topic](#/en/notification/latest/NotificationTopic). + Supported destination services: Notifications, Streaming. + Limit: One destination per supported destination service. + items: + type: string + minItems: 1 + type: array + displayName: + description: | + A user-friendly name for the alarm. It does not have to be unique, and it's changeable. + Avoid entering confidential information. + + This value determines the title of each alarm notification. + + Example: `High CPU Utilization` + maxLength: 255 + minLength: 1 + type: string + evaluationSlackDuration: + description: | + Customizable slack period to wait for metric ingestion before evaluating the alarm. + Specify a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` + for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. + For more information about the slack period, see + [About the Internal Reset Period](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#reset). + type: string + freeformTags: + additionalProperties: + type: string + description: | + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{"Department": "Finance"}` + type: object + isEnabled: + description: | + Whether the alarm is enabled. + + Example: `true` + type: boolean + isNotificationsPerMetricDimensionEnabled: + default: false + description: | + When set to `true`, splits alarm notifications per metric stream. + When set to `false`, groups alarm notifications across metric streams. + Example: `true` + type: boolean + messageFormat: + default: RAW + description: | + The format to use for alarm notifications. The formats are: + * `RAW` - Raw JSON blob. Default value. When the `destinations` attribute specifies `Streaming`, all alarm notifications use this format. + * `PRETTY_JSON`: JSON with new lines and indents. Available when the `destinations` attribute specifies `Notifications` only. + * `ONS_OPTIMIZED`: Simplified, user-friendly layout. Available when the `destinations` attribute specifies `Notifications` only. Applies to Email subscription types only. + enum: + - RAW + - PRETTY_JSON + - ONS_OPTIMIZED + type: string + metricCompartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric + being evaluated by the alarm. + maxLength: 255 + minLength: 1 + type: string + metricCompartmentIdInSubtree: + description: | + When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can + only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). + A true value requires the user to have tenancy-level permissions. If this requirement is not met, + then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified + in metricCompartmentId. Default is false. + + Example: `true` + type: boolean + namespace: + description: | + The source service or application emitting the metric that is evaluated by the alarm. + + Example: `oci_computeagent` + maxLength: 255 + minLength: 1 + type: string + notificationTitle: + description: | + Customizable notification title (`title` [alarm message parameter](/iaas/Content/Monitoring/alarm-message-format.htm)). + Optionally include [dynamic variables](/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). + The notification title appears as the subject line in a formatted email message and as the title in a Slack message. + type: string + notificationVersion: + description: | + The version of the alarm notification to be delivered. Allowed value: `1.X` + The value must start with a number (up to four digits), followed by a period and an uppercase X. + type: string + overrides: + description: | + A set of overrides that control evaluations of the alarm. + + Each override can specify values for query, severity, body, and pending duration. + When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position `0`), + and then evaluates the alarm's base values (`ruleName` value of `BASE`). + items: + $ref: '#/components/schemas/AlarmOverride' + maxItems: 2 + type: array + pendingDuration: + description: | + The period of time that the condition defined in the alarm must persist before the alarm state + changes from "OK" to "FIRING". For example, a value of 5 minutes means that the + alarm must persist in breaching the condition for five minutes before the alarm updates its + state to "FIRING". + + The duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` + for one hour). Minimum: PT1M. Maximum: PT24H. Default: PT1M. + + Under the default value of PT1M, the first evaluation that breaches the alarm updates the + state to "FIRING". + + The alarm updates its status to "OK" when the breaching condition has been clear for + the most recent minute. + + Example: `PT5M` + type: string + query: + description: | + The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of + the Monitoring service interprets results for each returned time series as Boolean values, + where zero represents false and a non-zero value represents true. A true value means that the trigger + rule condition has been met. The query must specify a metric, statistic, interval, and trigger + rule (threshold or absence). Supported values for interval depend on the specified time range. More + interval values are supported for smaller time ranges. You can optionally + specify dimensions and grouping functions. + Also, you can customize the + [absence detection period](/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). + Supported grouping functions: `grouping()`, `groupBy()`. + For information about writing MQL expressions, see + [Editing the MQL Expression for a Query](/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). + For details about MQL, see + [Monitoring Query Language (MQL) Reference](/iaas/Content/Monitoring/Reference/mql.htm). + For available dimensions, review the metric definition for the supported service. See + [Supported Services](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices). + + Example of threshold alarm: + + ----- + + CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85 + + ----- + + Example of absence alarm: + + ----- + + CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent() + + ----- + Example of absence alarm with custom absence detection period of 20 hours: + + ----- + + CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) + + ----- + maxLength: 1000 + minLength: 1 + type: string + repeatNotificationDuration: + description: | + The frequency for re-submitting alarm notifications, if the alarm keeps firing without + interruption. Format defined by ISO 8601. For example, `PT4H` indicates four hours. + As another example, `PT0M` indicates a repeat notification each time the alarm trigger condition is met, + otherwise known as an event-based notification. For more information, see + [Getting Event-Based Notifications for an Alarm](/iaas/Content/Monitoring/Tasks/update-alarm-event.htm). + Minimum: PT0M. Maximum: P30D. + + Default value: null (notifications are not re-submitted). + type: string + resolution: + description: | + The time between calculated aggregation windows for the alarm. Supported value: `1m` + type: string + resourceGroup: + description: | + Resource group that you want to match. A null value returns only metric data that has no resource groups. The alarm retrieves metric data associated with the specified resource group only. Only one resource group can be applied per metric. + A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). + Avoid entering confidential information. + + Example: `frontend-fleet` + maxLength: 255 + minLength: 1 + type: string + ruleName: + description: | + Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. + Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](#/en/monitoring/latest/datatypes/AlarmOverride). + type: string + severity: + description: | + The perceived type of response required when the alarm is in the "FIRING" state. + type: string + x-obmcs-enumref: '#/definitions/Alarm/severity' + suppression: + $ref: '#/components/schemas/Suppression' + required: + - displayName + - compartmentId + - metricCompartmentId + - namespace + - query + - severity + - destinations + - isEnabled + type: object + x-example: | + Sample 1: Single condition + + { + "body": "CPU utilization has reached high values.", + "compartmentId": "<compartment_OCID>", + "destinations": [ "<topic_OCID>" ], + "displayName": "High CPU Utilization", + "isEnabled": true, + "isNotificationsPerMetricDimensionEnabled": true, + "messageFormat": "ONS_OPTIMIZED", + "metricCompartmentId": "<compartment_OCID>", + "namespace": "oci_computeagent", + "pendingDuration": "PT5M", + "query": "CpuUtilization[1m]{availabilityDomain = \"cumS:PHX-AD-1"\}.groupBy(availabilityDomain).percentile(0.9) > 85", + "repeatNotificationDuration": "PT2H", + "severity": "WARNING", + "suppression": + { + "description": "System Maintenance", + "timeSuppressFrom": "2023-02-04T05:00:00.600Z", + "timeSuppressUntil": "2023-02-04T07:00:00.600Z" + } + } + + Sample 2: Multiple conditions, with dynamic variables and a five-minute evaluation slack duration + + { + "alarmSummary": "test summary with severity = {{severity}} and query = {{{query}}}", + "body": "{{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}", + "compartmentId": "<compartment_OCID>", + "destinations": [ "<topic_OCID>" ], + "displayName": "High CPU Utilization", + "evaluationSlackDuration": "PT5M", + "isEnabled": true, + "isNotificationsPerMetricDimensionEnabled": true, + "messageFormat": "ONS_OPTIMIZED", + "metricCompartmentId": "<compartment_OCID>", + "namespace": "oci_computeagent", + "notificationTitle": "Sample title with severity {{severity}}", + "overrides": + [ + {"body": "95% CPU utilization", "query": "CPUUtilization[1m].mean()>95", "severity": "CRITICAL"}, + {"body": "80% CPU utilization", "query": "CPUUtilization[1m].mean()>80", "severity": "WARNING"} + ], + "pendingDuration": "PT5M", + "query": "CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.groupBy(availabilityDomain).percentile(0.9) > 85", + "repeatNotificationDuration": "PT2H", + "ruleName": "BASE", + "severity": "INFO" + } + + Sample 3: Event-based alarm + + { + "body": "Database instance terminated.", + "compartmentId": "<compartment_OCID>", + "destinations": [ "<topic_OCID>" ], + "displayName": "Database instance shutdown", + "isEnabled": true, + "isNotificationsPerMetricDimensionEnabled": true, + "messageFormat": "ONS_OPTIMIZED", + "metricCompartmentId": "<compartment_OCID>", + "namespace": "oci_database", + "pendingDuration": "PT1M", + "query": "DatabaseInstance.Shutdown[1m].groupBy(availabilityDomain).count() > 0", + "repeatNotificationDuration": "PT0M", + "severity": "INFO" + } + Alarm: + description: | + The properties that define an alarm. + For information about alarms, see + [Alarms Overview](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#AlarmsOverview). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + + For information about endpoints and signing API requests, see + [About the API](/iaas/Content/API/Concepts/usingapi.htm). + For information about available SDKs and tools, see + [SDKS and Other Tools](/iaas/Content/API/Concepts/sdks.htm). + properties: + alarmSummary: + description: | + Customizable alarm summary (`alarmSummary` [alarm message parameter](/iaas/Content/Monitoring/alarm-message-format.htm)). + Optionally include [dynamic variables](/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). + The alarm summary appears within the body of the alarm message and in responses to + [ListAlarmStatus](#/en/monitoring/latest/AlarmStatusSummary/ListAlarmsStatus) + [GetAlarmHistory](#/en/monitoring/latest/AlarmHistoryCollection/GetAlarmHistory) and + [RetrieveDimensionStates](#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates). + type: string + body: + description: | + The human-readable content of the delivered alarm notification. + Optionally include [dynamic variables](/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). + Oracle recommends providing guidance + to operators for resolving the alarm condition. Consider adding links to standard runbook + practices. Avoid entering confidential information. + + Example: `High CPU usage alert. Follow runbook instructions for resolution.` + maxLength: 1000 + minLength: 1 + type: string + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only String types are currently supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing predefined tags' keys and values scoped to a namespace + Example: `{"CostCenter": "42"}` + type: object + description: | + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + destinations: + description: | + A list of destinations for alarm notifications. + Each destination is represented by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) + of a related resource, such as a [topic](#/en/notification/latest/NotificationTopic). + Supported destination services: Notifications, Streaming. + Limit: One destination per supported destination service. + items: + type: string + minItems: 1 + type: array + displayName: + description: | + A user-friendly name for the alarm. It does not have to be unique, and it's changeable. + + This value determines the title of each alarm notification. + + Example: `High CPU Utilization` + maxLength: 255 + minLength: 1 + type: string + evaluationSlackDuration: + description: | + Customizable slack period to wait for metric ingestion before evaluating the alarm. + Specify a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` + for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. + For more information about the slack period, see + [About the Internal Reset Period](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#reset). + type: string + freeformTags: + additionalProperties: + type: string + description: | + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{"Department": "Finance"}` + type: object + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the alarm. + maxLength: 255 + minLength: 1 + type: string + isEnabled: + description: | + Whether the alarm is enabled. + + Example: `true` + type: boolean + isNotificationsPerMetricDimensionEnabled: + default: false + description: | + When set to `true`, splits alarm notifications per metric stream. + When set to `false`, groups alarm notifications across metric streams. + type: boolean + lifecycleState: + description: | + The current lifecycle state of the alarm. + + Example: `DELETED` + enum: + - ACTIVE + - DELETING + - DELETED + type: string + messageFormat: + default: RAW + description: | + The format to use for alarm notifications. The formats are: + * `RAW` - Raw JSON blob. Default value. When the `destinations` attribute specifies `Streaming`, all alarm notifications use this format. + * `PRETTY_JSON`: JSON with new lines and indents. Available when the `destinations` attribute specifies `Notifications` only. + * `ONS_OPTIMIZED`: Simplified, user-friendly layout. Available when the `destinations` attribute specifies `Notifications` only. Applies to Email subscription types only. + enum: + - RAW + - PRETTY_JSON + - ONS_OPTIMIZED + type: string + metricCompartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric + being evaluated by the alarm. + maxLength: 255 + minLength: 1 + type: string + metricCompartmentIdInSubtree: + description: | + When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can + only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). + A true value requires the user to have tenancy-level permissions. If this requirement is not met, + then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified + in metricCompartmentId. Default is false. + + Example: `true` + type: boolean + namespace: + description: | + The source service or application emitting the metric that is evaluated by the alarm. + + Example: `oci_computeagent` + maxLength: 255 + minLength: 1 + type: string + notificationTitle: + description: | + Customizable notification title (`title` [alarm message parameter](/iaas/Content/Monitoring/alarm-message-format.htm)). + Optionally include [dynamic variables](/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). + The notification title appears as the subject line in a formatted email message and as the title in a Slack message. + type: string + notificationVersion: + description: | + The version of the alarm notification to be delivered. Allowed value: `1.X` + The value must start with a number (up to four digits), followed by a period and an uppercase X. + type: string + overrides: + description: | + A set of overrides that control evaluations of the alarm. + + Each override can specify values for query, severity, body, and pending duration. + When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position `0`), + and then evaluates the alarm's base values (`ruleName` value of `BASE`). + items: + $ref: '#/components/schemas/AlarmOverride' + maxItems: 2 + type: array + pendingDuration: + description: | + The period of time that the condition defined in the alarm must persist before the alarm state + changes from "OK" to "FIRING". For example, a value of 5 minutes means that the + alarm must persist in breaching the condition for five minutes before the alarm updates its + state to "FIRING". + + The duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` + for one hour). Minimum: PT1M. Maximum: PT24H. Default: PT1M. + + Under the default value of PT1M, the first evaluation that breaches the alarm updates the + state to "FIRING". + + The alarm updates its status to "OK" when the breaching condition has been clear for + the most recent minute. + + Example: `PT5M` + type: string + query: + description: | + The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of + the Monitoring service interprets results for each returned time series as Boolean values, + where zero represents false and a non-zero value represents true. A true value means that the trigger + rule condition has been met. The query must specify a metric, statistic, interval, and trigger + rule (threshold or absence). Supported values for interval depend on the specified time range. More + interval values are supported for smaller time ranges. You can optionally + specify dimensions and grouping functions. + Also, you can customize the + [absence detection period](/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). + Supported grouping functions: `grouping()`, `groupBy()`. + For information about writing MQL expressions, see + [Editing the MQL Expression for a Query](/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). + For details about MQL, see + [Monitoring Query Language (MQL) Reference](/iaas/Content/Monitoring/Reference/mql.htm). + For available dimensions, review the metric definition for the supported service. See + [Supported Services](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices). + + Example of threshold alarm: + + ----- + + CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85 + + ----- + + Example of absence alarm: + + ----- + + CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent() + + ----- + Example of absence alarm with custom absence detection period of 20 hours: + + ----- + + CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) + + ----- + maxLength: 1000 + minLength: 1 + type: string + repeatNotificationDuration: + description: | + The frequency for re-submitting alarm notifications, if the alarm keeps firing without + interruption. Format defined by ISO 8601. For example, `PT4H` indicates four hours. + As another example, `PT0M` indicates a repeat notification each time the alarm trigger condition is met, + otherwise known as an event-based notification. For more information, see + [Getting Event-Based Notifications for an Alarm](/iaas/Content/Monitoring/Tasks/update-alarm-event.htm). + Minimum: PT0M. Maximum: P30D. + type: string + resolution: + description: | + The time between calculated aggregation windows for the alarm. Supported value: `1m` + type: string + resourceGroup: + description: | + Resource group to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. + A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). + + Example: `frontend-fleet` + maxLength: 255 + minLength: 1 + type: string + ruleName: + description: | + Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. + Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](#/en/monitoring/latest/datatypes/AlarmOverride). + type: string + severity: + description: | + The perceived type of response required when the alarm is in the "FIRING" state. + + Example: `CRITICAL` + enum: + - CRITICAL + - ERROR + - WARNING + - INFO + type: string + suppression: + $ref: '#/components/schemas/Suppression' + timeCreated: + description: | + The date and time the alarm was created. Format defined by RFC3339. + + Example: `2023-02-01T01:02:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time the alarm was last updated. Format defined by RFC3339. + + Example: `2023-02-03T01:02:29.600Z` + format: date-time + type: string + required: + - id + - displayName + - compartmentId + - metricCompartmentId + - namespace + - query + - severity + - destinations + - isEnabled + - lifecycleState + - timeCreated + - timeUpdated + type: object + x-example: | + Sample 1: Single condition + + { + "body": "CPU utilization has reached high values.", + "compartmentId": "<compartment_OCID>", + "destinations": [ "<topic_OCID>" ], + "displayName": "High CPU Utilization", + "id": "ocid1.alarm.oc1..exampleuniqueID", + "isEnabled": true, + "isNotificationsPerMetricDimensionEnabled": true, + "lifecycleState": "ACTIVE", + "messageFormat": "ONS_OPTIMIZED", + "metricCompartmentId": "<compartment_OCID>", + "namespace": "oci_computeagent", + "pendingDuration": "PT5M", + "query": "CpuUtilization[1m]{availabilityDomain = \"cumS:PHX-AD-1"\}.groupBy(availabilityDomain).percentile(0.9) > 85", + "repeatNotificationDuration": "PT2H", + "severity": "WARNING", + "suppression": + { + "description": "System Maintenance", + "timeSuppressFrom": "2023-02-04T05:00:00.600Z", + "timeSuppressUntil": "2023-02-04T07:00:00.600Z" + }, + "timeCreated": "2023-02-01T01:02:29.600Z", + "timeUpdated": "2023-02-03T01:02:29.600Z" + } + + Sample 2: Multiple conditions, with dynamic variables and a five-minute evaluation slack duration + + { + "alarmSummary": "test summary with severity = {{severity}} and query = {{{query}}}", + "body": "{{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}", + "compartmentId": "<compartment_OCID>", + "destinations": [ "<topic_OCID>" ], + "displayName": "High CPU Utilization", + "evaluationSlackDuration": "PT5M", + "id": "ocid1.alarm.oc1..exampleuniqueID", + "isEnabled": true, + "isNotificationsPerMetricDimensionEnabled": true, + "lifecycleState": "ACTIVE", + "messageFormat": "ONS_OPTIMIZED", + "metricCompartmentId": "<compartment_OCID>", + "namespace": "oci_computeagent", + "notificationTitle": "Sample title with severity {{severity}}", + "overrides": + [ + {"body": "95% CPU utilization", "query": "CPUUtilization[1m].mean()>95", "severity": "CRITICAL"}, + {"body": "80% CPU utilization", "query": "CPUUtilization[1m].mean()>80", "severity": "WARNING"} + ], + "pendingDuration": "PT5M", + "query": "CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.groupBy(availabilityDomain).percentile(0.9) > 85", + "repeatNotificationDuration": "PT2H", + "ruleName": "BASE", + "severity": "INFO", + "timeCreated": "2023-02-01T01:02:29.600Z", + "timeUpdated": "2023-02-03T01:02:29.600Z" + } + + Sample 3: Event-based alarm + + { + "body": "Database instance terminated.", + "compartmentId": "<compartment_OCID>", + "destinations": [ "<topic_OCID>" ], + "displayName": "Database instance shutdown", + "id": "ocid1.alarm.oc1..exampleuniqueID", + "isEnabled": true, + "isNotificationsPerMetricDimensionEnabled": true, + "lifecycleState": "ACTIVE", + "messageFormat": "ONS_OPTIMIZED", + "metricCompartmentId": "<compartment_OCID>", + "namespace": "oci_database", + "pendingDuration": "PT1M", + "query": "DatabaseInstance.Shutdown[1m].groupBy(availabilityDomain).count() > 0", + "repeatNotificationDuration": "PT0M", + "severity": "INFO", + "timeCreated": "2025-01-01T01:02:29.600Z", + "timeUpdated": "2025-01-03T01:02:29.600Z" + } + AlarmStatusSummary: + description: | + A summary of properties for the specified alarm and its current evaluation status. + For information about alarms, see + [Alarms Overview](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#AlarmsOverview). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + + For information about endpoints and signing API requests, see + [About the API](/iaas/Content/API/Concepts/usingapi.htm). + For information about available SDKs and tools, see + [SDKS and Other Tools](/iaas/Content/API/Concepts/sdks.htm). + properties: + alarmSummary: + description: | + Customizable alarm summary (`alarmSummary` [alarm message parameter](/iaas/Content/Monitoring/alarm-message-format.htm)). + Optionally include [dynamic variables](/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). + The alarm summary appears within the body of the alarm message and in responses to + [ListAlarmStatus](#/en/monitoring/latest/AlarmStatusSummary/ListAlarmsStatus) + [GetAlarmHistory](#/en/monitoring/latest/AlarmHistoryCollection/GetAlarmHistory) and + [RetrieveDimensionStates](#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates). + type: string + displayName: + description: | + The configured name of the alarm. + + Example: `High CPU Utilization` + maxLength: 255 + minLength: 1 + type: string + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the alarm. + maxLength: 255 + minLength: 1 + type: string + ruleName: + description: | + Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. + Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](#/en/monitoring/latest/datatypes/AlarmOverride). + type: string + severity: + description: | + The perceived type of response required when the alarm is in the "FIRING" state. + + Example: `CRITICAL` + enum: + - CRITICAL + - ERROR + - WARNING + - INFO + type: string + status: + description: | + The status of this alarm. + Status is collective, across all metric streams in the alarm. + To list alarm status for each metric stream, use [RetrieveDimensionStates](#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates). + + Example: `FIRING` + enum: + - FIRING + - OK + - SUSPENDED + type: string + suppression: + $ref: '#/components/schemas/Suppression' + timestampTriggered: + description: | + Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. + Note: A three-minute lag for this value accounts for any late-arriving metrics. + + Example: `2023-02-01T01:02:29.600Z` + format: date-time + type: string + required: + - alarmSummary + - id + - displayName + - severity + - ruleName + - timestampTriggered + - status + type: object + x-example: | + { + "alarmSummary": "Alarm test-name is in a FIRING state; because 1 metric meets the trigger rule", + "id": "ocid1.alarm.oc1..exampleuniqueID", + "displayName": "High CPU Utilization", + "severity": "WARNING", + "ruleName": "BASE", + "timestampTriggered": "2023-02-01T01:02:29.600Z", + "status": "FIRING" + } + UpdateAlarmDetails: + description: | + The configuration details for updating an alarm. + properties: + alarmSummary: + description: | + Customizable alarm summary (`alarmSummary` [alarm message parameter](/iaas/Content/Monitoring/alarm-message-format.htm)). + Optionally include [dynamic variables](/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). + The alarm summary appears within the body of the alarm message and in responses to + [ListAlarmStatus](#/en/monitoring/latest/AlarmStatusSummary/ListAlarmsStatus) + [GetAlarmHistory](#/en/monitoring/latest/AlarmHistoryCollection/GetAlarmHistory) and + [RetrieveDimensionStates](#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates). + type: string + body: + description: | + The human-readable content of the delivered alarm notification. + Optionally include [dynamic variables](/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). + Oracle recommends providing guidance + to operators for resolving the alarm condition. Consider adding links to standard runbook + practices. Avoid entering confidential information. + + Example: `High CPU usage alert. Follow runbook instructions for resolution.` + maxLength: 1000 + minLength: 1 + type: string + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only String types are currently supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing predefined tags' keys and values scoped to a namespace + Example: `{"CostCenter": "42"}` + type: object + description: | + Usage of predefined tag keys. These predefined keys are scoped to namespaces. + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + destinations: + description: | + A list of destinations for alarm notifications. + Each destination is represented by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) + of a related resource, such as a [topic](#/en/notification/latest/NotificationTopic). + Supported destination services: Notifications, Streaming. + Limit: One destination per supported destination service. + items: + type: string + type: array + displayName: + description: | + A user-friendly name for the alarm. It does not have to be unique, and it's changeable. + Avoid entering confidential information. + + This value determines the title of each alarm notification. + + Example: `High CPU Utilization` + maxLength: 255 + minLength: 1 + type: string + evaluationSlackDuration: + description: | + Customizable slack period to wait for metric ingestion before evaluating the alarm. + Specify a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` + for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. + For more information about the slack period, see + [About the Internal Reset Period](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#reset). + type: string + freeformTags: + additionalProperties: + type: string + description: | + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{"Department": "Finance"}` + type: object + isEnabled: + description: | + Whether the alarm is enabled. + + Example: `true` + type: boolean + isNotificationsPerMetricDimensionEnabled: + default: false + description: | + When set to `true`, splits alarm notifications per metric stream. + When set to `false`, groups alarm notifications across metric streams. + type: boolean + messageFormat: + description: | + The format to use for alarm notifications. The formats are: + * `RAW` - Raw JSON blob. Default value. When the `destinations` attribute specifies `Streaming`, all alarm notifications use this format. + * `PRETTY_JSON`: JSON with new lines and indents. Available when the `destinations` attribute specifies `Notifications` only. + * `ONS_OPTIMIZED`: Simplified, user-friendly layout. Available when the `destinations` attribute specifies `Notifications` only. Applies to Email subscription types only. + enum: + - RAW + - PRETTY_JSON + - ONS_OPTIMIZED + type: string + metricCompartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric + being evaluated by the alarm. + maxLength: 255 + minLength: 1 + type: string + metricCompartmentIdInSubtree: + description: | + When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can + only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). + A true value requires the user to have tenancy-level permissions. If this requirement is not met, + then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified + in metricCompartmentId. Default is false. + + Example: `true` + type: boolean + namespace: + description: | + The source service or application emitting the metric that is evaluated by the alarm. + + Example: `oci_computeagent` + maxLength: 255 + minLength: 1 + type: string + notificationTitle: + description: | + Customizable notification title (`title` [alarm message parameter](/iaas/Content/Monitoring/alarm-message-format.htm)). + Optionally include [dynamic variables](/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). + The notification title appears as the subject line in a formatted email message and as the title in a Slack message. + type: string + notificationVersion: + description: | + The version of the alarm notification to be delivered. Allowed value: `1.X` + The value must start with a number (up to four digits), followed by a period and an uppercase X. + type: string + overrides: + description: | + A set of overrides that control evaluations of the alarm. + + Each override can specify values for query, severity, body, and pending duration. + When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position `0`), + and then evaluates the alarm's base values (`ruleName` value of `BASE`). + items: + $ref: '#/components/schemas/AlarmOverride' + maxItems: 2 + type: array + pendingDuration: + description: | + The period of time that the condition defined in the alarm must persist before the alarm state + changes from "OK" to "FIRING". For example, a value of 5 minutes means that the + alarm must persist in breaching the condition for five minutes before the alarm updates its + state to "FIRING". + + The duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` + for one hour). Minimum: PT1M. Maximum: PT24H. Default: PT1M. + + Under the default value of PT1M, the first evaluation that breaches the alarm updates the + state to "FIRING". + + The alarm updates its status to "OK" when the breaching condition has been clear for + the most recent minute. + + Example: `PT5M` + type: string + query: + description: | + The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of + the Monitoring service interprets results for each returned time series as Boolean values, + where zero represents false and a non-zero value represents true. A true value means that the trigger + rule condition has been met. The query must specify a metric, statistic, interval, and trigger + rule (threshold or absence). Supported values for interval depend on the specified time range. More + interval values are supported for smaller time ranges. You can optionally + specify dimensions and grouping functions. + Also, you can customize the + [absence detection period](/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). + Supported grouping functions: `grouping()`, `groupBy()`. + For information about writing MQL expressions, see + [Editing the MQL Expression for a Query](/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). + For details about MQL, see + [Monitoring Query Language (MQL) Reference](/iaas/Content/Monitoring/Reference/mql.htm). + For available dimensions, review the metric definition for the supported service. See + [Supported Services](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices). + + Example of threshold alarm: + + ----- + + CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85 + + ----- + + Example of absence alarm: + + ----- + + CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent() + + ----- + Example of absence alarm with custom absence detection period of 20 hours: + + ----- + + CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) + + ----- + maxLength: 1000 + minLength: 1 + type: string + repeatNotificationDuration: + description: | + The frequency for re-submitting alarm notifications, if the alarm keeps firing without + interruption. Format defined by ISO 8601. For example, `PT4H` indicates four hours. + As another example, `PT0M` indicates a repeat notification each time the alarm trigger condition is met, + otherwise known as an event-based notification. For more information, see + [Getting Event-Based Notifications for an Alarm](/iaas/Content/Monitoring/Tasks/update-alarm-event.htm). + Minimum: PT0M. Maximum: P30D. + type: string + resolution: + description: | + The time between calculated aggregation windows for the alarm. Supported value: `1m` + type: string + resourceGroup: + description: | + Resource group that you want to match. A null value returns only metric data that has no resource groups. The alarm retrieves metric data associated with the specified resource group only. Only one resource group can be applied per metric. + A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). + Avoid entering confidential information. + + Example: `frontend-fleet` + maxLength: 255 + minLength: 1 + type: string + ruleName: + description: | + Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. + Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](#/en/monitoring/latest/datatypes/AlarmOverride). + type: string + severity: + description: | + The perceived severity of the alarm with regard to the affected system. + type: string + x-obmcs-enumref: '#/definitions/Alarm/severity' + suppression: + $ref: '#/components/schemas/Suppression' + type: object + x-example: | + { + "destinations": + [ + "ocid1.onstopic.exampleuniqueID" + ] + } + ChangeAlarmCompartmentDetails: + description: | + The configuration details for moving an alarm. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the alarm to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + x-example: | + { + "compartmentId": "<compartment_OCID>" + } + RetrieveDimensionStatesDetails: + description: | + The configuration details for retrieving the alarm state entries. + Filter retrieved alarm state entries by status value and dimension key-value pairs. + properties: + dimensionFilters: + additionalProperties: + type: string + description: | + A filter to return only alarm state entries that match the exact set of specified dimension key-value pairs. + If you specify `"availabilityDomain": "phx-ad-1"` but the alarm state entry corresponds to the set `"availabilityDomain": "phx-ad-1"` + and `"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"`, then no results are returned. + type: object + status: + description: | + A filter to return only alarm state entries that match the status value. + type: string + x-obmcs-enumref: '#/definitions/AlarmDimensionStatesEntry/status' + type: object + x-example: | + { + "dimensions": + { + "availabilityDomain": "phx-ad-1", + "resourceId": "ocid1.instance.region1.phx.exampleuniqueID" + }, + "status" : FIRING + } + AlarmDimensionStatesCollection: + description: | + The list of current alarm state entries for each metric stream that matches the filters. + properties: + alarmId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the alarm to retrieve alarm state entries for. + type: string + isEnabled: + description: | + Whether the alarm is enabled. + + Example: `true` + type: boolean + isNotificationsPerMetricDimensionEnabled: + description: | + When set to `true`, splits alarm notifications per metric stream. + When set to `false`, groups alarm notifications across metric streams. + type: boolean + items: + description: | + Array of alarm state entries. + items: + $ref: '#/components/schemas/AlarmDimensionStatesEntry' + type: array + required: + - alarmId + - isEnabled + - isNotificationsPerMetricDimensionEnabled + - items + type: object + x-example: | + { + "alarmId": "ocid1.alarm.oc1..exampleuniqueID", + "isEnabled": true, + "isNotificationsPerMetricDimensionEnabled": true, + "items": + [ + { + "alarmSummary": "Customizable alarm summary with dynamic variables severity CRITICAL", + "dimensions": + { + "availabilityDomain": "phx-ad-1", + "resourceId": "ocid1.instance.region1.phx.exampleuniqueID" + }, + "status" : FIRING + "timestamp" : "2021-12-01T01:02:30.600Z" + + } + ] + } + SummarizeAlarmSuppressionHistoryDetails: + description: | + The configuration details for returning history of suppressions for the specified alarm. + properties: + dimensions: + additionalProperties: + type: string + description: | + A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. + If you specify {"availabilityDomain": "phx-ad-1"} + and the alarm state entry corresponds to the set {"availabilityDomain": "phx-ad-1" and "resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}, + then this alarm will be included for suppression. + + Example: `{"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}` + type: object + timeSuppressFromGreaterThanOrEqualTo: + description: | + A filter to return only entries with "timeSuppressFrom" time occurring on or after the specified time. + + The value cannot be a future time. + Format defined by RFC3339. + + Example: `2023-02-01T01:02:29.600Z` + format: date-time + type: string + timeSuppressFromLessThan: + description: | + A filter to return only entries with "timeSuppressFrom" time occurring before the specified time. + + The value cannot be a future time. + Format defined by RFC3339. + + Example: `2023-02-01T01:02:29.600Z` + format: date-time + type: string + type: object + AlarmSuppressionHistoryItemCollection: + description: | + Collection of property summaries for alarm suppression history items. + properties: + items: + description: | + List of alarm suppression history items. + items: + $ref: '#/components/schemas/AlarmSuppressionHistoryItem' + type: array + required: + - items + type: object + AlarmHistoryCollection: + description: | + The configuration details for retrieving alarm history. + properties: + alarmId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the alarm to retrieve history for. + type: string + entries: + description: | + The set of history entries retrieved for the alarm. + items: + $ref: '#/components/schemas/AlarmHistoryEntry' + type: array + isEnabled: + description: | + Whether the alarm is enabled. + + Example: `true` + type: boolean + required: + - alarmId + - isEnabled + - entries + type: object + x-example: | + { + "alarmId": "ocid1.alarm.oc1..exampleuniqueID", + "isEnabled": true, + "entries": + [ + { + "alarmSummary": "Customizable alarm summary with dynamic variables severity CRITICAL", + "summary": "Alarm transitioned from OK to FIRING.", + "timestamp": "2023-02-01T01:02:29.600Z" + }, + { + "alarmSummary": "Customizable alarm summary with dynamic variables severity CRITICAL", + "summary": "Alarm transitioned from FIRING to OK.", + "timestamp": "2023-02-01T01:02:30.600Z" + }, + { + "alarmSummary": "Customizable alarm summary with dynamic variables severity CRITICAL", + "summary": "Alarm transitioned from OK to FIRING.", + "timestamp": "2023-02-01T01:02:31.600Z" + } + ] + } + PostMetricDataDetails: + description: | + An array of metric objects containing raw metric data points to be posted to the Monitoring service. + properties: + batchAtomicity: + default: NON_ATOMIC + description: | + Batch atomicity behavior. Requires either partial or full pass of input validation for + metric objects in PostMetricData requests. The default value of NON_ATOMIC requires a + partial pass: at least one metric object in the request must pass input validation, and + any objects that failed validation are identified in the returned summary, along with + their error messages. A value of ATOMIC requires a full pass: all metric objects in + the request must pass input validation. + + Example: `NON_ATOMIC` + enum: + - ATOMIC + - NON_ATOMIC + type: string + metricData: + description: | + A metric object containing raw metric data points to be posted to the Monitoring service. + items: + $ref: '#/components/schemas/MetricDataDetails' + type: array + required: + - metricData + type: object + PostMetricDataResponseDetails: + description: | + The response object returned from a PostMetricData operation. + properties: + failedMetrics: + description: | + A list of records identifying metric objects that failed input validation + and the reasons for the failures. + items: + $ref: '#/components/schemas/FailedMetricRecord' + type: array + failedMetricsCount: + description: The number of metric objects that failed input validation. + format: int32 + type: integer + required: + - failedMetricsCount + type: object + ListMetricsDetails: + description: | + The request details for retrieving metric definitions. Specify optional properties to filter the returned results. + Use an asterisk (*) as a wildcard character, placed anywhere in the string. + For example, to search for all metrics with names that begin with "disk", specify "name" as "disk*". + If no properties are specified, then all metric definitions within the request scope are returned. + properties: + dimensionFilters: + additionalProperties: + maxLength: 255 + minLength: 1 + type: string + description: | + Qualifiers that you want to use when searching for metric definitions. + Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. + + Example: `{"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}` + minItems: 1 + type: object + groupBy: + description: | + Group metrics by these fields in the response. For example, to list all metric namespaces available + in a compartment, groupBy the "namespace" field. Supported fields: namespace, name, resourceGroup. + If `groupBy` is used, then `dimensionFilters` is ignored. + + Example - group by namespace: + `[ "namespace" ]` + items: + type: string + type: array + name: + description: | + The metric name to use when searching for metric definitions. + + Example: `CpuUtilization` + type: string + namespace: + description: | + The source service or application to use when searching for metric definitions. + + Example: `oci_computeagent` + type: string + resourceGroup: + description: | + Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. + A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). + + Example: `frontend-fleet` + maxLength: 255 + minLength: 1 + type: string + sortBy: + description: | + The field to use when sorting returned metric definitions. Only one sorting level is provided. + + Example: `NAMESPACE` + enum: + - NAMESPACE + - NAME + - RESOURCEGROUP + type: string + sortOrder: + description: | + The sort order to use when sorting returned metric definitions. Ascending (ASC) or + descending (DESC). + + Example: `ASC` + enum: + - ASC + - DESC + type: string + type: object + x-example: | + Sample 1: List all namespaces + + { + "groupBy":["namespace"] + } + + Sample 2: List all resource groups in a namespace + + { + "groupBy":["resourceGroup"], + "namespace":"my_namespace" + } + + Sample 3: List all metrics in a namespace for a specific resource group + + { + "groupBy":["name"], + "namespace": "my_namespace", + "resourceGroup": "my_resourcegroup" + } + Metric: + description: | + The properties that define a metric. + For information about metrics, see + [Metrics Overview](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#MetricsOverview). + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing + the resources monitored by the metric. + example: ocid1.compartment.oc1..exampleuniqueID + type: string + dimensions: + additionalProperties: + maxLength: 255 + minLength: 1 + type: string + description: | + Qualifiers provided in a metric definition. Available dimensions vary by metric namespace. + Each dimension takes the form of a key-value pair. + + Example: `{"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}` + type: object + name: + description: | + The name of the metric. + + Example: `CpuUtilization` + type: string + namespace: + description: | + The source service or application emitting the metric. + + Example: `oci_computeagent` + type: string + resourceGroup: + description: | + Resource group provided with the posted metric. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. + A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). + + Example: `frontend-fleet` + maxLength: 255 + minLength: 1 + type: string + type: object + x-example: | + { + "name": "DiskBytesRead", + "namespace": "oci_computeagent", + "compartmentId": "ocid1.tenancy.oc1..exampleuniqueID", + "dimensions": + { + "resourceId": "ocid1.instance.region1.phx.exampleuniqueID" + } + } + SummarizeMetricsDataDetails: + description: | + The request details for retrieving aggregated data. + Use the query and optional properties to filter the returned results. + properties: + endTime: + description: | + The end of the time range to use when searching for metric data points. + Format is defined by RFC3339. The response excludes metric data points for the endTime. + Default value: the timestamp representing when the call was sent. + + Example: `2023-02-01T02:02:29.600Z` + format: date-time + type: string + namespace: + description: | + The source service or application to use when searching for metric data points to aggregate. + + Example: `oci_computeagent` + type: string + query: + description: | + The Monitoring Query Language (MQL) expression to use when searching for metric data points to + aggregate. The query must specify a metric, statistic, and interval. + Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. + You can optionally specify dimensions and grouping functions. + When specifying a dimension value, surround it with double quotes, and escape each double quote with a backslash (`\`) character. + Supported grouping functions: `grouping()`, `groupBy()`. + + Construct your query to avoid exceeding limits on returned data. See [MetricData Reference](#/en/monitoring/20180401/MetricData). + + For details about Monitoring Query Language (MQL), see + [Monitoring Query Language (MQL) Reference](/iaas/Content/Monitoring/Reference/mql.htm). + For available dimensions, review the metric definition for the supported service. See + [Supported Services](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices). + + Example 1: `CpuUtilization[1m].sum()` + + Example 2 (escaped double quotes for value string): `CpuUtilization[1m]{resourceId = \"<instance_OCID>\"}.max()` + maxLength: 1000 + minLength: 1 + type: string + resolution: + description: | + The time between calculated aggregation windows. Use with the query interval to vary the + frequency for returning aggregated data points. For example, use a query interval of + 5 minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute + frequency. The resolution must be equal or less than the interval in the query. The default + resolution is 1m (one minute). Supported values: `1m`-`60m`, `1h`-`24h`, `1d`. + + Example: `5m` + type: string + resourceGroup: + description: | + Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. + A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). + + Example: `frontend-fleet` + maxLength: 255 + minLength: 1 + type: string + startTime: + description: | + The beginning of the time range to use when searching for metric data points. + Format is defined by RFC3339. The response includes metric data points for the startTime. + Default value: the timestamp 3 hours before the call was sent. + + Example: `2023-02-01T01:02:29.600Z` + format: date-time + type: string + required: + - namespace + - query + type: object + x-example: | + { + "namespace": "oci_computeagent", + "query": "DiskBytesRead[1m]{resourceId = \"ocid1.instance.region1.phx.exampleuniqueID\"}.max()", + "startTime": "2023-03-10T22:44:26.789Z", + "endTime": "2023-03-10T22:59:26.789Z" + } + MetricData: + description: | + The set of aggregated data returned for a metric. + For information about metrics, see + [Metrics Overview](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#MetricsOverview). + + Limits information for returned data follows. + + * Data points: 100,000. + * Metric streams* within data points: 2,000. + * Time range returned for 1-day resolution: 90 days. + * Time range returned for 1-hour resolution: 90 days. + * Time range returned for 5-minute resolution: 30 days. + * Time range returned for 1-minute resolution: 7 days. + + *A metric stream is an individual set of aggregated data for a metric with zero or more dimension values. + Metric streams cannot be aggregated across metric groups. + A metric group is the combination of a given metric, metric namespace, and tenancy for the purpose of determining limits. + For more information about metric-related concepts, see + [Monitoring Concepts](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#concepts). + properties: + aggregatedDatapoints: + description: | + The list of timestamp-value pairs returned for the specified request. Metric values are rolled up to the start time specified in the request. + For important limits information related to data points, see MetricData Reference at the top of this page. + items: + $ref: '#/components/schemas/AggregatedDatapoint' + minItems: 1 + type: array + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the + resources that the aggregated data was returned from. + example: ocid1.compartment.oc1..exampleuniqueID + maxLength: 255 + minLength: 1 + type: string + dimensions: + additionalProperties: + maxLength: 255 + minLength: 1 + type: string + description: | + Qualifiers provided in the definition of the returned metric. + Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. + + Example: `{"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}` + type: object + metadata: + additionalProperties: + maxLength: 255 + minLength: 1 + type: string + description: | + The references provided in a metric definition to indicate extra information about the metric. + + Example: `"unit": "bytes"` + type: object + name: + description: | + The name of the metric. + + Example: `CpuUtilization` + maxLength: 255 + minLength: 1 + type: string + namespace: + description: | + The reference provided in a metric definition to indicate the source service or + application that emitted the metric. + + Example: `oci_computeagent` + maxLength: 255 + minLength: 1 + type: string + resolution: + description: | + The time between calculated aggregation windows. Use with the query interval to vary the + frequency for returning aggregated data points. For example, use a query interval of + 5 minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute + frequency. The resolution must be equal or less than the interval in the query. The default + resolution is 1m (one minute). Supported values: `1m`-`60m`, `1h`-`24h`, `1d`. + + Example: `5m` + type: string + resourceGroup: + description: | + Resource group provided with the posted metric. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. + A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). + + Example: `frontend-fleet` + maxLength: 255 + minLength: 1 + type: string + required: + - namespace + - compartmentId + - name + - dimensions + - aggregatedDatapoints + type: object + x-example: | + [ + { + "namespace": "oci_computeagent", + "compartmentId": "ocid1.tenancy.oc1..exampleuniqueID", + "name": "DiskBytesRead", + "dimensions": + { + "resourceId": "ocid1.instance.region1.phx.exampleuniqueID" + }, + "metadata": + { + "unit": "bytes" + } + }, + "aggregatedDatapoints": + [ + { + "timestamp": "2023-03-10T22:19:00Z", + "value": 10.4 + }, + { + "timestamp": "2023-03-10T22:20:00Z", + "value": 11.3 + }, + { + "timestamp": "2023-03-10T22:21:00Z", + "value": 11.2 + }, + { + "timestamp": "2023-03-10T22:22:00Z", + "value": 10.9 + }, + { + "timestamp": "2023-03-10T22:23:00Z", + "value": 10.2 + }, + { + "timestamp": "2023-03-10T22:24:00Z", + "value": 10.5 + }, + { + "timestamp": "2023-03-10T22:25:00Z", + "value": 11.3 + }, + { + "timestamp": "2023-03-10T22:26:00Z", + "value": 9.6 + }, + { + "timestamp": "2023-03-10T22:27:00Z", + "value": 10.7 + }, + { + "timestamp": "2023-03-10T22:28:00Z", + "value": 11.3 + } + ] + ] + AlarmSuppressionSummary: + description: | + A summary of properties for the specified alarm suppression. + properties: + alarmSuppressionTarget: + $ref: '#/components/schemas/AlarmSuppressionTarget' + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm suppression. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only String types are currently supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing predefined tags' keys and values scoped to a namespace + Example: `{"CostCenter": "42"}` + type: object + description: | + Defined tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{"foo-namespace": {"bar-key": "value"}}` + type: object + description: + description: | + Human-readable reason for this alarm suppression. + It does not have to be unique, and it's changeable. + Avoid entering confidential information. + + Oracle recommends including tracking information for the event or associated work, + such as a ticket number. + + Example: `Planned outage due to change IT-1234.` + type: string + dimensions: + additionalProperties: + type: string + description: | + Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs. + + Example: `{"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}` + type: object + displayName: + description: A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information. + type: string + freeformTags: + additionalProperties: + type: string + description: | + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + Example: `{"bar-key": "value"}` + type: object + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the alarm suppression. + type: string + level: + description: | + The level of this alarm suppression. + `ALARM` indicates a suppression of the entire alarm, regardless of dimension. + `DIMENSION` indicates a suppression configured for specified dimensions. + + Defaut: `DIMENSION` + type: string + x-obmcs-enumref: '#/definitions/AlarmSuppression/level' + lifecycleState: + description: | + The current lifecycle state of the alarm suppression. + type: string + x-obmcs-enumref: '#/definitions/AlarmSuppression/lifecycleState' + suppressionConditions: + description: | + Array of all preconditions for alarm suppression. + Example: `[{ + conditionType: "RECURRENCE", + suppressionRecurrence: "FRQ=DAILY;BYHOUR=10", + suppressionDuration: "PT1H" + }]` + items: + $ref: '#/components/schemas/SuppressionCondition' + maxItems: 1 + minItems: 1 + type: array + timeCreated: + description: | + The date and time the alarm suppression was created. Format defined by RFC3339. + + Example: `2023-02-01T01:02:29.600Z` + format: date-time + type: string + timeSuppressFrom: + description: | + The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. + + Example: `2023-02-01T01:02:29.600Z` + format: date-time + type: string + timeSuppressUntil: + description: | + The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. + + Example: `2023-02-01T02:02:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. + + Example: `2023-02-03T01:02:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - alarmSuppressionTarget + - level + - displayName + - timeSuppressFrom + - timeSuppressUntil + - lifecycleState + - timeCreated + - timeUpdated + type: object + Error: + description: An error has occurred. + properties: + code: + description: | + A short error code that defines the error, meant for programmatic parsing. See + [API Errors](/iaas/Content/API/References/apierrors.htm). + type: string + message: + description: A human-readable error string. + type: string + required: + - code + - message + type: object + AlarmSuppressionTarget: + description: The target of the alarm suppression. + discriminator: + propertyName: targetType + properties: + targetType: + description: The type of the alarm suppression target. + enum: + - ALARM + - COMPARTMENT + type: string + required: + - targetType + type: object + SuppressionCondition: + description: | + Precondition for an alarm suppression within the suppression date and time range (`timeSuppressFrom` to `timeSuppressUntil`). + discriminator: + propertyName: conditionType + properties: + conditionType: + description: Type of suppression condition. + enum: + - RECURRENCE + type: string + required: + - conditionType + x-example: | + { + "conditionType": "RECURRENCE", + "suppressionRecurrence":"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;BYMINUTE=00;BYSECOND=00", + "suppressionDuration":"PT1H" + } + type: object + AlarmOverride: + description: | + Values to use for an independent evaluation of the alarm. + You can specify values for query, severity, body, and pending duration. + When an alarm contains overrides, the Monitoring service evaluates each override in order, + beginning with the first override in the array (index position `0`), + and then evaluates the alarm's base values (`ruleName` value of `BASE`) + properties: + body: + description: | + The human-readable content of the delivered alarm notification. + Optionally include [dynamic variables](/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). + Oracle recommends providing guidance + to operators for resolving the alarm condition. Consider adding links to standard runbook + practices. Avoid entering confidential information. + + Example: `High CPU usage alert. Follow runbook instructions for resolution.` + maxLength: 1000 + minLength: 1 + type: string + pendingDuration: + description: | + The period of time that the condition defined in the alarm must persist before the alarm state + changes from "OK" to "FIRING". For example, a value of 5 minutes means that the + alarm must persist in breaching the condition for five minutes before the alarm updates its + state to "FIRING". + + The duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` + for one hour). Minimum: PT1M. Maximum: PT24H. Default: PT1M. + + Under the default value of PT1M, the first evaluation that breaches the alarm updates the + state to "FIRING". + + The alarm updates its status to "OK" when the breaching condition has been clear for + the most recent minute. + + Example: `PT5M` + type: string + query: + description: | + The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of + the Monitoring service interprets results for each returned time series as Boolean values, + where zero represents false and a non-zero value represents true. A true value means that the trigger + rule condition has been met. The query must specify a metric, statistic, interval, and trigger + rule (threshold or absence). Supported values for interval depend on the specified time range. More + interval values are supported for smaller time ranges. You can optionally + specify dimensions and grouping functions. + Also, you can customize the + [absence detection period](/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). + Supported grouping functions: `grouping()`, `groupBy()`. + For information about writing MQL expressions, see + [Editing the MQL Expression for a Query](/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). + For details about MQL, see + [Monitoring Query Language (MQL) Reference](/iaas/Content/Monitoring/Reference/mql.htm). + For available dimensions, review the metric definition for the supported service. See + [Supported Services](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices). + + Example of threshold alarm: + + ----- + + CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85 + + ----- + + Example of absence alarm: + + ----- + + CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent() + + ----- + Example of absence alarm with custom absence detection period of 20 hours: + + ----- + + CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) + + ----- + maxLength: 1000 + minLength: 1 + type: string + ruleName: + description: | + A user-friendly description for this alarm override. Must be unique across all `ruleName` values for the alarm. + type: string + severity: + description: | + The perceived severity of the alarm with regard to the affected system. + type: string + x-obmcs-enumref: '#/definitions/Alarm/severity' + type: object + x-example: | + { + "body": "95% CPU utilization", + "pendingDuration": "PT5M", + "query": "CPUUtilization[1m].mean()>95", + "ruleName": "95", + "severity": "CRITICAL" + } + Suppression: + description: | + The configuration details for an alarm-wide suppression. + For dimension-specific suppressions, see [AlarmSuppression](#/en/monitoring/latest/AlarmSuppression). + + For information about alarms, see + [Alarms Overview](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#AlarmsOverview). + properties: + description: + description: | + Human-readable reason for suppressing alarm notifications. + It does not have to be unique, and it's changeable. + Avoid entering confidential information. + + Oracle recommends including tracking information for the event or associated work, + such as a ticket number. + + Example: `Planned outage due to change IT-1234.` + maxLength: 255 + minLength: 1 + type: string + timeSuppressFrom: + description: | + The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. + + Example: `2023-02-01T01:02:29.600Z` + format: date-time + type: string + timeSuppressUntil: + description: | + The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. + + Example: `2023-02-01T02:02:29.600Z` + format: date-time + type: string + required: + - timeSuppressFrom + - timeSuppressUntil + type: object + x-example: | + { + "description": "Planned outage due to change IT-1234.", + "timeSuppressFrom": "2023-02-01T01:02:29.600Z", + "timeSuppressUntil": "2023-02-01T02:02:29.600Z" + } + AlarmDimensionStatesEntry: + description: | + A timestamped alarm state entry for a metric stream. + properties: + alarmSummary: + description: | + Customizable alarm summary (`alarmSummary` [alarm message parameter](/iaas/Content/Monitoring/alarm-message-format.htm)). + Optionally include [dynamic variables](/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). + The alarm summary appears within the body of the alarm message and in responses to + [ListAlarmStatus](#/en/monitoring/latest/AlarmStatusSummary/ListAlarmsStatus) + [GetAlarmHistory](#/en/monitoring/latest/AlarmHistoryCollection/GetAlarmHistory) and + [RetrieveDimensionStates](#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates). + type: string + dimensions: + additionalProperties: + maxLength: 255 + minLength: 1 + type: string + description: | + Indicator of the metric stream associated with the alarm state entry. Includes one or more dimension key-value pairs. + type: object + ruleName: + description: | + Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. + Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](#/en/monitoring/latest/datatypes/AlarmOverride). + type: string + status: + description: | + Transition state (status value) associated with the alarm state entry. + + Example: `FIRING` + enum: + - FIRING + - OK + type: string + timestamp: + description: | + Transition time associated with the alarm state entry. Format defined by RFC3339. + + Example: `2022-02-01T01:02:29.600Z` + format: date-time + type: string + required: + - alarmSummary + - dimensions + - status + - ruleName + - timestamp + type: object + x-example: | + { + "alarmSummary": "Customizable alarm summary with dynamic variables severity CRITICAL", + "dimensions": "{ + "availabilityDomain": "phx-ad-1", + "resourceId": "ocid1.instance.region1.phx.exampleuniqueID" + }" + "status": "Firing", + "ruleName": "BASE", + "timestamp": "2021-12-01T01:02:29.600Z" + } + AlarmSuppressionHistoryItem: + description: | + A summary of properties for the specified alarm suppression history item. + properties: + alarmSuppressionTarget: + $ref: '#/components/schemas/AlarmSuppressionTarget' + description: + description: | + Human-readable reason for this alarm suppression. + It does not have to be unique, and it's changeable. + Avoid entering confidential information. + + Oracle recommends including tracking information for the event or associated work, + such as a ticket number. + + Example: `Planned outage due to change IT-1234.` + type: string + dimensions: + additionalProperties: + type: string + description: | + Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs. + + Example: `{"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}` + type: object + displayName: + description: A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information. + type: string + level: + description: | + The level of this alarm suppression. + `ALARM` indicates a suppression of the entire alarm, regardless of dimension. + `DIMENSION` indicates a suppression configured for specified dimensions. + enum: + - ALARM + - DIMENSION + type: string + suppressionConditions: + description: | + Array of all preconditions for alarm suppression. + Example: `[{ + conditionType: "RECURRENCE", + suppressionRecurrence: "FRQ=DAILY;BYHOUR=10", + suppressionDuration: "PT1H" + }]` + items: + $ref: '#/components/schemas/SuppressionCondition' + maxItems: 1 + minItems: 1 + type: array + suppressionId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the alarm suppression. + type: string + timeEffectiveFrom: + description: | + The start date and time for the suppression actually starts, inclusive. Format defined by RFC3339. + + Example: `2023-02-01T01:02:29.600Z` + format: date-time + type: string + timeEffectiveUntil: + description: | + The end date and time for the suppression actually ends, inclusive. Format defined by RFC3339. + + Example: `2023-02-01T02:02:29.600Z` + format: date-time + type: string + required: + - suppressionId + - alarmSuppressionTarget + - level + - displayName + - timeEffectiveFrom + - timeEffectiveUntil + type: object + AlarmHistoryEntry: + description: | + An alarm history entry indicating a description of the entry and the time that the entry occurred. + If the entry corresponds to a state transition, such as OK to Firing, then the entry also includes a transition timestamp. + properties: + alarmSummary: + description: | + Customizable alarm summary (`alarmSummary` [alarm message parameter](/iaas/Content/Monitoring/alarm-message-format.htm)). + Optionally include [dynamic variables](/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). + The alarm summary appears within the body of the alarm message and in responses to + [ListAlarmStatus](#/en/monitoring/latest/AlarmStatusSummary/ListAlarmsStatus) + [GetAlarmHistory](#/en/monitoring/latest/AlarmHistoryCollection/GetAlarmHistory) and + [RetrieveDimensionStates](#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates). + type: string + summary: + description: | + Description for this alarm history entry. + + Example 1 - alarm state history entry: `The alarm state is FIRING` + + Example 2 - alarm state transition history entry: `State transitioned from OK to Firing` + type: string + timestamp: + description: | + Timestamp for this alarm history entry. Format defined by RFC3339. + + Example: `2023-02-01T01:02:29.600Z` + format: date-time + type: string + timestampTriggered: + description: | + Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. + Available for state transition entries only. Note: A three-minute lag for this value accounts for any late-arriving metrics. + + Example: `2023-02-01T0:59:00.789Z` + format: date-time + type: string + required: + - alarmSummary + - summary + - timestamp + type: object + x-example: | + { + "alarmSummary": "Alarm is in a FIRING state; because 1 metric meets the trigger rule: Example[1m].mean() > 1", + "summary": "State transitioned from OK to Firing.", + "timestamp": "2023-02-01T01:02:29.600Z", + "timestampTriggered": "2023-02-01T00:59:00.789Z" + } + MetricDataDetails: + description: | + A metric object containing raw metric data points to be posted to the Monitoring service. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to use for metrics. + example: ocid1.compartment.oc1..exampleuniqueID + maxLength: 255 + minLength: 1 + type: string + datapoints: + description: | + A list of metric values with timestamps. At least one data point is required per call. + For a data point to be posted, its timestamp must be near current time (less than two hours in the past and less than 10 minutes in the future). + items: + $ref: '#/components/schemas/Datapoint' + minItems: 1 + type: array + dimensions: + additionalProperties: + maxLength: 255 + minLength: 1 + type: string + description: | + Qualifiers provided in a metric definition. Available dimensions vary by metric namespace. + Each dimension takes the form of a key-value pair. + A valid dimension key includes only printable ASCII, excluding spaces. The character limit for a dimension key is 256. + A valid dimension value includes only Unicode characters. The character limit for a dimension value is 512. + Empty strings are not allowed for keys or values. Avoid entering confidential information. + + Example: `{"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}` + type: object + metadata: + additionalProperties: + maxLength: 255 + minLength: 1 + type: string + description: | + Properties describing metrics. These are not part of the unique fields identifying the metric. + Each metadata item takes the form of a key-value pair. The character limit for a metadata key is 256. The character limit for a metadata value is 256. + + Example: `"unit": "bytes"` + type: object + name: + description: | + The name of the metric. + + A valid name value starts with an alphabetical character and includes only alphanumeric characters, dots, underscores, hyphens, and dollar signs. + Avoid entering confidential information. + + Example: `my_app.success_rate` + maxLength: 255 + minLength: 1 + type: string + namespace: + description: | + The source service or application emitting the metric. + + A valid namespace value starts with an alphabetical character and includes only alphanumeric characters and underscores. Custom metrics can't use the following reserved prefixes: `oci_` and `oracle_` + Avoid entering confidential information. + + Example: `my_namespace` + maxLength: 255 + minLength: 1 + type: string + resourceGroup: + description: | + Resource group to assign to the metric. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. + A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). + Avoid entering confidential information. + + Example: `frontend-fleet` + maxLength: 255 + minLength: 1 + type: string + required: + - namespace + - compartmentId + - name + - datapoints + - dimensions + type: object + x-example: | + [ + { + "namespace": "my_namespace", + "name": "my_app.success_rate", + "compartmentId": "ocid1.compartment.oc1..exampleuniqueID", + "resourceGroup":"my_ResourceGroup", + "dimensions": + { + "resourceId": "ocid1.instance.region1.phx.exampleuniqueID", + "availabilityDomain": "cumS:PHX-AD-1" + }, + "metadata": { "unit": "percent" }, + "datapoints": + [ + { + "timestamp": "2023-03-10T22:19:20Z", + "value": 83 + }, + { + "timestamp": "2023-03-10T22:19:40Z", + "value": 90 + }, + { + "timestamp": "2023-03-10T22:20:00Z", + "value": 85 + }, + { + "timestamp": "2023-03-10T22:21:20Z", + "value": 87 + }, + { + "timestamp": "2023-03-10T22:21:40Z", + "value": 81 + }, + { + "timestamp": "2023-03-10T22:22:00Z", + "value": 92 + } + ] + } + ] + FailedMetricRecord: + description: | + The record of a single metric object that failed input validation and the reason for the failure. + properties: + message: + description: | + An error message indicating the reason that the indicated metric object failed input validation. + type: string + metricData: + $ref: '#/components/schemas/MetricDataDetails' + required: + - message + - metricData + type: object + AggregatedDatapoint: + description: | + A timestamp-value pair returned for the specified request. + properties: + timestamp: + description: | + The date and time associated with the value of this data point. Format defined by RFC3339. + + Example: `2023-02-01T01:02:29.600Z` + format: date-time + type: string + value: + description: | + Numeric value of the metric. + + Example: `10.4` + format: double + type: number + required: + - timestamp + - value + type: object + x-example: | + { + "timestamp": "2023-03-10T22:20:00Z", + "value": 10.4 + } + Datapoint: + description: | + Metric value for a specific timestamp. + properties: + count: + description: | + The number of occurrences of the associated value in the set of data. + + Default is 1. Value must be greater than zero. + format: int32 + type: integer + timestamp: + description: | + Timestamp for this metric value. Format defined by RFC3339. + For a data point to be posted, its timestamp must be near current time (less than two hours in the past and less than 10 minutes in the future). + + Example: `2023-02-01T01:02:29.600Z` + format: date-time + type: string + value: + description: | + Numeric value of the metric. + + Example: `10.23` + format: double + type: number + required: + - timestamp + - value + type: object + x-example: | + { + "timestamp": "2023-03-10T22:20:00Z", + "value": 10.4, + "count": 2 + } + ListAlarmsResponse: + type: object + properties: + alarms: + type: array + items: + $ref: '#/components/schemas/AlarmSummary' + ListAlarmsStatusResponse: + type: object + properties: + alarms_status: + type: array + items: + $ref: '#/components/schemas/AlarmStatusSummary' + ListMetricsResponse: + type: object + properties: + metrics: + type: array + items: + $ref: '#/components/schemas/Metric' + SummarizeMetricsDataResponse: + type: object + properties: + summarize_metrics_data: + type: array + items: + $ref: '#/components/schemas/MetricData' + responses: + '400': + description: Bad Request + 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' + '401': + description: Unauthorized + 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' + '404': + description: Not Authorized Or Not Found + 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' + '409': + description: Conflict + 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' + '412': + description: Precondition Failed + 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' + '429': + description: Client is getting throttled, please retry with backoff. + 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' + '500': + description: Internal Server 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' + DefaultError: + description: An error has occurred. + 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' + parameters: + RequestIdHeader: + description: | + Customer part of the request identifier token. If you need to contact Oracle about a particular + request, please provide the complete request ID. + in: header + name: opc-request-id + schema: + type: string + AlarmIdQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the alarm that is the target of the alarm suppression. + in: query + name: alarmId + required: false + schema: + type: string + FilterByAlarmSuppressionDisplayNameQueryParam: + description: | + A filter to return only resources that match the given display name exactly. + Use this filter to list an alarm suppression by name. + Alternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation. + in: query + name: displayName + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + FilterByAlarmSuppressionLifecycleStateQueryParam: + description: | + A filter to return only resources that match the given lifecycle state exactly. When not specified, only resources in the ACTIVE lifecycle state are listed. + in: query + name: lifecycleState + required: false + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/AlarmSuppression/lifecycleState' + schema: + type: string + AlarmSuppressionLevelQueryParam: + description: | + The level of this alarm suppression. + `ALARM` indicates a suppression of the entire alarm, regardless of dimension. + `DIMENSION` indicates a suppression configured for specified dimensions. + in: query + name: level + required: false + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/AlarmSuppression/level' + schema: + type: string + AlarmSuppressionCompartmentIdQueryParam: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment for searching. + Use the tenancy OCID to search in the root compartment. + + If targetType is not specified, searches all suppressions defined under the compartment. + If targetType is `COMPARTMENT`, searches suppressions in the specified compartment only. + + Example: `ocid1.compartment.oc1..exampleuniqueID` + in: query + name: compartmentId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + CompartmentIdInSubtreeQueryParam: + description: | + When true, returns resources from all compartments and subcompartments. The parameter can + only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). + A true value requires the user to have tenancy-level permissions. If this requirement is not met, + then the call is rejected. When false, returns resources from only the compartment specified in + compartmentId. Default is false. + in: query + name: compartmentIdInSubtree + required: false + x-default-description: 'null' + schema: + type: boolean + AlarmSuppressionTargetTypeQueryParam: + description: | + The target type to use when listing alarm suppressions. + `ALARM` lists all suppression records for the specified alarm. + `COMPARTMENT` lists all suppression records for the specified compartment or tenancy. + in: query + name: targetType + required: false + x-default-description: 'null' + schema: + type: string + enum: + - ALARM + - COMPARTMENT + IsAllSuppressionsQueryParam: + description: | + Setting this parameter to true requires the query to specify the alarm (`alarmId`). + + When true, lists all alarm suppressions that affect the specified alarm, + including suppressions that target the corresponding compartment or tenancy. + When false, lists only the alarm suppressions that target the specified alarm. + + Default is false. + in: query + name: isAllSuppressions + required: false + x-default-description: 'null' + schema: + type: boolean + AlarmSuppressionSortByQueryParam: + description: | + The field to use when sorting returned alarm suppressions. Only one sorting level is provided. + + Example: `timeCreated` + in: query + name: sortBy + required: false + x-default-description: 'null' + schema: + type: string + enum: + - displayName + - timeCreated + - timeSuppressFrom + AlarmSuppressionSortOrderQueryParam: + description: | + The sort order to use when sorting returned alarm suppressions. Ascending (ASC) or descending (DESC). + + Example: `ASC` + in: query + name: sortOrder + required: false + x-default-description: 'null' + schema: + type: string + enum: + - ASC + - DESC + PaginationTokenQueryParam: + description: | + For list pagination. The value of the `opc-next-page` response header from the previous "List" call. + For important details about how pagination works, see + [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + in: query + name: page + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 512 + PaginationLimitQueryParam: + description: | + For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. + For important details about how pagination works, see + [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + + Default: 1000 + + Example: 500 + in: query + name: limit + x-default-description: 'null' + schema: + type: integer + minimum: 1 + maximum: 1000 + RetryTokenHeaderParam: + description: | + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + in: header + name: opc-retry-token + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 64 + 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 + schema: + type: string + AlarmSuppressionIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the alarm suppression. + in: path + name: alarmSuppressionId + required: true + schema: + type: string + CompartmentIdQueryParam: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the + resources monitored by the metric that you are searching for. Use tenancyId to search in + the root compartment. + + Example: `ocid1.compartment.oc1..exampleuniqueID` + in: query + name: compartmentId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + FilterByDisplayNameQueryParam: + description: | + A filter to return only resources that match the given display name exactly. + Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation. + in: query + name: displayName + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + FilterByLifecycleStateQueryParam: + description: | + A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed. + in: query + name: lifecycleState + required: false + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/Alarm/lifecycleState' + schema: + type: string + SortByQueryParam: + description: | + The field to use when sorting returned alarm definitions. Only one sorting level is provided. + + Example: `severity` + in: query + name: sortBy + required: false + x-default-description: 'null' + schema: + type: string + enum: + - displayName + - severity + SortOrderQueryParam: + description: | + The sort order to use when sorting returned alarm definitions. Ascending (ASC) or descending (DESC). + + Example: `ASC` + in: query + name: sortOrder + required: false + x-default-description: 'null' + schema: + type: string + enum: + - ASC + - DESC + ResourceIdQueryParam: + description: | + A filter to return only the resource with the specified [OCID](/iaas/Content/General/Concepts/identifiers.htm). + The resource must be monitored by the metric that you are searching for. + + Example: `ocid1.instance.oc1.phx.exampleuniqueID` + in: query + name: resourceId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + ServiceNameQueryParam: + description: | + A filter to return only resources that match the given service name exactly. + Use this filter to list all alarms containing metric streams that match the *exact* service-name dimension. + + Example: `logging-analytics` + in: query + name: serviceName + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + EntityIdQueryParam: + description: | + A filter to return only resources that match the given entity [OCID](/iaas/Content/General/Concepts/identifiers.htm) exactly. + The resource (entity) must be monitored by the metric that you are searching for. + + Example: `ocid1.instance.oc1.phx.exampleuniqueID` + in: query + name: entityId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + StatusQueryParam: + description: | + A filter to return only metric streams that match the specified status. + For example, the value "FIRING" returns only firing metric streams. + + Example: `FIRING` + in: query + name: status + required: false + x-default-description: 'null' + schema: + type: string + enum: + - FIRING + - OK + AlarmIdPathParam: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an alarm. + in: path + name: alarmId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + AlarmHistoryTypeParam: + description: | + The type of history entries to retrieve. + State history (STATE_HISTORY), state transition history (STATE_TRANSITION_HISTORY), rule history (RULE_HISTORY) or rule transition history (RULE_TRANSITION_HISTORY). + If not specified, entries of all types are retrieved. + + Example: `STATE_HISTORY` + in: query + name: alarmHistorytype + required: false + x-default-description: 'null' + schema: + type: string + enum: + - STATE_HISTORY + - STATE_TRANSITION_HISTORY + - RULE_HISTORY + - RULE_TRANSITION_HISTORY + FilterByAlarmHistoryTimeStampFromParam: + description: | + A filter to return only alarm history entries with timestamps occurring on or after the specified date and time. Format defined by RFC3339. + + Example: `2023-01-01T01:00:00.789Z` + in: query + name: timestampGreaterThanOrEqualTo + required: false + x-default-description: 'null' + schema: + type: string + format: date-time + FilterByAlarmHistoryTimeStampUntilParam: + description: | + A filter to return only alarm history entries with timestamps occurring before the specified date and time. Format defined by RFC3339. + + Example: `2023-01-02T01:00:00.789Z` + in: query + name: timestampLessThan + required: false + x-default-description: 'null' + schema: + type: string + format: date-time + EncodingHeader: + description: | + The optional Content-Encoding header that defines the content encodings that were applied to the payload. + in: header + name: content-encoding + schema: + type: string + x-stackQL-resources: + alarm_suppressions: + id: oci.monitoring.alarm_suppressions + name: alarm_suppressions + title: Alarm Suppressions + methods: + list: + operation: + $ref: '#/paths/~1alarmSuppressions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1alarmSuppressions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1alarmSuppressions~1{alarmSuppressionId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1alarmSuppressions~1{alarmSuppressionId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/alarm_suppressions/methods/get' + - $ref: '#/components/x-stackQL-resources/alarm_suppressions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/alarm_suppressions/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/alarm_suppressions/methods/delete' + replace: [] + alarms: + id: oci.monitoring.alarms + name: alarms + title: Alarms + methods: + list: + operation: + $ref: '#/paths/~1alarms/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.alarms + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAlarmsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"alarms\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1alarms/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1alarms~1{alarmId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1alarms~1{alarmId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1alarms~1{alarmId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1alarms~1{alarmId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + remove_alarm_suppression: + operation: + $ref: '#/paths/~1alarms~1{alarmId}~1actions~1removeSuppression/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + retrieve_dimension_states: + config: + requestBodyTranslate: + algorithm: naive + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + operation: + $ref: '#/paths/~1alarms~1{alarmId}~1actions~1retrieveDimensionStates/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + summarize_alarm_suppression_history: + config: + requestBodyTranslate: + algorithm: naive + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + operation: + $ref: '#/paths/~1alarms~1{alarmId}~1actions~1summarizeAlarmSuppressionHistory/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/alarms/methods/get' + - $ref: '#/components/x-stackQL-resources/alarms/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/alarms/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/alarms/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/alarms/methods/delete' + replace: [] + alarms_status: + id: oci.monitoring.alarms_status + name: alarms_status + title: Alarms Status + methods: + list: + operation: + $ref: '#/paths/~1alarms~1status/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.alarms_status + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAlarmsStatusResponse' + transform: + body: |- + {{- $wrapped := printf "{\"alarms_status\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/alarms_status/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + alarm_histories: + id: oci.monitoring.alarm_histories + name: alarm_histories + title: Alarm Histories + methods: + get: + operation: + $ref: '#/paths/~1alarms~1{alarmId}~1history/get' + response: + mediaType: application/json + openAPIDocKey: '200' + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/alarm_histories/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + metrics: + id: oci.monitoring.metrics + name: metrics + title: Metrics + methods: + list_metrics: + config: + requestBodyTranslate: + algorithm: naive + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + operation: + $ref: '#/paths/~1metrics~1actions~1listMetrics/post' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.metrics + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListMetricsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"metrics\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + summarize_metrics_data: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1metrics~1actions~1summarizeMetricsData/post' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.summarize_metrics_data + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/SummarizeMetricsDataResponse' + transform: + body: |- + {{- $wrapped := printf "{\"summarize_metrics_data\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://telemetry.{region}.oraclecloud.com/20180401 + variables: + region: + default: us-ashburn-1 + description: OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. + x-stackQL-envVar: OCI_REGION +x-stackQL-config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: opc-next-page + location: header diff --git a/providers/src/oci/v00.00.00000/services/network.yaml b/providers/src/oci/v00.00.00000/services/network.yaml new file mode 100644 index 00000000..9a207c31 --- /dev/null +++ b/providers/src/oci/v00.00.00000/services/network.yaml @@ -0,0 +1,32894 @@ +openapi: 3.0.0 +info: + title: network API + description: oci network API + version: '20160918' +paths: + /allowedPeerRegionsForRemotePeering: + get: + description: | + Lists the regions that support remote VCN peering (which is peering across regions). + For more information, see [VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm). + operationId: ListAllowedPeerRegionsForRemotePeering + responses: + '200': + description: The list is retrieved. + 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/ListAllowedPeerRegionsForRemotePeeringResponse' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListAllowedPeerRegionsForRemotePeering + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /byoasns: + get: + description: | + Lists the `Byoasn` resources in the specified compartment. + You can filter the list using query parameters. + operationId: ListByoasns + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/FilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/ByoasnSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ByoasnCollection' + '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/DefaultError' + summary: ListByoasns + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/Byoasn' + post: + description: | + Creates a BYOASN Resource + operationId: CreateByoasn + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateByoasnDetails' + description: Details needed to create a BYOASN Resource. + required: true + responses: + '200': + description: The BYOASN resource was created. + 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/Byoasn' + '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/DefaultError' + summary: CreateByoasn + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /byoasns/{byoasnId}: + delete: + description: | + Deletes the specified `Byoasn` resource. + The resource must be in one of the following states: CREATING, ACTIVE or FAILED. + It must not be in use by any of the byoipRanges or deletion will fail. + You must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm). + operationId: DeleteByoasn + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/ByoasnIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The `Byoasn` resource is 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 + '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/DefaultError' + summary: DeleteByoasn + tags: + - virtualNetwork + x-related-resource: '#/definitions/Byoasn' + get: + description: | + Gets the `Byoasn` resource. You must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm). + operationId: GetByoasn + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/ByoasnIdPathParam' + responses: + '200': + description: The `Byoasn` resource was retrieved. + 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/Byoasn' + '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/DefaultError' + summary: GetByoasn + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + put: + description: | + Updates the tags or display name associated with the specified BYOASN Resource. + operationId: UpdateByoasn + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/ByoasnIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateByoasnDetails' + description: Byoasn Range details. + required: true + responses: + '200': + description: The associated tags or display name for the BYOASN resource were updated. + 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/Byoasn' + '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/DefaultError' + summary: UpdateByoasn + tags: + - virtualNetwork + /byoasns/{byoasnId}/actions/changeCompartment: + post: + description: | + Moves a BYOASN Resource to a different compartment. For information + about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeByoasnCompartment + parameters: + - $ref: '#/components/parameters/ByoasnIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeByoasnCompartmentDetails' + description: Request to change the compartment of a BYOIP CIDR block. + required: true + responses: + '204': + description: The asn resource was moved to the specified 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 + '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/DefaultError' + summary: ChangeByoasnCompartment + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/Byoasn' + /byoasns/{byoasnId}/actions/validate: + post: + description: | + Submits the BYOASN for validation. Please do not submit to Oracle for validation if the information for the BYOASN is not already modified in the Regional Internet Registry. + See [To import a BYOASN](/iaas/Content/Network/Concepts/BYOASN.htm) for details. + operationId: ValidateByoasn + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/ByoasnIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '202': + description: The Byoasn submitted for validation. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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/DefaultError' + summary: ValidateByoasn + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-obmcs-terraform: + actionType: UPDATE_FIELD + x-related-resource: '#/definitions/Byoasn' + /byoipRanges: + get: + description: | + Lists the `ByoipRange` resources in the specified compartment. + You can filter the list using query parameters. + operationId: ListByoipRanges + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/FilterByLifecycleStateQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ByoipRangeCollection' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListByoipRanges + tags: + - virtualNetwork + x-related-resource: '#/definitions/ByoipRange' + post: + description: | + Creates a subrange of the BYOIP CIDR block. + operationId: CreateByoipRange + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateByoipRangeDetails' + description: Details needed to create a BYOIP CIDR block subrange. + required: true + responses: + '200': + description: The BYOIP CIDR block was created. + 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/ByoipRange' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateByoipRange + tags: + - virtualNetwork + /byoipRanges/{byoipRangeId}: + delete: + description: | + Deletes the specified `ByoipRange` resource. + The resource must be in one of the following states: CREATING, PROVISIONED, ACTIVE, or FAILED. + It must not have any subranges currently allocated to a PublicIpPool object or the deletion will fail. + You must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm). + If the `ByoipRange` resource is currently in the PROVISIONED or ACTIVE state, it will be de-provisioned and then deleted. + operationId: DeleteByoipRange + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/ByoipRangeIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '202': + description: The `ByoipRange` resource is being 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteByoipRange + tags: + - virtualNetwork + x-related-resource: '#/definitions/ByoipRange' + get: + description: | + Gets the `ByoipRange` resource. You must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm). + operationId: GetByoipRange + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/ByoipRangeIdPathParam' + responses: + '200': + description: The `ByoipRange` resource was retrieved. + 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/ByoipRange' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetByoipRange + tags: + - virtualNetwork + put: + description: | + Updates the tags or display name associated to the specified BYOIP CIDR block. + operationId: UpdateByoipRange + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/ByoipRangeIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateByoipRangeDetails' + description: Byoip Range details. + required: true + responses: + '200': + description: The associated tags or display name for a BYOIP CIDR block were updated. + 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/ByoipRange' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateByoipRange + tags: + - virtualNetwork + /byoipRanges/{byoipRangeId}/actions/advertise: + post: + description: | + Begins BGP route advertisements for the BYOIP CIDR block you imported to the Oracle Cloud. + The `ByoipRange` resource must be in the PROVISIONED state before the BYOIP CIDR block routes can be advertised with BGP. + operationId: AdvertiseByoipRange + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/ByoipRangeIdPathParam' + responses: + '204': + description: The BYOIP CIDR block is being advertised. + 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: AdvertiseByoipRange + tags: + - virtualNetwork + x-related-resource: '#/definitions/ByoipRange' + /byoipRanges/{byoipRangeId}/actions/changeCompartment: + post: + description: | + Moves a BYOIP CIDR block to a different compartment. For information + about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeByoipRangeCompartment + parameters: + - $ref: '#/components/parameters/ByoipRangeIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeByoipRangeCompartmentDetails' + description: Request to change the compartment of a BYOIP CIDR block. + required: true + responses: + '204': + description: The BYOIP CIDR block was moved to the specified 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeByoipRangeCompartment + tags: + - virtualNetwork + x-related-resource: '#/definitions/ByoipRange' + /byoipRanges/{byoipRangeId}/actions/setOrigin/byoasn: + post: + description: | + Update BYOIP's origin ASN to byoasn. + operationId: SetOriginAsn + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/ByoipRangeIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetOriginAsnDetails' + description: ASN details + required: true + responses: + '202': + description: Recieved update prefix's origin request. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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/DefaultError' + summary: SetOriginAsn + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-obmcs-terraform: + actionType: UPDATE_FIELD + x-related-resource: '#/definitions/ByoipRange' + /byoipRanges/{byoipRangeId}/actions/setOrigin/oracleAsn: + post: + description: | + Update prefix's origin ASN to OCI + operationId: SetOriginAsnToOracle + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/ByoipRangeIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '200': + description: Origin ASN was updated with Oracle ASN. + 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 + '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/DefaultError' + summary: SetOriginAsnToOracle + tags: + - virtualNetwork + x-obmcs-terraform: + actionType: UPDATE_FIELD + x-related-resource: '#/definitions/ByoipRange' + /byoipRanges/{byoipRangeId}/actions/validate: + post: + description: | + Submits the BYOIP CIDR block you are importing for validation. Do not submit to Oracle for validation if you have not already + modified the information for the BYOIP CIDR block with your Regional Internet Registry. See [To import a CIDR block](/iaas/Content/Network/Concepts/BYOIP.htm#import_cidr) for details. + operationId: ValidateByoipRange + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/ByoipRangeIdPathParam' + responses: + '202': + description: The BYOIP CIDR was submitted for validation. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ValidateByoipRange + tags: + - virtualNetwork + x-related-resource: '#/definitions/ByoipRange' + /byoipRanges/{byoipRangeId}/actions/withdraw: + post: + description: | + Withdraws BGP route advertisement for the BYOIP CIDR block. + operationId: WithdrawByoipRange + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/ByoipRangeIdPathParam' + responses: + '204': + description: The BYOIP CIDR block was withdrawn from BGP advertisement. + 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: WithdrawByoipRange + tags: + - virtualNetwork + x-related-resource: '#/definitions/ByoipRange' + /byoipRanges/{byoipRangeId}/byoipAllocatedRanges: + get: + description: | + Lists the subranges of a BYOIP CIDR block currently allocated to an IP pool. + Each `ByoipAllocatedRange` object also lists the IP pool where it is allocated. + operationId: ListByoipAllocatedRanges + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/ByoipRangeIdPathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ByoipAllocatedRangeCollection' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListByoipAllocatedRanges + tags: + - virtualNetwork + x-related-resource: '#/definitions/ByoipAllocatedRangeSummary' + /captureFilters: + get: + description: | + Lists the capture filters in the specified compartment. + operationId: ListCaptureFilters + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/FilterByCaptureFilterLifecycleStateQueryParam' + responses: + '200': + description: The list of VTAP filters is being retrieved. + 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/ListCaptureFiltersResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListCaptureFilters + tags: + - virtualNetwork + post: + description: | + Creates a virtual test access point (VTAP) capture filter in the specified compartment. + + For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains + the VTAP. For more information about compartments and access control, see + [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). + For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). + + You may optionally specify a *display name* for the VTAP, otherwise a default is provided. + It does not have to be unique, and you can change it. + operationId: CreateCaptureFilter + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCaptureFilterDetails' + description: Details for creating a capture filter. + required: true + responses: + '200': + description: The capture filter was created. + 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/CaptureFilter' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateCaptureFilter + tags: + - virtualNetwork + x-example: | + POST /20160918/captureFilters + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName" : "MyCaptureFilter", + "compartmentId" : "ocid1.compartment.oc1..<unique_ID>" + } + /captureFilters/{captureFilterId}: + delete: + description: | + Deletes the specified VTAP capture filter. This is an asynchronous operation. The VTAP capture filter's `lifecycleState` will + change to TERMINATING temporarily until the VTAP capture filter is completely removed. + operationId: DeleteCaptureFilter + parameters: + - $ref: '#/components/parameters/CaptureFilterIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '204': + description: The capture filter is being 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteCaptureFilter + tags: + - virtualNetwork + x-related-resource: '#/definitions/CaptureFilter' + get: + description: Gets information about the specified VTAP capture filter. + operationId: GetCaptureFilter + parameters: + - $ref: '#/components/parameters/CaptureFilterIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The VTAP capture filter was retrieved. + 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/CaptureFilter' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetCaptureFilter + tags: + - virtualNetwork + put: + description: | + Updates the specified VTAP capture filter's display name or tags. + operationId: UpdateCaptureFilter + parameters: + - $ref: '#/components/parameters/CaptureFilterIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCaptureFilterDetails' + description: Details object for updating a VTAP. + required: true + responses: + '200': + description: The VTAP capture filter was updated. + 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/CaptureFilter' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateCaptureFilter + tags: + - virtualNetwork + x-related-resource: '#/definitions/CaptureFilter' + /captureFilters/{captureFilterId}/actions/changeCompartment: + post: + description: | + Moves a capture filter to a new compartment in the same tenancy. For information + about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeCaptureFilterCompartment + parameters: + - $ref: '#/components/parameters/CaptureFilterIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeCaptureFilterCompartmentDetails' + description: Request to change the compartment of a VTAP. + required: true + responses: + '202': + description: The capture filter is being moved to the new compartment. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeCaptureFilterCompartment + tags: + - virtualNetwork + x-related-resource: '#/definitions/CaptureFilter' + /cpeDeviceShapes: + get: + description: | + Lists the CPE device types that the Networking service provides CPE configuration + content for (example: Cisco ASA). The content helps a network engineer configure + the actual CPE device represented by a [Cpe](#/en/iaas/latest/Cpe/) object. + + If you want to generate CPE configuration content for one of the returned CPE device types, + ensure that the [Cpe](#/en/iaas/latest/Cpe/) object's `cpeDeviceShapeId` attribute is set + to the CPE device type's [OCID](/iaas/Content/General/Concepts/identifiers.htm) (returned by this operation). + + For information about generating CPE configuration content, see these operations: + + * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent) + * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent) + * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent) + operationId: ListCpeDeviceShapes + parameters: + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The list is being retrieved. + 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/ListCpeDeviceShapesResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListCpeDeviceShapes + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /cpeDeviceShapes/{cpeDeviceShapeId}: + get: + description: | + Gets the detailed information about the specified CPE device type. This might include a set of questions + that are specific to the particular CPE device type. The customer must supply answers to those questions + (see [UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)). + The service merges the answers with a template of other information for the CPE device type. The following + operations return the merged content: + + * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent) + * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent) + * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent) + operationId: GetCpeDeviceShape + parameters: + - $ref: '#/components/parameters/CpeDeviceShapeIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The parameters is being retrieved. + 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/CpeDeviceShapeDetail' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetCpeDeviceShape + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/CpeDeviceShapeDetail' + /cpes: + get: + description: | + Lists the customer-premises equipment objects (CPEs) in the specified compartment. + operationId: ListCpes + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListCpesResponse' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListCpes + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + post: + description: | + Creates a new virtual customer-premises equipment (CPE) object in the specified compartment. For + more information, see [Site-to-Site VPN Overview](/iaas/Content/Network/Tasks/overviewIPsec.htm). + + For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want + the CPE to reside. Notice that the CPE doesn't have to be in the same compartment as the IPSec + connection or other Networking Service components. If you're not sure which compartment to + use, put the CPE in the same compartment as the DRG. For more information about + compartments and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). + For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). + + You must provide the public IP address of your on-premises router. See + [CPE Configuration](/iaas/Content/Network/Tasks/configuringCPE.htm). + + You may optionally specify a *display name* for the CPE, otherwise a default is provided. It does not have to + be unique, and you can change it. Avoid entering confidential information. + operationId: CreateCpe + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCpeDetails' + description: Details for creating a CPE. + required: true + responses: + '200': + description: The CPE has been created. + 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/Cpe' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.compartment.oc1..", + "displayName" : "MyCpe", + "id" : "ocid1.cpe.oc1.phx.", + "ipAddress" : "203.0.113.5", + "timeCreated" : "2016-12-16T22:40:52.059Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateCpe + tags: + - virtualNetwork + x-example: | + POST /20160918/cpes + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "ipAddress" : "203.0.113.6", + "displayName" : "MyCpe", + "compartmentId" : "ocid1.compartment.oc1..<compartment_OCID>" + } + x-obmcs-client-retries-enabled: true + /cpes/{cpeId}: + delete: + description: | + Deletes the specified CPE object. The CPE must not be connected to a DRG. This is an asynchronous + operation. The CPE's `lifecycleState` will change to TERMINATING temporarily until the CPE is completely + removed. + operationId: DeleteCpe + parameters: + - $ref: '#/components/parameters/CpeIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The CPE is being 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteCpe + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + get: + description: Gets the specified CPE's information. + operationId: GetCpe + parameters: + - $ref: '#/components/parameters/CpeIdPathParam' + responses: + '200': + description: The CPE was retrieved. + 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/Cpe' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetCpe + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + put: + description: | + Updates the specified CPE's display name or tags. + Avoid entering confidential information. + operationId: UpdateCpe + parameters: + - $ref: '#/components/parameters/CpeIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCpeDetails' + description: Details object for updating a CPE. + required: true + responses: + '200': + description: The CPE was updated. + 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/Cpe' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateCpe + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /cpes/{cpeId}/actions/changeCompartment: + post: + description: | + Moves a CPE object into a different compartment within the same tenancy. For information + about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeCpeCompartment + parameters: + - $ref: '#/components/parameters/CpeIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeCpeCompartmentDetails' + description: Request to change the compartment of a CPE. + required: true + responses: + '204': + description: The CPE object has been moved to the specified compartment. + 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 + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeCpeCompartment + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/Cpe' + /cpes/{cpeId}/cpeConfigContent: + get: + description: | + Renders a set of CPE configuration content that can help a network engineer configure the actual + CPE device (for example, a hardware router) represented by the specified [Cpe](#/en/iaas/latest/Cpe/) + object. + + The rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the + [Cpe](#/en/iaas/latest/Cpe/) must have the CPE's device type specified by the `cpeDeviceShapeId` + attribute. The content optionally includes answers that the customer provides (see + [UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)), + merged with a template of other information specific to the CPE device type. + + The operation returns configuration information for *all* of the + [IPSecConnection](#/en/iaas/latest/IPSecConnection/) objects that use the specified CPE. + Here are similar operations: + + * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent) + returns CPE configuration content for all IPSec tunnels in a single IPSec connection. + * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent) + returns CPE configuration content for a specific IPSec tunnel in an IPSec connection. + operationId: GetCpeDeviceConfigContent + parameters: + - $ref: '#/components/parameters/CpeIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The information was retrieved. + 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: + text/plain; charset=utf-8: + schema: + format: binary + type: string + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetCpeDeviceConfigContent + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/Cpe' + /crossConnectGroups: + get: + description: | + Lists the cross-connect groups in the specified compartment. + operationId: ListCrossConnectGroups + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to return only resources that match the specified lifecycle + state. The value is case insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/CrossConnectGroup/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListCrossConnectGroupsResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListCrossConnectGroups + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + post: + description: | + Creates a new cross-connect group to use with Oracle Cloud Infrastructure + FastConnect. For more information, see + [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). + + For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the + compartment where you want the cross-connect group to reside. If you're + not sure which compartment to use, put the cross-connect group in the + same compartment with your VCN. For more information about + compartments and access control, see + [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). + For information about OCIDs, see + [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). + + You may optionally specify a *display name* for the cross-connect group. + It does not have to be unique, and you can change it. Avoid entering confidential information. + operationId: CreateCrossConnectGroup + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCrossConnectGroupDetails' + description: Details to create a CrossConnectGroup + required: true + responses: + '200': + description: The cross-connect group was created. + 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/CrossConnectGroup' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateCrossConnectGroup + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /crossConnectGroups/{crossConnectGroupId}: + delete: + description: | + Deletes the specified cross-connect group. It must not contain any + cross-connects, and it cannot be mapped to a + [VirtualCircuit](#/en/iaas/latest/VirtualCircuit/). + operationId: DeleteCrossConnectGroup + parameters: + - $ref: '#/components/parameters/CrossConnectGroupIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The cross-connect group is being 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteCrossConnectGroup + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + get: + description: Gets the specified cross-connect group's information. + operationId: GetCrossConnectGroup + parameters: + - $ref: '#/components/parameters/CrossConnectGroupIdPathParam' + responses: + '200': + description: The cross-connect group was retrieved. + 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/CrossConnectGroup' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetCrossConnectGroups + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + put: + description: | + Updates the specified cross-connect group's display name. + Avoid entering confidential information. + operationId: UpdateCrossConnectGroup + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/CrossConnectGroupIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCrossConnectGroupDetails' + description: Update CrossConnectGroup fields + required: true + responses: + '200': + description: The cross-connect group was updated. + 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/CrossConnectGroup' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateCrossConnectGroup + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /crossConnectGroups/{crossConnectGroupId}/actions/changeCompartment: + post: + description: | + Moves a cross-connect group into a different compartment within the same tenancy. For information + about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeCrossConnectGroupCompartment + parameters: + - $ref: '#/components/parameters/CrossConnectGroupIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeCrossConnectGroupCompartmentDetails' + description: Request to change the compartment of a Cross Connect Group. + required: true + responses: + '204': + description: The cross-connect group has been moved to the specified compartment. + 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 + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeCrossConnectGroupCompartment + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/CrossConnectGroup' + /crossConnectLocations: + get: + description: | + Lists the available FastConnect locations for cross-connect installation. You need + this information so you can specify your desired location when you create a cross-connect. + operationId: ListCrossConnectLocations + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListCrossConnectLocationsResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListCrossConnectLocations + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /crossConnectPortSpeedShapes: + get: + description: | + Lists the available port speeds for cross-connects. You need this information + so you can specify your desired port speed (that is, shape) when you create a + cross-connect. + operationId: ListCrossconnectPortSpeedShapes + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListCrossconnectPortSpeedShapesResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListCrossConnectPortSpeedShapes + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /crossConnects: + get: + description: | + Lists the cross-connects in the specified compartment. You can filter the list + by specifying the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a cross-connect group. + operationId: ListCrossConnects + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/CrossConnectGroupIdOptionalQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to return only resources that match the specified lifecycle + state. The value is case insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/CrossConnect/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListCrossConnectsResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListCrossConnects + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + post: + description: | + Creates a new cross-connect. Oracle recommends you create each cross-connect in a + [CrossConnectGroup](#/en/iaas/latest/CrossConnectGroup) so you can use link aggregation + with the connection. + + After creating the `CrossConnect` object, you need to go the FastConnect location + and request to have the physical cable installed. For more information, see + [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). + + For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the + compartment where you want the cross-connect to reside. If you're + not sure which compartment to use, put the cross-connect in the + same compartment with your VCN. For more information about + compartments and access control, see + [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). + For information about OCIDs, see + [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). + + You may optionally specify a *display name* for the cross-connect. + It does not have to be unique, and you can change it. Avoid entering confidential information. + operationId: CreateCrossConnect + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCrossConnectDetails' + description: Details to create a CrossConnect + required: true + responses: + '200': + description: The cross-connect was created. + 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/CrossConnect' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateCrossConnect + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /crossConnects/{crossConnectId}: + delete: + description: | + Deletes the specified cross-connect. It must not be mapped to a + [VirtualCircuit](#/en/iaas/latest/VirtualCircuit/). + operationId: DeleteCrossConnect + parameters: + - $ref: '#/components/parameters/CrossConnectIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The cross-connect is being 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteCrossConnect + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + get: + description: Gets the specified cross-connect's information. + operationId: GetCrossConnect + parameters: + - $ref: '#/components/parameters/CrossConnectIdPathParam' + responses: + '200': + description: The cross-connect was retrieved. + 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/CrossConnect' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetCrossConnect + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + put: + description: Updates the specified cross-connect. + operationId: UpdateCrossConnect + parameters: + - $ref: '#/components/parameters/CrossConnectIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCrossConnectDetails' + description: Update CrossConnect fields. + required: true + responses: + '200': + description: The cross-connect was updated. + 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/CrossConnect' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateCrossConnect + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /crossConnects/{crossConnectId}/actions/changeCompartment: + post: + description: | + Moves a cross-connect into a different compartment within the same tenancy. For information + about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeCrossConnectCompartment + parameters: + - $ref: '#/components/parameters/CrossConnectIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeCrossConnectCompartmentDetails' + description: Request to change the compartment of a Cross Connect. + required: true + responses: + '204': + description: The cross-connect has been moved to the specified compartment. + 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 + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeCrossConnectCompartment + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/CrossConnect' + /crossConnects/{crossConnectId}/letterOfAuthority: + get: + description: Gets the Letter of Authority for the specified cross-connect. + operationId: GetCrossConnectLetterOfAuthority + parameters: + - $ref: '#/components/parameters/CrossConnectIdPathParam' + responses: + '200': + description: The Letter of Authority was retrieved. + 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/LetterOfAuthority' + text/html: + schema: + $ref: '#/components/schemas/LetterOfAuthority' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Gets the Letter of Authority associated with the mentioned cross-connect. + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /crossConnects/{crossConnectId}/status: + get: + description: | + Gets the status of the specified cross-connect. + operationId: GetCrossConnectStatus + parameters: + - $ref: '#/components/parameters/CrossConnectIdPathParam' + responses: + '200': + description: The cross-connect's status was retrieved. + 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/CrossConnectStatus' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetCrossConnectStatus + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /dhcps: + get: + description: | + Lists the sets of DHCP options in the specified VCN and specified compartment. + If the VCN ID is not provided, then the list includes the sets of DHCP options from all VCNs in the specified compartment. + The response includes the default set of options that automatically comes with each VCN, + plus any other sets you've created. + operationId: ListDhcpOptions + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/VcnIdOptionalQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle + state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/DhcpOptions/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListDhcpOptionsResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDhcpOptions + tags: + - virtualNetwork + post: + description: | + Creates a new set of DHCP options for the specified VCN. For more information, see + [DhcpOptions](#/en/iaas/latest/DhcpOptions/). + + For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the set of + DHCP options to reside. Notice that the set of options doesn't have to be in the same compartment as the VCN, + subnets, or other Networking Service components. If you're not sure which compartment to use, put the set + of DHCP options in the same compartment as the VCN. For more information about compartments and access control, see + [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see + [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). + + You may optionally specify a *display name* for the set of DHCP options, otherwise a default is provided. + It does not have to be unique, and you can change it. Avoid entering confidential information. + operationId: CreateDhcpOptions + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateDhcpDetails' + description: Request object for creating a new set of DHCP options. + required: true + responses: + '200': + description: The set of DHCP options has been created. + 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/DhcpOptions' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateDhcpOptions + tags: + - virtualNetwork + x-example: | + POST /20160918/dhcps + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "options" : [{ + "type" : "DomainNameServer", + "customDnsServers" : ["203.0.113.6"], + "serverType" : "CustomDnsServer" + }], + "vcnId" : "ocid1.vcn.oc1.phx.<unique_ID>", + "displayName" : "MyDhcpOptions", + "compartmentId" : "ocid1.compartment.oc1..<unique_ID>" + } + /dhcps/{dhcpId}: + delete: + description: | + Deletes the specified set of DHCP options, but only if it's not associated with a subnet. You can't delete a + VCN's default set of DHCP options. + + This is an asynchronous operation. The state of the set of options will switch to TERMINATING temporarily + until the set is completely removed. + operationId: DeleteDhcpOptions + parameters: + - $ref: '#/components/parameters/DhcpIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '200': + description: The set of DHCP options is being 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteDhcpOptions + tags: + - virtualNetwork + get: + description: Gets the specified set of DHCP options. + operationId: GetDhcpOptions + parameters: + - $ref: '#/components/parameters/DhcpIdPathParam' + responses: + '200': + description: The set of DHCP options was retrieved. + 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/DhcpOptions' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetDhcpOptions + tags: + - virtualNetwork + put: + description: | + Updates the specified set of DHCP options. You can update the display name or the options + themselves. Avoid entering confidential information. + + Note that the `options` object you provide replaces the entire existing set of options. + operationId: UpdateDhcpOptions + parameters: + - $ref: '#/components/parameters/DhcpIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateDhcpDetails' + description: Request object for updating a set of DHCP options. + required: true + responses: + '200': + description: The set of DHCP options was updated. + 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/DhcpOptions' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateDhcpOptions + tags: + - virtualNetwork + x-related-resource: '#/definitions/DhcpOptions' + /dhcps/{dhcpId}/actions/changeCompartment: + post: + description: | + Moves a set of DHCP options into a different compartment within the same tenancy. For information + about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeDhcpOptionsCompartment + parameters: + - $ref: '#/components/parameters/DhcpIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeDhcpOptionsCompartmentDetails' + description: Request to change the compartment of a set of DHCP Options. + required: true + responses: + '204': + description: The set of DHCP options has been moved to the specified compartment. + 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeDhcpOptionsCompartment + tags: + - virtualNetwork + x-related-resource: '#/definitions/DhcpOptions' + /drgAttachments: + get: + description: | + Lists the `DrgAttachment` resource for the specified compartment. You can filter the + results by DRG, attached network, attachment type, DRG route table or + VCN route table. + + The LIST API lists DRG attachments by attachment type. It will default to list VCN attachments, + but you may request to list ALL attachments of ALL types. + operationId: ListDrgAttachments + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/VcnIdOptionalQueryParam' + - $ref: '#/components/parameters/DrgIdOptionalQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/NetworkIdQueryParam' + - $ref: '#/components/parameters/DrgAttachmentTypeQueryParam' + - $ref: '#/components/parameters/DrgRouteTableIdQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to return only resources that match the specified lifecycle + state. The value is case insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/DrgAttachment/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListDrgAttachmentsResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDrgAttachments + tags: + - virtualNetwork + post: + description: | + Attaches the specified DRG to the specified network resource. A VCN can be attached to only one DRG + at a time, but a DRG can be attached to more than one VCN. The response includes a `DrgAttachment` + object with its own [OCID](/iaas/Content/General/Concepts/identifiers.htm). For more information about DRGs, see + [Dynamic Routing Gateways (DRGs)](/iaas/Content/Network/Tasks/managingDRGs.htm). + + You may optionally specify a *display name* for the attachment, otherwise a default is provided. + It does not have to be unique, and you can change it. Avoid entering confidential information. + + For the purposes of access control, the DRG attachment is automatically placed into the currently selected compartment. + For more information about compartments and access control, see + [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). + operationId: CreateDrgAttachment + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateDrgAttachmentDetails' + description: Details for creating a `DrgAttachment`. + required: true + responses: + '200': + description: The DRG was attached. + 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/DrgAttachment' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateDrgAttachment + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /drgAttachments/{drgAttachmentId}: + delete: + description: | + Detaches a DRG from a network resource by deleting the corresponding `DrgAttachment` resource. This is an asynchronous + operation. The attachment's `lifecycleState` will temporarily change to DETACHING until the attachment + is completely removed. + operationId: DeleteDrgAttachment + parameters: + - $ref: '#/components/parameters/DrgAttachmentIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The DRG is being detached. + 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteDrgAttachment + tags: + - virtualNetwork + get: + description: Gets the `DrgAttachment` resource. + operationId: GetDrgAttachment + parameters: + - $ref: '#/components/parameters/DrgAttachmentIdPathParam' + responses: + '200': + description: The `DrgAttachment` was retrieved. + 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/DrgAttachment' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetDrgAttachment + tags: + - virtualNetwork + put: + description: | + Updates the display name and routing information for the specified `DrgAttachment`. + Avoid entering confidential information. + operationId: UpdateDrgAttachment + parameters: + - $ref: '#/components/parameters/DrgAttachmentIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateDrgAttachmentDetails' + description: Details object for updating a `DrgAttachment`. + required: true + responses: + '200': + description: The `DrgAttachment` was updated. + 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/DrgAttachment' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateDrgAttachment + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /drgAttachments/{drgAttachmentId}/actions/removeExportDrgRouteDistribution: + post: + description: | + Removes the export route distribution from the DRG attachment so no routes are advertised to it. + operationId: RemoveExportDrgRouteDistribution + parameters: + - $ref: '#/components/parameters/DrgAttachmentIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '200': + description: The route distribution was removed. + 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/DrgAttachment' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: RemoveExportDrgRouteDistribution + tags: + - virtualNetwork + x-related-resource: '#/definitions/DrgAttachment' + x-obmcs-client-retries-enabled: true + /drgRouteDistributions: + get: + description: | + Lists the route distributions in the specified DRG. + + To retrieve the statements in a distribution, use the + ListDrgRouteDistributionStatements operation. + operationId: ListDrgRouteDistributions + parameters: + - $ref: '#/components/parameters/DrgIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter that only returns resources that match the specified lifecycle + state. The value is case insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/DrgRouteDistribution/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListDrgRouteDistributionsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDrgRouteDistributionStatements + tags: + - virtualNetwork + post: + description: | + Creates a new route distribution for the specified DRG. + Assign the route distribution as an import distribution to a DRG route table using the `UpdateDrgRouteTable` or `CreateDrgRouteTable` operations. + Assign the route distribution as an export distribution to a DRG attachment + using the `UpdateDrgAttachment` or `CreateDrgAttachment` operations. + operationId: CreateDrgRouteDistribution + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateDrgRouteDistributionDetails' + description: Details for creating a route distribution. + required: true + responses: + '200': + description: The route distribution was created. + 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/DrgRouteDistribution' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateDrgRouteDistribution + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /drgRouteDistributions/{drgRouteDistributionId}: + delete: + description: | + Deletes the specified route distribution. You can't delete a route distribution currently in use by a DRG attachment or DRG route table. + + Remove the DRG route distribution from a DRG attachment or DRG route table by using the "RemoveExportDrgRouteDistribution" or "RemoveImportDrgRouteDistribution' operations. + operationId: DeleteDrgRouteDistribution + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/DrgRouteDistributionIdPathParam' + responses: + '204': + description: The route distribution is being 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteDrgRouteDistribution + tags: + - virtualNetwork + x-related-resource: '#/definitions/DrgRouteDistributionStatement' + get: + description: Gets the specified route distribution's information. + operationId: GetDrgRouteDistribution + parameters: + - $ref: '#/components/parameters/DrgRouteDistributionIdPathParam' + responses: + '200': + description: The route distribution was retrieved. + 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/DrgRouteDistribution' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetDrgRouteDistribution + tags: + - virtualNetwork + put: + description: | + Updates the specified route distribution + operationId: UpdateDrgRouteDistribution + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/DrgRouteDistributionIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateDrgRouteDistributionDetails' + description: Details object for updating a route distribution + required: true + responses: + '200': + description: The route distribution was updated. + 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/DrgRouteDistribution' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateDrgRouteDistribution + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /drgRouteDistributions/{drgRouteDistributionId}/actions/addDrgRouteDistributionStatements: + post: + description: | + Adds one or more route distribution statements to the specified route distribution. + operationId: AddDrgRouteDistributionStatements + parameters: + - $ref: '#/components/parameters/DrgRouteDistributionIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddDrgRouteDistributionStatementsDetails' + description: Request with one or more route distribution statements to be inserted into the route distribution. + required: true + responses: + '200': + description: The route distribution statements were added. + 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/AddDrgRouteDistributionStatementsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: AddDrgRouteDistributionStatements + tags: + - virtualNetwork + x-related-resource: '#/definitions/DrgRouteDistributionStatement' + x-obmcs-client-retries-enabled: true + /drgRouteDistributions/{drgRouteDistributionId}/actions/removeDrgRouteDistributionStatements: + post: + description: | + Removes one or more route distribution statements from the specified route distribution's map. + operationId: RemoveDrgRouteDistributionStatements + parameters: + - $ref: '#/components/parameters/DrgRouteDistributionIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveDrgRouteDistributionStatementsDetails' + description: | + Request with one or more route distribution statements to remove from the route distribution. + required: true + responses: + '200': + description: The route distribution statements are being 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: RemoveDrgRouteDistributionStatements + tags: + - virtualNetwork + x-related-resource: '#/definitions/DrgRouteDistributionStatement' + x-obmcs-client-retries-enabled: true + /drgRouteDistributions/{drgRouteDistributionId}/actions/updateDrgRouteDistributionStatements: + post: + description: | + Updates one or more route distribution statements in the specified route distribution. + operationId: UpdateDrgRouteDistributionStatements + parameters: + - $ref: '#/components/parameters/DrgRouteDistributionIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateDrgRouteDistributionStatementsDetails' + description: | + Request to update one or more route distribution statements in the route distribution. + required: true + responses: + '200': + description: The route distribution statements were 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 + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateDrgRouteDistributionStatementsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateDrgRouteDistributionStatements + tags: + - virtualNetwork + x-related-resource: '#/definitions/DrgRouteDistributionStatement' + x-obmcs-client-retries-enabled: true + /drgRouteDistributions/{drgRouteDistributionId}/drgRouteDistributionStatements: + get: + description: Lists the statements for the specified route distribution. + operationId: ListDrgRouteDistributionStatements + parameters: + - $ref: '#/components/parameters/DrgRouteDistributionIdPathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/ListDrgRouteDistributionStatementsSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListDrgRouteDistributionStatementsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDrgRouteDistributionStatements + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /drgRouteTables: + get: + description: | + Lists the DRG route tables for the specified DRG. + + Use the `ListDrgRouteRules` operation to retrieve the route rules in a table. + operationId: ListDrgRouteTables + parameters: + - $ref: '#/components/parameters/DrgIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/ImportDrgRouteDistributionIdQueryParam' + - description: | + A filter that only returns matches for the specified lifecycle + state. The value is case insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/DrgRouteTable/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListDrgRouteTablesResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDrgRouteTables + tags: + - virtualNetwork + post: + description: | + Creates a new DRG route table for the specified DRG. Assign the DRG route table to a DRG attachment + using the `UpdateDrgAttachment` or `CreateDrgAttachment` operations. + operationId: CreateDrgRouteTable + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateDrgRouteTableDetails' + description: Details for creating a DRG route table. + required: true + responses: + '200': + description: The DRG route table was created. + 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/DrgRouteTable' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateDrgRouteTable + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /drgRouteTables/{drgRouteTableId}: + delete: + description: | + Deletes the specified DRG route table. There must not be any DRG attachments assigned. + operationId: DeleteDrgRouteTable + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/DrgRouteTableIdPathParam' + responses: + '204': + description: The DRG route table is being 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteDrgRouteTable + tags: + - virtualNetwork + x-related-resource: '#/definitions/InternalPublicIp' + get: + description: Gets the specified DRG route table's information. + operationId: GetDrgRouteTable + parameters: + - $ref: '#/components/parameters/DrgRouteTableIdPathParam' + responses: + '200': + description: The DRG route table was retrieved. + 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/DrgRouteTable' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetDrgRouteTable + tags: + - virtualNetwork + put: + description: | + Updates the specified DRG route table. + operationId: UpdateDrgRouteTable + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/DrgRouteTableIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateDrgRouteTableDetails' + description: Details object used to updating a DRG route table. + required: true + responses: + '200': + description: The DRG route table was updated. + 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/DrgRouteTable' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateDrgRouteTable + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /drgRouteTables/{drgRouteTableId}/actions/addDrgRouteRules: + post: + description: | + Adds one or more static route rules to the specified DRG route table. + operationId: AddDrgRouteRules + parameters: + - $ref: '#/components/parameters/DrgRouteTableIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddDrgRouteRulesDetails' + description: Request for one or more route rules to be inserted into the DRG route table. + required: true + responses: + '200': + description: The route rules were added. + 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/AddDrgRouteRulesResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: AddDrgRouteRules + tags: + - virtualNetwork + x-related-resource: '#/definitions/DrgRouteRule' + x-obmcs-client-retries-enabled: true + /drgRouteTables/{drgRouteTableId}/actions/removeDrgRouteRules: + post: + description: | + Removes one or more route rules from the specified DRG route table. + operationId: RemoveDrgRouteRules + parameters: + - $ref: '#/components/parameters/DrgRouteTableIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveDrgRouteRulesDetails' + description: | + Request to remove one or more route rules in the DRG route table. + required: true + responses: + '200': + description: The route rules are being 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: RemoveDrgRouteRules + tags: + - virtualNetwork + x-related-resource: '#/definitions/DrgRouteRule' + x-obmcs-client-retries-enabled: true + /drgRouteTables/{drgRouteTableId}/actions/removeImportDrgRouteDistribution: + post: + description: | + Removes the import route distribution from the DRG route table so no routes are imported + into it. + operationId: RemoveImportDrgRouteDistribution + parameters: + - $ref: '#/components/parameters/DrgRouteTableIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '200': + description: The route distribution was removed. + 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/DrgRouteTable' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: RemoveImportDrgRouteDistribution + tags: + - virtualNetwork + x-related-resource: '#/definitions/DrgRouteTable' + x-obmcs-client-retries-enabled: true + /drgRouteTables/{drgRouteTableId}/actions/updateDrgRouteRules: + post: + description: | + Updates one or more route rules in the specified DRG route table. + operationId: UpdateDrgRouteRules + parameters: + - $ref: '#/components/parameters/DrgRouteTableIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateDrgRouteRulesDetails' + description: | + Request to update one or more route rules in the DRG route table. + required: true + responses: + '200': + description: The DRG route rules were 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 + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateDrgRouteRulesResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateDrgRouteRules + tags: + - virtualNetwork + x-related-resource: '#/definitions/DrgRouteRule' + x-obmcs-client-retries-enabled: true + /drgRouteTables/{drgRouteTableId}/drgRouteRules: + get: + description: Lists the route rules in the specified DRG route table. + operationId: ListDrgRouteRules + parameters: + - $ref: '#/components/parameters/DrgRouteTableIdPathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RouteTypeQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListDrgRouteRulesResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDrgRouteRules + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /drgs: + get: + description: | + Lists the DRGs in the specified compartment. + operationId: ListDrgs + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListDrgsResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListDrgs + tags: + - virtualNetwork + post: + description: | + Creates a new dynamic routing gateway (DRG) in the specified compartment. For more information, + see [Dynamic Routing Gateways (DRGs)](/iaas/Content/Network/Tasks/managingDRGs.htm). + + For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want + the DRG to reside. Notice that the DRG doesn't have to be in the same compartment as the VCN, + the DRG attachment, or other Networking Service components. If you're not sure which compartment + to use, put the DRG in the same compartment as the VCN. For more information about compartments + and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). + For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). + + You may optionally specify a *display name* for the DRG, otherwise a default is provided. + It does not have to be unique, and you can change it. Avoid entering confidential information. + operationId: CreateDrg + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateDrgDetails' + description: Details for creating a DRG. + required: true + responses: + '200': + description: The DRG was created. + 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/Drg' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateDrg + tags: + - virtualNetwork + x-example: | + POST /20160918/drgs + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName" : "MyDrg", + "compartmentId" : "ocid1.compartment.oc1..<unique_ID>" + } + x-obmcs-client-retries-enabled: true + /drgs/{drgId}: + delete: + description: | + Deletes the specified DRG. The DRG must not be attached to a VCN or be connected to your on-premise + network. Also, there must not be a route table that lists the DRG as a target. This is an asynchronous + operation. The DRG's `lifecycleState` will change to TERMINATING temporarily until the DRG is completely + removed. + operationId: DeleteDrg + parameters: + - $ref: '#/components/parameters/DrgIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The DRG is being 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteDrg + tags: + - virtualNetwork + get: + description: Gets the specified DRG's information. + operationId: GetDrg + parameters: + - $ref: '#/components/parameters/DrgIdPathParam' + responses: + '200': + description: The DRG was retrieved. + 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/Drg' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetDrg + tags: + - virtualNetwork + put: + description: | + Updates the specified DRG's display name or tags. Avoid entering confidential information. + operationId: UpdateDrg + parameters: + - $ref: '#/components/parameters/DrgIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateDrgDetails' + description: Details object for updating a DRG. + required: true + responses: + '200': + description: The DRG was updated. + 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/Drg' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateDrg + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /drgs/{drgId}/actions/getAllDrgAttachments: + post: + description: | + Returns a complete list of DRG attachments that belong to a particular DRG. + operationId: GetAllDrgAttachments + parameters: + - $ref: '#/components/parameters/DrgIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/DrgAttachmentTypeQueryParam' + - $ref: '#/components/parameters/CrossTenancyQueryParam' + responses: + '202': + description: The list is being retrieved. + 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/GetAllDrgAttachmentsResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetAllDrgAttachments + tags: + - virtualNetwork + x-related-resource: '#/definitions/Drg' + x-obmcs-client-retries-enabled: true + /drgs/{drgId}/actions/upgrade: + post: + description: | + Upgrades the DRG. After upgrade, you can control routing inside your DRG + via DRG attachments, route distributions, and DRG route tables. + operationId: UpgradeDrg + parameters: + - $ref: '#/components/parameters/DrgIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '202': + description: The DRG is upgrading. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpgradeDrg + tags: + - virtualNetwork + x-related-resource: '#/definitions/Drg' + x-obmcs-client-retries-enabled: true + /drgs/{drgId}/actions/upgradeStatus: + get: + description: | + Returns the DRG upgrade status. The status can be not updated, in progress, or updated. Also indicates how much of the upgrade is completed. + operationId: GetUpgradeStatus + parameters: + - $ref: '#/components/parameters/DrgIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The DRG is upgrading. + 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/UpgradeStatus' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpgradeStatus + tags: + - virtualNetwork + x-related-resource: '#/definitions/Drg' + x-obmcs-client-retries-enabled: true + /drgs/{drgId}/redundancyStatus: + get: + description: | + Gets the redundancy status for the specified DRG. For more information, see + [Redundancy Remedies](/iaas/Content/Network/Troubleshoot/drgredundancy.htm). + operationId: GetDrgRedundancyStatus + parameters: + - $ref: '#/components/parameters/DrgIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The parameters is being retrieved. + 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/DrgRedundancyStatus' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetDrgRedundancyStatus + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /fastConnectProviderServices: + get: + description: | + Lists the service offerings from supported providers. You need this + information so you can specify your desired provider and service + offering when you create a virtual circuit. + + For the compartment ID, provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of your tenancy (the root compartment). + + For more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). + operationId: ListFastConnectProviderServices + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListFastConnectProviderServicesResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListFastConnectProviderServices + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /fastConnectProviderServices/{providerServiceId}: + get: + description: | + Gets the specified provider service. + For more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). + operationId: GetFastConnectProviderService + parameters: + - $ref: '#/components/parameters/ProviderServiceIdPathParam' + responses: + '200': + description: The provider service is being retrieved. + 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/FastConnectProviderService' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetFastConnectProviderService + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /fastConnectProviderServices/{providerServiceId}/providerServiceKeys/{providerServiceKeyName}: + get: + description: | + Gets the specified provider service key's information. Use this operation to validate a + provider service key. An invalid key returns a 404 error. + operationId: GetFastConnectProviderServiceKey + parameters: + - $ref: '#/components/parameters/ProviderServiceIdPathParam' + - $ref: '#/components/parameters/ProviderServiceKeyNamePathParam' + responses: + '200': + description: The provider service key name is being retrieved. + 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/FastConnectProviderServiceKey' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetFastConnectProviderServiceKey + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /fastConnectProviderServices/{providerServiceId}/virtualCircuitBandwidthShapes: + get: + description: | + Gets the list of available virtual circuit bandwidth levels for a provider. + You need this information so you can specify your desired bandwidth level (shape) when you create a virtual circuit. + + For more information about virtual circuits, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). + operationId: ListFastConnectProviderVirtualCircuitBandwidthShapes + parameters: + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/ProviderServiceIdPathParam' + responses: + '200': + description: The list is being retrieved. + 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/ListFastConnectProviderVirtualCircuitBandwidthShapesResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListFastConnectProviderVirtualCircuitBandwidthShapes + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/FastConnectProviderService' + /internetGateways: + get: + description: | + Lists the internet gateways in the specified VCN and the specified compartment. + If the VCN ID is not provided, then the list includes the internet gateways from all VCNs in the specified compartment. + operationId: ListInternetGateways + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/VcnIdOptionalQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle + state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/InternetGateway/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListInternetGatewaysResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListInternetGateways + tags: + - virtualNetwork + post: + description: | + Creates a new internet gateway for the specified VCN. For more information, see + [Access to the Internet](/iaas/Content/Network/Tasks/managingIGs.htm). + + For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the Internet + Gateway to reside. Notice that the internet gateway doesn't have to be in the same compartment as the VCN or + other Networking Service components. If you're not sure which compartment to use, put the Internet + Gateway in the same compartment with the VCN. For more information about compartments and access control, see + [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). + + You may optionally specify a *display name* for the internet gateway, otherwise a default is provided. It + does not have to be unique, and you can change it. Avoid entering confidential information. + + For traffic to flow between a subnet and an internet gateway, you must create a route rule accordingly in + the subnet's route table (for example, 0.0.0.0/0 > internet gateway). See + [UpdateRouteTable](#/en/iaas/latest/RouteTable/UpdateRouteTable). + + You must specify whether the internet gateway is enabled when you create it. If it's disabled, that means no + traffic will flow to/from the internet even if there's a route rule that enables that traffic. You can later + use [UpdateInternetGateway](#/en/iaas/latest/InternetGateway/UpdateInternetGateway) to easily disable/enable + the gateway without changing the route rule. + operationId: CreateInternetGateway + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateInternetGatewayDetails' + description: Details for creating a new internet gateway. + required: true + responses: + '200': + description: The internet gateway was created. + 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/InternetGateway' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateInternetGateway + tags: + - virtualNetwork + x-example: | + POST /20160918/internetGateways + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName" : "MyInternetGateway", + "compartmentId" : "ocid1.compartment.oc1..<unique_ID>", + "vcnId" : "ocid1.vcn.oc1.phx.<unique_ID>", + "isEnabled" : true + } + /internetGateways/{igId}: + delete: + description: | + Deletes the specified internet gateway. The internet gateway does not have to be disabled, but + there must not be a route table that lists it as a target. + + This is an asynchronous operation. The gateway's `lifecycleState` will change to TERMINATING temporarily + until the gateway is completely removed. + operationId: DeleteInternetGateway + parameters: + - $ref: '#/components/parameters/InternetGatewayIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The internet gateway is being 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteInternetGateway + tags: + - virtualNetwork + get: + description: Gets the specified internet gateway's information. + operationId: GetInternetGateway + parameters: + - $ref: '#/components/parameters/InternetGatewayIdPathParam' + responses: + '200': + description: The internet gateway was retrieved. + 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/InternetGateway' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetInternetGateway + tags: + - virtualNetwork + put: + description: | + Updates the specified internet gateway. You can disable/enable it, or change its display name + or tags. Avoid entering confidential information. + + If the gateway is disabled, that means no traffic will flow to/from the internet even if there's + a route rule that enables that traffic. + operationId: UpdateInternetGateway + parameters: + - $ref: '#/components/parameters/InternetGatewayIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateInternetGatewayDetails' + description: Details for updating the internet gateway. + required: true + responses: + '200': + description: The internet gateway was updated. + 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/InternetGateway' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateInternetGateway + tags: + - virtualNetwork + /internetGateways/{igId}/actions/changeCompartment: + post: + description: | + Moves an internet gateway into a different compartment within the same tenancy. For information + about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeInternetGatewayCompartment + parameters: + - $ref: '#/components/parameters/InternetGatewayIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeInternetGatewayCompartmentDetails' + description: Request to change the compartment of an internet gateway. + required: true + responses: + '204': + description: The internet gateway has been moved to the specified compartment. + 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeInternetGatewayCompartment + tags: + - virtualNetwork + x-related-resource: '#/definitions/InternetGateway' + /ipInventory: + post: + description: | + Lists the IP Inventory information in the selected compartments. + operationId: ListIpInventory + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ListIpInventoryDetails' + description: Details required to list the IP Inventory data. + required: true + responses: + '200': + description: Lists details of IP Inventory data. + headers: + data-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the resource. + schema: + type: string + etag: + description: | + For optimistic concurrency control. See `if-match`. + schema: + type: string + lifecycle-state: + description: The IpInventory API current state. + schema: + type: string + enum: + - IN_PROGRESS + - DONE + 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 + opc-total-items: + description: | + For list pagination. A pagination token to get the total number of results available. + schema: + type: integer + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/IpInventoryCollection' + '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/DefaultError' + summary: ListIpInventory + tags: + - virtualNetwork + /ipInventory/subnets/{subnetId}: + get: + description: | + Gets the IP Inventory data of the specified subnet. Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm). + operationId: GetSubnetIpInventory + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SubnetIdPathParam' + responses: + '200': + description: Retrieve `IpInventorySubnetResourceCollection` resource. + 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/IpInventorySubnetResourceCollection' + '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/DefaultError' + summary: GetSubnetIpInventory + tags: + - virtualNetwork + /ipInventory/subnets/{subnetId}/cidrs: + get: + description: | + Gets the CIDR utilization data of the specified subnet. Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm). + operationId: GetSubnetCidrUtilization + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SubnetIdPathParam' + responses: + '200': + description: Retrieve `IpInventoryCidrUtilizationCollection` resource. + 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 + opc-total-items: + description: | + For list pagination. A pagination token to get the total number of results available. + schema: + type: integer + content: + application/json: + schema: + $ref: '#/components/schemas/IpInventoryCidrUtilizationCollection' + '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/DefaultError' + summary: GetSubnetCidrUtilization + tags: + - virtualNetwork + /ipInventory/vcns/{vcnId}/overlaps: + post: + description: | + Gets the CIDR overlap information of the specified VCN in selected compartments. Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm). + operationId: GetVcnOverlap + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/VcnIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIpInventoryVcnOverlapDetails' + description: Lists details of the IP Inventory VCN overlap data. + required: true + responses: + '200': + description: Retrieve the VCN Overlap details. + headers: + data-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the resource. + schema: + type: string + etag: + description: | + For optimistic concurrency control. See `if-match`. + schema: + type: string + lifecycle-state: + description: The IpInventory API current state. + schema: + type: string + enum: + - IN_PROGRESS + - DONE + 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-total-items: + description: | + For list pagination. A pagination token to get the total number of results available. + schema: + type: integer + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/IpInventoryVcnOverlapCollection' + '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/DefaultError' + summary: GetIpInventoryVcnOverlap + tags: + - virtualNetwork + /ipinventory/DataRequestId/{dataRequestId}: + get: + description: | + Gets the `IpInventory` resource. + operationId: GetResourceIpInventory + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/DataRequestIdPathParam' + responses: + '200': + description: Lists the IP Inventory data. + headers: + etag: + description: | + For optimistic concurrency control. See `if-match`. + schema: + 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). + 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 + opc-total-items: + description: | + For list pagination. A pagination token to get the total number of results available. + schema: + type: integer + content: + application/json: + schema: + $ref: '#/components/schemas/IpInventoryCollection' + '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/DefaultError' + summary: GetResourceIpInventory + tags: + - virtualNetwork + /ipsecAlgorithms: + get: + description: | + The parameters allowed for IKE IPSec tunnels. + operationId: GetAllowedIkeIPSecParameters + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The parameters allowed for IKE IPSec were retrieved. + 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/AllowedIkeIPSecParameters' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetAllowedIkeIPSecParameters + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /ipsecConnections: + get: + description: | + Lists the IPSec connections for the specified compartment. You can filter the + results by DRG or CPE. + operationId: ListIPSecConnections + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/DrgIdOptionalQueryParam' + - $ref: '#/components/parameters/CpeIdOptionalQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListIPSecConnectionsResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListIPSecConnections + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + post: + description: | + Creates a new IPSec connection between the specified DRG and CPE. For more information, see + [Site-to-Site VPN Overview](/iaas/Content/Network/Tasks/overviewIPsec.htm). + + If you configure at least one tunnel to use static routing, then in the request you must provide + at least one valid static route (you're allowed a maximum of 10). For example: 10.0.0.0/16. + If you configure both tunnels to use BGP dynamic routing, you can provide an empty list for + the static routes. For more information, see the important note in + [IPSecConnection](#/en/iaas/latest/IPSecConnection/). + + For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the + IPSec connection to reside. Notice that the IPSec connection doesn't have to be in the same compartment + as the DRG, CPE, or other Networking Service components. If you're not sure which compartment to + use, put the IPSec connection in the same compartment as the DRG. For more information about + compartments and access control, see + [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). + + You may optionally specify a *display name* for the IPSec connection, otherwise a default is provided. + It does not have to be unique, and you can change it. Avoid entering confidential information. + + After creating the IPSec connection, you need to configure your on-premises router + with tunnel-specific information. For tunnel status and the required configuration information, see: + + * [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/) + * [IPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/) + + For each tunnel, you need the IP address of Oracle's VPN headend and the shared secret + (that is, the pre-shared key). For more information, see + [CPE Configuration](/iaas/Content/Network/Tasks/configuringCPE.htm). + operationId: CreateIPSecConnection + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateIPSecConnectionDetails' + description: Details for creating an `IPSecConnection`. + required: true + responses: + '200': + description: The IPSec connection was created. + 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/IPSecConnection' + application-json: + examples: + response: + value: | + { + "compartmentId" : "ocid1.compartment.oc1..", + "cpeId" : "ocid1.cpe.oc1.phx.", + "displayName" : "MyIPSecConnection", + "drgId" : "ocid1.drg.oc1.phx.", + "id" : "ocid1.ipsecconnection.oc1.phx.", + "lifecycleState" : "PROVISIONING", + "staticRoutes" : [ "192.0.2.0/24", "2001:db8::/32" ], + "timeCreated" : "2016-12-16T22:43:25.588Z" + } + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateIPSecConnection + tags: + - virtualNetwork + x-example: | + POST /20160918/ipsecConnections + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName" : "MyIPSecConnection", + "cpeId" : "ocid1.cpe.oc1.phx.<unique_ID>", + "staticRoutes" : ["192.0.2.0/24", "2001:db8::/32" ], + "drgId" : "ocid1.drg.oc1.phx.<unique_ID>", + "compartmentId" : "ocid1.compartment.oc1..<unique_ID>" + } + x-obmcs-client-retries-enabled: true + /ipsecConnections/{ipscId}: + delete: + description: | + Deletes the specified IPSec connection. If your goal is to disable the Site-to-Site VPN between your VCN and + on-premises network, it's easiest to simply detach the DRG but keep all the Site-to-Site VPN components intact. + If you were to delete all the components and then later need to create an Site-to-Site VPN again, you would + need to configure your on-premises router again with the new information returned from + [CreateIPSecConnection](#/en/iaas/latest/IPSecConnection/CreateIPSecConnection). + + This is an asynchronous operation. The connection's `lifecycleState` will change to TERMINATING temporarily + until the connection is completely removed. + operationId: DeleteIPSecConnection + parameters: + - $ref: '#/components/parameters/IPSecConnectionIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The request has been accepted + 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteIPSecConnection + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + get: + description: | + Gets the specified IPSec connection's basic information, including the static routes for the + on-premises router. If you want the status of the connection (whether it's up or down), use + [GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel). + operationId: GetIPSecConnection + parameters: + - $ref: '#/components/parameters/IPSecConnectionIdPathParam' + responses: + '200': + description: The information was retrieved. + 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/IPSecConnection' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetIPSecConnection + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + put: + description: | + Updates the specified IPSec connection. + + To update an individual IPSec tunnel's attributes, use + [UpdateIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/UpdateIPSecConnectionTunnel). + operationId: UpdateIPSecConnection + parameters: + - $ref: '#/components/parameters/IPSecConnectionIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateIPSecConnectionDetails' + description: Details object for updating an IPSec connection. + required: true + responses: + '200': + description: The IPSec connection was updated. + 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/IPSecConnection' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateIPSecConnection + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /ipsecConnections/{ipscId}/actions/changeCompartment: + post: + description: | + Moves an IPSec connection into a different compartment within the same tenancy. For information + about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeIPSecConnectionCompartment + parameters: + - $ref: '#/components/parameters/IPSecConnectionIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeIPSecConnectionCompartmentDetails' + description: Request to change the compartment of a IPSec connection. + required: true + responses: + '204': + description: The IPSec connection has been moved to the specified compartment. + 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 + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeIPSecConnectionCompartment + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/IPSecConnection' + /ipsecConnections/{ipscId}/cpeConfigContent: + get: + description: | + Renders a set of CPE configuration content for the specified IPSec connection (for all the + tunnels in the connection). The content helps a network engineer configure the actual CPE + device (for example, a hardware router) that the specified IPSec connection terminates on. + + The rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the + [Cpe](#/en/iaas/latest/Cpe/) used by the specified [IPSecConnection](#/en/iaas/latest/IPSecConnection/) + must have the CPE's device type specified by the `cpeDeviceShapeId` attribute. The content + optionally includes answers that the customer provides (see + [UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)), + merged with a template of other information specific to the CPE device type. + + The operation returns configuration information for all tunnels in the single specified + [IPSecConnection](#/en/iaas/latest/IPSecConnection/) object. Here are other similar + operations: + + * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent) + returns CPE configuration content for a specific tunnel within an IPSec connection. + * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent) + returns CPE configuration content for *all* IPSec connections that use a specific CPE. + operationId: GetIpsecCpeDeviceConfigContent + parameters: + - $ref: '#/components/parameters/IPSecConnectionIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The information was retrieved. + 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: + text/plain; charset=utf-8: + schema: + format: binary + type: string + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetIpsecCpeDeviceConfigContent + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/IPSecConnection' + /ipsecConnections/{ipscId}/deviceConfig: + get: + description: | + Deprecated. To get tunnel information, instead use: + + * [GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel) + * [GetIPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/GetIPSecConnectionTunnelSharedSecret) + operationId: GetIPSecConnectionDeviceConfig + parameters: + - $ref: '#/components/parameters/IPSecConnectionIdPathParam' + responses: + '200': + description: The configuration information was retrieved. + 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/IPSecConnectionDeviceConfig' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetIPSecConnectionDeviceConfig + tags: + - virtualNetwork + x-example: | + GET /20160918/ipsecConnections/<ipscId>/deviceConfig + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-client-retries-enabled: true + /ipsecConnections/{ipscId}/deviceStatus: + get: + description: | + Deprecated. To get the tunnel status, instead use + [GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel). + operationId: GetIPSecConnectionDeviceStatus + parameters: + - $ref: '#/components/parameters/IPSecConnectionIdPathParam' + responses: + '200': + description: The status was retrieved. + 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/IPSecConnectionDeviceStatus' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetIPSecConnectionDeviceStatus + tags: + - virtualNetwork + x-example: | + GET /20160918/ipsecConnections/<ipscId>/deviceStatus + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-client-retries-enabled: true + /ipsecConnections/{ipscId}/tunnels: + get: + description: | + Lists the tunnel information for the specified IPSec connection. + operationId: ListIPSecConnectionTunnels + parameters: + - $ref: '#/components/parameters/IPSecConnectionIdPathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListIPSecConnectionTunnelsResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListIPSecConnectionTunnels + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /ipsecConnections/{ipscId}/tunnels/{tunnelId}: + get: + description: | + Gets the specified tunnel's information. The resulting object does not include the tunnel's + shared secret (pre-shared key). To retrieve that, use + [GetIPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/GetIPSecConnectionTunnelSharedSecret). + operationId: GetIPSecConnectionTunnel + parameters: + - $ref: '#/components/parameters/IPSecConnectionIdPathParam' + - $ref: '#/components/parameters/IPSecConnectionTunnelIdPathParam' + responses: + '200': + description: The information was retrieved. + 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/IPSecConnectionTunnel' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetIPSecConnectionTunnel + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + put: + description: | + Updates the specified tunnel. This operation lets you change tunnel attributes such as the + routing type (BGP dynamic routing or static routing). Here are some important notes: + + * If you change the tunnel's routing type or BGP session configuration, the tunnel will go + down while it's reprovisioned. + + * If you want to switch the tunnel's `routing` from `STATIC` to `BGP`, make sure the tunnel's + BGP session configuration attributes have been set ([bgpSessionConfig](#/en/iaas/latest/datatypes/BgpSessionInfo)). + + * If you want to switch the tunnel's `routing` from `BGP` to `STATIC`, make sure the + [IPSecConnection](#/en/iaas/latest/IPSecConnection/) already has at least one valid CIDR + static route. + operationId: UpdateIPSecConnectionTunnel + parameters: + - $ref: '#/components/parameters/IPSecConnectionIdPathParam' + - $ref: '#/components/parameters/IPSecConnectionTunnelIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateIPSecConnectionTunnelDetails' + description: Details object for updating a IPSecConnection tunnel's details. + required: true + responses: + '200': + description: The IPSec connection tunnel was updated. + 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/IPSecConnectionTunnel' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateIPSecConnectionTunnelDetails + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /ipsecConnections/{ipscId}/tunnels/{tunnelId}/error: + get: + description: | + Gets the identified error for the specified IPSec tunnel ID. + operationId: GetIPSecConnectionTunnelError + parameters: + - $ref: '#/components/parameters/IPSecConnectionIdPathParam' + - $ref: '#/components/parameters/IPSecConnectionTunnelIdPathParam' + responses: + '200': + description: The tunnel error was successfully returned. + 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/IPSecConnectionTunnelErrorDetails' + '204': + description: No tunnel errors found. + 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetIPSecConnectionTunnelError + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /ipsecConnections/{ipscId}/tunnels/{tunnelId}/routes: + get: + description: | + The routes advertised to the on-premises network and the routes received from the on-premises network. + operationId: ListIPSecConnectionTunnelRoutes + parameters: + - $ref: '#/components/parameters/IPSecConnectionIdPathParam' + - $ref: '#/components/parameters/IPSecConnectionTunnelIdPathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/BgpRouteAdvertiserQueryParam' + responses: + '200': + description: The tunnel routes were retrieved. + 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 + opc-total-items: + description: | + For list pagination. A pagination token to get the total number of results available. + schema: + type: integer + content: + application/json: + schema: + $ref: '#/components/schemas/ListIPSecConnectionTunnelRoutesResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListIPSecConnectionTunnelRoutes + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /ipsecConnections/{ipscId}/tunnels/{tunnelId}/sharedSecret: + get: + description: | + Gets the specified tunnel's shared secret (pre-shared key). To get other information + about the tunnel, use [GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel). + operationId: GetIPSecConnectionTunnelSharedSecret + parameters: + - $ref: '#/components/parameters/IPSecConnectionIdPathParam' + - $ref: '#/components/parameters/IPSecConnectionTunnelIdPathParam' + responses: + '200': + description: The information was retrieved. + 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/IPSecConnectionTunnelSharedSecret' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetIPSecConnectionTunnelSharedSecret + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + put: + description: | + Updates the shared secret (pre-shared key) for the specified tunnel. + + **Important:** If you change the shared secret, the tunnel will go down while it's reprovisioned. + operationId: UpdateIPSecConnectionTunnelSharedSecret + parameters: + - $ref: '#/components/parameters/IPSecConnectionIdPathParam' + - $ref: '#/components/parameters/IPSecConnectionTunnelIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateIPSecConnectionTunnelSharedSecretDetails' + description: Details object for updating a IPSec connection tunnel's sharedSecret. + required: true + responses: + '200': + description: The IPSec connection tunnel's shared secret was updated. + 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/IPSecConnectionTunnelSharedSecret' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateIPSecConnectionTunnelSharedSecret + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelDeviceConfig: + get: + description: | + Gets the set of CPE configuration answers for the tunnel, which the customer provided in + [UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig). + To get the full set of content for the tunnel (any answers merged with the template of other + information specific to the CPE device type), use + [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent). + operationId: GetTunnelCpeDeviceConfig + parameters: + - $ref: '#/components/parameters/IPSecConnectionIdPathParam' + - $ref: '#/components/parameters/IPSecConnectionTunnelIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The information was retrieved. + 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/TunnelCpeDeviceConfig' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetTunnelCpeDeviceConfig + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/TunnelCpeDeviceConfig' + put: + description: | + Creates or updates the set of CPE configuration answers for the specified tunnel. + The answers correlate to the questions that are specific to the CPE device type (see the + `parameters` attribute of [CpeDeviceShapeDetail](#/en/iaas/latest/CpeDeviceShapeDetail/)). + operationId: UpdateTunnelCpeDeviceConfig + parameters: + - $ref: '#/components/parameters/IPSecConnectionIdPathParam' + - $ref: '#/components/parameters/IPSecConnectionTunnelIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateTunnelCpeDeviceConfigDetails' + description: Request to input the tunnel's cpe configuration parameters + required: true + responses: + '200': + description: Updating the Tunnel CpeDevice Config Details. + 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/TunnelCpeDeviceConfig' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateTunnelCpeDeviceConfig + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelDeviceConfig/content: + get: + description: | + Renders a set of CPE configuration content for the specified IPSec tunnel. The content helps a + network engineer configure the actual CPE device (for example, a hardware router) that the specified + IPSec tunnel terminates on. + + The rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the + [Cpe](#/en/iaas/latest/Cpe/) used by the specified [IPSecConnection](#/en/iaas/latest/IPSecConnection/) + must have the CPE's device type specified by the `cpeDeviceShapeId` attribute. The content + optionally includes answers that the customer provides (see + [UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)), + merged with a template of other information specific to the CPE device type. + + The operation returns configuration information for only the specified IPSec tunnel. + Here are other similar operations: + + * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent) + returns CPE configuration content for all tunnels in a single IPSec connection. + * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent) + returns CPE configuration content for *all* IPSec connections that use a specific CPE. + operationId: GetTunnelCpeDeviceConfigContent + parameters: + - $ref: '#/components/parameters/IPSecConnectionIdPathParam' + - $ref: '#/components/parameters/IPSecConnectionTunnelIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The information was retrieved. + 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: + text/plain; charset=utf-8: + schema: + format: binary + type: string + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetTunnelCpeDeviceConfigContent + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/TunnelCpeDeviceConfig' + /ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelSecurityAssociations: + get: + description: | + Lists the tunnel security associations information for the specified IPSec tunnel ID. + operationId: ListIPSecConnectionTunnelSecurityAssociations + parameters: + - $ref: '#/components/parameters/IPSecConnectionIdPathParam' + - $ref: '#/components/parameters/IPSecConnectionTunnelIdPathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: The list is retrieved. + 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 + opc-total-items: + description: | + For list pagination. A pagination token to get the total number of results available. + schema: + type: integer + content: + application/json: + schema: + $ref: '#/components/schemas/ListIPSecConnectionTunnelSecurityAssociationsResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListIPSecConnectionTunnelSecurityAssociations + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /ipv6: + get: + description: | + Lists the [IPv6](#/en/iaas/latest/Ipv6/) objects based + on one of these filters: + + * Subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm). + * VNIC [OCID](/iaas/Content/General/Concepts/identifiers.htm). + * Both IPv6 address and subnet OCID: This lets you get an `Ipv6` object based on its private + IPv6 address (for example, 2001:0db8:0123:1111:abcd:ef01:2345:6789) and not its [OCID](/iaas/Content/General/Concepts/identifiers.htm). For comparison, + [GetIpv6](#/en/iaas/latest/Ipv6/GetIpv6) requires the [OCID](/iaas/Content/General/Concepts/identifiers.htm). + operationId: ListIpv6s + parameters: + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/IpAddressOptionalQueryParam' + - $ref: '#/components/parameters/SubnetIdOptionalQueryParam' + - $ref: '#/components/parameters/VnicIdOptionalQueryParam' + - $ref: '#/components/parameters/IpStateOptionalQueryParam' + - $ref: '#/components/parameters/LifetimeOptionalQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The list is being retrieved. + 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/ListIpv6sResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListIpv6s + tags: + - virtualNetwork + post: + description: | + Creates an IPv6 for the specified VNIC. + operationId: CreateIpv6 + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateIpv6Details' + description: Create IPv6 details. + required: true + responses: + '200': + description: The IPv6 was created. + 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/Ipv6' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateIpv6 + tags: + - virtualNetwork + /ipv6/actions/bulkCreateIpv6s: + post: + description: | + Create new IPv6s in bulk for a VNIC or subnet. + operationId: BulkCreateIpv6s + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BulkCreateIpv6sDetails' + description: Create Ipv6s in bulk. + required: true + responses: + '202': + description: The request to create IPv6s in bulk was successfully received. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: BulkCreateIpv6s + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/Ipv6' + /ipv6/actions/bulkDeleteIpv6s: + post: + description: | + Unassign and delete IPv6s for a VNIC in bulk. + operationId: BulkDeleteIpv6s + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BulkDeleteIpv6sDetails' + description: Details of the IPv6s to delete. + required: true + responses: + '202': + description: The request to delete IPv6s in bulk was successfully received. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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/404' + '412': + $ref: '#/components/responses/412' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: BulkDeleteIpv6s + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/Ipv6' + /ipv6/actions/bulkDetachIpv6s: + post: + description: | + Detach the specified IPv6s. + operationId: BulkDetachIpv6s + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BulkDetachIpv6sDetails' + description: Details needed to detach IPv6s in bulk. + required: true + responses: + '202': + description: The request to detach IPv6s in bulk was successfully received. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: BulkDetachIpv6s + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/Ipv6' + /ipv6/actions/bulkUpdateIpv6s: + post: + description: | + Updates the specified IPv6s in bulk. + operationId: BulkUpdateIpv6s + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BulkUpdateIpv6sDetails' + description: Details of the IPv6s to update. + required: true + responses: + '202': + description: The request to update IPv6s in bulk was successfully received. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: BulkUpdateIpv6s + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/Ipv6' + /ipv6/{ipv6Id}: + delete: + description: | + Unassigns and deletes the specified IPv6. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). + The IPv6 address is returned to the subnet's pool of available addresses. + operationId: DeleteIpv6 + parameters: + - $ref: '#/components/parameters/Ipv6IdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '204': + description: The IPv6 was 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteIpv6 + tags: + - virtualNetwork + get: + description: | + Gets the specified IPv6. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). + Alternatively, you can get the object by using + [ListIpv6s](#/en/iaas/latest/Ipv6/ListIpv6s) + with the IPv6 address (for example, 2001:0db8:0123:1111:98fe:dcba:9876:4321) and subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm). + operationId: GetIpv6 + parameters: + - $ref: '#/components/parameters/Ipv6IdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The IPv6 was retrievd. + 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/Ipv6' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetIpv6 + tags: + - virtualNetwork + put: + description: | + Updates the specified IPv6. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). + Use this operation if you want to: + + * Move an IPv6 to a different VNIC in the same subnet. + * Enable/disable internet access for an IPv6. + * Change the display name for an IPv6. + * Update resource tags for an IPv6. + operationId: UpdateIpv6 + parameters: + - $ref: '#/components/parameters/Ipv6IdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateIpv6Details' + description: IPv6 details to be updated. + required: true + responses: + '200': + description: The IPv6 was updated. + 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/Ipv6' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateIpv6 + tags: + - virtualNetwork + /ipv6/{ipv6Id}/actions/detach: + post: + description: | + Unassign the specified IPv6 address from Virtual Network Interface Card (VNIC). You must specify the IPv6 [OCID](/iaas/Content/General/Concepts/identifiers.htm). + operationId: Ipv6VnicDetach + parameters: + - $ref: '#/components/parameters/Ipv6IdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '200': + description: The IPv6 was detached. + 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/Ipv6' + '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/DefaultError' + summary: Ipv6VnicDetach + tags: + - virtualNetwork + x-obmcs-terraform: + actionType: UPDATE_FIELD + x-related-resource: '#/definitions/Ipv6' + /localPeeringGateways: + get: + description: | + Lists the local peering gateways (LPGs) for the specified VCN and specified compartment. + If the VCN ID is not provided, then the list includes the LPGs from all VCNs in the specified compartment. + operationId: ListLocalPeeringGateways + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/VcnIdOptionalQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListLocalPeeringGatewaysResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListLocalPeeringGateways + tags: + - virtualNetwork + post: + description: | + Creates a new local peering gateway (LPG) for the specified VCN. + operationId: CreateLocalPeeringGateway + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateLocalPeeringGatewayDetails' + description: Details for creating a new local peering gateway. + required: true + responses: + '200': + description: The local peering gateway was created. + 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/LocalPeeringGateway' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateLocalPeeringGateway + tags: + - virtualNetwork + /localPeeringGateways/{localPeeringGatewayId}: + delete: + description: | + Deletes the specified local peering gateway (LPG). + + This is an asynchronous operation; the local peering gateway's `lifecycleState` changes to TERMINATING temporarily + until the local peering gateway is completely removed. + operationId: DeleteLocalPeeringGateway + parameters: + - $ref: '#/components/parameters/LocalPeeringGatewayIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The local peering gateway is being 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteLocalPeeringGateway + tags: + - virtualNetwork + get: + description: Gets the specified local peering gateway's information. + operationId: GetLocalPeeringGateway + parameters: + - $ref: '#/components/parameters/LocalPeeringGatewayIdPathParam' + responses: + '200': + description: The local peering gateway was retrieved. + 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/LocalPeeringGateway' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetLocalPeeringGateway + tags: + - virtualNetwork + put: + description: | + Updates the specified local peering gateway (LPG). + operationId: UpdateLocalPeeringGateway + parameters: + - $ref: '#/components/parameters/LocalPeeringGatewayIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateLocalPeeringGatewayDetails' + description: Details object for updating a local peering gateway. + required: true + responses: + '200': + description: The local peering gateway was updated. + 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/LocalPeeringGateway' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateLocalPeeringGateway + tags: + - virtualNetwork + /localPeeringGateways/{localPeeringGatewayId}/actions/changeCompartment: + post: + description: | + Moves a local peering gateway into a different compartment within the same tenancy. For information + about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeLocalPeeringGatewayCompartment + parameters: + - $ref: '#/components/parameters/LocalPeeringGatewayIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeLocalPeeringGatewayCompartmentDetails' + description: Request to change the compartment of a given local peering gateway. + required: true + responses: + '204': + description: The local peering gateway has been moved to the specified compartment. + 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeLocalPeeringGatewayCompartment + tags: + - virtualNetwork + x-related-resource: '#/definitions/LocalPeeringGateway' + /localPeeringGateways/{localPeeringGatewayId}/actions/connect: + post: + description: | + Connects this local peering gateway (LPG) to another one in the same region. + + This operation must be called by the VCN administrator who is designated as + the *requestor* in the peering relationship. The *acceptor* must implement + an Identity and Access Management (IAM) policy that gives the requestor permission + to connect to LPGs in the acceptor's compartment. Without that permission, this + operation will fail. For more information, see + [VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm). + operationId: ConnectLocalPeeringGateways + parameters: + - $ref: '#/components/parameters/LocalPeeringGatewayIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConnectLocalPeeringGatewaysDetails' + description: Details regarding the local peering gateway to connect. + required: true + responses: + '204': + description: The connect request was accepted and a peering is being established. + 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 + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ConnectLocalPeeringGateways + tags: + - virtualNetwork + x-related-resource: '#/definitions/LocalPeeringGateway' + /natGateways: + get: + description: | + Lists the NAT gateways in the specified compartment. You may optionally specify a VCN OCID + to filter the results by VCN. + operationId: ListNatGateways + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/VcnIdOptionalQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to return only resources that match the specified lifecycle + state. The value is case insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/NatGateway/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListNatGatewaysResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListNatGateways + tags: + - virtualNetwork + post: + description: | + Creates a new NAT gateway for the specified VCN. You must also set up a route rule with the + NAT gateway as the rule's target. See [Route Table](#/en/iaas/latest/RouteTable/). + operationId: CreateNatGateway + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateNatGatewayDetails' + description: Details for creating a NAT gateway. + required: true + responses: + '200': + description: The NAT gateway was created. + 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/NatGateway' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateNatGateway + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /natGateways/{natGatewayId}: + delete: + description: | + Deletes the specified NAT gateway. The NAT gateway does not have to be disabled, but there + must not be a route rule that lists the NAT gateway as a target. + + This is an asynchronous operation. The NAT gateway's `lifecycleState` will change to + TERMINATING temporarily until the NAT gateway is completely removed. + operationId: DeleteNatGateway + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/NatGatewayIdPathParam' + responses: + '204': + description: The NAT gateway is being 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteNatGateway + tags: + - virtualNetwork + get: + description: Gets the specified NAT gateway's information. + operationId: GetNatGateway + parameters: + - $ref: '#/components/parameters/NatGatewayIdPathParam' + responses: + '200': + description: The NAT gateway was retrieved. + 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/NatGateway' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetNatGateway + tags: + - virtualNetwork + put: + description: | + Updates the specified NAT gateway. + operationId: UpdateNatGateway + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/NatGatewayIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateNatGatewayDetails' + description: Details object for updating a NAT gateway. + required: true + responses: + '200': + description: The NAT gateway was updated. + 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/NatGateway' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateNatGateway + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /natGateways/{natGatewayId}/actions/changeCompartment: + post: + description: | + Moves a NAT gateway into a different compartment within the same tenancy. For information + about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeNatGatewayCompartment + parameters: + - $ref: '#/components/parameters/NatGatewayIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeNatGatewayCompartmentDetails' + description: Request to change the compartment of a given NAT Gateway. + required: true + responses: + '204': + description: The NAT gateway has been moved to the specified compartment. + 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 + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeNatGatewayCompartment + tags: + - virtualNetwork + x-related-resource: '#/definitions/NatGateway' + x-obmcs-client-retries-enabled: true + /networkSecurityGroups: + get: + description: | + Lists either the network security groups in the specified compartment, or those associated with the specified VLAN. + You must specify either a `vlanId` or a `compartmentId`, but not both. If you specify a `vlanId`, all other parameters are ignored. + operationId: ListNetworkSecurityGroups + parameters: + - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' + - $ref: '#/components/parameters/VlanIdOptionalQueryParam' + - $ref: '#/components/parameters/VcnIdOptionalQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to return only resources that match the specified lifecycle + state. The value is case insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/NetworkSecurityGroup/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListNetworkSecurityGroupsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListNetworkSecurityGroups + tags: + - virtualNetwork + post: + description: | + Creates a new network security group for the specified VCN. + operationId: CreateNetworkSecurityGroup + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateNetworkSecurityGroupDetails' + description: Details for creating a network security group. + required: true + responses: + '200': + description: The network security group was created. + 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/NetworkSecurityGroup' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateNetworkSecurityGroup + tags: + - virtualNetwork + /networkSecurityGroups/{networkSecurityGroupId}: + delete: + description: | + Deletes the specified network security group. The group must not contain any VNICs. + + To get a list of the VNICs in a network security group, use + [ListNetworkSecurityGroupVnics](#/en/iaas/latest/NetworkSecurityGroupVnic/ListNetworkSecurityGroupVnics). + Each returned [NetworkSecurityGroupVnic](#/en/iaas/latest/NetworkSecurityGroupVnic/) object + contains both the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC and the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC's parent resource (for example, + the Compute instance that the VNIC is attached to). + operationId: DeleteNetworkSecurityGroup + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/NetworkSecurityGroupIdPathParam' + responses: + '204': + description: The network security group was 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteNetworkSecurityGroup + tags: + - virtualNetwork + x-related-resource: '#/definitions/NetworkSecurityGroup' + get: + description: | + Gets the specified network security group's information. + + To list the VNICs in an NSG, see + [ListNetworkSecurityGroupVnics](#/en/iaas/latest/NetworkSecurityGroupVnic/ListNetworkSecurityGroupVnics). + + To list the security rules in an NSG, see + [ListNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/ListNetworkSecurityGroupSecurityRules). + operationId: GetNetworkSecurityGroup + parameters: + - $ref: '#/components/parameters/NetworkSecurityGroupIdPathParam' + responses: + '200': + description: The network security group was retrieved. + 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/NetworkSecurityGroup' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetNetworkSecurityGroup + tags: + - virtualNetwork + put: + description: | + Updates the specified network security group. + + To add or remove an existing VNIC from the group, use + [UpdateVnic](#/en/iaas/latest/Vnic/UpdateVnic). + + To add a VNIC to the group *when you create the VNIC*, specify the NSG's [OCID](/iaas/Content/General/Concepts/identifiers.htm) during creation. + For example, see the `nsgIds` attribute in [CreateVnicDetails](#/en/iaas/latest/datatypes/CreateVnicDetails). + + To add or remove security rules from the group, use + [AddNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/AddNetworkSecurityGroupSecurityRules) + or + [RemoveNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/RemoveNetworkSecurityGroupSecurityRules). + + To edit the contents of existing security rules in the group, use + [UpdateNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/UpdateNetworkSecurityGroupSecurityRules). + operationId: UpdateNetworkSecurityGroup + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/NetworkSecurityGroupIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateNetworkSecurityGroupDetails' + description: Details object for updating a network security group. + required: true + responses: + '200': + description: The network security group was updated. + 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/NetworkSecurityGroup' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateNetworkSecurityGroup + tags: + - virtualNetwork + /networkSecurityGroups/{networkSecurityGroupId}/actions/addSecurityRules: + post: + description: | + Adds up to 25 security rules to the specified network security group. Adding more than 25 rules requires multiple operations. + operationId: AddNetworkSecurityGroupSecurityRules + parameters: + - $ref: '#/components/parameters/NetworkSecurityGroupIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddNetworkSecurityGroupSecurityRulesDetails' + description: Request with one or more security rules to be associated with the network security group. + required: true + responses: + '200': + description: The security rules were added. + 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/AddedNetworkSecurityGroupSecurityRules' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: AddNetworkSecurityGroupSecurityRules + tags: + - virtualNetwork + x-related-resource: '#/definitions/SecurityRule' + /networkSecurityGroups/{networkSecurityGroupId}/actions/changeCompartment: + post: + description: | + Moves a network security group into a different compartment within the same tenancy. For + information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeNetworkSecurityGroupCompartment + parameters: + - $ref: '#/components/parameters/NetworkSecurityGroupIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeNetworkSecurityGroupCompartmentDetails' + description: Request to change the compartment of a network security group. + required: true + responses: + '204': + description: The network security group has been moved to the specified compartment. + 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeNetworkSecurityGroupCompartment + tags: + - virtualNetwork + x-related-resource: '#/definitions/NetworkSecurityGroup' + /networkSecurityGroups/{networkSecurityGroupId}/actions/removeSecurityRules: + post: + description: | + Removes one or more security rules from the specified network security group. + operationId: RemoveNetworkSecurityGroupSecurityRules + parameters: + - $ref: '#/components/parameters/NetworkSecurityGroupIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveNetworkSecurityGroupSecurityRulesDetails' + description: | + Request with one or more security rules associated with the network security group that + will be removed. + required: true + responses: + '200': + description: The security rules are being 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: RemoveNetworkSecurityGroupSecurityRules + tags: + - virtualNetwork + x-related-resource: '#/definitions/SecurityRule' + /networkSecurityGroups/{networkSecurityGroupId}/actions/updateSecurityRules: + post: + description: | + Updates one or more security rules in the specified network security group. + operationId: UpdateNetworkSecurityGroupSecurityRules + parameters: + - $ref: '#/components/parameters/NetworkSecurityGroupIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateNetworkSecurityGroupSecurityRulesDetails' + description: | + Request with one or more security rules associated with the network security group that + will be updated. + required: true + responses: + '200': + description: The security rules were 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 + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatedNetworkSecurityGroupSecurityRules' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateNetworkSecurityGroupSecurityRules + tags: + - virtualNetwork + x-related-resource: '#/definitions/SecurityRule' + /networkSecurityGroups/{networkSecurityGroupId}/securityRules: + get: + description: | + Lists the security rules in the specified network security group. + operationId: ListNetworkSecurityGroupSecurityRules + parameters: + - $ref: '#/components/parameters/NetworkSecurityGroupIdPathParam' + - $ref: '#/components/parameters/SecurityRuleDirectionOptionalQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/ListNetworkSecurityGroupSecurityRulesSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListNetworkSecurityGroupSecurityRulesResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListNetworkSecurityGroupSecurityRules + tags: + - virtualNetwork + /networkSecurityGroups/{networkSecurityGroupId}/vnics: + get: + description: | + Lists the VNICs in the specified network security group. + operationId: ListNetworkSecurityGroupVnics + parameters: + - $ref: '#/components/parameters/NetworkSecurityGroupIdPathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/ListNetworkSecurityGroupVnicsSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListNetworkSecurityGroupVnicsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListNetworkSecurityGroupVnics + tags: + - virtualNetwork + /networkingTopology: + get: + description: Gets a virtual networking topology for the current region. + operationId: GetNetworkingTopology + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/AccessLevelQueryParam' + - $ref: '#/components/parameters/QueryCompartmentSubtreeQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfNoneMatchHeader' + - $ref: '#/components/parameters/CacheControlHeader' + responses: + '200': + description: The topology was successfully returned. + 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/NetworkingTopology' + '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/DefaultError' + summary: Get a Virtual Networking topology for the current region + tags: + - virtualNetwork + /privateIps: + get: + description: | + Lists the [PrivateIp](#/en/iaas/latest/PrivateIp/) objects based + on one of these filters: + + - Subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm). + - VNIC [OCID](/iaas/Content/General/Concepts/identifiers.htm). + - Both private IP address and subnet OCID: This lets + you get a `privateIP` object based on its private IP + address (for example, 10.0.3.3) and not its [OCID](/iaas/Content/General/Concepts/identifiers.htm). For comparison, + [GetPrivateIp](#/en/iaas/latest/PrivateIp/GetPrivateIp) + requires the [OCID](/iaas/Content/General/Concepts/identifiers.htm). + + If you're listing all the private IPs associated with a given subnet + or VNIC, the response includes both primary and secondary private IPs. + + If you are an Oracle Cloud VMware Solution customer and have VLANs + in your VCN, you can filter the list by VLAN [OCID](/iaas/Content/General/Concepts/identifiers.htm). See [Vlan](#/en/iaas/latest/Vlan). + operationId: ListPrivateIps + parameters: + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/IpAddressOptionalQueryParam' + - $ref: '#/components/parameters/SubnetIdOptionalQueryParam' + - $ref: '#/components/parameters/VnicIdOptionalQueryParam' + - $ref: '#/components/parameters/IpStateOptionalQueryParam' + - $ref: '#/components/parameters/LifetimeOptionalQueryParam' + - $ref: '#/components/parameters/VlanIdOptionalQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListPrivateIpsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListPrivateIps + tags: + - virtualNetwork + post: + description: | + Creates a private IP. + For more information about private IPs, see + [IP Addresses](/iaas/Content/Network/Tasks/managingIPaddresses.htm). + operationId: CreatePrivateIp + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePrivateIpDetails' + description: Create private IP details. + required: true + responses: + '200': + description: The private IP was created. + 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/PrivateIp' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreatePrivateIp + tags: + - virtualNetwork + /privateIps/actions/bulkCreatePrivateIps: + post: + description: | + Create secondary private IPv4 addresses. + operationId: BulkCreatePrivateIps + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BulkCreatePrivateIpsDetails' + description: Details used to create secondary private IPs. + required: true + responses: + '202': + description: The request to create private IPs in bulk was received. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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/DefaultError' + summary: BulkCreatePrivateIps + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/PrivateIp' + /privateIps/actions/bulkDeletePrivateIps: + post: + description: | + Unassign and delete secondary private IPv4s for a VNIC. + operationId: BulkDeletePrivateIps + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BulkDeletePrivateIpsDetails' + description: Details of the secondary IPv4 addresses to delete. + required: true + responses: + '202': + description: The request to bulk delete private IPs was received. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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/DefaultError' + summary: BulkDeletePrivateIps + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/PrivateIp' + /privateIps/actions/bulkDetachPrivateIps: + post: + description: | + Unassign the specified private IP addresses from the Virtual Network Interface Card (VNIC). You must specify the PrivateIP object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). + operationId: BulkDetachPrivateIps + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BulkDetachPrivateIpsDetails' + description: The secondary IPv4 addresses to detach. + required: true + responses: + '202': + description: The request to bulk detach private IPs was received. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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/DefaultError' + summary: DetachPrivateIps + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/PrivateIp' + /privateIps/actions/bulkUpdatePrivateIps: + post: + description: Update existing secondary private IPv4s for a VNIC. + operationId: BulkUpdatePrivateIps + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BulkUpdatePrivateIpsDetails' + description: Details of the secondary IPv4 addresses to update. + required: true + responses: + '202': + description: The request to bulk update Private IPs was received. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdatePrivateIps + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-obmcs-terraform: + actionType: SPECIAL_UPDATE + x-related-resource: '#/definitions/PrivateIp' + /privateIps/{privateIpId}: + delete: + description: | + Unassigns and deletes the specified private IP. You must + specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). The private IP address is returned to + the subnet's pool of available addresses. + + This operation cannot be used with primary private IPs, which are + automatically unassigned and deleted when the VNIC is terminated. + + **Important:** If a secondary private IP is the + [target of a route rule](/iaas/Content/Network/Tasks/managingroutetables.htm#privateip), + unassigning it from the VNIC causes that route rule to blackhole and the traffic + will be dropped. + operationId: DeletePrivateIp + parameters: + - $ref: '#/components/parameters/PrivateIpIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The private IP is being 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeletePrivateIp + tags: + - virtualNetwork + get: + description: | + Gets the specified private IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). + Alternatively, you can get the object by using + [ListPrivateIps](#/en/iaas/latest/PrivateIp/ListPrivateIps) + with the private IP address (for example, 10.0.3.3) and subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm). + operationId: GetPrivateIp + parameters: + - $ref: '#/components/parameters/PrivateIpIdPathParam' + responses: + '200': + description: The private IP. + 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/PrivateIp' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetPrivateIp + tags: + - virtualNetwork + put: + description: | + Updates the specified private IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). + Use this operation if you want to: + + - Move a secondary private IP to a different VNIC in the same subnet. + - Change the display name for a secondary private IP. + - Change the hostname for a secondary private IP. + + This operation cannot be used with primary private IPs. + To update the hostname for the primary IP on a VNIC, use + [UpdateVnic](#/en/iaas/latest/Vnic/UpdateVnic). + operationId: UpdatePrivateIp + parameters: + - $ref: '#/components/parameters/PrivateIpIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePrivateIpDetails' + description: Private IP details. + required: true + responses: + '200': + description: The private IP was updated. + 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/PrivateIp' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdatePrivateIp + tags: + - virtualNetwork + /privateIps/{privateIpId}/actions/detach: + post: + description: | + Unassign the specified PrivateIP address from Virtual Network Interface Card (VNIC). You must specify the PrivateIP [OCID](/iaas/Content/General/Concepts/identifiers.htm). + operationId: PrivateIpVnicDetach + parameters: + - $ref: '#/components/parameters/PrivateIpIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + responses: + '200': + description: The private IP was detached. + 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/PrivateIp' + '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/DefaultError' + summary: PrivateIpVnicDetach + tags: + - virtualNetwork + x-obmcs-terraform: + actionType: UPDATE_FIELD + x-related-resource: '#/definitions/PrivateIp' + /publicIpPools: + get: + description: | + Lists the public IP pools in the specified compartment. + You can filter the list using query parameters. + operationId: ListPublicIpPools + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/FilterByByoipRangeIdQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/PublicIpPoolCollection' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListPublicIpPools + tags: + - virtualNetwork + x-related-resource: '#/definitions/PublicIpPool' + post: + description: | + Creates a public IP pool. + operationId: CreatePublicIpPool + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePublicIpPoolDetails' + description: Create Public Ip Pool details + required: true + responses: + '200': + description: The public IP pool was created. + 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/PublicIpPool' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreatePublicIpPool + tags: + - virtualNetwork + /publicIpPools/{publicIpPoolId}: + delete: + description: | + Deletes the specified public IP pool. + To delete a public IP pool it must not have any active IP address allocations. + You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm) when deleting an IP pool. + operationId: DeletePublicIpPool + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/PublicIpPoolIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The public IP pool was 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeletePublicIpPool + tags: + - virtualNetwork + x-related-resource: '#/definitions/PublicIpPool' + get: + description: | + Gets the specified `PublicIpPool` object. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). + operationId: GetPublicIpPool + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/PublicIpPoolIdPathParam' + responses: + '200': + description: The `PublicIpPool` object was retrieved. + 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/PublicIpPool' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetPublicIpPool + tags: + - virtualNetwork + put: + description: | + Updates the specified public IP pool. + operationId: UpdatePublicIpPool + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/PublicIpPoolIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePublicIpPoolDetails' + description: Public IP pool details. + required: true + responses: + '200': + description: The public IP pool was updated. + 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/PublicIpPool' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdatePublicIpPool + tags: + - virtualNetwork + /publicIpPools/{publicIpPoolId}/actions/addCapacity: + post: + description: | + Adds some or all of a CIDR block to a public IP pool. + + The CIDR block (or subrange) must not overlap with any other CIDR block already added to this or any other public IP pool. + operationId: AddPublicIpPoolCapacity + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/PublicIpPoolIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddPublicIpPoolCapacityDetails' + description: Byoip Range prefix and a cidr from it + required: true + responses: + '200': + description: The CIDR block was added to the IP pool. + 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/PublicIpPool' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: AddPublicIpPoolCapacity + tags: + - virtualNetwork + x-related-resource: '#/definitions/PublicIpPool' + /publicIpPools/{publicIpPoolId}/actions/changeCompartment: + post: + description: | + Moves a public IP pool to a different compartment. For information + about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangePublicIpPoolCompartment + parameters: + - $ref: '#/components/parameters/PublicIpPoolIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangePublicIpPoolCompartmentDetails' + description: Request to change the compartment of a public IP pool. + required: true + responses: + '204': + description: The public IP Pool was moved to the specified 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangePublicIpPoolCompartment + tags: + - virtualNetwork + x-related-resource: '#/definitions/PublicIpPool' + /publicIpPools/{publicIpPoolId}/actions/removeCapacity: + post: + description: | + Removes a CIDR block from the referenced public IP pool. + operationId: RemovePublicIpPoolCapacity + parameters: + - $ref: '#/components/parameters/PublicIpPoolIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemovePublicIpPoolCapacityDetails' + description: The CIDR block to remove from the IP pool. + required: true + responses: + '200': + description: The CIDR block was removed from the IP pool. + 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/PublicIpPool' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: RemovePublicIpPoolCapacity + tags: + - virtualNetwork + x-related-resource: '#/definitions/PublicIpPool' + /publicIps: + get: + description: | + Lists the [PublicIp](#/en/iaas/latest/PublicIp/) objects + in the specified compartment. You can filter the list by using query parameters. + + To list your reserved public IPs: + * Set `scope` = `REGION` (required) + * Leave the `availabilityDomain` parameter empty + * Set `lifetime` = `RESERVED` + + To list the ephemeral public IPs assigned to a regional entity such as a NAT gateway: + * Set `scope` = `REGION` (required) + * Leave the `availabilityDomain` parameter empty + * Set `lifetime` = `EPHEMERAL` + + To list the ephemeral public IPs assigned to private IPs: + * Set `scope` = `AVAILABILITY_DOMAIN` (required) + * Set the `availabilityDomain` parameter to the desired availability domain (required) + * Set `lifetime` = `EPHEMERAL` + + **Note:** An ephemeral public IP assigned to a private IP + is always in the same availability domain and compartment as the private IP. + operationId: ListPublicIps + parameters: + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PublicIpScopeQueryParam' + - $ref: '#/components/parameters/AvailabilityDomainQueryParam' + - $ref: '#/components/parameters/PublicIpLifetimeQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/FilterByPublicIpPoolIdQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListPublicIpsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListPublicIps + tags: + - virtualNetwork + post: + description: | + Creates a public IP. Use the `lifetime` property to specify whether it's an ephemeral or + reserved public IP. For information about limits on how many you can create, see + [Public IP Addresses](/iaas/Content/Network/Tasks/managingpublicIPs.htm). + + * **For an ephemeral public IP assigned to a private IP:** You must also specify a `privateIpId` + with the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the primary private IP you want to assign the public IP to. The public IP is + created in the same availability domain as the private IP. An ephemeral public IP must always be + assigned to a private IP, and only to the *primary* private IP on a VNIC, not a secondary + private IP. Exception: If you create a [NatGateway](#/en/iaas/latest/NatGateway/), Oracle + automatically assigns the NAT gateway a regional ephemeral public IP that you cannot remove. + + * **For a reserved public IP:** You may also optionally assign the public IP to a private + IP by specifying `privateIpId`. Or you can later assign the public IP with + [UpdatePublicIp](#/en/iaas/latest/PublicIp/UpdatePublicIp). + + **Note:** When assigning a public IP to a private IP, the private IP must not already have + a public IP with `lifecycleState` = ASSIGNING or ASSIGNED. If it does, an error is returned. + + Also, for reserved public IPs, the optional assignment part of this operation is + asynchronous. Poll the public IP's `lifecycleState` to determine if the assignment + succeeded. + operationId: CreatePublicIp + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePublicIpDetails' + description: Create public IP details. + required: true + responses: + '200': + description: The public IP was created. + 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/PublicIp' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreatePublicIp + tags: + - virtualNetwork + /publicIps/actions/getByIpAddress: + post: + description: | + Gets the public IP based on the public IP address (for example, 203.0.113.2). + + **Note:** If you're fetching a reserved public IP that is in the process of being + moved to a different private IP, the service returns the public IP object with + `lifecycleState` = ASSIGNING and `assignedEntityId` = [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target private IP. + operationId: GetPublicIpByIpAddress + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetPublicIpByIpAddressDetails' + description: IP address details for fetching the public IP. + required: true + responses: + '200': + description: The public IP was retrieved. + 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/PublicIp' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetPublicIpByIpAddress + tags: + - virtualNetwork + /publicIps/actions/getByPrivateIpId: + post: + description: | + Gets the public IP assigned to the specified private IP. You must specify the OCID + of the private IP. If no public IP is assigned, a 404 is returned. + + **Note:** If you're fetching a reserved public IP that is in the process of being + moved to a different private IP, and you provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the original private + IP, this operation returns a 404. If you instead provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target + private IP, or if you instead call + [GetPublicIp](#/en/iaas/latest/PublicIp/GetPublicIp) or + [GetPublicIpByIpAddress](#/en/iaas/latest/PublicIp/GetPublicIpByIpAddress), the + service returns the public IP object with `lifecycleState` = ASSIGNING and + `assignedEntityId` = [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target private IP. + operationId: GetPublicIpByPrivateIpId + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetPublicIpByPrivateIpIdDetails' + description: Private IP details for fetching the public IP. + required: true + responses: + '200': + description: The public IP was retrieved. + 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/PublicIp' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetPublicIpByPrivateIpId + tags: + - virtualNetwork + /publicIps/{publicIpId}: + delete: + description: | + Unassigns and deletes the specified public IP (either ephemeral or reserved). + You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). The public IP address is returned to the + Oracle Cloud Infrastructure public IP pool. + + **Note:** You cannot update, unassign, or delete the public IP that Oracle automatically + assigned to an entity for you (such as a load balancer or NAT gateway). The public IP is + automatically deleted if the assigned entity is terminated. + + For an assigned reserved public IP, the initial unassignment portion of this operation + is asynchronous. Poll the public IP's `lifecycleState` to determine + if the operation succeeded. + + If you want to simply unassign a reserved public IP and return it to your pool + of reserved public IPs, instead use + [UpdatePublicIp](#/en/iaas/latest/PublicIp/UpdatePublicIp). + operationId: DeletePublicIp + parameters: + - $ref: '#/components/parameters/PublicIpIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The public IP is being 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeletePublicIp + tags: + - virtualNetwork + get: + description: | + Gets the specified public IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). + + Alternatively, you can get the object by using [GetPublicIpByIpAddress](#/en/iaas/latest/PublicIp/GetPublicIpByIpAddress) + with the public IP address (for example, 203.0.113.2). + + Or you can use [GetPublicIpByPrivateIpId](#/en/iaas/latest/PublicIp/GetPublicIpByPrivateIpId) + with the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private IP that the public IP is assigned to. + + **Note:** If you're fetching a reserved public IP that is in the process of being + moved to a different private IP, the service returns the public IP object with + `lifecycleState` = ASSIGNING and `assignedEntityId` = [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target private IP. + operationId: GetPublicIp + parameters: + - $ref: '#/components/parameters/PublicIpIdPathParam' + responses: + '200': + description: The public IP was retrieved. + 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/PublicIp' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetPublicIp + tags: + - virtualNetwork + put: + description: | + Updates the specified public IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). Use this operation if you want to: + + * Assign a reserved public IP in your pool to a private IP. + * Move a reserved public IP to a different private IP. + * Unassign a reserved public IP from a private IP (which returns it to your pool + of reserved public IPs). + * Change the display name or tags for a public IP. + + Assigning, moving, and unassigning a reserved public IP are asynchronous + operations. Poll the public IP's `lifecycleState` to determine if the operation + succeeded. + + **Note:** When moving a reserved public IP, the target private IP + must not already have a public IP with `lifecycleState` = ASSIGNING or ASSIGNED. If it + does, an error is returned. Also, the initial unassignment from the original + private IP always succeeds, but the assignment to the target private IP is asynchronous and + could fail silently (for example, if the target private IP is deleted or has a different public IP + assigned to it in the interim). If that occurs, the public IP remains unassigned and its + `lifecycleState` switches to AVAILABLE (it is not reassigned to its original private IP). + You must poll the public IP's `lifecycleState` to determine if the move succeeded. + + Regarding ephemeral public IPs: + + * If you want to assign an ephemeral public IP to a primary private IP, use + [CreatePublicIp](#/en/iaas/latest/PublicIp/CreatePublicIp). + * You can't move an ephemeral public IP to a different private IP. + * If you want to unassign an ephemeral public IP from its private IP, use + [DeletePublicIp](#/en/iaas/latest/PublicIp/DeletePublicIp), which + unassigns and deletes the ephemeral public IP. + + **Note:** If a public IP is assigned to a secondary private + IP (see [PrivateIp](#/en/iaas/latest/PrivateIp)), and you move that secondary + private IP to another VNIC, the public IP moves with it. + + **Note:** There's a limit to the number of [public IPs](#/en/iaas/latest/PublicIp/) + a VNIC or instance can have. If you try to move a reserved public IP + to a VNIC or instance that has already reached its public IP limit, an error is + returned. For information about the public IP limits, see + [Public IP Addresses](/iaas/Content/Network/Tasks/managingpublicIPs.htm). + operationId: UpdatePublicIp + parameters: + - $ref: '#/components/parameters/PublicIpIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePublicIpDetails' + description: Public IP details. + required: true + responses: + '200': + description: The public IP was updated. + 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/PublicIp' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdatePublicIp + tags: + - virtualNetwork + /publicIps/{publicIpId}/actions/changeCompartment: + post: + description: | + Moves a public IP into a different compartment within the same tenancy. For information + about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + + This operation applies only to reserved public IPs. Ephemeral public IPs always belong to the + same compartment as their VNIC and move accordingly. + operationId: ChangePublicIpCompartment + parameters: + - $ref: '#/components/parameters/PublicIpIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangePublicIpCompartmentDetails' + description: Request to change the compartment of a Public IP. + required: true + responses: + '204': + description: The public IP has been moved to the specified compartment. + 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangePublicIpCompartment + tags: + - virtualNetwork + x-related-resource: '#/definitions/PublicIp' + /remotePeeringConnections: + get: + description: | + Lists the remote peering connections (RPCs) for the specified DRG and compartment + (the RPC's compartment). + operationId: ListRemotePeeringConnections + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/DrgIdOptionalQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListRemotePeeringConnectionsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListRemotePeeringConnections + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + post: + description: | + Creates a new remote peering connection (RPC) for the specified DRG. + operationId: CreateRemotePeeringConnection + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateRemotePeeringConnectionDetails' + description: Request to create peering connection to remote region + required: true + responses: + '200': + description: The remote peering connection was created. + 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/RemotePeeringConnection' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateRemotePeeringConnection + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /remotePeeringConnections/{remotePeeringConnectionId}: + delete: + description: | + Deletes the remote peering connection (RPC). + + This is an asynchronous operation; the RPC's `lifecycleState` changes to TERMINATING temporarily + until the RPC is completely removed. + operationId: DeleteRemotePeeringConnection + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RemotePeeringConnectionIdPathParam' + responses: + '204': + description: The RPC is being 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteRemotePeeringConnection + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + get: + description: | + Get the specified remote peering connection's information. + operationId: GetRemotePeeringConnection + parameters: + - $ref: '#/components/parameters/RemotePeeringConnectionIdPathParam' + responses: + '200': + description: The RPC was retrieved. + 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/RemotePeeringConnection' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetRemotePeeringConnection + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + put: + description: | + Updates the specified remote peering connection (RPC). + operationId: UpdateRemotePeeringConnection + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RemotePeeringConnectionIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateRemotePeeringConnectionDetails' + description: Request to the update the peering connection to remote region + required: true + responses: + '200': + description: The RPC was updated. + 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/RemotePeeringConnection' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateRemotePeeringConnection + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /remotePeeringConnections/{remotePeeringConnectionId}/actions/changeCompartment: + post: + description: | + Moves a remote peering connection (RPC) into a different compartment within the same tenancy. For information + about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeRemotePeeringConnectionCompartment + parameters: + - $ref: '#/components/parameters/RemotePeeringConnectionIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeRemotePeeringConnectionCompartmentDetails' + description: Request to change the compartment of a remote peering connection. + required: true + responses: + '204': + description: The remote peering connection has been moved to the specified compartment. + 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 + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeRemotePeeringConnectionCompartment + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/RemotePeeringConnection' + /remotePeeringConnections/{remotePeeringConnectionId}/actions/connect: + post: + description: | + Connects this RPC to another one in a different region. + + This operation must be called by the VCN administrator who is designated as + the *requestor* in the peering relationship. The *acceptor* must implement + an Identity and Access Management (IAM) policy that gives the requestor permission + to connect to RPCs in the acceptor's compartment. Without that permission, this + operation will fail. For more information, see + [VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm). + operationId: ConnectRemotePeeringConnections + parameters: + - $ref: '#/components/parameters/RemotePeeringConnectionIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConnectRemotePeeringConnectionsDetails' + description: | + Details to connect peering connection with peering connection from remote region + required: true + responses: + '204': + description: The connect request was accepted and a peering is being established. + 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 + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ConnectRemotePeeringConnections + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/RemotePeeringConnection' + /routeTables: + get: + description: | + Lists the route tables in the specified VCN and specified compartment. + If the VCN ID is not provided, then the list includes the route tables from all VCNs in the specified compartment. + The response includes the default route table that automatically comes with + each VCN in the specified compartment, plus any route tables you've created. + operationId: ListRouteTables + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/VcnIdOptionalQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle + state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/RouteTable/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListRouteTablesResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListRouteTables + tags: + - virtualNetwork + post: + description: | + Creates a new route table for the specified VCN. In the request you must also include at least one route + rule for the new route table. For information on the number of rules you can have in a route table, see + [Service Limits](/iaas/Content/General/Concepts/servicelimits.htm). For general information about route + tables in your VCN and the types of targets you can use in route rules, + see [Route Tables](/iaas/Content/Network/Tasks/managingroutetables.htm). + + For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the route + table to reside. Notice that the route table doesn't have to be in the same compartment as the VCN, subnets, + or other Networking Service components. If you're not sure which compartment to use, put the route + table in the same compartment as the VCN. For more information about compartments and access control, see + [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see + [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). + + You may optionally specify a *display name* for the route table, otherwise a default is provided. + It does not have to be unique, and you can change it. Avoid entering confidential information. + operationId: CreateRouteTable + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateRouteTableDetails' + description: Details for creating a new route table. + required: true + responses: + '200': + description: The route table was created. + 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/RouteTable' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateRouteTable + tags: + - virtualNetwork + x-example: | + POST /20160918/routeTables + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName" : "MyRouteTable", + "vcnId" : "ocid1.vcn.oc1.phx.<unique_ID>", + "routeRules" : [{ + "cidrBlock" : "0.0.0.0/0", + "networkEntityId" : "ocid1.internetgateway.oc1.phx.<unique_ID>" + }], + "compartmentId" : "ocid1.compartment.oc1..<unique_ID>" + } + /routeTables/{rtId}: + delete: + description: | + Deletes the specified route table, but only if it's not associated with a subnet. You can't delete a + VCN's default route table. + + This is an asynchronous operation. The route table's `lifecycleState` will change to TERMINATING temporarily + until the route table is completely removed. + operationId: DeleteRouteTable + parameters: + - $ref: '#/components/parameters/RouteTableIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The route table is being 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteRouteTable + tags: + - virtualNetwork + get: + description: Gets the specified route table's information. + operationId: GetRouteTable + parameters: + - $ref: '#/components/parameters/RouteTableIdPathParam' + responses: + '200': + description: The route table was retrieved. + 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/RouteTable' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetRouteTable + tags: + - virtualNetwork + put: + description: | + Updates the specified route table's display name or route rules. + Avoid entering confidential information. + + Note that the `routeRules` object you provide replaces the entire existing set of rules. + operationId: UpdateRouteTable + parameters: + - $ref: '#/components/parameters/RouteTableIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateRouteTableDetails' + description: Details object for updating a route table. + required: true + responses: + '200': + description: The route table was updated. + 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/RouteTable' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateRouteTable + tags: + - virtualNetwork + /routeTables/{rtId}/actions/changeCompartment: + post: + description: | + Moves a route table into a different compartment within the same tenancy. For information + about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeRouteTableCompartment + parameters: + - $ref: '#/components/parameters/RouteTableIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeRouteTableCompartmentDetails' + description: Request to change the compartment of a given route table. + required: true + responses: + '204': + description: The route table has been moved to the specified compartment. + 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeRouteTableCompartment + tags: + - virtualNetwork + x-related-resource: '#/definitions/RouteTable' + /securityLists: + get: + description: | + Lists the security lists in the specified VCN and compartment. + If the VCN ID is not provided, then the list includes the security lists from all VCNs in the specified compartment. + operationId: ListSecurityLists + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/VcnIdOptionalQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle + state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/SecurityList/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListSecurityListsResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListSecurityLists + tags: + - virtualNetwork + post: + description: | + Creates a new security list for the specified VCN. For more information + about security lists, see [Security Lists](/iaas/Content/Network/Concepts/securitylists.htm). + For information on the number of rules you can have in a security list, see + [Service Limits](/iaas/Content/General/Concepts/servicelimits.htm). + + For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the security + list to reside. Notice that the security list doesn't have to be in the same compartment as the VCN, subnets, + or other Networking Service components. If you're not sure which compartment to use, put the security + list in the same compartment as the VCN. For more information about compartments and access control, see + [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see + [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). + + You may optionally specify a *display name* for the security list, otherwise a default is provided. + It does not have to be unique, and you can change it. Avoid entering confidential information. + operationId: CreateSecurityList + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateSecurityListDetails' + description: Details regarding the security list to create. + required: true + responses: + '200': + description: The security list has been created. + 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/SecurityList' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateSecurityList + tags: + - virtualNetwork + x-example: | + POST /20160918/securityLists + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "vcnId" : "ocid1.vcn.oc1.phx.<unique_ID>", + "displayName" : "MyPrivateSubnetSecurityList", + "ingressSecurityRules" : [{ + "protocol" : "6", + "source" : "10.0.1.0/24", + "tcpOptions" : { + "destinationPortRange" : { + "min" : "1521", + "max" : "1521" + } + } + },{ + "protocol" : "6", + "source" : "10.0.2.0/24", + "tcpOptions" : { + "destinationPortRange" : { + "min" : "1521", + "max" : "1521" + } + } + }], + "egressSecurityRules" : [{ + "protocol" : "6", + "destination" : "10.0.2.0/24", + "tcpOptions" : { + "destinationPortRange" : { + "min" : "1521", + "max" : "1521" + } + } + }], + "compartmentId" : "ocid1.compartment.oc1..<unique_ID>" + } + /securityLists/{securityListId}: + delete: + description: | + Deletes the specified security list, but only if it's not associated with a subnet. You can't delete + a VCN's default security list. + + This is an asynchronous operation. The security list's `lifecycleState` will change to TERMINATING temporarily + until the security list is completely removed. + operationId: DeleteSecurityList + parameters: + - $ref: '#/components/parameters/SecurityListIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The security list is being 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteSecurityList + tags: + - virtualNetwork + get: + description: Gets the specified security list's information. + operationId: GetSecurityList + parameters: + - $ref: '#/components/parameters/SecurityListIdPathParam' + responses: + '200': + description: The security list was retrieved. + 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/SecurityList' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetSecurityList + tags: + - virtualNetwork + put: + description: | + Updates the specified security list's display name or rules. + Avoid entering confidential information. + + Note that the `egressSecurityRules` or `ingressSecurityRules` objects you provide replace the entire + existing objects. + operationId: UpdateSecurityList + parameters: + - $ref: '#/components/parameters/SecurityListIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSecurityListDetails' + description: Updated details for the security list. + required: true + responses: + '200': + description: The security list was updated. + 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/SecurityList' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateSecurityList + tags: + - virtualNetwork + /securityLists/{securityListId}/actions/changeCompartment: + post: + description: | + Moves a security list into a different compartment within the same tenancy. For information + about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeSecurityListCompartment + parameters: + - $ref: '#/components/parameters/SecurityListIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeSecurityListCompartmentDetails' + description: Request to change the compartment of a given security list. + required: true + responses: + '204': + description: The security list has been moved to the specified compartment. + 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeSecurityListCompartment + tags: + - virtualNetwork + x-related-resource: '#/definitions/SecurityList' + /serviceGateways: + get: + description: | + Lists the service gateways in the specified compartment. You may optionally specify a VCN OCID + to filter the results by VCN. + operationId: ListServiceGateways + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/VcnIdOptionalQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - 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-obmcs-enumref: '#/definitions/ServiceGateway/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListServiceGatewaysResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListServiceGateways + tags: + - virtualNetwork + post: + description: | + Creates a new service gateway in the specified compartment. + + For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want + the service gateway to reside. For more information about compartments and access control, see + [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). + For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). + + You may optionally specify a *display name* for the service gateway, otherwise a default is provided. + It does not have to be unique, and you can change it. Avoid entering confidential information. + + Use the [ListServices](#/en/iaas/latest/Service/ListServices) operation to find service CIDR labels + available in the region. + operationId: CreateServiceGateway + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateServiceGatewayDetails' + description: Details for creating a service gateway. + required: true + responses: + '200': + description: The service gateway was created. + 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/ServiceGateway' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateServiceGateway + tags: + - virtualNetwork + x-example: | + POST /20160918/serviceGateways + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId" : "ocid1.compartment.oc1.phx.<unique_ID>", + "vcnid" : "ocid1.vcn.oc1.phx.<unique_ID>", + "displayName" : "MyServiceGateway" + "services":[ + { "serviceId": "ocid1.service.oc1.phx.<unique_ID>" } + ] + } + /serviceGateways/{serviceGatewayId}: + delete: + description: | + Deletes the specified service gateway. There must not be a route table that lists the service + gateway as a target. + operationId: DeleteServiceGateway + parameters: + - $ref: '#/components/parameters/ServiceGatewayIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The service gateway is being 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteServiceGateway + tags: + - virtualNetwork + get: + description: Gets the specified service gateway's information. + operationId: GetServiceGateway + parameters: + - $ref: '#/components/parameters/ServiceGatewayIdPathParam' + responses: + '200': + description: The service gateway was retrieved. + 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/ServiceGateway' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetServiceGateway + tags: + - virtualNetwork + put: + description: | + Updates the specified service gateway. The information you provide overwrites the existing + attributes of the gateway. + operationId: UpdateServiceGateway + parameters: + - $ref: '#/components/parameters/ServiceGatewayIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateServiceGatewayDetails' + description: Details object for updating a service gateway. + required: true + responses: + '200': + description: The service gateway was updated. + 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/ServiceGateway' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateServiceGateway + tags: + - virtualNetwork + /serviceGateways/{serviceGatewayId}/actions/attachService: + post: + description: | + Adds the specified [Service](#/en/iaas/latest/Service/) to the list of enabled + `Service` objects for the specified gateway. You must also set up a route rule with the + `cidrBlock` of the `Service` as the rule's destination and the service gateway as the rule's + target. See [Route Table](#/en/iaas/latest/RouteTable/). + + **Note:** The `AttachServiceId` operation is an easy way to add an individual `Service` to + the service gateway. Compare it with + [UpdateServiceGateway](#/en/iaas/latest/ServiceGateway/UpdateServiceGateway), which replaces + the entire existing list of enabled `Service` objects with the list that you provide in the + `Update` call. + operationId: AttachServiceId + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/ServiceGatewayIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceIdRequestDetails' + description: ServiceId of Service to be attached to a service gateway. + required: true + responses: + '200': + description: The service has been enabled for the service gateway. + 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/ServiceGateway' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: AttachService + tags: + - virtualNetwork + /serviceGateways/{serviceGatewayId}/actions/changeCompartment: + post: + description: | + Moves a service gateway into a different compartment within the same tenancy. For information + about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeServiceGatewayCompartment + parameters: + - $ref: '#/components/parameters/ServiceGatewayIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeServiceGatewayCompartmentDetails' + description: Request to change the compartment of a given Service Gateway. + required: true + responses: + '204': + description: The Service Gateway's compartment has been changed + 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeServiceGatewayCompartment + tags: + - virtualNetwork + x-related-resource: '#/definitions/ServiceGateway' + /serviceGateways/{serviceGatewayId}/actions/detachService: + post: + description: | + Removes the specified [Service](#/en/iaas/latest/Service/) from the list of enabled + `Service` objects for the specified gateway. You do not need to remove any route + rules that specify this `Service` object's `cidrBlock` as the destination CIDR. However, consider + removing the rules if your intent is to permanently disable use of the `Service` through this + service gateway. + + **Note:** The `DetachServiceId` operation is an easy way to remove an individual `Service` from + the service gateway. Compare it with + [UpdateServiceGateway](#/en/iaas/latest/ServiceGateway/UpdateServiceGateway), which replaces + the entire existing list of enabled `Service` objects with the list that you provide in the + `Update` call. `UpdateServiceGateway` also lets you block all traffic through the service + gateway without having to remove each of the individual `Service` objects. + operationId: DetachServiceId + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/ServiceGatewayIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceIdRequestDetails' + description: ServiceId of Service to be detached from a service gateway. + required: true + responses: + '200': + description: The service has been disabled for the service gateway. + 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/ServiceGateway' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DetachService + tags: + - virtualNetwork + /services: + get: + description: | + Lists the available [Service](#/en/iaas/latest/Service/) objects that you can enable for a + service gateway in this region. + operationId: ListServices + parameters: + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListServicesResponse' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListServices + tags: + - virtualNetwork + /services/{serviceId}: + get: + description: | + Gets the specified [Service](#/en/iaas/latest/Service/) object. + operationId: GetService + parameters: + - $ref: '#/components/parameters/ServiceIdPathParam' + responses: + '200': + description: The `Service` is being retrieved. + 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/Service' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetService + tags: + - virtualNetwork + /subnetTopology: + get: + description: Gets a topology for a given subnet. + operationId: GetSubnetTopology + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/AccessLevelQueryParam' + - $ref: '#/components/parameters/QueryCompartmentSubtreeQueryParam' + - $ref: '#/components/parameters/SubnetIdQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfNoneMatchHeader' + - $ref: '#/components/parameters/CacheControlHeader' + responses: + '200': + description: The topology was successfully returned. + 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/SubnetTopology' + '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/DefaultError' + summary: Get virtual network subnet topology + tags: + - virtualNetwork + /subnets: + get: + description: | + Lists the subnets in the specified VCN and the specified compartment. + If the VCN ID is not provided, then the list includes the subnets from all VCNs in the specified compartment. + operationId: ListSubnets + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/VcnIdOptionalQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle + state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/Subnet/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListSubnetsResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListSubnets + tags: + - virtualNetwork + post: + description: | + Creates a new subnet in the specified VCN. You can't change the size of the subnet after creation, + so it's important to think about the size of subnets you need before creating them. + For more information, see [VCNs and Subnets](/iaas/Content/Network/Tasks/managingVCNs.htm). + For information on the number of subnets you can have in a VCN, see + [Service Limits](/iaas/Content/General/Concepts/servicelimits.htm). + + For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the subnet + to reside. Notice that the subnet doesn't have to be in the same compartment as the VCN, route tables, or + other Networking Service components. If you're not sure which compartment to use, put the subnet in + the same compartment as the VCN. For more information about compartments and access control, see + [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, + see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). + + You may optionally associate a route table with the subnet. If you don't, the subnet will use the + VCN's default route table. For more information about route tables, see + [Route Tables](/iaas/Content/Network/Tasks/managingroutetables.htm). + + You may optionally associate a security list with the subnet. If you don't, the subnet will use the + VCN's default security list. For more information about security lists, see + [Security Lists](/iaas/Content/Network/Concepts/securitylists.htm). + + You may optionally associate a set of DHCP options with the subnet. If you don't, the subnet will use the + VCN's default set. For more information about DHCP options, see + [DHCP Options](/iaas/Content/Network/Tasks/managingDHCP.htm). + + You may optionally specify a *display name* for the subnet, otherwise a default is provided. + It does not have to be unique, and you can change it. Avoid entering confidential information. + + You can also add a DNS label for the subnet, which is required if you want the Internet and + VCN Resolver to resolve hostnames for instances in the subnet. For more information, see + [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). + operationId: CreateSubnet + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateSubnetDetails' + description: Details for creating a subnet. + required: true + responses: + '200': + description: The subnet was created. + 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/Subnet' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateSubnet + tags: + - virtualNetwork + x-example: | + POST /20160918/subnets + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName" : "MySubnet", + "cidrBlock" : "10.0.2.0/24", + "availabilityDomain" : "crmS:PHX-AD-1", + "routeTableId" : "ocid1.routetable.oc1.phx.<unique_ID>", + "securityListIds" : [ "ocid1.securitylist.oc1.phx.<unique_ID>" ], + "dhcpOptionsId" : "ocid1.dhcpoptions.oc1.phx.<unique_ID>", + "vcnId" : "ocid1.vcn.oc1.phx.<unique_ID>", + "compartmentId" : "ocid1.compartment.oc1..<unique_ID>" + } + /subnets/{subnetId}: + delete: + description: | + Deletes the specified subnet, but only if there are no instances in the subnet. This is an asynchronous + operation. The subnet's `lifecycleState` will change to TERMINATING temporarily. If there are any + instances in the subnet, the state will instead change back to AVAILABLE. + operationId: DeleteSubnet + parameters: + - $ref: '#/components/parameters/SubnetIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The subnet is being 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteSubnet + tags: + - virtualNetwork + get: + description: Gets the specified subnet's information. + operationId: GetSubnet + parameters: + - $ref: '#/components/parameters/SubnetIdPathParam' + responses: + '200': + description: The subnet was retrieved. + 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/Subnet' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetSubnet + tags: + - virtualNetwork + put: + description: | + Updates the specified subnet. + operationId: UpdateSubnet + parameters: + - $ref: '#/components/parameters/SubnetIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSubnetDetails' + description: Details object for updating a subnet. + required: true + responses: + '200': + description: The subnet was updated. + 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/Subnet' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateSubnet + tags: + - virtualNetwork + /subnets/{subnetId}/actions/addIpv4Cidr: + post: + description: | + Add an IPv4 prefix to a subnet. + operationId: AddIpv4SubnetCidr + parameters: + - $ref: '#/components/parameters/SubnetIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddIpv4SubnetCidrDetails' + description: Details object for adding an IPv4 prefix to a subnet. + required: true + responses: + '202': + description: Request to add IPv4 prefix was queued. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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/DefaultError' + summary: AddIpv4SubnetCidr + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/Subnet' + /subnets/{subnetId}/actions/addIpv6Cidr: + post: + description: | + Add an IPv6 prefix to a subnet. + operationId: AddIpv6SubnetCidr + parameters: + - $ref: '#/components/parameters/SubnetIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddSubnetIpv6CidrDetails' + description: Details object for adding an IPv6 prefix to a subnet. + required: true + responses: + '202': + description: Request to add IPv6 prefix was queued. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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' + '500': + $ref: '#/components/responses/500' + summary: AddIpv6SubnetCidr + tags: + - virtualNetwork + x-related-resource: '#/definitions/Subnet' + /subnets/{subnetId}/actions/changeCompartment: + post: + description: | + Moves a subnet into a different compartment within the same tenancy. For information + about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeSubnetCompartment + parameters: + - $ref: '#/components/parameters/SubnetIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeSubnetCompartmentDetails' + description: Request to change the compartment of a given subnet. + required: true + responses: + '202': + description: The subnet has been moved to the specified compartment. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeSubnetCompartment + tags: + - virtualNetwork + x-related-resource: '#/definitions/Subnet' + /subnets/{subnetId}/actions/modifyIpv4Cidr: + post: + description: | + Updates the specified Ipv4 CIDR block of a Subnet. The new Ipv4 CIDR IP range must meet the following criteria: + + - Must be valid. + - Must not overlap with another Ipv4 CIDR block in the Subnet or the on-premises network CIDR block. + - Must not exceed the limit of Ipv4 CIDR blocks allowed per Subnet. + - Must include IP addresses from the original CIDR block that are used in the VCN's existing route rules. + - No IP address in an existing subnet should be outside of the new CIDR block range. + operationId: ModifyIpv4SubnetCidr + parameters: + - $ref: '#/components/parameters/SubnetIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModifyIpv4SubnetCidrDetails' + description: Details object for updating a SUBNET IPv4 prefix. + required: true + responses: + '202': + description: A request to update the SUBNET's IPv4 prefix subnet was queued. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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/DefaultError' + summary: ModifyIpv4SubnetCidr + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/Subnet' + /subnets/{subnetId}/actions/removeIpv4Cidr: + post: + description: | + Remove an IPv4 prefix from a subnet + operationId: RemoveIpv4SubnetCidr + parameters: + - $ref: '#/components/parameters/SubnetIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveIpv4SubnetCidrDetails' + description: Details object for removing an IPv4 SUBNET prefix. + required: true + responses: + '202': + description: A request to remove an IPv4 prefix from the subnet was queued. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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/DefaultError' + summary: RemoveIpv4SubnetCidr + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/Subnet' + /subnets/{subnetId}/actions/removeIpv6Cidr: + post: + description: | + Remove an IPv6 prefix from a subnet. At least one IPv6 CIDR should remain. + operationId: RemoveIpv6SubnetCidr + parameters: + - $ref: '#/components/parameters/SubnetIdPathParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveSubnetIpv6CidrDetails' + description: Details object for removing an IPv6 SUBNET prefix. + required: true + responses: + '202': + description: A request to remove an IPv6 prefix from the subnet was queued. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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' + '500': + $ref: '#/components/responses/500' + summary: RemoveIpv6SubnetCidr + tags: + - virtualNetwork + x-related-resource: '#/definitions/Subnet' + /vcnTopology: + get: + description: Gets a virtual network topology for a given VCN. + operationId: GetVcnTopology + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/AccessLevelQueryParam' + - $ref: '#/components/parameters/QueryCompartmentSubtreeQueryParam' + - $ref: '#/components/parameters/VcnIdQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/IfNoneMatchHeader' + - $ref: '#/components/parameters/CacheControlHeader' + responses: + '200': + description: The topology was successfully returned. + 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/VcnTopology' + '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/DefaultError' + summary: Get Virtual Network VCN topology + tags: + - virtualNetwork + /vcns: + get: + description: | + Lists the virtual cloud networks (VCNs) in the specified compartment. + operationId: ListVcns + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle + state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/Vcn/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListVcnsResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListVcns + tags: + - virtualNetwork + post: + description: | + Creates a new virtual cloud network (VCN). For more information, see + [VCNs and Subnets](/iaas/Content/Network/Tasks/managingVCNs.htm). + + For the VCN, you specify a list of one or more IPv4 CIDR blocks that meet the following criteria: + + - The CIDR blocks must be valid. + - They must not overlap with each other or with the on-premises network CIDR block. + - The number of CIDR blocks does not exceed the limit of CIDR blocks allowed per VCN. + + For a CIDR block, Oracle recommends that you use one of the private IP address ranges specified in [RFC 1918](https://tools.ietf.org/html/rfc1918) (10.0.0.0/8, 172.16/12, and 192.168/16). Example: + 172.16.0.0/16. The CIDR blocks can range from /16 to /30. + + For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the VCN to + reside. Consult an Oracle Cloud Infrastructure administrator in your organization if you're not sure which + compartment to use. Notice that the VCN doesn't have to be in the same compartment as the subnets or other + Networking Service components. For more information about compartments and access control, see + [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see + [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). + + You may optionally specify a *display name* for the VCN, otherwise a default is provided. It does not have to + be unique, and you can change it. Avoid entering confidential information. + + You can also add a DNS label for the VCN, which is required if you want the instances to use the + Interent and VCN Resolver option for DNS in the VCN. For more information, see + [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). + + The VCN automatically comes with a default route table, default security list, and default set of DHCP options. + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for each is returned in the response. You can't delete these default objects, but you can change their + contents (that is, change the route rules, security list rules, and so on). + + The VCN and subnets you create are not accessible until you attach an internet gateway or set up a Site-to-Site VPN + or FastConnect. For more information, see + [Overview of the Networking Service](/iaas/Content/Network/Concepts/overview.htm). + operationId: CreateVcn + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateVcnDetails' + description: Details for creating a new VCN. + required: true + responses: + '200': + description: The VCN was created. + 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/Vcn' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateVcn + tags: + - virtualNetwork + x-example: | + POST /20160918/vcns + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "cidrBlock" : "10.0.0.0/16", + "compartmentId" : "ocid1.compartment.oc1..<unique_ID>", + "displayName" : "MyVcn" + } + /vcns/{vcnId}: + delete: + description: | + Deletes the specified VCN. The VCN must be completely empty and have no attached gateways. This is an asynchronous + operation. + + A deleted VCN's `lifecycleState` changes to TERMINATING and then TERMINATED temporarily until the VCN is completely + removed. A completely removed VCN does not appear in the results of a `ListVcns` operation and can't be used in a + `GetVcn` operation. + operationId: DeleteVcn + parameters: + - $ref: '#/components/parameters/VcnIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The VCN is being 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteVcn + tags: + - virtualNetwork + get: + description: Gets the specified VCN's information. + operationId: GetVcn + parameters: + - $ref: '#/components/parameters/VcnIdPathParam' + responses: + '200': + description: The VCN was retrieved. + 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/Vcn' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetVcn + tags: + - virtualNetwork + put: + description: | + Updates the specified VCN. + operationId: UpdateVcn + parameters: + - $ref: '#/components/parameters/VcnIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateVcnDetails' + description: Details object for updating a VCN. + required: true + responses: + '200': + description: The VCN was updated. + 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/Vcn' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateVcn + tags: + - virtualNetwork + /vcns/{vcnId}/actions/addCidr: + post: + description: | + Adds a CIDR block to a VCN. The CIDR block you add: + + - Must be valid. + - Must not overlap with another CIDR block in the VCN, a CIDR block of a peered VCN, or the on-premises network CIDR block. + - Must not exceed the limit of CIDR blocks allowed per VCN. + + **Note:** Adding a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can take a few minutes. You can use the `GetWorkRequest` operation to check the status of the update. + operationId: AddVcnCidr + parameters: + - $ref: '#/components/parameters/VcnIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddVcnCidrDetails' + description: Details object for deleting a VCN CIDR. + required: true + responses: + '202': + description: The request to add the CIDR block to the VCN was successfully received. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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' + '500': + $ref: '#/components/responses/500' + summary: AddVcnCidr + tags: + - virtualNetwork + x-related-resource: '#/definitions/Vcn' + /vcns/{vcnId}/actions/addIpv6Cidr: + post: + description: | + Add an IPv6 prefix to a VCN. The VCN size is always /56. + AddIpv6VcnCidr supports adding Private IPv6 Prefix i.e. ULA or an IPv6 GUA assigned by Oracle or BYOIPv6 Prefix, only one of these per request. + Once added the IPv6 prefix cannot be removed or modified. + operationId: AddIpv6VcnCidr + parameters: + - $ref: '#/components/parameters/VcnIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddVcnIpv6CidrDetails' + description: | + Details object for adding an IPv6 VCN CIDR. + responses: + '202': + description: Add IPv6 prefix request has been queued. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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' + '500': + $ref: '#/components/responses/500' + summary: AddVcnIpv6Cidr + tags: + - virtualNetwork + x-related-resource: '#/definitions/Vcn' + /vcns/{vcnId}/actions/changeCompartment: + post: + description: | + Moves a VCN into a different compartment within the same tenancy. For information + about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeVcnCompartment + parameters: + - $ref: '#/components/parameters/VcnIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeVcnCompartmentDetails' + description: Request to change the compartment of a given VCN. + required: true + responses: + '202': + description: The VCN has been moved to the specified compartment. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeVcnCompartment + tags: + - virtualNetwork + x-related-resource: '#/definitions/Vcn' + /vcns/{vcnId}/actions/modifyCidr: + post: + description: | + Updates the specified CIDR block of a VCN. The new CIDR IP range must meet the following criteria: + + - Must be valid. + - Must not overlap with another CIDR block in the VCN, a CIDR block of a peered VCN, or the on-premises network CIDR block. + - Must not exceed the limit of CIDR blocks allowed per VCN. + - Must include IP addresses from the original CIDR block that are used in the VCN's existing route rules. + - No IP address in an existing subnet should be outside of the new CIDR block range. + + **Note:** Modifying a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can vary depending on the size of your network. Updating a small network could take about a minute, and updating a large network could take up to an hour. You can use the `GetWorkRequest` operation to check the status of the update. + operationId: ModifyVcnCidr + parameters: + - $ref: '#/components/parameters/VcnIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModifyVcnCidrDetails' + description: Details object for updating a VCN CIDR. + required: true + responses: + '202': + description: The request to update the VCN's CIDR block was successfully received. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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' + '500': + $ref: '#/components/responses/500' + summary: ModifyVcnCidr + tags: + - virtualNetwork + x-related-resource: '#/definitions/Vcn' + /vcns/{vcnId}/actions/removeCidr: + post: + description: | + Removes a specified CIDR block from a VCN. + + **Notes:** + - You cannot remove a CIDR block if an IP address in its range is in use. + - Removing a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can take a few minutes. You can use the `GetWorkRequest` operation to check the status of the update. + operationId: RemoveVcnCidr + parameters: + - $ref: '#/components/parameters/VcnIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveVcnCidrDetails' + description: Details object for removing a VCN CIDR. + required: true + responses: + '202': + description: The request to remove the CIDR block from the VCN was successfully received. + 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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' + '500': + $ref: '#/components/responses/500' + summary: RemoveVcnCidr + tags: + - virtualNetwork + x-related-resource: '#/definitions/Vcn' + /vcns/{vcnId}/actions/removeIpv6Cidr: + post: + description: | + Removing an existing IPv6 prefix from a VCN. + operationId: RemoveIpv6VcnCidr + parameters: + - $ref: '#/components/parameters/VcnIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveVcnIpv6CidrDetails' + description: Details object for removing a VCN IPv6 prefix. + responses: + '202': + description: The request to remove the IPv6 prefix from the VCN was successfully received. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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' + '500': + $ref: '#/components/responses/500' + summary: RemoveIpv6VcnCidr + tags: + - virtualNetwork + x-related-resource: '#/definitions/Vcn' + /virtualCircuitBandwidthShapes: + get: + description: | + The operation lists available bandwidth levels for virtual circuits. For the compartment ID, provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of your tenancy (the root compartment). + operationId: ListVirtualCircuitBandwidthShapes + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: The list is being retrieved. + 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/ListVirtualCircuitBandwidthShapesResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListVirtualCircuitBandwidthShapes + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /virtualCircuits: + get: + description: | + Lists the virtual circuits in the specified compartment. + operationId: ListVirtualCircuits + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to return only resources that match the specified lifecycle + state. The value is case insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/VirtualCircuit/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListVirtualCircuitsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListVirtualCircuits + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + post: + description: | + Creates a new virtual circuit to use with Oracle Cloud + Infrastructure FastConnect. For more information, see + [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). + + For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the + compartment where you want the virtual circuit to reside. If you're + not sure which compartment to use, put the virtual circuit in the + same compartment with the DRG it's using. For more information about + compartments and access control, see + [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). + For information about OCIDs, see + [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). + + You may optionally specify a *display name* for the virtual circuit. + It does not have to be unique, and you can change it. Avoid entering confidential information. + + **Important:** When creating a virtual circuit, you specify a DRG for + the traffic to flow through. Make sure you attach the DRG to your + VCN and confirm the VCN's routing sends traffic to the DRG. Otherwise + traffic will not flow. For more information, see + [Route Tables](/iaas/Content/Network/Tasks/managingroutetables.htm). + operationId: CreateVirtualCircuit + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateVirtualCircuitDetails' + description: Details to create a VirtualCircuit. + required: true + responses: + '200': + description: The VirtualCircuit was created. + 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/VirtualCircuit' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateVirtualCircuit + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /virtualCircuits/{virtualCircuitId}: + delete: + description: | + Deletes the specified virtual circuit. + + **Important:** If you're using FastConnect via a provider, + make sure to also terminate the connection with + the provider, or else the provider may continue to bill you. + operationId: DeleteVirtualCircuit + parameters: + - $ref: '#/components/parameters/VirtualCircuitIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The virtual circuit is being 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteVirtualCircuit + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + get: + description: Gets the specified virtual circuit's information. + operationId: GetVirtualCircuit + parameters: + - $ref: '#/components/parameters/VirtualCircuitIdPathParam' + responses: + '200': + description: The virtual circuit was retrieved. + 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/VirtualCircuit' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetVirtualCircuit + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + put: + description: | + Updates the specified virtual circuit. This can be called by + either the customer who owns the virtual circuit, or the + provider (when provisioning or de-provisioning the virtual + circuit from their end). The documentation for + [UpdateVirtualCircuitDetails](#/en/iaas/latest/requests/UpdateVirtualCircuitDetails) + indicates who can update each property of the virtual circuit. + + **Important:** If the virtual circuit is working and in the + PROVISIONED state, updating any of the network-related properties + (such as the DRG being used, the BGP ASN, and so on) will cause the virtual + circuit's state to switch to PROVISIONING and the related BGP + session to go down. After Oracle re-provisions the virtual circuit, + its state will return to PROVISIONED. Make sure you confirm that + the associated BGP session is back up. For more information + about the various states and how to test connectivity, see + [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). + + To change the list of public IP prefixes for a public virtual circuit, + use [BulkAddVirtualCircuitPublicPrefixes](#/en/iaas/latest/VirtualCircuitPublicPrefix/BulkAddVirtualCircuitPublicPrefixes) + and + [BulkDeleteVirtualCircuitPublicPrefixes](#/en/iaas/latest/VirtualCircuitPublicPrefix/BulkDeleteVirtualCircuitPublicPrefixes). + Updating the list of prefixes does NOT cause the BGP session to go down. However, + Oracle must verify the customer's ownership of each added prefix before + traffic for that prefix will flow across the virtual circuit. + operationId: UpdateVirtualCircuit + parameters: + - $ref: '#/components/parameters/VirtualCircuitIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateVirtualCircuitDetails' + description: Update VirtualCircuit fields. + required: true + responses: + '200': + description: The virtual circuit was updated. + 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/VirtualCircuit' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateVirtualCircuit + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /virtualCircuits/{virtualCircuitId}/actions/bulkAddPublicPrefixes: + post: + description: | + Adds one or more customer public IP prefixes to the specified public virtual circuit. + Use this operation (and not [UpdateVirtualCircuit](#/en/iaas/latest/VirtualCircuit/UpdateVirtualCircuit)) + to add prefixes to the virtual circuit. Oracle must verify the customer's ownership + of each prefix before traffic for that prefix will flow across the virtual circuit. + operationId: BulkAddVirtualCircuitPublicPrefixes + parameters: + - $ref: '#/components/parameters/VirtualCircuitIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BulkAddVirtualCircuitPublicPrefixesDetails' + description: Request with publix prefixes to be added to the virtual circuit + required: true + responses: + '204': + description: Addition of public prefixes accepted. + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: BulkAddVirtualCircuitPublicPrefixes + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/VirtualCircuitPublicPrefix' + /virtualCircuits/{virtualCircuitId}/actions/bulkDeletePublicPrefixes: + post: + description: | + Removes one or more customer public IP prefixes from the specified public virtual circuit. + Use this operation (and not [UpdateVirtualCircuit](#/en/iaas/latest/VirtualCircuit/UpdateVirtualCircuit)) + to remove prefixes from the virtual circuit. When the virtual circuit's state switches + back to PROVISIONED, Oracle stops advertising the specified prefixes across the connection. + operationId: BulkDeleteVirtualCircuitPublicPrefixes + parameters: + - $ref: '#/components/parameters/VirtualCircuitIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BulkDeleteVirtualCircuitPublicPrefixesDetails' + description: Request with public prefixes to be deleted from the virtual circuit. + required: true + responses: + '204': + description: Deletion of public prefixes accepted. + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: BulkDeleteVirtualCircuitPublicPrefixes + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/VirtualCircuitPublicPrefix' + /virtualCircuits/{virtualCircuitId}/actions/changeCompartment: + post: + description: | + Moves a virtual circuit into a different compartment within the same tenancy. For information + about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeVirtualCircuitCompartment + parameters: + - $ref: '#/components/parameters/VirtualCircuitIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeVirtualCircuitCompartmentDetails' + description: Request to change the compartment of a virtual circuit. + required: true + responses: + '204': + description: The virtual circuit has been moved to the specified compartment. + 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 + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeVirtualCircuitCompartment + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/VirtualCircuit' + /virtualCircuits/{virtualCircuitId}/associatedTunnels: + get: + description: Gets the specified virtual circuit's associatedTunnelsInfo. + operationId: ListVirtualCircuitAssociatedTunnels + parameters: + - $ref: '#/components/parameters/VirtualCircuitIdPathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: The virtual circuit's `associatedTunnelsInfo` was retrieved. + headers: + etag: + description: | + For optimistic concurrency control. See `if-match`. + schema: + 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). + 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/ListVirtualCircuitAssociatedTunnelsResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListVirtualCircuitAssociatedTunnels + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/VirtualCircuitAssociatedTunnelDetails' + /virtualCircuits/{virtualCircuitId}/crossConnectMappings: + get: + description: | + Lists the Cross Connect mapping Details for the specified + virtual circuit. + operationId: ListCrossConnectMappings + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/VirtualCircuitIdPathParam' + responses: + '200': + description: The list is being retrieved. + 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/CrossConnectMappingDetailsCollection' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListCrossConnectMappings + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /virtualCircuits/{virtualCircuitId}/publicPrefixes: + get: + description: | + Lists the public IP prefixes and their details for the specified + public virtual circuit. + operationId: ListVirtualCircuitPublicPrefixes + parameters: + - $ref: '#/components/parameters/VirtualCircuitIdPathParam' + - description: | + A filter to only return resources that match the given verification + state. + + The state value is case-insensitive. + in: query + name: verificationState + required: false + x-obmcs-enumref: '#/definitions/VirtualCircuitPublicPrefix/verificationState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListVirtualCircuitPublicPrefixesResponse' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListVirtualCircuitPublicPrefixes + tags: + - virtualNetwork + x-obmcs-client-retries-enabled: true + /vlans: + get: + description: | + Lists the VLANs in the specified VCN and the specified compartment. + operationId: ListVlans + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/VcnIdQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - description: | + A filter to only return resources that match the given lifecycle + state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/Vlan/lifecycleState' + schema: + type: string + responses: + '200': + description: The list is being retrieved. + 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/ListVlansResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListVlans + tags: + - virtualNetwork + post: + description: | + Creates a VLAN in the specified VCN and the specified compartment. + operationId: CreateVlan + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateVlanDetails' + description: Details for creating a VLAN + required: true + responses: + '200': + description: The VLAN was created. + 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/Vlan' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateVlan + tags: + - virtualNetwork + /vlans/{vlanId}: + delete: + description: | + Deletes the specified VLAN, but only if there are no VNICs in the VLAN. + operationId: DeleteVlan + parameters: + - $ref: '#/components/parameters/VlanIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '204': + description: The VLAN is being 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 + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteVlan + tags: + - virtualNetwork + x-related-resource: '#/definitions/Vlan' + get: + description: Gets the specified VLAN's information. + operationId: GetVlan + parameters: + - $ref: '#/components/parameters/VlanIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The VLAN was retrieved. + 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/Vlan' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetVlan + tags: + - virtualNetwork + put: + description: | + Updates the specified VLAN. Note that this operation might require changes to all + the VNICs in the VLAN, which can take a while. The VLAN will be in the UPDATING state until the changes are complete. + operationId: UpdateVlan + parameters: + - $ref: '#/components/parameters/VlanIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateVlanDetails' + description: Details object for updating a subnet. + required: true + responses: + '200': + description: The VLAN was updated. + 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/Vlan' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateVlan + tags: + - virtualNetwork + /vlans/{vlanId}/actions/changeCompartment: + post: + description: | + Moves a VLAN into a different compartment within the same tenancy. + For information about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeVlanCompartment + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/VlanIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeVlanCompartmentDetails' + description: Request to change the compartment of a given VLAN. + required: true + responses: + '202': + description: The VLAN has been moved to the specified 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeVlanCompartment + tags: + - virtualNetwork + x-related-resource: '#/definitions/Vlan' + /vnics/{vnicId}: + get: + description: | + Gets the information for the specified virtual network interface card (VNIC). + You can get the VNIC [OCID](/iaas/Content/General/Concepts/identifiers.htm) from the + [ListVnicAttachments](#/en/iaas/latest/VnicAttachment/ListVnicAttachments) + operation. + operationId: GetVnic + parameters: + - $ref: '#/components/parameters/VnicIdPathParam' + responses: + '200': + description: The VNIC was retrieved. + 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/Vnic' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetVnic + tags: + - virtualNetwork + put: + description: | + Updates the specified VNIC. + operationId: UpdateVnic + parameters: + - $ref: '#/components/parameters/VnicIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateVnicDetails' + description: Details object for updating a VNIC. + required: true + responses: + '200': + description: The VNIC was updated. + 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/Vnic' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateVnic + tags: + - virtualNetwork + /vtaps: + get: + description: | + Lists the virtual test access points (VTAPs) in the specified compartment. + operationId: ListVtaps + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/VcnIdOptionalQueryParam' + - $ref: '#/components/parameters/VtapSourceIdOptionalQueryParam' + - $ref: '#/components/parameters/VtapTargetIdOptionalQueryParam' + - $ref: '#/components/parameters/VtapTargetIpOptionalQueryParam' + - $ref: '#/components/parameters/VtapIsEnabledOptionalQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/FilterByVtapLifecycleStateQueryParam' + responses: + '200': + description: The list of VTAPs is being retrieved. + 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/ListVtapsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ListVtaps + tags: + - virtualNetwork + post: + description: | + Creates a virtual test access point (VTAP) in the specified compartment. + + For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the VTAP. + For more information about compartments and access control, see + [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). + For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). + + You may optionally specify a *display name* for the VTAP, otherwise a default is provided. + It does not have to be unique, and you can change it. + operationId: CreateVtap + parameters: + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateVtapDetails' + description: Details used to create a VTAP. + required: true + responses: + '200': + description: The VTAP was created. + 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/Vtap' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: CreateVtap + tags: + - virtualNetwork + x-example: | + POST /20160918/vtaps + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName" : "MyVTAP", + "compartmentId" : "ocid1.compartment.oc1..<unique_ID>" + } + /vtaps/{vtapId}: + delete: + description: | + Deletes the specified VTAP. This is an asynchronous operation. The VTAP's `lifecycleState` will change to + TERMINATING temporarily until the VTAP is completely removed. + operationId: DeleteVtap + parameters: + - $ref: '#/components/parameters/VtapIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '202': + description: The VTAP is being 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 work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: DeleteVtap + tags: + - virtualNetwork + x-related-resource: '#/definitions/Vtap' + get: + description: Gets the specified `Vtap` resource. + operationId: GetVtap + parameters: + - $ref: '#/components/parameters/VtapIdPathParam' + - $ref: '#/components/parameters/RequestIdHeader' + responses: + '200': + description: The VTAP was retrieved. + 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/Vtap' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: GetVtap + tags: + - virtualNetwork + put: + description: | + Updates the specified VTAP's display name or tags. + operationId: UpdateVtap + parameters: + - $ref: '#/components/parameters/VtapIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateVtapDetails' + description: Details object for updating a VTAP. + required: true + responses: + '202': + description: The VTAP was updated. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Vtap' + '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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: UpdateVtap + tags: + - virtualNetwork + /vtaps/{vtapId}/actions/changeCompartment: + post: + description: | + Moves a VTAP to a new compartment within the same tenancy. For information + about moving resources between compartments, see + [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: ChangeVtapCompartment + parameters: + - $ref: '#/components/parameters/VtapIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeVtapCompartmentDetails' + description: Request to change the compartment that contains a VTAP. + required: true + responses: + '202': + description: The VTAP is being moved to the new compartment. + 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 + opc-work-request-id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) + with this ID to track the status of the request. + schema: + type: string + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: ChangeVtapCompartment + tags: + - virtualNetwork + x-related-resource: '#/definitions/Vtap' +components: + schemas: + PeerRegionForRemotePeering: + description: | + Details about a region that supports remote VCN peering. For more + information, see [VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm). + properties: + name: + description: | + The region's name. + + Example: `us-phoenix-1` + maxLength: 255 + minLength: 1 + type: string + required: + - name + type: object + ByoasnCollection: + description: The results returned by a `ListByoasn` operation. + properties: + items: + description: A list of `Byoasn` resource summaries. + items: + $ref: '#/components/schemas/ByoasnSummary' + type: array + required: + - items + type: object + CreateByoasnDetails: + description: The information used to create a `Byoasn` resource. + properties: + asn: + description: | + The Autonomous System Number (ASN) you are importing to the Oracle cloud. + format: int64 + maximum: 4294967294 + minimum: 1 + type: integer + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the BYOASN Resource. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + required: + - compartmentId + - asn + - displayName + type: object + Byoasn: + description: Oracle offers the ability to Bring Your Own Autonomous System Number (BYOASN), importing AS Numbers you currently own to Oracle Cloud Infrastructure. A `Byoasn` resource is a record of the imported AS Number and also some associated metadata. The process used to [Bring Your Own ASN](/iaas/Content/Network/Concepts/BYOASN.htm) is explained in the documentation. + properties: + asn: + description: The Autonomous System Number (ASN) you are importing to the Oracle cloud. + format: int64 + maximum: 4294967294 + minimum: 1 + type: integer + byoipRanges: + description: The BYOIP Ranges that has the `Byoasn` as origin. + items: + $ref: '#/components/schemas/ByoasnByoipRange' + type: array + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the `Byoasn` resource. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `Byoasn` resource. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The `Byoasn` resource's current state. + enum: + - UPDATING + - ACTIVE + - DELETED + - FAILED + - CREATING + type: string + timeCreated: + description: | + The date and time the `Byoasn` resource was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeUpdated: + description: | + The date and time the `Byoasn` resource was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeValidated: + description: | + The date and time the `Byoasn` resource was validated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + validationToken: + description: The validation token is an internally-generated ASCII string used in the validation process. See [Importing a Byoasn](/iaas/Content/Network/Concepts/BYOASN.htm) for details. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - asn + - lifecycleState + - validationToken + - timeCreated + type: object + UpdateByoasnDetails: + description: The information used to update a `Byoasn` resource. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + ChangeByoasnCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the destination compartment for the BYOASN resource move. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ByoipRangeCollection: + description: The results returned by a `ListByoipRange` operation. + properties: + items: + description: A list of `ByoipRange` resource summaries. + items: + $ref: '#/components/schemas/ByoipRangeSummary' + type: array + required: + - items + type: object + CreateByoipRangeDetails: + description: The information used to create a `ByoipRange` resource. + properties: + cidrBlock: + description: | + The BYOIP CIDR block. You can assign some or all of it to a public IP pool after it is validated. + Example: `10.0.1.0/24` + maxLength: 18 + minLength: 9 + type: string + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the BYOIP CIDR block. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + ipv6CidrBlock: + description: | + The BYOIPv6 prefix. You can assign some or all of it to a VCN after it is validated. + maxLength: 45 + minLength: 1 + type: string + required: + - compartmentId + type: object + ByoipRange: + description: |- + Oracle offers the ability to Bring Your Own IP (BYOIP), importing public IP addresses or IPv6 addresses that you currently own to Oracle Cloud Infrastructure. A `ByoipRange` resource is a record of the imported address block (a BYOIP CIDR block) and also some associated metadata. + The process used to [Bring Your Own IP](/iaas/Content/Network/Concepts/BYOIP.htm) is explained in the documentation. + properties: + byoipRangeVcnIpv6Allocations: + description: | + A list of `ByoipRangeVcnIpv6AllocationSummary` objects. + items: + $ref: '#/components/schemas/ByoipRangeVcnIpv6AllocationSummary' + type: array + cidrBlock: + description: The public IPv4 CIDR block being imported from on-premises to the Oracle cloud. + maxLength: 18 + minLength: 9 + type: string + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the BYOIP CIDR block. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource. + maxLength: 255 + minLength: 1 + type: string + ipv6CidrBlock: + description: | + The IPv6 prefix being imported to the Oracle cloud. This prefix must be /48 or larger, and can be subdivided into sub-ranges used + across multiple VCNs. A BYOIPv6 prefix can be also assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify + a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size. + maxLength: 45 + minLength: 1 + type: string + lifecycleDetails: + description: The `ByoipRange` resource's current status. + enum: + - CREATING + - VALIDATING + - PROVISIONED + - ACTIVE + - FAILED + - DELETING + - DELETED + - ADVERTISING + - WITHDRAWING + type: string + lifecycleState: + description: The `ByoipRange` resource's current state. + enum: + - INACTIVE + - UPDATING + - ACTIVE + - DELETING + - DELETED + type: string + originAsn: + $ref: '#/components/schemas/ByoipRangeOriginAsn' + timeAdvertised: + description: | + The date and time the `ByoipRange` resource was advertised to the internet by BGP, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeCreated: + description: | + The date and time the `ByoipRange` resource was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeValidated: + description: | + The date and time the `ByoipRange` resource was validated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeWithdrawn: + description: | + The date and time the `ByoipRange` resource was withdrawn from advertisement by BGP to the internet, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + validationToken: + description: The validation token is an internally-generated ASCII string used in the validation process. See [Importing a CIDR block](/iaas/Content/Network/Concepts/BYOIP.htm#import_cidr) for details. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - lifecycleState + - validationToken + - timeCreated + type: object + UpdateByoipRangeDetails: + description: The information used to update a `ByoipRange` resource. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + ChangeByoipRangeCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the destination compartment for the BYOIP CIDR block move. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + SetOriginAsnDetails: + description: Update Origin ASN of a BYOIP Range + properties: + asPathPrependLength: + default: 1 + description: The as path prepend length. + minimum: 1 + type: integer + byoasnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `Byoasn` Resource to be associated. + maxLength: 255 + minLength: 1 + type: string + required: + - byoasnId + type: object + ByoipAllocatedRangeCollection: + description: Results of a `ListByoipAllocatedRanges` operation. + properties: + items: + description: A list of subranges of a BYOIP CIDR block allocated to an IP pool. + items: + $ref: '#/components/schemas/ByoipAllocatedRangeSummary' + type: array + required: + - items + type: object + CaptureFilter: + description: | + A capture filter contains a set of *[rules](#/en/iaas/latest/datatypes/CaptureFilterRuleDetails)* governing what traffic is + mirrored for a *[VTAP](#/en/iaas/latest/Vtap)* or captured for a *[VCN Flow Log](/iaas/Content/Network/Concepts/vcn-flow-logs.htm)*. + The capture filter is created with no rules defined, and it must have at least one rule to mirror traffic for the VTAP or collect VCN flow logs. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the capture filter. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + filterType: + description: Indicates which service will use this capture filter + enum: + - VTAP + 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 + id: + description: | + The capture filter's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The capture filter's current administrative state. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + type: string + timeCreated: + description: | + The date and time the capture filter was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2021-08-25T21:10:29.600Z` + format: date-time + type: string + vtapCaptureFilterRules: + description: | + The set of rules governing what traffic a VTAP mirrors. + items: + $ref: '#/components/schemas/VtapCaptureFilterRuleDetails' + type: array + required: + - compartmentId + - id + - lifecycleState + type: object + CreateCaptureFilterDetails: + description: | + A capture filter contains a set of rules governing what traffic a VTAP mirrors or a VCN flow log collects. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the capture filter. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + filterType: + description: Indicates which service will use this capture filter + enum: + - VTAP + 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 + vtapCaptureFilterRules: + description: | + The set of rules governing what traffic a VTAP mirrors. + items: + $ref: '#/components/schemas/VtapCaptureFilterRuleDetails' + type: array + required: + - compartmentId + - filterType + type: object + UpdateCaptureFilterDetails: + description: | + These details can be included in a request to update a capture filter. A capture filter contains a set of rules governing what traffic a VTAP mirrors or a VCN flow log collects. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + vtapCaptureFilterRules: + description: | + The set of rules governing what traffic a VTAP mirrors. + items: + $ref: '#/components/schemas/VtapCaptureFilterRuleDetails' + type: array + type: object + ChangeCaptureFilterCompartmentDetails: + description: | + These configuration details are used in the move operation when changing the compartment containing a capture filter. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the destination compartment for the VTAP + capture filter move. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + CpeDeviceShapeSummary: + description: | + A summary of information about a particular CPE device type. Compare with + [CpeDeviceShapeDetail](#/en/iaas/latest/CpeDeviceShapeDetail/). + properties: + cpeDeviceInfo: + $ref: '#/components/schemas/CpeDeviceInfo' + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE device shape. + This value uniquely identifies the type of CPE device. + maxLength: 255 + minLength: 1 + type: string + type: object + CpeDeviceShapeDetail: + description: | + The detailed information about a particular CPE device type. Compare with + [CpeDeviceShapeSummary](#/en/iaas/latest/CpeDeviceShapeSummary/). + properties: + cpeDeviceInfo: + $ref: '#/components/schemas/CpeDeviceInfo' + cpeDeviceShapeId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE device shape. + This value uniquely identifies the type of CPE device. + maxLength: 255 + minLength: 1 + type: string + parameters: + description: | + For certain CPE devices types, the customer can provide answers to + questions that are specific to the device type. This attribute contains + a list of those questions. The Networking service merges the answers with + other information and renders a set of CPE configuration content. To + provide the answers, use + [UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig). + items: + $ref: '#/components/schemas/CpeDeviceConfigQuestion' + type: array + template: + description: | + A template of CPE device configuration information that will be merged with the customer's + answers to the questions to render the final CPE device configuration content. Also see: + + * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent) + * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent) + * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent) + minLength: 1 + type: string + type: object + Cpe: + description: | + An object you create when setting up a Site-to-Site VPN between your on-premises network + and VCN. The `Cpe` is a virtual representation of your customer-premises equipment, + which is the actual router on-premises at your site at your end of the Site-to-Site VPN IPSec connection. + For more information, + see [Overview of the Networking Service](/iaas/Content/Network/Concepts/overview.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the CPE. + maxLength: 255 + minLength: 1 + type: string + cpeDeviceShapeId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE's device type. + The Networking service maintains a general list of CPE device types (for example, + Cisco ASA). For each type, Oracle provides CPE configuration content that can help + a network engineer configure the CPE. The [OCID](/iaas/Content/General/Concepts/identifiers.htm) uniquely identifies the type of + device. To get the OCIDs for the device types on the list, see + [ListCpeDeviceShapes](#/en/iaas/latest/CpeDeviceShapeSummary/ListCpeDeviceShapes). + + For information about how to generate CPE configuration content for a + CPE device type, see: + + * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent) + * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent) + * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent) + * [GetTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfig) + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The CPE's Oracle ID (OCID). + maxLength: 255 + minLength: 1 + type: string + ipAddress: + description: The public IP address of the on-premises router. + maxLength: 46 + minLength: 1 + type: string + isPrivate: + default: false + description: | + Indicates whether this CPE is of type `private` or not. + type: boolean + timeCreated: + description: | + The date and time the CPE was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - compartmentId + - id + - ipAddress + type: object + CreateCpeDetails: + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the CPE. + maxLength: 255 + minLength: 1 + type: string + cpeDeviceShapeId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE device type. You can provide + a value if you want to later generate CPE device configuration content for IPSec connections + that use this CPE. You can also call [UpdateCpe](#/en/iaas/latest/Cpe/UpdateCpe) later to + provide a value. For a list of possible values, see + [ListCpeDeviceShapes](#/en/iaas/latest/CpeDeviceShapeSummary/ListCpeDeviceShapes). + + For more information about generating CPE device configuration content, see: + + * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent) + * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent) + * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent) + * [GetTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfig) + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + ipAddress: + description: | + The public IP address of the on-premises router. + + Example: `203.0.113.2` + maxLength: 46 + minLength: 1 + type: string + isPrivate: + default: false + description: | + Indicates whether this CPE is of type `private` or not. + type: boolean + required: + - compartmentId + - ipAddress + type: object + UpdateCpeDetails: + properties: + cpeDeviceShapeId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE device type. You can provide + a value if you want to generate CPE device configuration content for IPSec connections + that use this CPE. For a list of possible values, see + [ListCpeDeviceShapes](#/en/iaas/latest/CpeDeviceShapeSummary/ListCpeDeviceShapes). + + For more information about generating CPE device configuration content, see: + + * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent) + * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent) + * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent) + * [GetTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfig) + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + ChangeCpeCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the + CPE object to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + CrossConnectGroup: + description: | + For use with Oracle Cloud Infrastructure FastConnect. A cross-connect group + is a link aggregation group (LAG), which can contain one or more + [CrossConnects](#/en/iaas/latest/CrossConnect). Customers who are colocated with + Oracle in a FastConnect location create and use cross-connect groups. For more + information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). + + **Note:** If you're a provider who is setting up a physical connection to Oracle so customers + can use FastConnect over the connection, be aware that your connection is modeled the + same way as a colocated customer's (with `CrossConnect` and `CrossConnectGroup` objects, and so on). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the cross-connect group. + maxLength: 255 + minLength: 1 + type: string + customerReferenceName: + description: | + A reference name or identifier for the physical fiber connection that this cross-connect + group uses. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The cross-connect group's Oracle ID (OCID). + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The cross-connect group's current state. + enum: + - PROVISIONING + - PROVISIONED + - INACTIVE + - TERMINATING + - TERMINATED + type: string + macsecProperties: + $ref: '#/components/schemas/MacsecProperties' + ociLogicalDeviceName: + description: | + The FastConnect device that terminates the logical connection. + This device might be different than the device that terminates the physical connection. + maxLength: 255 + minLength: 1 + type: string + ociPhysicalDeviceName: + description: | + The FastConnect device that terminates the physical connection. + maxLength: 255 + minLength: 1 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. + Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }` + type: object + timeCreated: + description: | + The date and time the cross-connect group was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + type: object + CreateCrossConnectGroupDetails: + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the cross-connect group. + maxLength: 255 + minLength: 1 + type: string + customerReferenceName: + description: | + A reference name or identifier for the physical fiber connection that this cross-connect + group uses. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + macsecProperties: + $ref: '#/components/schemas/CreateMacsecProperties' + required: + - compartmentId + type: object + UpdateCrossConnectGroupDetails: + properties: + customerReferenceName: + description: | + A reference name or identifier for the physical fiber connection this cross-connect group uses. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + macsecProperties: + $ref: '#/components/schemas/UpdateMacsecProperties' + type: object + ChangeCrossConnectGroupCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the + cross-connect group to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + CrossConnectLocation: + description: An individual FastConnect location. + properties: + description: + description: A description of the location. + maxLength: 255 + minLength: 1 + type: string + name: + description: | + The name of the location. + + Example: `CyrusOne, Chandler, AZ` + maxLength: 255 + minLength: 1 + type: string + required: + - name + - description + type: object + CrossConnectPortSpeedShape: + description: | + An individual port speed level for cross-connects. + properties: + name: + description: | + The name of the port speed shape. + + Example: `10 Gbps` + maxLength: 255 + minLength: 1 + type: string + portSpeedInGbps: + description: | + The port speed in Gbps. + + Example: `10` + maxLength: 255 + minLength: 1 + type: integer + required: + - name + - portSpeedInGbps + type: object + CrossConnect: + description: | + For use with Oracle Cloud Infrastructure FastConnect. A cross-connect represents a + physical connection between an existing network and Oracle. Customers who are colocated + with Oracle in a FastConnect location create and use cross-connects. For more + information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). + + Oracle recommends you create each cross-connect in a + [CrossConnectGroup](#/en/iaas/latest/CrossConnectGroup) so you can use link aggregation + with the connection. + + **Note:** If you're a provider who is setting up a physical connection to Oracle so customers + can use FastConnect over the connection, be aware that your connection is modeled the + same way as a colocated customer's (with `CrossConnect` and `CrossConnectGroup` objects, and so on). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the cross-connect group. + maxLength: 255 + minLength: 1 + type: string + crossConnectGroupId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect group this cross-connect belongs to (if any). + maxLength: 255 + minLength: 1 + type: string + customerReferenceName: + description: | + A reference name or identifier for the physical fiber connection that this cross-connect + uses. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The cross-connect's Oracle ID (OCID). + maxLength: 255 + minLength: 1 + type: string + interfaceName: + description: | + The name of the FastConnect interface where this cross-connect is installed. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The cross-connect's current state. + enum: + - PENDING_CUSTOMER + - PROVISIONING + - PROVISIONED + - INACTIVE + - TERMINATING + - TERMINATED + type: string + locationName: + description: | + The name of the FastConnect location where this cross-connect is installed. + maxLength: 255 + minLength: 1 + type: string + macsecProperties: + $ref: '#/components/schemas/MacsecProperties' + ociLogicalDeviceName: + description: | + The FastConnect device that terminates the logical connection. + This device might be different than the device that terminates the physical connection. + maxLength: 255 + minLength: 1 + type: string + ociPhysicalDeviceName: + description: | + The FastConnect device that terminates the physical connection. + maxLength: 255 + minLength: 1 + type: string + portName: + description: A string identifying the meet-me room port for this cross-connect. + maxLength: 255 + minLength: 1 + type: string + portSpeedShapeName: + description: | + The port speed for this cross-connect. + + Example: `10 Gbps` + type: string + timeCreated: + description: | + The date and time the cross-connect was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + type: object + CreateCrossConnectDetails: + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the cross-connect. + maxLength: 255 + minLength: 1 + type: string + crossConnectGroupId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect group to put this cross-connect in. + maxLength: 255 + minLength: 1 + type: string + customerReferenceName: + description: | + A reference name or identifier for the physical fiber connection that this cross-connect + uses. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + farCrossConnectOrCrossConnectGroupId: + description: | + If you already have an existing cross-connect or cross-connect group at this FastConnect + location, and you want this new cross-connect to be on a different router (for the + purposes of redundancy), provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of that existing cross-connect or + cross-connect group. + 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 + interfaceName: + description: | + The name of the FastConnect interface where this cross-connect is installed. + maxLength: 255 + minLength: 1 + type: string + locationName: + description: | + The name of the FastConnect location where this cross-connect will be installed. + To get a list of the available locations, see + [ListCrossConnectLocations](#/en/iaas/latest/CrossConnectLocation/ListCrossConnectLocations). + + Example: `CyrusOne, Chandler, AZ` + maxLength: 255 + minLength: 1 + type: string + macsecProperties: + $ref: '#/components/schemas/CreateMacsecProperties' + nearCrossConnectOrCrossConnectGroupId: + description: | + If you already have an existing cross-connect or cross-connect group at this FastConnect + location, and you want this new cross-connect to be on the same router, provide the + [OCID](/iaas/Content/General/Concepts/identifiers.htm) of that existing cross-connect or cross-connect group. + maxLength: 255 + minLength: 1 + type: string + ociPhysicalDeviceName: + description: | + The name of the FastConnect device where this cross-connect is installed. + maxLength: 255 + minLength: 1 + type: string + portSpeedShapeName: + description: | + The port speed for this cross-connect. To get a list of the available port speeds, see + [ListCrossConnectPortSpeedShapes](#/en/iaas/latest/CrossConnectPortSpeedShape/ListCrossconnectPortSpeedShapes). + + Example: `10 Gbps` + type: string + required: + - locationName + - portSpeedShapeName + - compartmentId + type: object + UpdateCrossConnectDetails: + description: | + Update a CrossConnect + properties: + customerReferenceName: + description: | + A reference name or identifier for the physical fiber connection this cross-connect uses. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + isActive: + description: | + Set to true to activate the cross-connect. You activate it after the physical cabling + is complete, and you've confirmed the cross-connect's light levels are good and your side + of the interface is up. Activation indicates to Oracle that the physical connection is ready. + + Example: `true` + type: boolean + macsecProperties: + $ref: '#/components/schemas/UpdateMacsecProperties' + type: object + ChangeCrossConnectCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the + cross-connect to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + LetterOfAuthority: + description: | + The Letter of Authority for the cross-connect. You must submit this letter when + requesting cabling for the cross-connect at the FastConnect location. + properties: + authorizedEntityName: + description: The name of the entity authorized by this Letter of Authority. + maxLength: 255 + minLength: 1 + type: string + circuitType: + description: The type of cross-connect fiber, termination, and optical specification. + enum: + - Single_mode_LC + - Single_mode_SC + type: string + crossConnectId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect. + maxLength: 255 + minLength: 1 + type: string + facilityLocation: + description: The address of the FastConnect location. + maxLength: 255 + minLength: 1 + type: string + portName: + description: The meet-me room port for this cross-connect. + maxLength: 255 + minLength: 1 + type: string + timeExpires: + description: | + The date and time when the Letter of Authority expires, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + timeIssued: + description: | + The date and time the Letter of Authority was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + type: object + CrossConnectStatus: + description: The status of the cross-connect. + properties: + crossConnectId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect. + maxLength: 255 + minLength: 1 + type: string + encryptionStatus: + description: | + Encryption status of this cross connect. + + Possible values: + * **UP:** Traffic is encrypted over this cross-connect + * **DOWN:** Traffic is not encrypted over this cross-connect + * **CIPHER_MISMATCH:** The MACsec encryption cipher doesn't match the cipher on the CPE + * **CKN_MISMATCH:** The MACsec Connectivity association Key Name (CKN) doesn't match the CKN on the CPE + * **CAK_MISMATCH:** The MACsec Connectivity Association Key (CAK) doesn't match the CAK on the CPE + enum: + - UP + - DOWN + - CIPHER_MISMATCH + - CKN_MISMATCH + - CAK_MISMATCH + type: string + interfaceState: + description: Indicates whether Oracle's side of the interface is up or down. + enum: + - UP + - DOWN + type: string + lightLevelIndBm: + description: | + The light level of the cross-connect (in dBm). + + Example: `14.0` + format: float + maximum: 50 + minimum: -50 + type: number + lightLevelIndicator: + description: | + Status indicator corresponding to the light level. + + * **NO_LIGHT:** No measurable light + * **LOW_WARN:** There's measurable light but it's too low + * **HIGH_WARN:** Light level is too high + * **BAD:** There's measurable light but the signal-to-noise ratio is bad + * **GOOD:** Good light level + enum: + - NO_LIGHT + - LOW_WARN + - HIGH_WARN + - BAD + - GOOD + type: string + lightLevelsInDBm: + description: | + The light levels of the cross-connect (in dBm). + + Example: `[14.0, -14.0, 2.1, -10.1]` + items: + format: float + maximum: 50 + minimum: -50 + type: number + type: array + required: + - crossConnectId + type: object + DhcpOptions: + description: | + A set of DHCP options. Used by the VCN to automatically provide configuration + information to the instances when they boot up. There are two options you can set: + + - [DhcpDnsOption](#/en/iaas/latest/DhcpDnsOption/): Lets you specify how DNS (hostname resolution) is + handled in the subnets in your VCN. + + - [DhcpSearchDomainOption](#/en/iaas/latest/DhcpSearchDomainOption/): Lets you specify + a search domain name to use for DNS queries. + + For more information, see [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm) + and [DHCP Options](/iaas/Content/Network/Tasks/managingDHCP.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the set of DHCP options. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)) for the set of DHCP options. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The current state of the set of DHCP options. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + type: string + options: + description: The collection of individual DHCP options. + items: + $ref: '#/components/schemas/DhcpOption' + type: array + timeCreated: + description: | + Date and time the set of DHCP options was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the set of DHCP options belongs to. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - options + - lifecycleState + - timeCreated + - vcnId + x-example: | + { + "compartmentId" : "ocid1.compartment.oc1..<unique_ID>", + "displayName" : "MyDhcpOptions", + "id" : "ocid1.dhcpoptions.oc1.phx.<unique_ID>", + "lifecycleState" : "AVAILABLE", + "options" : [{ + "type" : "DomainNameServer", + "customDnsServers" : ["203.0.113.7"], + "serverType":"CustomDnsServer" + }], + "timeCreated" : "2016-12-17T01:31:50.047Z", + "vcnId" : "ocid1.vcn.oc1.phx.<unique_ID>" + } + type: object + CreateDhcpDetails: + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the set of DHCP options. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + options: + description: A set of DHCP options. + items: + $ref: '#/components/schemas/DhcpOption' + type: array + uniqueItems: true + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the set of DHCP options belongs to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - options + - vcnId + type: object + UpdateDhcpDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + options: + items: + $ref: '#/components/schemas/DhcpOption' + type: array + uniqueItems: true + type: object + ChangeDhcpOptionsCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the + set of DHCP options to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + DrgAttachment: + description: | + A DRG attachment serves as a link between a DRG and a network resource. A DRG can be attached to a VCN, + IPSec tunnel, remote peering connection, or virtual circuit. + + For more information, see [Overview of the Networking Service](/iaas/Content/Network/Concepts/overview.htm). + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the DRG attachment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + drgId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG. + maxLength: 255 + minLength: 1 + type: string + drgRouteTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table that is assigned to this attachment. + + The DRG route table manages traffic inside the DRG. + maxLength: 255 + minLength: 1 + type: string + exportDrgRouteDistributionId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the export route distribution used to specify how routes in the assigned DRG route table + are advertised to the attachment. + If this value is null, no routes are advertised through this attachment. + 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 + id: + description: The DRG attachment's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). + maxLength: 255 + minLength: 1 + type: string + isCrossTenancy: + description: | + Indicates whether the DRG attachment and attached network live in a different tenancy than the DRG. + + Example: `false` + type: boolean + lifecycleState: + description: The DRG attachment's current state. + enum: + - ATTACHING + - ATTACHED + - DETACHING + - DETACHED + type: string + networkDetails: + $ref: '#/components/schemas/DrgAttachmentNetworkDetails' + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the DRG attachment is using. + + For information about why you would associate a route table with a DRG attachment, see: + + * [Transit Routing: Access to Multiple VCNs in Same Region](/iaas/Content/Network/Tasks/transitrouting.htm) + * [Transit Routing: Private Access to Oracle Services](/iaas/Content/Network/Tasks/transitroutingoracleservices.htm) + + This field is deprecated. Instead, use the `networkDetails` field to view the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the attached resource. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the DRG attachment was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + vcnId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN. + This field is deprecated. Instead, use the `networkDetails` field to view the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the attached resource. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - drgId + - lifecycleState + type: object + CreateDrgAttachmentDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + drgId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG. + maxLength: 255 + minLength: 1 + type: string + drgRouteTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table that is assigned to this attachment. + + The DRG route table manages traffic inside the DRG. + 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 + networkDetails: + $ref: '#/components/schemas/DrgAttachmentNetworkCreateDetails' + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table used by the DRG attachment. + + If you don't specify a route table here, the DRG attachment is created without an associated route + table. The Networking service does NOT automatically associate the attached VCN's default route table + with the DRG attachment. + For information about why you would associate a route table with a DRG attachment, see: + + * [Transit Routing: Access to Multiple VCNs in Same Region](/iaas/Content/Network/Tasks/transitrouting.htm) + * [Transit Routing: Private Access to Oracle Services](/iaas/Content/Network/Tasks/transitroutingoracleservices.htm) + This field is deprecated. Instead, use the networkDetails field to specify the VCN route table for this attachment. + maxLength: 255 + minLength: 1 + type: string + vcnId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN. + This field is deprecated. Instead, use the `networkDetails` field to specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the attached resource. + maxLength: 255 + minLength: 1 + type: string + required: + - drgId + type: object + UpdateDrgAttachmentDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + drgRouteTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table that is assigned to this attachment. + + The DRG route table manages traffic inside the DRG. + + You can't remove a DRG route table from a DRG attachment, but you can reassign which + DRG route table it uses. + maxLength: 255 + minLength: 1 + type: string + exportDrgRouteDistributionId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the export route distribution used to specify how routes in the assigned DRG route table + are advertised out through the attachment. + If this value is null, no routes are advertised through this attachment. + 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 + networkDetails: + $ref: '#/components/schemas/DrgAttachmentNetworkUpdateDetails' + routeTableId: + description: | + This is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table that is used to route the traffic as it enters a VCN through this attachment. + + For information about why you would associate a route table with a DRG attachment, see: + + * [Transit Routing: Access to Multiple VCNs in Same Region](/iaas/Content/Network/Tasks/transitrouting.htm) + * [Transit Routing: Private Access to Oracle Services](/iaas/Content/Network/Tasks/transitroutingoracleservices.htm) + maxLength: 255 + minLength: 1 + type: string + type: object + DrgRouteDistribution: + description: | + A route distribution establishes how routes get imported into DRG route tables and exported through the DRG attachments. + + A route distribution is a list of statements. Each statement consists of a set of matches, all of which must be `True` for the statement's action to take place. Each statement determines which routes are propagated. + + You can assign a route distribution as a route table's import distribution. The statements in an import + route distribution specify how how incoming route advertisements through a referenced attachment or all attachments of a certain type are inserted into the route table. + + You can assign a route distribution as a DRG attachment's export distribution unless the + attachment has the type `VCN`. Exporting routes through a VCN attachment is unsupported. Export + route distribution statements specify how routes in a DRG attachment's assigned table are + advertised out through the attachment. When a DRG is created, a route distribution is created + with a single ACCEPT statement with match criteria MATCH_ALL. By default, all DRG attachments + (except for those of type VCN), are assigned this distribution. You can't create a new export route distribution, one is created for you when the DRG is created. + + + The two auto-generated DRG route tables (one as the default for VCN attachments, and the other for all other types of attachments) + are each assigned an auto generated import route distribution. The default VCN table's import distribution has a single statement with match criteria MATCH_ALL to import routes from + each DRG attachment type. The other table's import distribution has a statement to import routes from attachments with the VCN type. + + The route distribution is always in the same compartment as the DRG. + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the route distribution. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + distributionType: + description: | + Whether this distribution defines how routes get imported into route tables or exported through DRG attachments. + enum: + - IMPORT + - EXPORT + type: string + drgId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG that contains this route distribution. + 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 + id: + description: The route distribution's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The route distribution's current state. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + type: string + timeCreated: + description: | + The date and time the route distribution was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - drgId + - id + - timeCreated + - lifecycleState + - compartmentId + - distributionType + type: object + CreateDrgRouteDistributionDetails: + description: | + Details used to create an import route distribution. You can't create a new export route distribution. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + distributionType: + description: | + States that this distribution defines how routes get imported into route tables. + enum: + - IMPORT + type: string + drgId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG the DRG route table belongs to. + 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 + required: + - drgId + - distributionType + type: object + UpdateDrgRouteDistributionDetails: + description: | + Details used in a request to update a route distribution. + + You cannot assign a table to a virtual circuit or IPSec tunnel attachment if there is a static route rule for an RPC attachment. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + AddDrgRouteDistributionStatementsDetails: + description: | + Details request to add statements to a route distribution. + properties: + statements: + description: | + The collection of route distribution statements to insert into the route distribution. + items: + $ref: '#/components/schemas/AddDrgRouteDistributionStatementDetails' + maxItems: 100 + minItems: 0 + type: array + required: + - statements + type: object + DrgRouteDistributionStatement: + description: | + A single statement within a route distribution. All match criteria in a statement must be met + for the action to take place. + properties: + action: + description: | + `ACCEPT` indicates the route should be imported or exported as-is. + enum: + - ACCEPT + type: string + id: + description: | + The Oracle-assigned ID of the route distribution statement. + maxLength: 255 + minLength: 1 + type: string + matchCriteria: + description: | + The action is applied only if all of the match criteria is met. + If there are no match criteria in a statement, any input is considered a match and the action is applied. + items: + $ref: '#/components/schemas/DrgRouteDistributionMatchCriteria' + maxItems: 1 + minItems: 0 + type: array + priority: + description: | + This field specifies the priority of each statement in a route distribution. + Priorities must be unique within a particular route distribution. + The priority will be represented as a number between 0 and 65535 where a lower number + indicates a higher priority. When a route is processed, statements are applied in the order + defined by their priority. The first matching rule dictates the action that will be taken + on the route. + maximum: 65535 + minimum: 1 + type: integer + required: + - matchCriteria + - action + - priority + - id + type: object + RemoveDrgRouteDistributionStatementsDetails: + description: | + Details request to remove statements from a route distribution. + properties: + statementIds: + description: | + The Oracle-assigned ID of each route distribution to remove. + items: + type: string + maxItems: 100 + minItems: 1 + type: array + type: object + UpdateDrgRouteDistributionStatementsDetails: + description: | + Details request to update statements in a route distribution. + properties: + statements: + description: | + The route distribution statements to update, and the details to be updated. + items: + $ref: '#/components/schemas/UpdateDrgRouteDistributionStatementDetails' + maxItems: 100 + minItems: 0 + type: array + required: + - statements + type: object + DrgRouteTable: + description: | + All routing inside the DRG is driven by the contents of DRG route tables. + DRG route tables contain rules which route packets to a particular network destination, + represented as a DRG attachment. + The routing decision for a packet entering a DRG is determined by the rules in the DRG route table + assigned to the attachment-of-entry. + + Each DRG attachment can inject routes in any DRG route table, provided there is a statement corresponding to the attachment in the route table's `importDrgRouteDistribution`. + You can also insert static routes into the DRG route tables. + + The DRG route table is always in the same compartment as the DRG. There must always be a default + DRG route table for each attachment type. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment the DRG is in. The DRG route table + is always in the same compartment as the DRG. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + drgId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG the DRG that contains this route table. + 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 + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the + DRG route table. + maxLength: 255 + minLength: 1 + type: string + importDrgRouteDistributionId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the import route distribution used to specify how incoming route advertisements from + referenced attachments are inserted into the DRG route table. + maxLength: 255 + minLength: 1 + type: string + isEcmpEnabled: + description: | + If you want traffic to be routed using ECMP across your virtual circuits or IPSec tunnels to + your on-premises network, enable ECMP on the DRG route table to which these attachments + import routes. + type: boolean + lifecycleState: + description: The DRG route table's current state. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + type: string + timeCreated: + description: | + The date and time the DRG route table was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - drgId + - id + - timeCreated + - compartmentId + - lifecycleState + - isEcmpEnabled + x-example: | + { + "drgId" : "ocid1.drg.oc1..<unique_ID>", + "id" : "ocid1.drgroutetable.oc1..<unique_ID>" + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "lifecycleState": "AVAILABLE", + "timeCreated" : "2016-12-16T22:43:25.588Z" + } + type: object + CreateDrgRouteTableDetails: + description: | + Details used in a request to create a DRG route table. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + drgId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG the DRG route table belongs to. + 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 + importDrgRouteDistributionId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the import route distribution used to specify how incoming route advertisements through + referenced attachments are inserted into the DRG route table. + maxLength: 255 + minLength: 1 + type: string + isEcmpEnabled: + default: false + description: | + If you want traffic to be routed using ECMP across your virtual circuits or IPSec tunnels to + your on-premises networks, enable ECMP on the DRG route table. + type: boolean + required: + - drgId + type: object + UpdateDrgRouteTableDetails: + description: | + Details used in a request to update a DRG route table. + + You can't assign a table to a virtual circuit or IPSec tunnel attachment if there is a static route rule for an RPC attachment. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + importDrgRouteDistributionId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the import route distribution used to specify how incoming route advertisements through + referenced attachements are inserted into the DRG route table. + maxLength: 255 + minLength: 1 + type: string + isEcmpEnabled: + description: | + If you want traffic to be routed using ECMP across your virtual circuits or IPSec tunnels to + your on-prem networks, set this value to true on the route table. + type: boolean + type: object + AddDrgRouteRulesDetails: + description: | + Details used in a request to add static routes to a DRG route table. + properties: + routeRules: + description: | + The collection of static rules used to insert routes into the DRG route table. + items: + $ref: '#/components/schemas/AddDrgRouteRuleDetails' + maxItems: 100 + minItems: 1 + type: array + type: object + DrgRouteRule: + description: | + A DRG route rule is a mapping between a destination IP address range and a DRG attachment. + The map is used to route matching packets. Traffic will be routed across the attachments using Equal-cost multi-path routing (ECMP) + if there are multiple rules with identical destinations and none of the rules conflict. + properties: + attributes: + additionalProperties: true + description: | + Additional properties for the route, computed by the service. + type: object + destination: + description: | + Represents the range of IP addresses to match against when routing traffic. + + Potential values: + * An IP address range (IPv4 or IPv6) in CIDR notation. For example: `192.168.1.0/24` + or `2001:0db8:0123:45::/56`. + * When you're setting up a security rule for traffic destined for a particular `Service` through + a service gateway, this is the `cidrBlock` value associated with that [Service](#/en/iaas/20160918/Service/). For example: `oci-phx-objectstorage`. + maxLength: 255 + minLength: 1 + type: string + destinationType: + description: | + The type of destination for the rule. + + Allowed values: + + * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation. + * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a + [Service](#/en/iaas/latest/Service/) (the rule is for traffic destined for a + particular `Service` through a service gateway). + enum: + - CIDR_BLOCK + - SERVICE_CIDR_BLOCK + type: string + id: + description: | + The Oracle-assigned ID of the DRG route rule. + maxLength: 255 + minLength: 1 + type: string + isBlackhole: + default: false + description: | + Indicates that if the next hop attachment does not exist, so traffic for this route is discarded without notification. + type: boolean + isConflict: + default: false + description: | + Indicates that the route was not imported due to a conflict between route rules. + type: boolean + nextHopDrgAttachmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the next hop DRG attachment responsible + for reaching the network destination. + + A value of `BLACKHOLE` means traffic for this route is discarded without notification. + maxLength: 255 + minLength: 1 + type: string + routeProvenance: + description: | + The earliest origin of a route. If a route is advertised to a DRG through an IPsec tunnel attachment, + and is propagated to peered DRGs via RPC attachments, the route's provenance in the peered DRGs remains `IPSEC_TUNNEL`, + because that is the earliest origin. + + No routes with a provenance `IPSEC_TUNNEL` or `VIRTUAL_CIRCUIT` will be exported to IPsec tunnel or virtual circuit attachments, + regardless of the attachment's export distribution. + enum: + - STATIC + - VCN + - VIRTUAL_CIRCUIT + - IPSEC_TUNNEL + type: string + routeType: + description: | + You can specify static routes for the DRG route table using the API. + The DRG learns dynamic routes from the DRG attachments using various routing protocols. + enum: + - STATIC + - DYNAMIC + type: string + required: + - destination + - nextHopDrgAttachmentId + - destinationType + - id + - routeProvenance + type: object + RemoveDrgRouteRulesDetails: + description: | + Details used in a request to remove static routes from a DRG route table. + properties: + routeRuleIds: + description: | + The Oracle-assigned ID of each DRG route rule to be deleted. + items: + type: string + maxItems: 100 + minItems: 1 + type: array + type: object + UpdateDrgRouteRulesDetails: + description: | + Details used to update route rules in a DRG route table. + properties: + routeRules: + description: The DRG rute rules to update. + items: + $ref: '#/components/schemas/UpdateDrgRouteRuleDetails' + maxItems: 100 + minItems: 1 + type: array + type: object + Drg: + description: | + A dynamic routing gateway (DRG) is a virtual router that provides a path for private + network traffic between networks. You use it with other Networking + Service components to create a connection to your on-premises network using [Site-to-Site VPN](/iaas/Content/Network/Tasks/managingIPsec.htm) or a connection that uses + [FastConnect](/iaas/Content/Network/Concepts/fastconnect.htm). For more information, see + [Networking Overview](/iaas/Content/Network/Concepts/overview.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the DRG. + maxLength: 255 + minLength: 1 + type: string + defaultDrgRouteTables: + $ref: '#/components/schemas/DefaultDrgRouteTables' + defaultExportDrgRouteDistributionId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this DRG's default export route distribution for the DRG attachments. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The DRG's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The DRG's current state. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + type: string + timeCreated: + description: | + The date and time the DRG was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - compartmentId + - id + - lifecycleState + x-example: | + { + "compartmentId" : "ocid1.compartment.oc1..<unique_ID>", + "displayName" : "MyDrg", + "id" : "ocid1.drg.oc1.phx.<unique_ID>", + "lifecycleState" : "PROVISIONING", + "timeCreated" : "2016-12-16T22:34:20.948Z" + } + type: object + CreateDrgDetails: + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the DRG. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + required: + - compartmentId + type: object + UpdateDrgDetails: + properties: + defaultDrgRouteTables: + $ref: '#/components/schemas/DefaultDrgRouteTables' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + DrgAttachmentInfo: + description: | + The `DrgAttachmentInfo` resource contains the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment. + properties: + id: + description: | + The Oracle-assigned ID of the DRG attachment + maxLength: 255 + minLength: 1 + type: string + required: + - id + type: object + UpgradeStatus: + description: | + The upgrade status of a DRG. + properties: + drgId: + description: | + The `drgId` of the upgraded DRG. + type: string + status: + description: | + The current upgrade status of the DRG attachment. + enum: + - NOT_UPGRADED + - IN_PROGRESS + - UPGRADED + type: string + upgradedConnections: + description: | + The number of upgraded connections. + type: string + required: + - drgId + - status + - upgradedConnections + type: object + DrgRedundancyStatus: + description: | + The redundancy status of the DRG. For more information, see + [Redundancy Remedies](/iaas/Content/Network/Troubleshoot/drgredundancy.htm). + properties: + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG. + maxLength: 255 + minLength: 1 + type: string + status: + description: The redundancy status of the DRG. + enum: + - NOT_AVAILABLE + - REDUNDANT + - NOT_REDUNDANT_SINGLE_IPSEC + - NOT_REDUNDANT_SINGLE_VIRTUALCIRCUIT + - NOT_REDUNDANT_MULTIPLE_IPSECS + - NOT_REDUNDANT_MULTIPLE_VIRTUALCIRCUITS + - NOT_REDUNDANT_MIX_CONNECTIONS + - NOT_REDUNDANT_NO_CONNECTION + type: string + type: object + FastConnectProviderService: + description: | + A service offering from a supported provider. For more information, + see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). + properties: + bandwithShapeManagement: + description: | + Who is responsible for managing the virtual circuit bandwidth. + enum: + - CUSTOMER_MANAGED + - PROVIDER_MANAGED + - ORACLE_MANAGED + type: string + customerAsnManagement: + description: | + Who is responsible for managing the ASN information for the network at the other end + of the connection from Oracle. + enum: + - CUSTOMER_MANAGED + - PROVIDER_MANAGED + - ORACLE_MANAGED + type: string + description: + description: | + The location of the provider's website or portal. This portal is where you can get information + about the provider service, create a virtual circuit connection from the provider to Oracle + Cloud Infrastructure, and retrieve your provider service key for that virtual circuit connection. + + Example: `https://example.com` + maxLength: 255 + minLength: 1 + type: string + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the service offered by the provider. + maxLength: 255 + minLength: 1 + type: string + privatePeeringBgpManagement: + description: | + Who is responsible for managing the private peering BGP information. + enum: + - CUSTOMER_MANAGED + - PROVIDER_MANAGED + - ORACLE_MANAGED + type: string + providerName: + description: | + The name of the provider. + maxLength: 255 + minLength: 1 + type: string + providerServiceKeyManagement: + description: | + Who is responsible for managing the provider service key. + enum: + - CUSTOMER_MANAGED + - PROVIDER_MANAGED + - ORACLE_MANAGED + type: string + providerServiceName: + description: | + The name of the service offered by the provider. + maxLength: 255 + minLength: 1 + type: string + publicPeeringBgpManagement: + description: | + Who is responsible for managing the public peering BGP information. + enum: + - CUSTOMER_MANAGED + - PROVIDER_MANAGED + - ORACLE_MANAGED + type: string + requiredTotalCrossConnects: + description: | + Total number of cross-connect or cross-connect groups required for the virtual circuit. + type: integer + supportedVirtualCircuitTypes: + description: | + An array of virtual circuit types supported by this service. + items: + enum: + - PUBLIC + - PRIVATE + type: string + maximum: 2 + minimum: 0 + type: array + type: + description: | + Provider service type. + enum: + - LAYER2 + - LAYER3 + type: string + required: + - id + - providerName + - providerServiceName + - type + - privatePeeringBgpManagement + - publicPeeringBgpManagement + - customerAsnManagement + - providerServiceKeyManagement + - bandwithShapeManagement + - requiredTotalCrossConnects + type: object + FastConnectProviderServiceKey: + description: | + A provider service key and its details. A provider service key is an identifier for a provider's + virtual circuit. + properties: + bandwidthShapeName: + description: | + The provisioned data rate of the connection. To get a list of the + available bandwidth levels (that is, shapes), see + [ListFastConnectProviderServiceVirtualCircuitBandwidthShapes](#/en/iaas/latest/FastConnectProviderService/ListFastConnectProviderVirtualCircuitBandwidthShapes). + + Example: `10 Gbps` + type: string + name: + description: | + The service key that the provider gives you when you set up a virtual circuit connection + from the provider to Oracle Cloud Infrastructure. Use this value as the `providerServiceKeyName` + query parameter for + [GetFastConnectProviderServiceKey](#/en/iaas/latest/FastConnectProviderServiceKey/GetFastConnectProviderServiceKey). + maxLength: 255 + minLength: 1 + type: string + peeringLocation: + description: The provider's peering location. + maxLength: 255 + minLength: 1 + type: string + required: + - name + type: object + VirtualCircuitBandwidthShape: + description: | + An individual bandwidth level for virtual circuits. + properties: + bandwidthInMbps: + description: | + The bandwidth in Mbps. + + Example: `10000` + type: integer + name: + description: | + The name of the bandwidth shape. + + Example: `10 Gbps` + maxLength: 255 + minLength: 1 + type: string + required: + - name + type: object + InternetGateway: + description: | + Represents a router that connects the edge of a VCN with the Internet. For an example scenario + that uses an internet gateway, see + [Typical Networking Service Scenarios](/iaas/Content/Network/Concepts/overview.htm#scenarios). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the internet gateway. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The internet gateway's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). + maxLength: 255 + minLength: 1 + type: string + isEnabled: + description: | + Whether the gateway is enabled. When the gateway is disabled, traffic is not + routed to/from the Internet, regardless of route rules. + type: boolean + lifecycleState: + description: The internet gateway's current state. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + type: string + routeTableId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the Internet Gateway is using. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the internet gateway was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the Internet Gateway belongs to. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - lifecycleState + - vcnId + x-example: | + { + "compartmentId" : "ocid1.compartment.oc1..<unique_ID>", + "displayName" : "MyInternetGateway", + "id" : "ocid1.internetgateway.oc1.phx.<unique_ID>", + "isEnabled" : true, + "lifecycleState" : "AVAILABLE", + "timeCreated" : "2016-12-14T20:56:24.516Z", + "vcnId" : "ocid1.vcn.oc1.phx.<unique_ID>" + } + type: object + CreateInternetGatewayDetails: + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the internet gateway. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + isEnabled: + description: Whether the gateway is enabled upon creation. + type: boolean + routeTableId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the Internet Gateway is using. + maxLength: 255 + minLength: 1 + type: string + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the Internet Gateway is attached to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - vcnId + - isEnabled + type: object + UpdateInternetGatewayDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + isEnabled: + description: Whether the gateway is enabled. + type: boolean + routeTableId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the Internet Gateway is using. + maxLength: 255 + minLength: 1 + type: string + type: object + ChangeInternetGatewayCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the + internet gateway to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ListIpInventoryDetails: + description: | + Required input parameters for retrieving IP Inventory data within the specified compartments of a region. + properties: + addressTypeList: + description: List of IP address types used. + items: + $ref: '#/components/schemas/AddressType' + type: array + compartmentList: + description: List the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartments. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + overlappingVcnsOnly: + default: false + description: List of overlapping VCNs. + type: boolean + overrideFilters: + default: false + description: List of selected filters. + type: boolean + paginationLimit: + default: 10 + description: | + Specifies the maximum number of results displayed per page for a paginated "List" call. For more information, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + Example: `50` + format: int32 + maximum: 50 + minimum: 1 + type: integer + paginationOffset: + default: 0 + description: | + Most List operations paginate results. Results are paginated for the ListInstances operations. When you call a paginated List operation, the response indicates more pages of results by including the opc-next-page header. + For more information, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + format: int32 + maxLength: 4096 + minLength: 1 + type: integer + regionList: + description: Lists the selected regions. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + resourceTypeList: + description: List of VCN resource types. + items: + enum: + - Resource + type: string + type: array + searchKeyword: + description: Filters the results for the specified string. + maxLength: 255 + minLength: 0 + type: string + sortBy: + default: DISPLAYNAME + description: | + Provide the sort order (`sortOrder`) to sort the fields such as TIMECREATED in descending or descending order, and DISPLAYNAME in case sensitive. + + **Note:** For some "List" operations (for example, `ListInstances`), sort resources by an availability domain when the resources belong to a single availability domain. + If you sort the "List" operations without specifying + an availability domain, the resources are grouped by availability domains and then sorted. + enum: + - DISPLAYNAME + - UTILIZATION + - DNS_HOSTNAME + - REGION + type: string + x-default-description: The default field to sort by varies by API. + sortOrder: + default: ASC + description: | + Specifies the sort order to use. Select either ascending (`ASC`) or descending (`DESC`) order. The DISPLAYNAME sort order + is case sensitive. + enum: + - ASC + - DESC + type: string + x-default-description: The default sort order varies by API. + utilization: + description: The CIDR utilization of a VCN. + format: float + maximum: 100 + minimum: 0 + type: number + required: + - regionList + - compartmentList + type: object + IpInventoryCollection: + description: The results returned by a `ListIpInventory` operation. + properties: + compartmentsPerTenant: + description: | + The number of compartments per compartments per tenant. + format: int64 + type: integer + count: + description: Species the count for the number of results for the response. + format: int32 + type: integer + inventoryVcnCollection: + description: | + Lists `IpInventoryVcnSummary` objects. + items: + $ref: '#/components/schemas/InventoryVcnSummary' + type: array + lastUpdatedTimestamp: + description: | + The timestamp of the latest update from the database in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + message: + description: | + Indicates the status of the data. + maxLength: 255 + minLength: 1 + type: string + type: object + IpInventorySubnetResourceCollection: + description: The results returned by a `ListIpInventorySubnet` operation. + properties: + compartmentId: + description: | + The compartment of the subnet. + maxLength: 255 + minLength: 1 + type: string + count: + description: Specifies the count for the number of results for the response. + format: int32 + type: integer + ipInventorySubnetResourceSummary: + description: | + Lists `SubnetResourceSummary` objects. + items: + $ref: '#/components/schemas/IpInventorySubnetResourceSummary' + type: array + lastUpdatedTimestamp: + description: | + The Timestamp of the latest update from the database in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + message: + description: | + Indicates the status of the data. + maxLength: 255 + minLength: 1 + type: string + type: object + IpInventoryCidrUtilizationCollection: + description: The IP Inventory CIDR utilization details of a subnet. + properties: + compartmentId: + description: | + Compartment of the subnet. + maxLength: 255 + minLength: 1 + type: string + count: + description: Specifies the count for the number of results for the response. + format: int32 + type: integer + ipInventoryCidrUtilizationSummary: + description: | + Lists 'IpInventoryCidrUtilizationSummary` object. + items: + $ref: '#/components/schemas/IpInventoryCidrUtilizationSummary' + type: array + lastUpdatedTimestamp: + description: | + The Timestamp of the latest update from the database in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + message: + description: Indicates the status of the data. + maxLength: 255 + minLength: 1 + type: string + type: object + GetIpInventoryVcnOverlapDetails: + description: Lists the compartment to find VCN overlap. + properties: + compartmentList: + description: The list of [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartments. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + regionList: + description: Lists the selected regions. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + required: + - regionList + - compartmentList + type: object + IpInventoryVcnOverlapCollection: + description: The details of the overlapping VCNs and compartments. + properties: + ipInventoryVcnOverlapSummary: + description: | + Lists `IpInventoryVcnOverlapSummary` object. + items: + $ref: '#/components/schemas/IpInventoryVcnOverlapSummary' + type: array + lastUpdatedTimestamp: + description: | + The timestamp of the latest update from the database in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + message: + description: Indicates the status of the data. + maxLength: 255 + minLength: 1 + type: string + overlapCount: + description: The overlap count for the given VCN and compartments. + format: int32 + type: integer + type: object + AllowedIkeIPSecParameters: + description: Lists the current allowed and default IPSec tunnel parameters. + properties: + allowedPhaseOneParameters: + $ref: '#/components/schemas/AllowedPhaseOneParameters' + allowedPhaseTwoParameters: + $ref: '#/components/schemas/AllowedPhaseTwoParameters' + defaultPhaseOneParameters: + $ref: '#/components/schemas/DefaultPhaseOneParameters' + defaultPhaseTwoParameters: + $ref: '#/components/schemas/DefaultPhaseTwoParameters' + required: + - allowedPhaseOneParameters + - allowedPhaseTwoParameters + - defaultPhaseOneParameters + - defaultPhaseTwoParameters + type: object + IPSecConnection: + description: | + A connection between a DRG and CPE. This connection consists of multiple IPSec + tunnels. Creating this connection is one of the steps required when setting up + a Site-to-Site VPN. + + **Important:** Each tunnel in an IPSec connection can use either static routing or BGP dynamic + routing (see the [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/) object's + `routing` attribute). Originally only static routing was supported and + every IPSec connection was required to have at least one static route configured. + To maintain backward compatibility in the API when support for BPG dynamic routing was introduced, + the API accepts an empty list of static routes if you configure both of the IPSec tunnels to use + BGP dynamic routing. If you switch a tunnel's routing from `BGP` to `STATIC`, you must first + ensure that the IPSec connection is configured with at least one valid CIDR block static route. + Oracle uses the IPSec connection's static routes when routing a tunnel's traffic *only* + if that tunnel's `routing` attribute = `STATIC`. Otherwise the static routes are ignored. + + For more information about the workflow for setting up an IPSec connection, see + [Site-to-Site VPN Overview](/iaas/Content/Network/Tasks/overviewIPsec.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the IPSec connection. + maxLength: 255 + minLength: 1 + type: string + cpeId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the [Cpe](#/en/iaas/latest/Cpe/) object. + maxLength: 255 + minLength: 1 + type: string + cpeLocalIdentifier: + description: | + Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, + the fully qualified domain name (FQDN)). The type of identifier here must correspond + to the value for `cpeLocalIdentifierType`. + + If you don't provide a value when creating the IPSec connection, the `ipAddress` attribute + for the [Cpe](#/en/iaas/latest/Cpe/) object specified by `cpeId` is used as the `cpeLocalIdentifier`. + + For information about why you'd provide this value, see + [If Your CPE Is Behind a NAT Device](/iaas/Content/Network/Tasks/overviewIPsec.htm#nat). + + Example IP address: `10.0.3.3` + + Example hostname: `cpe.example.com` + maxLength: 255 + minLength: 1 + type: string + cpeLocalIdentifierType: + description: | + The type of identifier for your CPE device. The value here must correspond to the value + for `cpeLocalIdentifier`. + enum: + - IP_ADDRESS + - HOSTNAME + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + drgId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG. + 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 + id: + description: The IPSec connection's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The IPSec connection's current state. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + type: string + staticRoutes: + description: | + Static routes to the CPE. The CIDR must not be a + multicast address or class E address. + + Used for routing a given IPSec tunnel's traffic only if the tunnel + is using static routing. If you configure at least one tunnel to use static routing, then + you must provide at least one valid static route. If you configure both + tunnels to use BGP dynamic routing, you can provide an empty list for the static routes. + + The CIDR can be either IPv4 or IPv6. IPv6 addressing is supported for all commercial and government regions. + See [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + + Example: `10.0.1.0/24` + + Example: `2001:db8::/32` + items: + maxLength: 10 + type: string + type: array + uniqueItems: true + timeCreated: + description: | + The date and time the IPSec connection was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + transportType: + default: INTERNET + description: | + The transport type used for the IPSec connection. + enum: + - INTERNET + - FASTCONNECT + type: string + required: + - compartmentId + - id + - drgId + - cpeId + - lifecycleState + type: object + CreateIPSecConnectionDetails: + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the IPSec connection. + maxLength: 255 + minLength: 1 + type: string + cpeId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the [Cpe](#/en/iaas/latest/Cpe/) object. + maxLength: 255 + minLength: 1 + type: string + cpeLocalIdentifier: + description: | + Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the + fully qualified domain name (FQDN)). The type of identifier you provide here must correspond + to the value for `cpeLocalIdentifierType`. + + If you don't provide a value, the `ipAddress` attribute for the [Cpe](#/en/iaas/latest/Cpe/) + object specified by `cpeId` is used as the `cpeLocalIdentifier`. + + For information about why you'd provide this value, see + [If Your CPE Is Behind a NAT Device](/iaas/Content/Network/Tasks/overviewIPsec.htm#nat). + + Example IP address: `10.0.3.3` + + Example hostname: `cpe.example.com` + maxLength: 255 + minLength: 1 + type: string + cpeLocalIdentifierType: + description: | + The type of identifier for your CPE device. The value you provide here must correspond to the value + for `cpeLocalIdentifier`. + enum: + - IP_ADDRESS + - HOSTNAME + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + drgId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG. + 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 + staticRoutes: + description: | + Static routes to the CPE. A static route's CIDR must not be a + multicast address or class E address. + + Used for routing a given IPSec tunnel's traffic only if the tunnel + is using static routing. If you configure at least one tunnel to use static routing, then + you must provide at least one valid static route. If you configure both + tunnels to use BGP dynamic routing, you can provide an empty list for the static routes. + For more information, see the important note in [IPSecConnection](#/en/iaas/latest/IPSecConnection/). + + The CIDR can be either IPv4 or IPv6. IPv6 addressing is supported for all commercial and government regions. + See [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + + Example: `10.0.1.0/24` + + Example: `2001:db8::/32` + items: + type: string + maxLength: 10 + minLength: 1 + type: array + uniqueItems: true + tunnelConfiguration: + description: | + Information for creating the individual tunnels in the IPSec connection. You can provide a + maximum of 2 `tunnelConfiguration` objects in the array (one for each of the + two tunnels). + items: + $ref: '#/components/schemas/CreateIPSecConnectionTunnelDetails' + type: array + required: + - compartmentId + - drgId + - cpeId + type: object + UpdateIPSecConnectionDetails: + properties: + cpeLocalIdentifier: + description: | + Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the + fully qualified domain name (FQDN)). The type of identifier you provide here must correspond + to the value for `cpeLocalIdentifierType`. + + For information about why you'd provide this value, see + [If Your CPE Is Behind a NAT Device](/iaas/Content/Network/Tasks/overviewIPsec.htm#nat). + + Example IP address: `10.0.3.3` + + Example hostname: `cpe.example.com` + maxLength: 255 + minLength: 1 + type: string + cpeLocalIdentifierType: + description: | + The type of identifier for your CPE device. The value you provide here must correspond to the value + for `cpeLocalIdentifier`. + enum: + - IP_ADDRESS + - HOSTNAME + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + staticRoutes: + description: | + Static routes to the CPE. If you provide this attribute, it replaces the entire current set of + static routes. A static route's CIDR must not be a multicast address or class E address. + The CIDR can be either IPv4 or IPv6. + IPv6 addressing is supported for all commercial and government regions. + See [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + + Example: `10.0.1.0/24` + + Example: `2001:db8::/32` + items: + type: string + maxLength: 10 + minLength: 1 + type: array + uniqueItems: true + type: object + ChangeIPSecConnectionCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the + IPSec connection to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + IPSecConnectionDeviceConfig: + description: | + Deprecated. For tunnel information, instead see: + + * [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/) + * [IPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/) + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the IPSec connection. + maxLength: 255 + minLength: 1 + type: string + id: + description: The IPSec connection's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: The date and time the IPSec connection was created. + format: date-time + type: string + tunnels: + description: Two [TunnelConfig](#/en/iaas/latest/TunnelConfig/) objects. + items: + $ref: '#/components/schemas/TunnelConfig' + type: array + required: + - compartmentId + - id + x-example: | + { + "compartmentId" : "ocid1.compartment.oc1..<unique_ID>", + "id" : "ocid1.ipsecconnection.oc1.phx.<unique_ID>", + "timeCreated" : "2016-12-16T22:43:25.588Z", + "tunnels" : [{ + "ipAddress" : "203.0.113.50", + "sharedSecret" : "<example_shared_secret>", + "timeCreated" : "2016-12-16T22:43:31.826Z" + }, { + "ipAddress" : "203.0.113.52", + "sharedSecret" : "<example_shared_secret>", + "timeCreated" : "2016-12-16T22:43:31.861Z" + }, { + "ipAddress" : "203.0.113.51", + "sharedSecret" : "<example_shared_secret>", + "timeCreated" : "2016-12-16T22:43:31.844Z" + }] + } + type: object + IPSecConnectionDeviceStatus: + description: | + Deprecated. For tunnel information, instead see + [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/). + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the IPSec connection. + maxLength: 255 + minLength: 1 + type: string + id: + description: The IPSec connection's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the IPSec connection was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + tunnels: + description: Two [TunnelStatus](#/en/iaas/latest/TunnelStatus/) objects. + items: + $ref: '#/components/schemas/TunnelStatus' + type: array + required: + - compartmentId + - id + type: object + IPSecConnectionTunnel: + description: | + Information about a single IPSec tunnel in an IPSec connection. This object does not include the tunnel's + shared secret (pre-shared key), which is found in the + [IPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/) object. + properties: + associatedVirtualCircuits: + description: | + The list of virtual circuit [OCID](/iaas/Content/General/Concepts/identifiers.htm)s over which your network can reach this tunnel. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + uniqueItems: true + bgpSessionInfo: + $ref: '#/components/schemas/BgpSessionInfo' + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the tunnel. + maxLength: 255 + minLength: 1 + type: string + cpeIp: + description: | + The IP address of the CPE device's VPN headend. + + Example: `203.0.113.22` + maxLength: 46 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + dpdMode: + description: | + Dead peer detection (DPD) mode set on the Oracle side of the connection. + This mode sets whether Oracle can only respond to a request from the CPE device to start DPD, + or both respond to and initiate requests. + enum: + - INITIATE_AND_RESPOND + - RESPOND_ONLY + type: string + dpdTimeoutInSec: + description: DPD timeout in seconds. + type: integer + encryptionDomainConfig: + $ref: '#/components/schemas/EncryptionDomainConfig' + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The tunnel's lifecycle state. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + type: string + natTranslationEnabled: + description: | + By default (the `AUTO` setting), IKE sends packets with a source and destination port set to 500, + and when it detects that the port used to forward packets has changed (most likely because a NAT device + is between the CPE device and the Oracle VPN headend) it will try to negotiate the use of NAT-T. + + The `ENABLED` option sets the IKE protocol to use port 4500 instead of 500 and forces encapsulating traffic with the ESP protocol inside UDP packets. + + The `DISABLED` option directs IKE to completely refuse to negotiate NAT-T + even if it senses there may be a NAT device in use. + + + . + enum: + - ENABLED + - DISABLED + - AUTO + type: string + oracleCanInitiate: + description: | + Indicates whether Oracle can only respond to a request to start an IPSec tunnel from the CPE device, or both respond to and initiate requests. + enum: + - INITIATOR_OR_RESPONDER + - RESPONDER_ONLY + type: string + phaseOneDetails: + $ref: '#/components/schemas/TunnelPhaseOneDetails' + phaseTwoDetails: + $ref: '#/components/schemas/TunnelPhaseTwoDetails' + routing: + description: | + The type of routing used for this tunnel (BGP dynamic routing, static routing, or policy-based routing). + enum: + - BGP + - STATIC + - POLICY + type: string + status: + description: The status of the tunnel based on IPSec protocol characteristics. + enum: + - UP + - DOWN + - DOWN_FOR_MAINTENANCE + - PARTIAL_UP + type: string + timeCreated: + description: | + The date and time the IPSec tunnel was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeStatusUpdated: + description: | + When the status of the IPSec tunnel last changed, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + vpnIp: + description: | + The IP address of the Oracle VPN headend for the connection. + + Example: `203.0.113.21` + maxLength: 46 + minLength: 1 + type: string + required: + - compartmentId + - id + - lifecycleState + type: object + UpdateIPSecConnectionTunnelDetails: + properties: + bgpSessionConfig: + $ref: '#/components/schemas/UpdateIPSecTunnelBgpSessionDetails' + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + dpdConfig: + $ref: '#/components/schemas/DpdConfig' + encryptionDomainConfig: + $ref: '#/components/schemas/UpdateIPSecTunnelEncryptionDomainDetails' + natTranslationEnabled: + description: | + By default (the `AUTO` setting), IKE sends packets with a source and destination port set to 500, + and when it detects that the port used to forward packets has changed (most likely because a NAT device + is between the CPE device and the Oracle VPN headend) it will try to negotiate the use of NAT-T. + + The `ENABLED` option sets the IKE protocol to use port 4500 instead of 500 and forces encapsulating traffic with the ESP protocol inside UDP packets. + + The `DISABLED` option directs IKE to completely refuse to negotiate NAT-T + even if it senses there may be a NAT device in use. + enum: + - ENABLED + - DISABLED + - AUTO + type: string + oracleInitiation: + description: | + Indicates whether the Oracle end of the IPSec connection is able to initiate starting up the IPSec tunnel. + enum: + - INITIATOR_OR_RESPONDER + - RESPONDER_ONLY + type: string + phaseOneConfig: + $ref: '#/components/schemas/PhaseOneConfigDetails' + phaseTwoConfig: + $ref: '#/components/schemas/PhaseTwoConfigDetails' + routing: + description: | + The type of routing to use for this tunnel (BGP dynamic routing, static routing, or policy-based routing). + enum: + - BGP + - STATIC + - POLICY + type: string + type: object + IPSecConnectionTunnelErrorDetails: + description: Details for an error on an IPSec tunnel. + properties: + errorCode: + description: Unique code describes the error type. + maxLength: 255 + minLength: 1 + type: string + errorDescription: + description: A detailed description of the error. + maxLength: 1000 + minLength: 1 + type: string + id: + description: Unique ID generated for each error report. + maxLength: 255 + minLength: 1 + type: string + ociResourcesLink: + description: Link to more Oracle resources or relevant documentation. + maxLength: 255 + minLength: 1 + type: string + solution: + description: Resolution for the error. + maxLength: 1000 + minLength: 1 + type: string + timestamp: + description: Timestamp when the error occurred. + format: date-time + type: string + required: + - id + - errorCode + - errorDescription + - solution + - ociResourcesLink + - timestamp + type: object + TunnelRouteSummary: + description: | + A summary of the routes advertised to and received from the on-premises network. + properties: + advertiser: + description: The source of the route advertisement. + enum: + - CUSTOMER + - ORACLE + type: string + age: + description: The age of the route. + format: int64 + type: integer + asPath: + description: A list of ASNs in AS_Path. + items: + type: integer + type: array + isBestPath: + description: Indicates this is the best route. + type: boolean + prefix: + description: The BGP network layer reachability information. + maxLength: 255 + minLength: 1 + type: string + type: object + IPSecConnectionTunnelSharedSecret: + description: The tunnel's shared secret (pre-shared key). + properties: + sharedSecret: + description: | + The tunnel's shared secret (pre-shared key). + maxLength: 255 + minLength: 1 + type: string + required: + - sharedSecret + type: object + UpdateIPSecConnectionTunnelSharedSecretDetails: + properties: + sharedSecret: + description: | + The shared secret (pre-shared key) to use for the tunnel. Only numbers, letters, and spaces + are allowed. + maxLength: 255 + minLength: 1 + type: string + type: object + TunnelCpeDeviceConfig: + description: | + The set of CPE configuration answers for the tunnel, which the customer provides in + [UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig). + The answers correlate to the questions that are specific to the CPE device type (see the + `parameters` attribute of [CpeDeviceShapeDetail](#/en/iaas/latest/CpeDeviceShapeDetail/)). + + See these related operations: + + * [GetTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfig) + * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent) + * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent) + * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent) + properties: + tunnelCpeDeviceConfigParameter: + items: + $ref: '#/components/schemas/CpeDeviceConfigAnswer' + type: array + type: object + UpdateTunnelCpeDeviceConfigDetails: + properties: + tunnelCpeDeviceConfig: + description: | + The set of configuration answers for a CPE device. + items: + $ref: '#/components/schemas/CpeDeviceConfigAnswer' + type: array + type: object + TunnelSecurityAssociationSummary: + description: | + A summary of the IPSec tunnel security association details. + properties: + cpeSubnet: + description: The IP address and mask of the partner subnet used in policy based VPNs or static routes. + maxLength: 255 + minLength: 1 + type: string + oracleSubnet: + description: The IP address and mask of the local subnet used in policy based VPNs or static routes. + maxLength: 255 + minLength: 1 + type: string + time: + description: Time in the current state, in seconds. + maxLength: 255 + minLength: 1 + type: string + tunnelSaErrorInfo: + description: | + Current state if the IPSec tunnel status is not `UP`, including phase one and phase two details and a possible reason the tunnel is not `UP`. + maxLength: 255 + minLength: 1 + type: string + tunnelSaStatus: + description: The IPSec tunnel's phase one status. + enum: + - INITIATING + - LISTENING + - UP + - DOWN + - ERROR + - UNKNOWN + type: string + type: object + Ipv6: + description: | + An *IPv6* is a conceptual term that refers to an IPv6 address and related properties. + The `IPv6` object is the API representation of an IPv6. + + You can create and assign an IPv6 to any VNIC that is in an IPv6-enabled subnet in an + IPv6-enabled VCN. + + **Note:** IPv6 addressing is supported for all commercial and government regions. For important + details about IPv6 addressing in a VCN, see [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + properties: + cidrPrefixLength: + description: Length of cidr range. Optional field to specify flexible cidr. + maximum: 128 + minimum: 80 + type: integer + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the IPv6. + This is the same as the VNIC's compartment. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6. + maxLength: 255 + minLength: 1 + type: string + ipAddress: + description: | + The IPv6 address of the `IPv6` object. The address is within the IPv6 prefix + of the VNIC's subnet (see the `ipv6CidrBlock` attribute for the [Subnet](#/en/iaas/latest/Subnet/) + object. + + Example: `2001:0db8:0123:1111:abcd:ef01:2345:6789` + type: string + ipState: + description: | + State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED, otherwise it is AVAILABLE. + enum: + - ASSIGNED + - AVAILABLE + type: string + isInternetAccessAllowed: + default: true + description: | + Whether the IPv6 can be used for internet communication. Allowed by default for an IPv6 in + a public subnet. Never allowed for an IPv6 in a private subnet. If the value is `true`, the + IPv6 uses its public IP address for internet communication. + + Example: `true` + type: boolean + lifecycleState: + description: The IPv6's current state. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + type: string + lifetime: + description: | + Lifetime of the IP address. + There are two types of IPs: + - Ephemeral + - Reserved + enum: + - EPHEMERAL + - RESERVED + type: string + publicIpAddress: + description: | + The IPv6 address to be used for internet communication. The address is within the + IPv6 prefix of the VNIC's subnet (see the `ipv6PublicCidrBlock` attribute for the + [Subnet](#/en/iaas/latest/Subnet/) object). + + If your organization did NOT assign a custom IPv6 prefix to the VCN for the private address + space, Oracle provides the IPv6 prefix and uses that same prefix for the private and public + address space. Therefore the `publicIpAddress` would be the same as the `ipAddress`. + + If your organization assigned a custom IPv6 prefix to the VCN for the address space, + the right 80 bits of the IPv6 IP (the subnet and address bits) are the same as for + the `ipAddress`. But the left 48 bits are from the IPv6 prefix that Oracle assigned + to the VCN. + + This is null if the IPv6 is created with `isInternetAccessAllowed` set to `false`. + + Example: `2001:0db8:0123:1111:abcd:ef01:2345:6789` + type: string + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see + [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). + maxLength: 255 + minLength: 0 + type: string + subnetId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet the VNIC is in. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the IPv6 was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + vnicId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC the IPv6 is assigned to. + The VNIC and IPv6 must be in the same subnet. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - displayName + - id + - ipAddress + - lifecycleState + - subnetId + - timeCreated + type: object + CreateIpv6Details: + properties: + cidrPrefixLength: + default: 128 + description: Length of cidr range. Optional field to specify flexible cidr. + maximum: 128 + minimum: 80 + type: integer + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + ipAddress: + description: | + An IPv6 address of your choice. Must be an available IP address within + the subnet's CIDR. If you don't specify a value, Oracle automatically + assigns an IPv6 address from the subnet. The subnet is the one that + contains the VNIC you specify in `vnicId`. + + Example: `2001:DB8::` + maxLength: 45 + minLength: 1 + type: string + ipv6SubnetCidr: + description: | + The IPv6 prefix allocated to the subnet. This is required if more than one IPv6 prefix exists on the subnet. + maxLength: 45 + minLength: 1 + type: string + x-default-description: 'null' + isInternetAccessAllowed: + default: true + description: | + Whether the IPv6 can be used for internet communication. Allowed by default for an IPv6 in + a public subnet. Never allowed for an IPv6 in a private subnet. If the value is `true`, the + IPv6 uses its public IP address for internet communication. + + If `isInternetAccessAllowed` is set to `false`, the resulting `publicIpAddress` attribute + for the `Ipv6` is null. + + Example: `true` + type: boolean + lifetime: + default: EPHEMERAL + description: | + Lifetime of the IP address. + There are two types of IPs: + - Ephemeral + - Reserved + enum: + - EPHEMERAL + - RESERVED + type: string + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see + [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). + maxLength: 255 + minLength: 0 + type: string + subnetId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet from which the IPv6 is to be drawn. The IP address, + *if supplied*, must be valid for the given subnet, only valid for reserved IPs currently. + maxLength: 255 + minLength: 1 + type: string + vnicId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC to assign the IPv6 to. The + IPv6 will be in the VNIC's subnet. + maxLength: 255 + minLength: 1 + type: string + type: object + BulkCreateIpv6sDetails: + description: Details needed to create secondary IPv6 addresses with a bulk operation. + properties: + bulkCreateIpv6sItem: + description: | + A secondary IPv6 address to assign. + items: + $ref: '#/components/schemas/BulkCreateIpv6sItem' + maxItems: 16 + minItems: 1 + type: array + subnetId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet from which the IPv6s are to be drawn. The IP addresses, + *if supplied*, must be valid for the given subnet, only valid for reserved IPs currently. + maxLength: 255 + minLength: 1 + type: string + vnicId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC to assign the IPv6s to. The + IPv6s will be in the VNIC's subnet. + maxLength: 255 + minLength: 1 + type: string + required: + - bulkCreateIpv6sItem + type: object + BulkDeleteIpv6sDetails: + description: A secondary IPv6 address bulk deletion object. + properties: + bulkDeleteIpv6sItem: + description: | + An IPv6 address to delete. + items: + $ref: '#/components/schemas/BulkDeleteIpv6sItem' + maxItems: 16 + minItems: 1 + type: array + subnetId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet from which the IPv6s addresses are deleted. + maxLength: 255 + minLength: 1 + type: string + vnicId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC to assign the IPv6s to. The + IPv6 will be in the VNIC's subnet. + maxLength: 255 + minLength: 1 + type: string + required: + - bulkDeleteIpv6sItem + type: object + BulkDetachIpv6sDetails: + description: Details needed to bulk detach secondary IPv6 addresses. + properties: + bulkDetachIpv6sItem: + description: | + A secondary IPv6 address to detach. + items: + $ref: '#/components/schemas/BulkDetachIpv6sItem' + maxItems: 16 + minItems: 1 + type: array + vnicId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC from which multiple IPv6s should be detached. The VNIC and IPv6s must be in the same subnet. + maxLength: 255 + minLength: 1 + type: string + required: + - bulkDetachIpv6sItem + type: object + BulkUpdateIpv6sDetails: + description: Address details to update for a Secondary IPv6 object. + properties: + bulkUpdateIpv6sItem: + description: | + A secondary IPv6 address to update. + items: + $ref: '#/components/schemas/BulkUpdateIpv6sItem' + maxItems: 16 + minItems: 1 + type: array + vnicId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC to move the IPv6s to. + The VNIC and IPv6s must be in the same subnet. + maxLength: 255 + minLength: 1 + type: string + required: + - bulkUpdateIpv6sItem + type: object + UpdateIpv6Details: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + isInternetAccessAllowed: + default: true + description: | + Whether the IPv6 can be used for internet communication. Allowed by default for an IPv6 in + a public subnet. Never allowed for an IPv6 in a private subnet. If the value is `true`, the + IPv6 uses its public IP address for internet communication. + + If you switch this from `true` to `false`, the `publicIpAddress` attribute for the IPv6 + becomes null. + + Example: `false` + type: boolean + lifetime: + description: | + Lifetime of the IP address. + There are two types of IPs: + - Ephemeral + - Reserved + enum: + - EPHEMERAL + - RESERVED + type: string + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see + [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). + maxLength: 255 + minLength: 0 + type: string + vnicId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC to reassign the IPv6 to. + The VNIC must be in the same subnet as the current VNIC. + maxLength: 255 + minLength: 1 + type: string + type: object + LocalPeeringGateway: + description: | + A local peering gateway (LPG) is an object on a VCN that lets that VCN peer + with another VCN in the same region. *Peering* means that the two VCNs can + communicate using private IP addresses, but without the traffic traversing the + internet or routing through your on-premises network. For more information, + see [VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the LPG. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The LPG's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). + maxLength: 255 + minLength: 1 + type: string + isCrossTenancyPeering: + description: | + Whether the VCN at the other end of the peering is in a different tenancy. + + Example: `false` + type: boolean + lifecycleState: + description: The LPG's current lifecycle state. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + type: string + peerAdvertisedCidr: + description: | + The smallest aggregate CIDR that contains all the CIDR routes advertised by the VCN + at the other end of the peering from this LPG. See `peerAdvertisedCidrDetails` for + the individual CIDRs. The value is `null` if the LPG is not peered. + + Example: `192.168.0.0/16`, or if aggregated with `172.16.0.0/24` then `128.0.0.0/1` + maxLength: 18 + minLength: 9 + type: string + peerAdvertisedCidrDetails: + description: | + The specific ranges of IP addresses available on or via the VCN at the other + end of the peering from this LPG. The value is `null` if the LPG is not peered. + You can use these as destination CIDRs for route rules to route a subnet's + traffic to this LPG. + + Example: [`192.168.0.0/16`, `172.16.0.0/24`] + items: + maxLength: 18 + minLength: 9 + type: string + type: array + peerId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the peered LPG. + maxLength: 255 + minLength: 1 + type: string + peeringStatus: + description: | + Whether the LPG is peered with another LPG. `NEW` means the LPG has not yet been + peered. `PENDING` means the peering is being established. `REVOKED` means the + LPG at the other end of the peering has been deleted. + enum: + - INVALID + - NEW + - PEERED + - PENDING + - REVOKED + type: string + peeringStatusDetails: + description: Additional information regarding the peering status, if applicable. + maxLength: 4096 + minLength: 0 + type: string + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the LPG is using. + + For information about why you would associate a route table with an LPG, see + [Transit Routing: Access to Multiple VCNs in Same Region](/iaas/Content/Network/Tasks/transitrouting.htm). + maxLength: 255 + minLength: 1 + type: string + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). + type: object + description: | + [Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels + for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) + (ZPR) policy to control access to ZPR-supported resources. + + Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}` + type: object + timeCreated: + description: | + The date and time the LPG was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN that uses the LPG. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - displayName + - id + - peerId + - isCrossTenancyPeering + - lifecycleState + - peeringStatus + - timeCreated + - vcnId + type: object + CreateLocalPeeringGatewayDetails: + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the local peering gateway (LPG). + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the LPG will use. + + If you don't specify a route table here, the LPG is created without an associated route + table. The Networking service does NOT automatically associate the attached VCN's default route table + with the LPG. + + For information about why you would associate a route table with an LPG, see + [Transit Routing: Access to Multiple VCNs in Same Region](/iaas/Content/Network/Tasks/transitrouting.htm). + maxLength: 255 + minLength: 1 + type: string + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). + type: object + description: | + [Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels + for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) + (ZPR) policy to control access to ZPR-supported resources. + + Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}` + type: object + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the LPG belongs to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - vcnId + type: object + UpdateLocalPeeringGatewayDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the LPG will use. + + For information about why you would associate a route table with an LPG, see + [Transit Routing: Access to Multiple VCNs in Same Region](/iaas/Content/Network/Tasks/transitrouting.htm). + maxLength: 255 + minLength: 1 + type: string + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). + type: object + description: | + [Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels + for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) + (ZPR) policy to control access to ZPR-supported resources. + + Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}` + type: object + type: object + ChangeLocalPeeringGatewayCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the + local peering gateway to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ConnectLocalPeeringGatewaysDetails: + description: Information about the other local peering gateway (LPG). + properties: + peerId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the LPG you want to peer with. + maxLength: 255 + minLength: 1 + type: string + required: + - peerId + type: object + NatGateway: + description: | + A NAT (Network Address Translation) gateway, which represents a router that lets instances + without public IPs contact the public internet without exposing the instance to inbound + internet traffic. For more information, see + [NAT Gateway](/iaas/Content/Network/Tasks/NATgateway.htm). + + To use any of the API operations, you must be authorized in an + IAM policy. If you are not authorized, talk to an + administrator. If you are an administrator who needs to write + policies to give users access, see [Getting Started with + Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + properties: + blockTraffic: + default: false + description: | + Whether the NAT gateway blocks traffic through it. The default is `false`. + + Example: `true` + type: boolean + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains + the NAT gateway. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the + NAT gateway. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The NAT gateway's current state. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + type: string + natIp: + description: | + The IP address associated with the NAT gateway. + maxLength: 255 + minLength: 1 + type: string + publicIpId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP address associated with the NAT gateway. + maxLength: 255 + minLength: 1 + type: string + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table used by the NAT gateway. + + If you don't specify a route table here, the NAT gateway is created without an associated route + table. The Networking service does NOT automatically associate the attached VCN's default route table + with the NAT gateway. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the NAT gateway was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + vcnId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the NAT gateway + belongs to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - vcnId + - natIp + - id + - lifecycleState + - timeCreated + - blockTraffic + type: object + CreateNatGatewayDetails: + properties: + blockTraffic: + default: false + description: | + Whether the NAT gateway blocks traffic through it. The default is `false`. + + Example: `true` + type: boolean + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the + NAT gateway. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + publicIpId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP address associated with the NAT gateway. + maxLength: 255 + minLength: 1 + type: string + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table used by the NAT gateway. + + If you don't specify a route table here, the NAT gateway is created without an associated route + table. The Networking service does NOT automatically associate the attached VCN's default route table + with the NAT gateway. + maxLength: 255 + minLength: 1 + type: string + vcnId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the gateway belongs to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - vcnId + type: object + UpdateNatGatewayDetails: + properties: + blockTraffic: + default: false + description: | + Whether the NAT gateway blocks traffic through it. The default is `false`. + + Example: `true` + type: boolean + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table used by the NAT gateway. + + If you don't specify a route table here, the NAT gateway is created without an associated route + table. The Networking service does NOT automatically associate the attached VCN's default route + table with the NAT gateway. + maxLength: 255 + minLength: 1 + type: string + type: object + ChangeNatGatewayCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the NAT gateway to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + NetworkSecurityGroup: + description: | + A *network security group* (NSG) provides virtual firewall rules for a specific set of + [VNICs](#/en/iaas/latest/Vnic/) in a VCN. Compare NSGs with [SecurityLists](#/en/iaas/latest/SecurityList/), + which provide virtual firewall rules to all the VNICs in a *subnet*. + + A network security group consists of two items: + + * The set of [VNICs](#/en/iaas/latest/Vnic/) that all have the same security rule needs (for + example, a group of Compute instances all running the same application) + * A set of NSG [SecurityRules](#/en/iaas/latest/SecurityRule/) that apply to the VNICs in the group + + After creating an NSG, you can add VNICs and security rules to it. For example, when you create + an instance, you can specify one or more NSGs to add the instance to (see + [CreateVnicDetails](#/en/iaas/latest/datatypes/CreateVnicDetails)). Or you can add an existing + instance to an NSG with [UpdateVnic](#/en/iaas/latest/Vnic/UpdateVnic). + + To add security rules to an NSG, see + [AddNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/AddNetworkSecurityGroupSecurityRules). + + To list the VNICs in an NSG, see + [ListNetworkSecurityGroupVnics](#/en/iaas/latest/NetworkSecurityGroupVnic/ListNetworkSecurityGroupVnics). + + To list the security rules in an NSG, see + [ListNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/ListNetworkSecurityGroupSecurityRules). + + For more information about network security groups, see + [Network Security Groups](/iaas/Content/Network/Concepts/networksecuritygroups.htm). + + **Important:** Oracle Cloud Infrastructure Compute service images automatically include firewall rules (for example, + Linux iptables, Windows firewall). If there are issues with some type of access to an instance, + make sure all of the following are set correctly: + + * Any security rules in any NSGs the instance's VNIC belongs to + * Any [SecurityLists](#/en/iaas/latest/SecurityList/) associated with the instance's subnet + * The instance's OS firewall rules + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment the network security group is in. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The network security group's current state. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + type: string + timeCreated: + description: | + The date and time the network security group was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group's VCN. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - id + - lifecycleState + - timeCreated + - vcnId + type: object + CreateNetworkSecurityGroupDetails: + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the + network security group. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + vcnId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN to create the network + security group in. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - vcnId + type: object + UpdateNetworkSecurityGroupDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + AddNetworkSecurityGroupSecurityRulesDetails: + properties: + securityRules: + description: | + An array of security rules to add to the NSG. You can add up to 25 rules in a single + `AddNetworkSecurityGroupSecurityRules` operation. + Adding more than 25 rules requires multiple operations. + items: + $ref: '#/components/schemas/AddSecurityRuleDetails' + maxItems: 25 + minItems: 1 + type: array + type: object + AddedNetworkSecurityGroupSecurityRules: + properties: + securityRules: + description: The NSG security rules that were added. + items: + $ref: '#/components/schemas/SecurityRule' + type: array + type: object + ChangeNetworkSecurityGroupCompartmentDetails: + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the network + security group to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + RemoveNetworkSecurityGroupSecurityRulesDetails: + properties: + securityRuleIds: + description: | + The Oracle-assigned ID of each [SecurityRule](#/en/iaas/latest/SecurityRule/) to be deleted. + items: + type: string + maxItems: 25 + minItems: 1 + type: array + type: object + UpdateNetworkSecurityGroupSecurityRulesDetails: + properties: + securityRules: + description: The NSG security rules to update. + items: + $ref: '#/components/schemas/UpdateSecurityRuleDetails' + maxItems: 25 + minItems: 1 + type: array + type: object + UpdatedNetworkSecurityGroupSecurityRules: + properties: + securityRules: + description: The NSG security rules that were updated. + items: + $ref: '#/components/schemas/SecurityRule' + type: array + type: object + SecurityRule: + description: | + A security rule is one of the items in a [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/). + It is a virtual firewall rule for the VNICs in the network security group. A rule can be for + either inbound (`direction`= INGRESS) or outbound (`direction`= EGRESS) IP packets. + properties: + description: + description: | + An optional description of your choice for the rule. + maxLength: 255 + minLength: 1 + type: string + destination: + description: | + Conceptually, this is the range of IP addresses that a packet originating from the instance + can go to. + + Allowed values: + + * An IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56` + IPv6 addressing is supported for all commercial and government regions. + See [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + + * The `cidrBlock` value for a [Service](#/en/iaas/latest/Service/), if you're + setting up a security rule for traffic destined for a particular `Service` through + a service gateway. For example: `oci-phx-objectstorage`. + + * The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/) in the same + VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control + traffic between VNICs in the same NSG. + type: string + destinationType: + description: | + Type of destination for the rule. Required if `direction` = `EGRESS`. + + Allowed values: + + * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation. + + * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a + [Service](#/en/iaas/latest/Service/) (the rule is for traffic destined for a + particular `Service` through a service gateway). + + * `NETWORK_SECURITY_GROUP`: If the rule's `destination` is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a + [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/). + enum: + - CIDR_BLOCK + - SERVICE_CIDR_BLOCK + - NETWORK_SECURITY_GROUP + type: string + direction: + description: | + Direction of the security rule. Set to `EGRESS` for rules to allow outbound IP packets, + or `INGRESS` for rules to allow inbound IP packets. + enum: + - EGRESS + - INGRESS + type: string + icmpOptions: + $ref: '#/components/schemas/IcmpOptions' + id: + description: | + An Oracle-assigned identifier for the security rule. You specify this ID when you want to + update or delete the rule. + + Example: `04ABEC` + maxLength: 255 + minLength: 1 + type: string + isStateless: + description: | + A stateless rule allows traffic in one direction. Remember to add a corresponding + stateless rule in the other direction if you need to support bidirectional traffic. For + example, if egress traffic allows TCP destination port 80, there should be an ingress + rule to allow TCP source port 80. Defaults to false, which means the rule is stateful + and a corresponding rule is not necessary for bidirectional traffic. + type: boolean + isValid: + description: | + Whether the rule is valid. The value is `True` when the rule is first created. If + the rule's `source` or `destination` is a network security group, the value changes to + `False` if that network security group is deleted. + type: boolean + protocol: + description: | + The transport protocol. Specify either `all` or an IPv4 protocol number as + defined in + [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). + Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58"). + type: string + source: + description: | + Conceptually, this is the range of IP addresses that a packet coming into the instance + can come from. + + Allowed values: + + * An IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56` + IPv6 addressing is supported for all commercial and government regions. + See [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + + * The `cidrBlock` value for a [Service](#/en/iaas/latest/Service/), if you're + setting up a security rule for traffic coming from a particular `Service` through + a service gateway. For example: `oci-phx-objectstorage`. + + * The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/) in the same + VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control + traffic between VNICs in the same NSG. + type: string + sourceType: + description: | + Type of source for the rule. Required if `direction` = `INGRESS`. + + * `CIDR_BLOCK`: If the rule's `source` is an IP address range in CIDR notation. + + * `SERVICE_CIDR_BLOCK`: If the rule's `source` is the `cidrBlock` value for a + [Service](#/en/iaas/latest/Service/) (the rule is for traffic coming from a + particular `Service` through a service gateway). + + * `NETWORK_SECURITY_GROUP`: If the rule's `source` is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a + [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/). + enum: + - CIDR_BLOCK + - SERVICE_CIDR_BLOCK + - NETWORK_SECURITY_GROUP + type: string + tcpOptions: + $ref: '#/components/schemas/TcpOptions' + timeCreated: + description: The date and time the security rule was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + udpOptions: + $ref: '#/components/schemas/UdpOptions' + required: + - direction + - protocol + type: object + NetworkSecurityGroupVnic: + description: | + Information about a VNIC that belongs to a network security group. + properties: + resourceId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the parent resource that the VNIC + is attached to (for example, a Compute instance). + maxLength: 255 + minLength: 1 + type: string + timeAssociated: + description: | + The date and time the VNIC was added to the network security group, in the format + defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + vnicId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC. + maxLength: 255 + minLength: 1 + type: string + required: + - vnicId + type: object + NetworkingTopology: + description: | + Defines the representation of a virtual network topology for a region. + See [Network Visualizer Documentation](/iaas/Content/Network/Concepts/network_visualizer.htm) for more information, including + conventions and pictures of symbols. + discriminator: + propertyName: type + properties: + entities: + description: Lists entities comprising the virtual network topology. + items: + type: string + description: (opaque JSON object) + type: array + limitedEntities: + description: | + Lists entities that are limited during ingestion. + The values for the items in the list are the entity type names of the limitedEntities. + Example: `vcn` + items: + type: string + maxItems: 100 + type: array + relationships: + description: Lists relationships between entities in the virtual network topology. + items: + $ref: '#/components/schemas/TopologyEntityRelationship' + type: array + timeCreated: + description: Records when the virtual network topology was created, in [RFC3339](https://tools.ietf.org/html/rfc3339) format for date and time. + format: date-time + type: string + type: + description: Type of the topology object. + enum: + - NETWORKING + - VCN + - SUBNET + - PATH + type: string + required: + - type + - entities + - relationships + - limitedEntities + - timeCreated + type: object + PrivateIp: + description: | + A *private IP* is a conceptual term that refers to an IPv4 private IP address and related properties. + The `privateIp` object is the API representation of a private IP. + + **Note:** For information about IPv6 addresses, see [Ipv6](#/en/iaas/latest/Ipv6/). + + Each instance has a *primary private IP* that is automatically created and + assigned to the primary VNIC during instance launch. If you add a secondary + VNIC to the instance, it also automatically gets a primary private IP. You + can't remove a primary private IP from its VNIC. The primary private IP is + automatically deleted when the VNIC is terminated. + + You can add *secondary private IPs* to a VNIC after it's created. For more + information, see the `privateIp` operations and also + [IP Addresses](/iaas/Content/Network/Tasks/managingIPaddresses.htm). + + **Note:** Only + [ListPrivateIps](#/en/iaas/latest/PrivateIp/ListPrivateIps) and + [GetPrivateIp](#/en/iaas/latest/PrivateIp/GetPrivateIp) work with + *primary* private IPs. To create and update primary private IPs, you instead + work with instance and VNIC operations. For example, a primary private IP's + properties come from the values you specify in + [CreateVnicDetails](#/en/iaas/latest/CreateVnicDetails/) when calling either + [LaunchInstance](#/en/iaas/latest/Instance/LaunchInstance) or + [AttachVnic](#/en/iaas/latest/VnicAttachment/AttachVnic). To update the hostname + for a primary private IP, you use [UpdateVnic](#/en/iaas/latest/Vnic/UpdateVnic). + + `PrivateIp` objects that are created for use with the Oracle Cloud VMware Solution are + assigned to a VLAN and not a VNIC in a subnet. See the + descriptions of the relevant attributes in the `PrivateIp` object. Also see + [Vlan](#/en/iaas/latest/Vlan). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + properties: + availabilityDomain: + description: | + The private IP's availability domain. This attribute will be null if this is a *secondary* + private IP assigned to a VNIC that is in a *regional* subnet. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + cidrPrefixLength: + description: The secondary IPv4 CIDR prefix length. + maximum: 32 + minimum: 18 + type: integer + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the private IP. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + hostnameLabel: + description: | + The hostname for the private IP. Used for DNS. The value is the hostname + portion of the private IP's fully qualified domain name (FQDN) + (for example, `bminstance1` in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`). + Must be unique across all VNICs in the subnet and comply with + [RFC 952](https://tools.ietf.org/html/rfc952) and + [RFC 1123](https://tools.ietf.org/html/rfc1123). + + For more information, see + [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). + + Example: `bminstance1` + maxLength: 63 + minLength: 1 + type: string + id: + description: The private IP's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). + maxLength: 255 + minLength: 1 + type: string + ipAddress: + description: | + The private IP address of the `privateIp` object. The address is within the CIDR + of the VNIC's subnet. + + However, if the `PrivateIp` object is being used with a VLAN as part of + the Oracle Cloud VMware Solution, the address is from the range specified by the + `cidrBlock` attribute for the VLAN. See [Vlan](#/en/iaas/latest/Vlan). + + Example: `10.0.3.3` + type: string + ipState: + description: | + State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED, otherwise it is AVAILABLE. + enum: + - ASSIGNED + - AVAILABLE + type: string + ipv4SubnetCidrAtCreation: + description: | + Ipv4 Subnet CIDR specified whn creating the PrivateIP. + maxLength: 32 + minLength: 1 + type: string + isPrimary: + description: | + Whether this private IP is the primary one on the VNIC. Primary private IPs + are unassigned and deleted automatically when the VNIC is terminated. + + Example: `true` + type: boolean + lifetime: + description: | + Lifetime of the IP address. + There are two types of IPs: + - Ephemeral + - Reserved + enum: + - EPHEMERAL + - RESERVED + type: string + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see + [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). + maxLength: 255 + minLength: 0 + type: string + subnetId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet the VNIC is in. + + However, if the `PrivateIp` object is being used with a VLAN as part of + the Oracle Cloud VMware Solution, the `subnetId` is null. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the private IP was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + vlanId: + description: | + Applicable only if the `PrivateIp` object is being used with a VLAN as part of + the Oracle Cloud VMware Solution. The `vlanId` is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. See + [Vlan](#/en/iaas/latest/Vlan). + maxLength: 255 + minLength: 1 + type: string + vnicId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC the private IP is assigned to. The VNIC and private IP + must be in the same subnet. + However, if the `PrivateIp` object is being used with a VLAN as part of + the Oracle Cloud VMware Solution, the `vnicId` is null. + maxLength: 255 + minLength: 1 + type: string + type: object + CreatePrivateIpDetails: + properties: + cidrPrefixLength: + default: 32 + description: | + An optional field that when combined with the ipAddress field, will be used to allocate secondary IPv4 CIDRs. + The CIDR range created by this combination must be within the subnet's CIDR + and the CIDR range should not collide with any existing IPv4 address allocation. + The VNIC ID specified in the request object should not already been assigned more than the max IPv4 addresses. + If you don't specify a value, this option will be ignored. + + Example: 18 + maximum: 32 + minimum: 18 + type: integer + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + hostnameLabel: + description: | + The hostname for the private IP. Used for DNS. The value + is the hostname portion of the private IP's fully qualified domain name (FQDN) + (for example, `bminstance1` in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`). + Must be unique across all VNICs in the subnet and comply with + [RFC 952](https://tools.ietf.org/html/rfc952) and + [RFC 1123](https://tools.ietf.org/html/rfc1123). + + For more information, see + [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). + + Example: `bminstance1` + maxLength: 63 + minLength: 1 + type: string + ipAddress: + description: | + A private IP address of your choice. Must be an available IP address within + the subnet's CIDR. If you don't specify a value, Oracle automatically + assigns a private IP address from the subnet. + + Example: `10.0.3.3` + maxLength: 32 + minLength: 1 + type: string + ipv4SubnetCidrAtCreation: + description: | + Any one of the IPv4 CIDRs allocated to the subnet. + maxLength: 32 + minLength: 1 + type: string + lifetime: + default: EPHEMERAL + description: | + Lifetime of the IP address. + There are two types of IPs: + - Ephemeral + - Reserved + enum: + - EPHEMERAL + - RESERVED + type: string + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see + [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). + maxLength: 255 + minLength: 0 + type: string + subnetId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet from which the private IP is to be drawn. The IP address, + *if supplied*, must be valid for the given subnet. + maxLength: 255 + minLength: 1 + type: string + vlanId: + description: | + Use this attribute only with the Oracle Cloud VMware Solution. + + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN from which the private IP is to be drawn. The IP address, + *if supplied*, must be valid for the given VLAN. See [Vlan](#/en/iaas/latest/Vlan). + maxLength: 255 + minLength: 1 + type: string + vnicId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC to assign the private IP to. The VNIC and private IP + must be in the same subnet. + maxLength: 255 + minLength: 1 + type: string + type: object + BulkCreatePrivateIpsDetails: + description: Details used to create secondary private IPv4 addresses in a bulk operation. + properties: + bulkCreatePrivateIpItem: + description: | + A secondary IPv4 address to assign. + items: + $ref: '#/components/schemas/BulkCreatePrivateIpItem' + maxItems: 16 + minItems: 1 + type: array + subnetId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet from which the private IPs is to be drawn. The IP addresses, + *if supplied*, must be valid for the given subnet. + maxLength: 255 + minLength: 1 + type: string + vlanId: + description: | + Use this attribute only with the Oracle Cloud VMware Solution. The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN from which the private IPs is to be drawn. The IP addresses, *if supplied*, must be valid for the given VLAN. See [Vlan](#/en/iaas/latest/Vlan). + maxLength: 255 + minLength: 1 + type: string + vnicId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC to assign the private IPs to. The VNIC and private IPs must be in the same subnet. + maxLength: 255 + minLength: 1 + type: string + required: + - bulkCreatePrivateIpItem + type: object + BulkDeletePrivateIpsDetails: + description: Details used tp delete Secondary IPv4 objects in a bulk operation. + properties: + bulkDeletePrivateIpItem: + description: | + A secondary IPv4 address to delete. + items: + $ref: '#/components/schemas/BulkDeletePrivateIpItem' + maxItems: 16 + minItems: 1 + type: array + subnetId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet from which the private IPs is to be deleted. + maxLength: 255 + minLength: 1 + type: string + vlanId: + description: | + Use this attribute only with the Oracle Cloud VMware Solution. + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN from which the private IP is to be deleted. + maxLength: 255 + minLength: 1 + type: string + vnicId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC of which + private IPs should be deleted. The VNIC and private IPs must be in the same subnet. + maxLength: 255 + minLength: 1 + type: string + required: + - bulkDeletePrivateIpItem + type: object + BulkDetachPrivateIpsDetails: + description: An object used to detatch Secondary IPv4 addresses with a bulk operation. + properties: + bulkDetachPrivateIpItem: + description: | + Secondary IPv4 addresses to detach. + items: + $ref: '#/components/schemas/BulkDetachPrivateIpItem' + maxItems: 16 + minItems: 1 + type: array + vnicId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC of which private IPs should be detached. The VNIC and private IPs must be in the same subnet. + maxLength: 255 + minLength: 1 + type: string + required: + - bulkDetachPrivateIpItem + type: object + BulkUpdatePrivateIpsDetails: + description: Details used for a secondary IPv4 address bulk update. + properties: + bulkUpdatePrivateIpItem: + description: | + A secondary IPv4 address to update. + items: + $ref: '#/components/schemas/BulkUpdatePrivateIpItem' + maxItems: 16 + minItems: 1 + type: array + vnicId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC to reassign + the private IPs to. The VNIC and private IPs must be in the same subnet. + maxLength: 255 + minLength: 1 + type: string + required: + - bulkUpdatePrivateIpItem + type: object + UpdatePrivateIpDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + hostnameLabel: + description: | + The hostname for the private IP. Used for DNS. The value + is the hostname portion of the private IP's fully qualified domain name (FQDN) + (for example, `bminstance1` in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`). + Must be unique across all VNICs in the subnet and comply with + [RFC 952](https://tools.ietf.org/html/rfc952) and + [RFC 1123](https://tools.ietf.org/html/rfc1123). + + For more information, see + [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). + + Example: `bminstance1` + maxLength: 63 + minLength: 1 + type: string + lifetime: + description: | + Lifetime of the IP address. + There are two types of IPs: + - Ephemeral + - Reserved + enum: + - EPHEMERAL + - RESERVED + type: string + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see + [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). + maxLength: 255 + minLength: 0 + type: string + vnicId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC to reassign the private IP to. The VNIC must + be in the same subnet as the current VNIC. + maxLength: 255 + minLength: 1 + type: string + type: object + PublicIpPoolCollection: + description: Results of a `ListPublicIpPool` operation. + properties: + items: + description: A list of public IP pool summaries. + items: + $ref: '#/components/schemas/PublicIpPoolSummary' + type: array + required: + - items + type: object + CreatePublicIpPoolDetails: + description: The information used to create a public IP pool. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the public IP pool. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + required: + - compartmentId + type: object + PublicIpPool: + description: | + A public IP pool is a set of public IP addresses represented as one or more IPv4 CIDR blocks. Resources like load balancers and compute instances can be allocated public IP addresses from a public IP pool. + properties: + cidrBlocks: + description: | + The CIDR blocks added to this pool. This could be all or a portion of a BYOIP CIDR block. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this pool. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The public IP pool's current state. + enum: + - INACTIVE + - UPDATING + - ACTIVE + - DELETING + - DELETED + type: string + timeCreated: + description: | + The date and time the public IP pool was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - timeCreated + type: object + UpdatePublicIpPoolDetails: + description: The data to update for a public IP pool. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + AddPublicIpPoolCapacityDetails: + description: The information used to add capacity to an IP pool. + properties: + byoipRangeId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource to which the CIDR block belongs. + maxLength: 255 + minLength: 1 + type: string + cidrBlock: + description: | + The CIDR block to add to the public IP pool. It could be all of the CIDR block identified in `byoipRangeId`, or a subrange. + Example: `10.0.1.0/24` + maxLength: 18 + minLength: 9 + type: string + required: + - byoipRangeId + - cidrBlock + type: object + ChangePublicIpPoolCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the destination compartment for the public IP pool move. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + RemovePublicIpPoolCapacityDetails: + description: The information needed to remove capacity from a public IP pool. + properties: + cidrBlock: + description: | + The CIDR block to remove from the public IP pool. + Example: `10.0.1.0/24` + maxLength: 18 + minLength: 9 + type: string + required: + - cidrBlock + type: object + PublicIp: + description: | + A *public IP* is a conceptual term that refers to a public IP address and related properties. + The `publicIp` object is the API representation of a public IP. + + There are two types of public IPs: + 1. Ephemeral + 2. Reserved + + For more information and comparison of the two types, + see [Public IP Addresses](/iaas/Content/Network/Tasks/managingpublicIPs.htm). + properties: + assignedEntityId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the entity the public IP is assigned to, or in the process of + being assigned to. + maxLength: 255 + minLength: 1 + type: string + assignedEntityType: + description: | + The type of entity the public IP is assigned to, or in the process of being + assigned to. + enum: + - PRIVATE_IP + - NAT_GATEWAY + type: string + availabilityDomain: + description: | + The public IP's availability domain. This property is set only for ephemeral public IPs + that are assigned to a private IP (that is, when the `scope` of the public IP is set to + AVAILABILITY_DOMAIN). The value is the availability domain of the assigned private IP. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the public IP. For an ephemeral public IP, this is + the compartment of its assigned entity (which can be a private IP or a regional entity such + as a NAT gateway). For a reserved public IP that is currently assigned, + its compartment can be different from the assigned private IP's. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The public IP's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). + maxLength: 255 + minLength: 1 + type: string + ipAddress: + description: | + The public IP address of the `publicIp` object. + + Example: `203.0.113.2` + type: string + lifecycleState: + description: The public IP's current state. + enum: + - PROVISIONING + - AVAILABLE + - ASSIGNING + - ASSIGNED + - UNASSIGNING + - UNASSIGNED + - TERMINATING + - TERMINATED + type: string + lifetime: + description: | + Defines when the public IP is deleted and released back to Oracle's public IP pool. + + * `EPHEMERAL`: The lifetime is tied to the lifetime of its assigned entity. An ephemeral + public IP must always be assigned to an entity. If the assigned entity is a private IP, + the ephemeral public IP is automatically deleted when the private IP is deleted, when + the VNIC is terminated, or when the instance is terminated. If the assigned entity is a + [NatGateway](#/en/iaas/latest/NatGateway/), the ephemeral public IP is automatically + deleted when the NAT gateway is terminated. + + * `RESERVED`: You control the public IP's lifetime. You can delete a reserved public IP + whenever you like. It does not need to be assigned to a private IP at all times. + + For more information and comparison of the two types, + see [Public IP Addresses](/iaas/Content/Network/Tasks/managingpublicIPs.htm). + enum: + - EPHEMERAL + - RESERVED + type: string + privateIpId: + description: | + Deprecated. Use `assignedEntityId` instead. + + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private IP that the public IP is currently assigned to, or in the + process of being assigned to. + + **Note:** This is `null` if the public IP is not assigned to a private IP, or is + in the process of being assigned to one. + maxLength: 255 + minLength: 1 + type: string + publicIpPoolId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pool object created in the current tenancy. + maxLength: 255 + minLength: 1 + type: string + scope: + description: | + Whether the public IP is regional or specific to a particular availability domain. + + * `REGION`: The public IP exists within a region and is assigned to a regional entity + (such as a [NatGateway](#/en/iaas/latest/NatGateway/)), or can be assigned to a private + IP in any availability domain in the region. Reserved public IPs and ephemeral public IPs + assigned to a regional entity have `scope` = `REGION`. + + * `AVAILABILITY_DOMAIN`: The public IP exists within the availability domain of the entity + it's assigned to, which is specified by the `availabilityDomain` property of the public IP object. + Ephemeral public IPs that are assigned to private IPs have `scope` = `AVAILABILITY_DOMAIN`. + enum: + - REGION + - AVAILABILITY_DOMAIN + type: string + timeCreated: + description: | + The date and time the public IP was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + type: object + CreatePublicIpDetails: + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the public IP. For ephemeral public IPs, + you must set this to the private IP's compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm). + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + lifetime: + description: | + Defines when the public IP is deleted and released back to the Oracle Cloud + Infrastructure public IP pool. For more information, see + [Public IP Addresses](/iaas/Content/Network/Tasks/managingpublicIPs.htm). + enum: + - EPHEMERAL + - RESERVED + type: string + privateIpId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private IP to assign the public IP to. + + Required for an ephemeral public IP because it must always be assigned to a private IP + (specifically a *primary* private IP). + + Optional for a reserved public IP. If you don't provide it, the public IP is created but not + assigned to a private IP. You can later assign the public IP with + [UpdatePublicIp](#/en/iaas/latest/PublicIp/UpdatePublicIp). + maxLength: 255 + minLength: 1 + type: string + publicIpPoolId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - lifetime + type: object + GetPublicIpByIpAddressDetails: + description: | + IP address of the public IP. + properties: + ipAddress: + description: | + The public IP address. + Example: 203.0.113.2 + maxLength: 32 + minLength: 1 + type: string + required: + - ipAddress + type: object + GetPublicIpByPrivateIpIdDetails: + description: | + Details of the private IP that the public IP is assigned to. + properties: + privateIpId: + description: | + [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private IP. + maxLength: 255 + minLength: 1 + type: string + required: + - privateIpId + type: object + UpdatePublicIpDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + privateIpId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private IP to assign the public IP to. + * If the public IP is already assigned to a different private IP, it will be unassigned + and then reassigned to the specified private IP. + * If you set this field to an empty string, the public IP will be unassigned from the + private IP it is currently assigned to. + maxLength: 255 + minLength: 0 + type: string + type: object + ChangePublicIpCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the + public IP to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + RemotePeeringConnection: + description: | + A remote peering connection (RPC) is an object on a DRG that lets the VCN that is attached + to the DRG peer with a VCN in a different region. *Peering* means that the two VCNs can + communicate using private IP addresses, but without the traffic traversing the internet or + routing through your on-premises network. For more information, see + [VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the RPC. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + drgId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG that this RPC belongs to. + 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the RPC. + maxLength: 255 + minLength: 1 + type: string + isCrossTenancyPeering: + description: | + Whether the VCN at the other end of the peering is in a different tenancy. + + Example: `false` + type: boolean + lifecycleState: + description: The RPC's current lifecycle state. + enum: + - AVAILABLE + - PROVISIONING + - TERMINATING + - TERMINATED + type: string + peerId: + description: | + If this RPC is peered, this value is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the other RPC. + maxLength: 255 + minLength: 1 + type: string + peerRegionName: + description: | + If this RPC is peered, this value is the region that contains the other RPC. + + Example: `us-ashburn-1` + maxLength: 255 + minLength: 1 + type: string + peerTenancyId: + description: | + If this RPC is peered, this value is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the other RPC's tenancy. + maxLength: 255 + minLength: 1 + type: string + peeringStatus: + description: | + Whether the RPC is peered with another RPC. `NEW` means the RPC has not yet been + peered. `PENDING` means the peering is being established. `REVOKED` means the + RPC at the other end of the peering has been deleted. + enum: + - INVALID + - NEW + - PENDING + - PEERED + - REVOKED + type: string + timeCreated: + description: | + The date and time the RPC was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - compartmentId + - displayName + - drgId + - id + - isCrossTenancyPeering + - lifecycleState + - peeringStatus + - timeCreated + type: object + CreateRemotePeeringConnectionDetails: + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the RPC. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + drgId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG the RPC belongs to. + 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 + required: + - compartmentId + - drgId + type: object + UpdateRemotePeeringConnectionDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + ChangeRemotePeeringConnectionCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the + remote peering connection to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ConnectRemotePeeringConnectionsDetails: + description: Information about the other remote peering connection (RPC). + properties: + peerId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the RPC you want to peer with. + maxLength: 255 + minLength: 1 + type: string + peerRegionName: + description: | + The name of the region that contains the RPC you want to peer with. + + Example: `us-ashburn-1` + maxLength: 255 + minLength: 1 + type: string + required: + - peerId + - peerRegionName + type: object + RouteTable: + description: | + A collection of `RouteRule` objects, which are used to route packets + based on destination IP to a particular network entity. For more information, see + [Overview of the Networking Service](/iaas/Content/Network/Concepts/overview.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the route table. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The route table's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The route table's current state. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + type: string + routeRules: + description: | + The collection of rules for routing destination IPs to network devices. + items: + $ref: '#/components/schemas/RouteRule' + type: array + timeCreated: + description: | + The date and time the route table was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the route table list belongs to. + maxLength: 255 + minLength: 1 + type: string + required: + - id + - compartmentId + - routeRules + - lifecycleState + - vcnId + x-example: | + { + "compartmentId" : "ocid1.compartment.oc1..<unique_ID>", + "displayName" : "MyRouteTable", + "id" : "ocid1.routetable.oc1.phx.<unique_ID>", + "lifecycleState" : "AVAILABLE", + "routeRules" : [{ + "cidrBlock" : "10.0.3.0/24", + "networkEntityId" : "ocid1.internetgateway.oc1.phx.<unique_ID>" + }], + "timeCreated" : "2016-12-14T20:50:04.956Z", + "vcnId" : "ocid1.vcn.oc1.phx.<unique_ID>" + } + type: object + CreateRouteTableDetails: + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the route table. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + routeRules: + description: | + The collection of rules used for routing destination IPs to network devices. + items: + $ref: '#/components/schemas/RouteRule' + type: array + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the route table belongs to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - routeRules + - vcnId + type: object + UpdateRouteTableDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + routeRules: + description: | + The collection of rules used for routing destination IPs to network devices. + items: + $ref: '#/components/schemas/RouteRule' + type: array + type: object + ChangeRouteTableCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the + route table to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + SecurityList: + description: | + A set of virtual firewall rules for your VCN. Security lists are configured at the subnet + level, but the rules are applied to the ingress and egress traffic for the individual instances + in the subnet. The rules can be stateful or stateless. For more information, see + [Security Lists](/iaas/Content/Network/Concepts/securitylists.htm). + **Note:** Compare security lists to [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/)s, + which let you apply a set of security rules to a *specific set of VNICs* instead of an entire + subnet. Oracle recommends using network security groups instead of security lists, although you + can use either or both together. + + **Important:** Oracle Cloud Infrastructure Compute service images automatically include firewall rules (for example, + Linux iptables, Windows firewall). If there are issues with some type of access to an instance, + make sure both the security lists associated with the instance's subnet and the instance's + firewall rules are set correctly. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the security list. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + egressSecurityRules: + description: Rules for allowing egress IP packets. + items: + $ref: '#/components/schemas/EgressSecurityRule' + type: array + 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 + id: + description: The security list's Oracle Cloud ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). + maxLength: 255 + minLength: 1 + type: string + ingressSecurityRules: + description: Rules for allowing ingress IP packets. + items: + $ref: '#/components/schemas/IngressSecurityRule' + type: array + lifecycleState: + description: The security list's current state. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + type: string + timeCreated: + description: | + The date and time the security list was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the security list belongs to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - displayName + - egressSecurityRules + - id + - ingressSecurityRules + - lifecycleState + - timeCreated + - vcnId + x-example: | + { + "compartmentId" : "ocid1.compartment.oc1..<unique_ID>", + "displayName" : "MyPrivateSubnetSecurityList", + "egressSecurityRules" : [{ + "destination" : "10.0.2.0/24", + "protocol" : "6", + "tcpOptions" : { + "destinationPortRange" : { + "max" : 1521, + "min" : 1521 + } + } + }], + "id" : "ocid1.securitylist.oc1.phx.<unique_ID>", + "ingressSecurityRules" : [{ + "protocol" : "6", + "source" : "10.0.1.0/24", + "tcpOptions" : { + "destinationPortRange" : { + "max" : 1521, + "min" : 1521 + } + } + },{ + "protocol" : "6", + "source" : "10.0.2.0/24", + "tcpOptions" : { + "destinationPortRange" : { + "max" : 1521, + "min" : 1521 + } + } + }], + "lifecycleState" : "AVAILABLE", + "timeCreated" : "2016-12-14T21:02:46.357Z", + "vcnId" : "ocid1.vcn.oc1.phx.<unique_ID>" + } + type: object + CreateSecurityListDetails: + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the security list. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + egressSecurityRules: + description: Rules for allowing egress IP packets. + items: + $ref: '#/components/schemas/EgressSecurityRule' + type: array + 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 + ingressSecurityRules: + description: Rules for allowing ingress IP packets. + items: + $ref: '#/components/schemas/IngressSecurityRule' + type: array + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the security list belongs to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - egressSecurityRules + - ingressSecurityRules + - vcnId + type: object + UpdateSecurityListDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + egressSecurityRules: + description: Rules for allowing egress IP packets. + items: + $ref: '#/components/schemas/EgressSecurityRule' + type: array + 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 + ingressSecurityRules: + description: Rules for allowing ingress IP packets. + items: + $ref: '#/components/schemas/IngressSecurityRule' + type: array + type: object + ChangeSecurityListCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the + security list to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ServiceGateway: + description: | + Represents a router that lets your VCN privately access specific Oracle services such as Object + Storage without exposing the VCN to the public internet. Traffic leaving the VCN and destined + for a supported Oracle service (use the [ListServices](#/en/iaas/latest/Service/ListServices) operation to + find available service CIDR labels) is routed through the service gateway and does not traverse the internet. + The instances in the VCN do not need to have public IP addresses nor be in a public subnet. The VCN does not + need an internet gateway for this traffic. For more information, see + [Access to Oracle Services: Service Gateway](/iaas/Content/Network/Tasks/servicegateway.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + properties: + blockTraffic: + default: false + description: | + Whether the service gateway blocks all traffic through it. The default is `false`. When + this is `true`, traffic is not routed to any services, regardless of route rules. + + Example: `true` + type: boolean + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the + service gateway. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the service gateway. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The service gateway's current state. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + type: string + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the service gateway is using. + For information about why you would associate a route table with a service gateway, see + [Transit Routing: Private Access to Oracle Services](/iaas/Content/Network/Tasks/transitroutingoracleservices.htm). + maxLength: 255 + minLength: 1 + type: string + services: + description: | + List of the [Service](#/en/iaas/latest/Service/) objects enabled for this service gateway. + The list can be empty. You can enable a particular `Service` by using + [AttachServiceId](#/en/iaas/latest/ServiceGateway/AttachServiceId) or + [UpdateServiceGateway](#/en/iaas/latest/ServiceGateway/UpdateServiceGateway). + items: + $ref: '#/components/schemas/ServiceIdResponseDetails' + type: array + timeCreated: + description: | + The date and time the service gateway was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + vcnId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the service gateway + belongs to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - id + - lifecycleState + - vcnId + - blockTraffic + - services + type: object + CreateServiceGatewayDetails: + properties: + compartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to contain the service gateway. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the service gateway will use. + + If you don't specify a route table here, the service gateway is created without an associated route + table. The Networking service does NOT automatically associate the attached VCN's default route table + with the service gateway. + + For information about why you would associate a route table with a service gateway, see + [Transit Routing: Private Access to Oracle Services](/iaas/Content/Network/Tasks/transitroutingoracleservices.htm). + maxLength: 255 + minLength: 1 + type: string + services: + description: | + List of the OCIDs of the [Service](#/en/iaas/latest/Service/) objects to + enable for the service gateway. This list can be empty if you don't want to enable any + `Service` objects when you create the gateway. You can enable a `Service` + object later by using either [AttachServiceId](#/en/iaas/latest/ServiceGateway/AttachServiceId) + or [UpdateServiceGateway](#/en/iaas/latest/ServiceGateway/UpdateServiceGateway). + + For each enabled `Service`, make sure there's a route rule with the `Service` object's `cidrBlock` + as the rule's destination and the service gateway as the rule's target. See + [Route Table](#/en/iaas/latest/RouteTable/). + items: + $ref: '#/components/schemas/ServiceIdRequestDetails' + type: array + uniqueItems: true + vcnId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - vcnId + - services + type: object + UpdateServiceGatewayDetails: + properties: + blockTraffic: + default: true + description: | + Whether the service gateway blocks all traffic through it. The default is `false`. When + this is `true`, traffic is not routed to any services, regardless of route rules. + + Example: `true` + type: boolean + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the service gateway will use. + For information about why you would associate a route table with a service gateway, see + [Transit Routing: Private Access to Oracle Services](/iaas/Content/Network/Tasks/transitroutingoracleservices.htm). + maxLength: 255 + minLength: 1 + type: string + services: + description: | + List of all the `Service` objects you want enabled on this service gateway. Sending an empty list + means you want to disable all services. Omitting this parameter entirely keeps the + existing list of services intact. + + You can also enable or disable a particular `Service` by using + [AttachServiceId](#/en/iaas/latest/ServiceGateway/AttachServiceId) or + [DetachServiceId](#/en/iaas/latest/ServiceGateway/DetachServiceId). + + For each enabled `Service`, make sure there's a route rule with the `Service` object's `cidrBlock` + as the rule's destination and the service gateway as the rule's target. See + [Route Table](#/en/iaas/latest/RouteTable/). + items: + $ref: '#/components/schemas/ServiceIdRequestDetails' + type: array + uniqueItems: true + type: object + ServiceIdRequestDetails: + additionalProperties: false + properties: + serviceId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the [Service](#/en/iaas/latest/Service/). + maxLength: 255 + minLength: 1 + type: string + required: + - serviceId + type: object + ChangeServiceGatewayCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the + service gateway to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + Service: + description: | + An object that represents one or multiple Oracle services that you can enable for a + [ServiceGateway](#/en/iaas/latest/ServiceGateway/). In the User Guide topic + [Access to Oracle Services: Service Gateway](/iaas/Content/Network/Tasks/servicegateway.htm), the + term *service CIDR label* is used to refer to the string that represents the regional public + IP address ranges of the Oracle service or services covered by a given `Service` object. That + unique string is the value of the `Service` object's `cidrBlock` attribute. + properties: + cidrBlock: + description: | + A string that represents the regional public IP address ranges for the Oracle service or + services covered by this `Service` object. Also known as the `Service` object's *service + CIDR label*. + + When you set up a route rule to route traffic to the service gateway, use this value as the + rule's destination. See [Route Table](#/en/iaas/latest/RouteTable/). Also, when you set up + a security list rule to cover traffic with the service gateway, use the `cidrBlock` value + as the rule's destination (for an egress rule) or the source (for an ingress rule). + See [Security List](#/en/iaas/latest/SecurityList/). + + Example: `oci-phx-objectstorage` + maxLength: 255 + minLength: 1 + type: string + description: + description: | + Description of the Oracle service or services covered by this `Service` object. + + Example: `OCI PHX Object Storage` + maxLength: 255 + minLength: 1 + type: string + id: + description: The `Service` object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). + maxLength: 255 + minLength: 1 + type: string + name: + description: | + Name of the `Service` object. This name can change and is not guaranteed to be unique. + + Example: `OCI PHX Object Storage` + maxLength: 127 + minLength: 1 + type: string + required: + - id + - name + - cidrBlock + - description + type: object + SubnetTopology: + description: | + Defines the visualization of a subnet in a VCN. + See [Network Visualizer Documentation](/iaas/Content/Network/Concepts/network_visualizer.htm) for more information, including + conventions and pictures of symbols. + discriminator: + propertyName: type + properties: + entities: + description: Lists entities comprising the virtual network topology. + items: + type: string + description: (opaque JSON object) + type: array + limitedEntities: + description: | + Lists entities that are limited during ingestion. + The values for the items in the list are the entity type names of the limitedEntities. + Example: `vcn` + items: + type: string + maxItems: 100 + type: array + relationships: + description: Lists relationships between entities in the virtual network topology. + items: + $ref: '#/components/schemas/TopologyEntityRelationship' + type: array + timeCreated: + description: Records when the virtual network topology was created, in [RFC3339](https://tools.ietf.org/html/rfc3339) format for date and time. + format: date-time + type: string + type: + description: Type of the topology object. + enum: + - NETWORKING + - VCN + - SUBNET + - PATH + type: string + subnetId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet for which the visualization is generated. + maxLength: 255 + minLength: 1 + type: string + required: + - type + - entities + - relationships + - limitedEntities + - timeCreated + type: object + Subnet: + description: | + A logical subdivision of a VCN. Each subnet + consists of a contiguous range of IP addresses that do not overlap with + other subnets in the VCN. Example: 172.16.1.0/24. For more information, see + [Overview of the Networking Service](/iaas/Content/Network/Concepts/overview.htm) and + [VCNs and Subnets](/iaas/Content/Network/Tasks/managingVCNs.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + properties: + availabilityDomain: + description: | + The subnet's availability domain. This attribute will be null if this is a regional subnet + instead of an AD-specific subnet. Oracle recommends creating regional subnets. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + cidrBlock: + description: | + The subnet's CIDR block. + + Example: `10.0.1.0/24` + maxLength: 32 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the subnet. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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 + dhcpOptionsId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the set of DHCP options that the subnet uses. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + dnsLabel: + description: | + A DNS label for the subnet, used in conjunction with the VNIC's hostname and + VCN's DNS label to form a fully qualified domain name (FQDN) for each VNIC + within this subnet (for example, `bminstance1.subnet123.vcn1.oraclevcn.com`). + Must be an alphanumeric string that begins with a letter and is unique within the VCN. + The value cannot be changed. + + The absence of this parameter means the Internet and VCN Resolver + will not resolve hostnames of instances in this subnet. + + For more information, see + [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). + + Example: `subnet123` + maxLength: 15 + 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 + id: + description: The subnet's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). + maxLength: 255 + minLength: 1 + type: string + ipv4CidrBlocks: + description: | + The list of all IPv4 CIDR blocks for the subnet that meets the following criteria: + - Ipv4 CIDR blocks must be valid. + - Multiple Ipv4 CIDR blocks must not overlap each other or the on-premises network CIDR block. + - The number of prefixes must not exceed the limit of IPv4 prefixes allowed to a subnet. + items: + maxLength: 32 + minLength: 1 + type: string + type: array + uniqueItems: true + ipv6CidrBlock: + description: | + For an IPv6-enabled subnet, this is the IPv6 prefix for the subnet's private IP address + space. The subnet size is always /64. IPv6 addressing is supported for all commercial and government regions. + See [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + + Example: `2001:0db8:0123:1111::/64` + maxLength: 45 + minLength: 1 + type: string + ipv6CidrBlocks: + description: | + The list of all IPv6 prefixes (Oracle allocated IPv6 GUA, ULA or private IPv6 prefixes, BYOIPv6 prefixes) for the subnet. + items: + maxLength: 45 + minLength: 1 + type: string + type: array + uniqueItems: true + ipv6PublicCidrBlock: + description: | + For an IPv6-enabled subnet, this is the IPv6 prefix for the subnet's public IP address + space. The subnet size is always /64. The left 48 bits are inherited from the + `ipv6PublicCidrBlock` of the [Vcn](#/en/iaas/latest/Vcn/), + and the remaining 16 bits are from the subnet's `ipv6CidrBlock`. + + Example: `2001:0db8:0123:1111::/64` + maxLength: 45 + minLength: 1 + type: string + ipv6VirtualRouterIp: + description: | + For an IPv6-enabled subnet, this is the IPv6 address of the virtual router. + + Example: `2001:0db8:0123:1111:89ab:cdef:1234:5678` + maxLength: 45 + minLength: 1 + type: string + lifecycleState: + description: The subnet's current state. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + type: string + prohibitPublicIpOnVnic: + description: | + Whether VNICs within this subnet can have public IP addresses. + Defaults to false, which means VNICs created in this subnet will + automatically be assigned public IP addresses unless specified + otherwise during instance launch or VNIC creation (with the + `assignPublicIp` flag in + [CreateVnicDetails](#/en/iaas/latest/CreateVnicDetails/)). + If `prohibitPublicIpOnVnic` is set to true, VNICs created in this + subnet cannot have public IP addresses (that is, it's a private + subnet). + + Example: `true` + type: boolean + routeTableId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table that the subnet uses. + maxLength: 255 + minLength: 1 + type: string + securityListIds: + description: | + The OCIDs of the security list or lists that the subnet uses. Remember + that security lists are associated *with the subnet*, but the + rules are applied to the individual VNICs in the subnet. + items: + maxLength: 255 + maximum: 5 + minLength: 1 + minimum: 0 + type: string + type: array + subnetDomainName: + description: | + The subnet's domain name, which consists of the subnet's DNS label, + the VCN's DNS label, and the `oraclevcn.com` domain. + + For more information, see + [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). + + Example: `subnet123.vcn1.oraclevcn.com` + maxLength: 253 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the subnet was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the subnet is in. + maxLength: 255 + minLength: 1 + type: string + virtualRouterIp: + description: | + The IP address of the virtual router. + + Example: `10.0.14.1` + maxLength: 32 + minLength: 1 + type: string + virtualRouterMac: + description: | + The MAC address of the virtual router. + + Example: `00:00:00:00:00:01` + maxLength: 32 + minLength: 1 + type: string + required: + - vcnId + - id + - compartmentId + - cidrBlock + - virtualRouterIp + - routeTableId + - virtualRouterMac + - lifecycleState + x-example: | + { + "availabilityDomain" : "crmS:PHX-AD-1", + "cidrBlock" : "10.0.2.0/24", + "compartmentId" : "ocid1.compartment.oc1..<unique_ID>", + "dhcpOptionsId" : "ocid1.dhcpoptions.oc1.phx.<unique_ID>", + "displayName" : "MySubnet", + "id" : "ocid1.subnet.oc1.phx.<unique_ID>", + "lifecycleState" : "AVAILABLE", + "routeTableId" : "ocid1.routetable.oc1.phx.<unique_ID>", + "securityListIds" : [ "ocid1.securitylist.oc1.phx.<unique_ID>" ], + "timeCreated" : "2016-11-18T22:26:14.639Z", + "vcnId" : "ocid1.vcn.oc1.phx.<unique_ID>", + "virtualRouterIp" : "10.0.1.1", + "virtualRouterMac" : "00:00:00:00:00:01" + } + type: object + CreateSubnetDetails: + properties: + availabilityDomain: + description: | + Controls whether the subnet is regional or specific to an availability domain. Oracle + recommends creating regional subnets because they're more flexible and make it easier to + implement failover across availability domains. Originally, AD-specific subnets were the + only kind available to use. + + To create a regional subnet, omit this attribute. Then any resources later created in this + subnet (such as a Compute instance) can be created in any availability domain in the region. + + To instead create an AD-specific subnet, set this attribute to the availability domain you + want this subnet to be in. Then any resources later created in this subnet can only be + created in that availability domain. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + cidrBlock: + description: | + The CIDR IP address range of the subnet. The CIDR must maintain the following rules - + + a. The CIDR block is valid and correctly formatted. + b. The new range is within one of the parent VCN ranges. + + Example: `10.0.1.0/24` + maxLength: 32 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the subnet. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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 + dhcpOptionsId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the set of DHCP options the subnet will use. If you don't + provide a value, the subnet uses the VCN's default set of DHCP options. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + dnsLabel: + description: | + A DNS label for the subnet, used in conjunction with the VNIC's hostname and + VCN's DNS label to form a fully qualified domain name (FQDN) for each VNIC + within this subnet (for example, `bminstance1.subnet123.vcn1.oraclevcn.com`). + Must be an alphanumeric string that begins with a letter and is unique within the VCN. + The value cannot be changed. + + This value must be set if you want to use the Internet and VCN Resolver to resolve the + hostnames of instances in the subnet. It can only be set if the VCN itself + was created with a DNS label. + + For more information, see + [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). + + Example: `subnet123` + maxLength: 15 + 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 + ipv4CidrBlocks: + description: | + The list of all IPv4 CIDR blocks for the subnet that meets the following criteria: + - Ipv4 CIDR blocks must be valid. + - Multiple Ipv4 CIDR blocks must not overlap each other or the on-premises network CIDR block. + - The number of prefixes must not exceed the limit of IPv4 prefixes allowed to a subnet. + items: + maxLength: 32 + minLength: 1 + type: string + type: array + uniqueItems: true + x-default-description: 'null' + ipv6CidrBlock: + description: | + Use this to enable IPv6 addressing for this subnet. The VCN must be enabled for IPv6. + You can't change this subnet characteristic later. All subnets are /64 in size. The subnet + portion of the IPv6 address is the fourth hextet from the left (1111 in the following example). + + For important details about IPv6 addressing in a VCN, see [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + + Example: `2001:0db8:0123:1111::/64` + maxLength: 45 + minLength: 1 + type: string + ipv6CidrBlocks: + description: | + The list of all IPv6 prefixes (Oracle allocated IPv6 GUA, ULA or private IPv6 prefixes, BYOIPv6 prefixes) for the subnet that meets the following criteria: + - The prefixes must be valid. + - Multiple prefixes must not overlap each other or the on-premises network prefix. + - The number of prefixes must not exceed the limit of IPv6 prefixes allowed to a subnet. + items: + maxLength: 45 + minLength: 1 + type: string + type: array + uniqueItems: true + x-default-description: 'null' + prohibitPublicIpOnVnic: + description: | + Whether VNICs within this subnet can have public IP addresses. + Defaults to false, which means VNICs created in this subnet will + automatically be assigned public IP addresses unless specified + otherwise during instance launch or VNIC creation (with the + `assignPublicIp` flag in [CreateVnicDetails](#/en/iaas/latest/CreateVnicDetails/)). + If `prohibitPublicIpOnVnic` is set to true, VNICs created in this + subnet cannot have public IP addresses (that is, it's a private + subnet). + + For IPv6, if `prohibitPublicIpOnVnic` is set to `true`, internet access is not allowed for any + IPv6s assigned to VNICs in the subnet. + + Example: `true` + type: boolean + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the subnet will use. If you don't provide a value, + the subnet uses the VCN's default route table. + maxLength: 255 + minLength: 1 + type: string + securityListIds: + description: | + The OCIDs of the security list or lists the subnet will use. If you don't + provide a value, the subnet uses the VCN's default security list. + Remember that security lists are associated *with the subnet*, but the + rules are applied to the individual VNICs in the subnet. + items: + maxLength: 255 + maximum: 5 + minLength: 1 + minimum: 0 + type: string + type: array + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN to contain the subnet. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + - vcnId + type: object + UpdateSubnetDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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 + dhcpOptionsId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the set of DHCP options the subnet will use. + maxLength: 255 + minLength: 1 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + ipv6CidrBlock: + description: | + This is the IPv6 prefix for the subnet's private IP address space. + The subnet size is always /64. + See [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + The provided prefix must maintain the following rules - + + a. The IPv6 prefix is valid and correctly formatted. + b. The IPv6 prefix is within the parent VCN IPv6 range. + + Example: `2001:0db8:0123:1111::/64` + maxLength: 45 + minLength: 1 + type: string + ipv6CidrBlocks: + description: | + The list of all IPv6 prefixes (Oracle allocated IPv6 GUA, ULA or private IPv6 prefix, BYOIPv6 prefixes) for the subnet that meets the following criteria: + - The prefixes must be valid. + - Multiple prefixes must not overlap each other or the on-premises network prefix. + - The number of prefixes must not exceed the limit of IPv6 prefixes allowed to a subnet. + items: + maxLength: 45 + minLength: 1 + type: string + type: array + uniqueItems: true + x-default-description: 'null' + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the subnet will use. + maxLength: 255 + minLength: 1 + type: string + securityListIds: + description: | + The OCIDs of the security list or lists the subnet will use. This + replaces the entire current set of security lists. Remember that + security lists are associated *with the subnet*, but the rules are + applied to the individual VNICs in the subnet. + items: + maxLength: 255 + maximum: 5 + minLength: 1 + minimum: 0 + type: string + type: array + type: object + AddIpv4SubnetCidrDetails: + description: Details used when adding an IPv4 prefix to a subnet. + properties: + ipv4CidrBlock: + description: | + The CIDR IP address range of the subnet. The CIDR must maintain the following rules - + + a. The CIDR block is valid and correctly formatted. + b. The new range is within one of the parent VCN ranges. + + Example: `10.0.1.0/24` + maxLength: 32 + minLength: 1 + type: string + required: + - ipv4CidrBlock + type: object + AddSubnetIpv6CidrDetails: + description: Details used when adding an IPv6 prefix to a subnet. + properties: + ipv6CidrBlock: + description: | + This field is not required and should only be specified when adding an IPv6 prefix + to a subnet's IPv6 address space. + See[IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + + Example: `2001:0db8:0123::/64` + maxLength: 45 + minLength: 1 + type: string + required: + - ipv6CidrBlock + type: object + ChangeSubnetCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the + subnet to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ModifyIpv4SubnetCidrDetails: + description: Details object for updating the specified Ipv4 CIDR block of a Subnet. + properties: + ipv4CidrBlock: + description: | + The Ipv4 CIDR IP address to update. + maxLength: 18 + minLength: 9 + type: string + updatedIpv4CidrBlock: + description: | + The new Ipv4 CIDR IP address. + maxLength: 18 + minLength: 9 + type: string + required: + - ipv4CidrBlock + - updatedIpv4CidrBlock + type: object + RemoveIpv4SubnetCidrDetails: + description: Details object for removing an IPv4 prefix from a subnet. + properties: + ipv4CidrBlock: + description: | + This field should only be specified when removing an IPv4 prefix from a subnet's IPv4 address space. + The CIDR must maintain the following rules - + + a. The CIDR block is valid and correctly formatted. + b. The CIDR range is within one of the parent VCN ranges. + c. The CIDR range to be removed is already present in the list of ipv4CidrBlocks + + Example: `10.0.1.0/24` + maxLength: 32 + minLength: 1 + type: string + required: + - ipv4CidrBlock + type: object + RemoveSubnetIpv6CidrDetails: + description: Details object for removing an IPv6 prefix from a subnet. + properties: + ipv6CidrBlock: + description: | + This field is not required and should only be specified when removing an IPv6 prefix + from a subnet's IPv6 address space. + See[IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + + Example: `2001:0db8:0123::/64` + maxLength: 45 + minLength: 1 + type: string + required: + - ipv6CidrBlock + type: object + VcnTopology: + description: | + Defines the representation of a virtual network topology for a VCN. + See [Network Visualizer Documentation](/iaas/Content/Network/Concepts/network_visualizer.htm) for more information, including + conventions and pictures of symbols. + discriminator: + propertyName: type + properties: + entities: + description: Lists entities comprising the virtual network topology. + items: + type: string + description: (opaque JSON object) + type: array + limitedEntities: + description: | + Lists entities that are limited during ingestion. + The values for the items in the list are the entity type names of the limitedEntities. + Example: `vcn` + items: + type: string + maxItems: 100 + type: array + relationships: + description: Lists relationships between entities in the virtual network topology. + items: + $ref: '#/components/schemas/TopologyEntityRelationship' + type: array + timeCreated: + description: Records when the virtual network topology was created, in [RFC3339](https://tools.ietf.org/html/rfc3339) format for date and time. + format: date-time + type: string + type: + description: Type of the topology object. + enum: + - NETWORKING + - VCN + - SUBNET + - PATH + type: string + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN for which the topology is generated. + maxLength: 255 + minLength: 1 + type: string + required: + - type + - entities + - relationships + - limitedEntities + - timeCreated + type: object + Vcn: + description: | + A virtual cloud network (VCN). For more information, see + [Overview of the Networking Service](/iaas/Content/Network/Concepts/overview.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + properties: + byoipv6CidrBlocks: + description: | + The list of BYOIPv6 prefixes required to create a VCN that uses BYOIPv6 ranges. + items: + maxLength: 45 + minLength: 1 + type: string + type: array + uniqueItems: true + cidrBlock: + description: | + Deprecated. The first CIDR IP address from cidrBlocks. + + Example: `172.16.0.0/16` + maxLength: 32 + minLength: 1 + type: string + cidrBlocks: + description: | + The list of IPv4 CIDR blocks the VCN will use. + items: + maxLength: 32 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the VCN. + maxLength: 255 + minLength: 1 + type: string + defaultDhcpOptionsId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the VCN's default set of DHCP options. + maxLength: 255 + minLength: 1 + type: string + defaultRouteTableId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the VCN's default route table. + maxLength: 255 + minLength: 1 + type: string + defaultSecurityListId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the VCN's default security list. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + dnsLabel: + description: | + A DNS label for the VCN, used in conjunction with the VNIC's hostname and + subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC + within this subnet (for example, `bminstance1.subnet123.vcn1.oraclevcn.com`). + Must be an alphanumeric string that begins with a letter. + The value cannot be changed. + + The absence of this parameter means the Internet and VCN Resolver will + not work for this VCN. + + For more information, see + [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). + + Example: `vcn1` + maxLength: 15 + 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 + id: + description: The VCN's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). + maxLength: 255 + minLength: 1 + type: string + ipv6CidrBlock: + description: | + For an IPv6-enabled VCN, this is the IPv6 prefix for the VCN's private IP address space. + The VCN size is always /56. Oracle + provides the IPv6 prefix to use as the *same* CIDR for the `ipv6PublicCidrBlock`. + When creating a subnet, specify the last 8 bits, 00 to FF. + See [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + Example: `2001:0db8:0123::/56` + maxLength: 45 + minLength: 1 + type: string + ipv6PrivateCidrBlocks: + description: | + For an IPv6-enabled VCN, this is the list of Private IPv6 prefixes for the VCN's IP address space. + items: + maxLength: 45 + minLength: 1 + type: string + type: array + uniqueItems: true + ipv6PublicCidrBlock: + description: | + For an IPv6-enabled VCN, this is the IPv6 prefix for the VCN's public IP address space. + The VCN size is always /56. This prefix is always provided by Oracle. If you don't provide a + custom prefix for the `ipv6CidrBlock` when creating the VCN, Oracle assigns that value and also + uses it for `ipv6PublicCidrBlock`. Oracle uses addresses from this block for the `publicIpAddress` + attribute of an [Ipv6](#/en/iaas/latest/Ipv6/) that has internet access allowed. + + Example: `2001:0db8:0123::/48` + maxLength: 45 + minLength: 1 + type: string + isEncrypted: + description: | + Indicates whether traffic within the VCN is encrypted. + For more information, see [VN Encryption](/iaas/Content/gov-cloud/govinfo.htm#govinfo_topic_LAN-encryption). + type: boolean + isZprOnly: + default: false + description: | + Indicates whether ZPR Only mode is enforced. + type: boolean + lifecycleState: + description: The VCN's current state. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + - UPDATING + type: string + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). + type: object + description: | + [Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels + for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) + (ZPR) policy to control access to ZPR-supported resources. + + Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}` + type: object + timeCreated: + description: | + The date and time the VCN was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + vcnDomainName: + description: | + The VCN's domain name, which consists of the VCN's DNS label, and the + `oraclevcn.com` domain. + + For more information, see + [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). + + Example: `vcn1.oraclevcn.com` + maxLength: 253 + minLength: 1 + type: string + required: + - id + - compartmentId + - cidrBlock + - lifecycleState + - cidrBlocks + x-example: | + { + "cidrBlock" : "10.0.0.0/16", + "cidrBlocks" : ["10.0.0.0/16","192.168.0.0/16"], + "compartmentId" : "ocid1.compartment.oc1..<unique_ID>", + "defaultDhcpOptionsId" : "ocid1.dhcpoptions.oc1.phx.<unique_ID>", + "defaultRouteTableId" : "ocid1.routetable.oc1.phx.<unique_ID>", + "defaultSecurityListId" : "ocid1.securitylist.oc1.phx.<unique_ID>", + "displayName" : "MyVcn", + "id" : "ocid1.vcn.oc1.phx.<unique_ID>", + "lifecycleState" : "AVAILABLE", + "timeCreated" : "2016-11-18T22:16:24.423Z" + } + type: object + CreateVcnDetails: + properties: + byoipv6CidrDetails: + description: | + The list of BYOIPv6 OCIDs and BYOIPv6 prefixes required to create a VCN that uses BYOIPv6 address ranges. + items: + $ref: '#/components/schemas/Byoipv6CidrDetails' + type: array + uniqueItems: true + x-default-description: 'null' + cidrBlock: + description: | + **Deprecated.** Do *not* set this value. Use `cidrBlocks` instead. + Example: `10.0.0.0/16` + maxLength: 32 + minLength: 1 + type: string + cidrBlocks: + description: | + The list of one or more IPv4 CIDR blocks for the VCN that meet the following criteria: + - The CIDR blocks must be valid. + - They must not overlap with each other or with the on-premises network CIDR block. + - The number of CIDR blocks must not exceed the limit of CIDR blocks allowed per VCN. + + **Important:** Do *not* specify a value for `cidrBlock`. Use this parameter instead. + items: + maxLength: 32 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the VCN. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + dnsLabel: + description: | + A DNS label for the VCN, used in conjunction with the VNIC's hostname and + subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC + within this subnet (for example, `bminstance1.subnet123.vcn1.oraclevcn.com`). + Not required to be unique, but it's a best practice to set unique DNS labels + for VCNs in your tenancy. Must be an alphanumeric string that begins with a letter. + The value cannot be changed. + + You must set this value if you want instances to be able to use hostnames to + resolve other instances in the VCN. Otherwise the Internet and VCN Resolver + will not work. + + For more information, see + [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). + + Example: `vcn1` + maxLength: 15 + 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 + ipv6CidrBlock: + description: | + If you enable IPv6 for the VCN (see `isIpv6Enabled`), you may optionally provide an IPv6 + /56 prefix from the supported ranges (see [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + The addresses in this block will be considered private and cannot be accessed + from the internet. The documentation refers to this as a *custom CIDR* for the VCN. + + If you don't provide a custom CIDR for the VCN, Oracle assigns the VCN's IPv6 /56 prefix. + + Regardless of whether you or Oracle assigns the `ipv6CidrBlock`, + Oracle *also* assigns the VCN an IPv6 prefix for the VCN's public IP address space + (see the `ipv6PublicCidrBlock` of the [Vcn](#/en/iaas/latest/Vcn/) object). If you do + not assign a custom prefix, Oracle uses the *same* Oracle-assigned prefix for both the private + IP address space (`ipv6CidrBlock` in the `Vcn` object) and the public IP addreses space + (`ipv6PublicCidrBlock` in the `Vcn` object). This means that a given VNIC might use the same + IPv6 IP address for both private and public (internet) communication. You control whether + an IPv6 address can be used for internet communication by using the `isInternetAccessAllowed` + attribute in the [Ipv6](#/en/iaas/latest/Ipv6/) object. + + For important details about IPv6 addressing in a VCN, see [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + + Example: `2001:0db8:0123::/48` + maxLength: 45 + minLength: 1 + type: string + ipv6PrivateCidrBlocks: + description: | + The list of one or more ULA or Private IPv6 prefixes for the VCN that meets the following criteria: + - The CIDR blocks must be valid. + - Multiple CIDR blocks must not overlap each other or the on-premises network prefix. + - The number of CIDR blocks must not exceed the limit of IPv6 prefixes allowed to a VCN. + + **Important:** Do *not* specify a value for `ipv6CidrBlock`. Use this parameter instead. + items: + maxLength: 45 + minLength: 1 + type: string + type: array + uniqueItems: true + x-default-description: 'null' + isEncrypted: + description: | + Indicates whether traffic within the VCN is encrypted. + For more information, see [VN Encryption](/iaas/Content/gov-cloud/govinfo.htm#govinfo_topic_LAN-encryption). + type: boolean + isIpv6Enabled: + description: | + Whether IPv6 is enabled for the VCN. Default is `false`. + If enabled, Oracle will assign the VCN a IPv6 /56 CIDR block. + + You may skip having Oracle allocate the VCN a IPv6 /56 CIDR block by setting isOracleGuaAllocationEnabled to `false`. + + For important details about IPv6 addressing in a VCN, see [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + + Example: `true` + type: boolean + isOracleGuaAllocationEnabled: + default: true + description: | + Specifies whether to skip Oracle allocated IPv6 GUA. By default, Oracle will allocate one GUA of /56 + size for an IPv6 enabled VCN. + type: boolean + isZprOnly: + default: false + description: | + Indicates whether ZPR Only mode is enforced. + type: boolean + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). + type: object + description: | + [Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels + for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) + (ZPR) policy to control access to ZPR-supported resources. + + Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}` + type: object + required: + - compartmentId + type: object + UpdateVcnDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + isEncrypted: + description: | + Indicates whether traffic within the VCN is encrypted. + For more information, see [VN Encryption](/iaas/Content/gov-cloud/govinfo.htm#govinfo_topic_LAN-encryption). + type: boolean + isZprOnly: + default: false + description: | + Indicates whether ZPR Only mode is enforced. + type: boolean + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). + type: object + description: | + [Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels + for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) + (ZPR) policy to control access to ZPR-supported resources. + + Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}` + type: object + type: object + AddVcnCidrDetails: + description: Details used to add a CIDR block to a VCN. + properties: + cidrBlock: + description: | + The CIDR block to add. + maxLength: 18 + minLength: 9 + type: string + required: + - cidrBlock + type: object + AddVcnIpv6CidrDetails: + description: Details used when adding a ULA or private IPv6 prefix or an IPv6 GUA assigned by Oracle or a BYOIPv6 prefix. You can add only one of these per request. + properties: + byoipv6CidrDetail: + $ref: '#/components/schemas/Byoipv6CidrDetails' + ipv6PrivateCidrBlock: + description: | + This field is not required and should only be specified if a ULA or private IPv6 prefix is desired for VCN's private IP address space. + See[IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + + Example: `2001:0db8:0123::/48` or `fd00:1000:0:1::/64` + maxLength: 45 + minLength: 1 + type: string + isOracleGuaAllocationEnabled: + default: true + description: | + Indicates whether Oracle will allocate an IPv6 GUA. Only one prefix of /56 size can be allocated by Oracle as a GUA. + type: boolean + type: object + ChangeVcnCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the + VCN to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + ModifyVcnCidrDetails: + description: | + Details for updating a CIDR block. + properties: + newCidrBlock: + description: | + The new CIDR IP address. + maxLength: 18 + minLength: 9 + type: string + originalCidrBlock: + description: | + The CIDR IP address to update. + maxLength: 18 + minLength: 9 + type: string + required: + - originalCidrBlock + - newCidrBlock + type: object + RemoveVcnCidrDetails: + description: Details for removing a CIDR block from a VCN. + properties: + cidrBlock: + description: | + The CIDR block to remove. + maxLength: 18 + minLength: 9 + type: string + required: + - cidrBlock + type: object + RemoveVcnIpv6CidrDetails: + description: | + Details used when removing ULA or private IPv6 prefix or an IPv6 GUA assigned by Oracle or BYOIPv6 prefix. You can only remove one of these per request. + properties: + ipv6CidrBlock: + description: | + This field is not required and should only be specified when removing ULA or private IPv6 prefix or an IPv6 GUA assigned by Oracle or BYOIPv6 prefix + from a VCN's IPv6 address space. + See[IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + + Example: `2001:0db8:0123::/56` + maxLength: 45 + minLength: 1 + type: string + type: object + VirtualCircuit: + description: | + For use with Oracle Cloud Infrastructure FastConnect. + + A virtual circuit is an isolated network path that runs over one or more physical + network connections to provide a single, logical connection between the edge router + on the customer's existing network and Oracle Cloud Infrastructure. *Private* + virtual circuits support private peering, and *public* virtual circuits support + public peering. For more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). + + Each virtual circuit is made up of information shared between a customer, Oracle, + and a provider (if the customer is using FastConnect via a provider). Who fills in + a given property of a virtual circuit depends on whether the BGP session related to + that virtual circuit goes from the customer's edge router to Oracle, or from the provider's + edge router to Oracle. Also, in the case where the customer is using a provider, values + for some of the properties may not be present immediately, but may get filled in as the + provider and Oracle each do their part to provision the virtual circuit. + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + properties: + bandwidthShapeName: + description: | + The provisioned data rate of the connection. To get a list of the + available bandwidth levels (that is, shapes), see + [ListFastConnectProviderServiceVirtualCircuitBandwidthShapes](#/en/iaas/latest/FastConnectProviderService/ListFastConnectProviderVirtualCircuitBandwidthShapes). + + Example: `10 Gbps` + type: string + bgpAdminState: + description: | + Set to `ENABLED` (the default) to activate the BGP session of the virtual circuit, set to `DISABLED` to deactivate the virtual circuit. + enum: + - ENABLED + - DISABLED + type: string + bgpIpv6SessionState: + description: The state of the Ipv6 BGP session associated with the virtual circuit. + enum: + - UP + - DOWN + type: string + bgpManagement: + description: | + Deprecated. Instead use the information in + [FastConnectProviderService](#/en/iaas/latest/FastConnectProviderService/). + enum: + - CUSTOMER_MANAGED + - PROVIDER_MANAGED + - ORACLE_MANAGED + type: string + bgpSessionState: + description: The state of the Ipv4 BGP session associated with the virtual circuit. + enum: + - UP + - DOWN + type: string + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the virtual circuit. + maxLength: 255 + minLength: 1 + type: string + crossConnectMappings: + description: | + An array of mappings, each containing properties for a + cross-connect or cross-connect group that is associated with this + virtual circuit. + items: + $ref: '#/components/schemas/CrossConnectMapping' + maximum: 2 + minimum: 0 + type: array + customerBgpAsn: + description: | + The BGP ASN of the network at the other end of the BGP + session from Oracle. If the session is between the customer's + edge router and Oracle, the value is the customer's ASN. If the BGP + session is between the provider's edge router and Oracle, the value + is the provider's ASN. + type: integer + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + gatewayId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the customer's [dynamic routing gateway (DRG)](#/en/iaas/latest/Drg) + that this virtual circuit uses. Applicable only to private virtual circuits. + maxLength: 255 + minLength: 1 + type: string + id: + description: The virtual circuit's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). + maxLength: 255 + minLength: 1 + type: string + ipMtu: + description: The layer 3 IP MTU to use on this virtual circuit. + enum: + - MTU_1500 + - MTU_9000 + type: string + x-obmcs-top-level-enum: '#/definitions/VirtualCircuitIpMtu' + isBfdEnabled: + default: false + description: | + Set to `true` to enable BFD for IPv4 BGP peering, or set to `false` to disable BFD. If this is not set, the default is `false`. + type: boolean + isTransportMode: + default: false + description: | + Set to `true` for the virtual circuit to carry only encrypted traffic, or set to `false` for the virtual circuit to carry unencrypted traffic. If this is not set, the default is `false`. + type: boolean + lifecycleState: + description: | + The virtual circuit's current state. For information about + the different states, see + [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). + enum: + - PENDING_PROVIDER + - VERIFYING + - PROVISIONING + - PROVISIONED + - FAILED + - INACTIVE + - TERMINATING + - TERMINATED + type: string + oracleBgpAsn: + description: The Oracle BGP ASN. + type: integer + providerName: + description: | + Deprecated. Instead use `providerServiceId`. + maxLength: 255 + minLength: 1 + type: string + providerServiceId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the service offered by the provider (if the customer is connecting via a provider). + maxLength: 255 + minLength: 1 + type: string + providerServiceKeyName: + description: | + The service key name offered by the provider (if the customer is connecting via a provider). + maxLength: 255 + minLength: 1 + type: string + providerServiceName: + description: | + Deprecated. Instead use `providerServiceId`. + maxLength: 255 + minLength: 1 + type: string + providerState: + description: | + The provider's state in relation to this virtual circuit (if the + customer is connecting via a provider). ACTIVE means + the provider has provisioned the virtual circuit from their end. + INACTIVE means the provider has not yet provisioned the virtual + circuit, or has de-provisioned it. + enum: + - ACTIVE + - INACTIVE + type: string + publicPrefixes: + description: | + For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to + advertise across the connection. All prefix sizes are allowed. + items: + maxLength: 50 + minLength: 9 + type: string + maximum: 50 + minimum: 0 + type: array + referenceComment: + description: | + Provider-supplied reference information about this virtual circuit + (if the customer is connecting via a provider). + type: string + region: + description: | + The Oracle Cloud Infrastructure region where this virtual + circuit is located. + maxLength: 255 + minLength: 1 + type: string + routingPolicy: + description: | + The routing policy sets how routing information about the Oracle cloud is shared over a public virtual circuit. + Policies available are: `ORACLE_SERVICE_NETWORK`, `REGIONAL`, `MARKET_LEVEL`, and `GLOBAL`. + See [Route Filtering](/iaas/Content/Network/Concepts/routingonprem.htm#route_filtering) for details. + By default, routing information is shared for all routes in the same market. + items: + enum: + - ORACLE_SERVICE_NETWORK + - REGIONAL + - MARKET_LEVEL + - GLOBAL + type: string + maxItems: 16 + type: array + serviceType: + description: | + Provider service type. + enum: + - COLOCATED + - LAYER2 + - LAYER3 + type: string + timeCreated: + description: | + The date and time the virtual circuit was created, + in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + type: + description: | + Whether the virtual circuit supports private or public peering. For more information, + see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). + enum: + - PUBLIC + - PRIVATE + type: string + virtualCircuitRedundancyMetadata: + $ref: '#/components/schemas/VirtualCircuitRedundancyMetadata' + type: object + CreateVirtualCircuitDetails: + properties: + bandwidthShapeName: + description: | + The provisioned data rate of the connection. To get a list of the + available bandwidth levels (that is, shapes), see + [ListFastConnectProviderServiceVirtualCircuitBandwidthShapes](#/en/iaas/latest/FastConnectProviderService/ListFastConnectProviderVirtualCircuitBandwidthShapes). + + Example: `10 Gbps` + type: string + bgpAdminState: + description: | + Set to `ENABLED` (the default) to activate the BGP session of the virtual circuit, set to `DISABLED` to deactivate the virtual circuit. + enum: + - ENABLED + - DISABLED + type: string + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the virtual circuit. + maxLength: 255 + minLength: 1 + type: string + crossConnectMappings: + description: | + Create a `CrossConnectMapping` for each cross-connect or cross-connect + group this virtual circuit will run on. + items: + $ref: '#/components/schemas/CrossConnectMapping' + maximum: 2 + minimum: 0 + type: array + customerBgpAsn: + description: | + Your BGP ASN (either public or private). Provide this value only if + there's a BGP session that goes from your edge router to Oracle. + Otherwise, leave this empty or null. + type: integer + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + gatewayId: + description: | + For private virtual circuits only. The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the [dynamic routing gateway (DRG)](#/en/iaas/latest/Drg) + that this virtual circuit uses. + maxLength: 255 + minLength: 1 + type: string + ipMtu: + description: The layer 3 IP MTU to use with this virtual circuit. + enum: + - MTU_1500 + - MTU_9000 + type: string + x-obmcs-top-level-enum: '#/definitions/VirtualCircuitIpMtu' + isBfdEnabled: + default: false + description: | + Set to `true` to enable BFD for IPv4 BGP peering, or set to `false` to disable BFD. If this is not set, the default is `false`. + type: boolean + isTransportMode: + default: false + description: | + Set to `true` for the virtual circuit to carry only encrypted traffic, or set to `false` for the virtual circuit to carry unencrypted traffic. If this is not set, the default is `false`. + type: boolean + providerName: + description: | + Deprecated. Instead use `providerServiceId`. + To get a list of the provider names, see + [ListFastConnectProviderServices](#/en/iaas/latest/FastConnectProviderService/ListFastConnectProviderServices). + maxLength: 255 + minLength: 1 + type: string + providerServiceId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the service offered by the provider (if you're connecting + via a provider). To get a list of the available service offerings, see + [ListFastConnectProviderServices](#/en/iaas/latest/FastConnectProviderService/ListFastConnectProviderServices). + maxLength: 255 + minLength: 1 + type: string + providerServiceKeyName: + description: | + The service key name or activation key offered by the provider (if the customer is connecting via a provider). + maxLength: 1000 + minLength: 1 + type: string + providerServiceName: + description: | + Deprecated. Instead use `providerServiceId`. + To get a list of the provider names, see + [ListFastConnectProviderServices](#/en/iaas/latest/FastConnectProviderService/ListFastConnectProviderServices). + maxLength: 255 + minLength: 1 + type: string + publicPrefixes: + description: | + For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to + advertise across the connection. + items: + $ref: '#/components/schemas/CreateVirtualCircuitPublicPrefixDetails' + maximum: 50 + minimum: 0 + type: array + region: + description: | + The Oracle Cloud Infrastructure region where this virtual + circuit is located. + Example: `phx` + maxLength: 255 + minLength: 1 + type: string + routingPolicy: + description: | + The routing policy sets how routing information about the Oracle cloud is shared over a public virtual circuit. + Policies available are: `ORACLE_SERVICE_NETWORK`, `REGIONAL`, `MARKET_LEVEL`, and `GLOBAL`. + See [Route Filtering](/iaas/Content/Network/Concepts/routingonprem.htm#route_filtering) for details. + By default, routing information is shared for all routes in the same market. + items: + enum: + - ORACLE_SERVICE_NETWORK + - REGIONAL + - MARKET_LEVEL + - GLOBAL + type: string + maxItems: 16 + type: array + type: + description: | + The type of IP addresses used in this virtual circuit. PRIVATE + means [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses + (10.0.0.0/8, 172.16/12, and 192.168/16). + enum: + - PUBLIC + - PRIVATE + type: string + required: + - compartmentId + - type + type: object + UpdateVirtualCircuitDetails: + properties: + bandwidthShapeName: + description: | + The provisioned data rate of the connection. To get a list of the + available bandwidth levels (that is, shapes), see + [ListFastConnectProviderVirtualCircuitBandwidthShapes](#/en/iaas/latest/FastConnectProviderService/ListFastConnectProviderVirtualCircuitBandwidthShapes). + To be updated only by the customer who owns the virtual circuit. + type: string + bgpAdminState: + description: | + Set to `ENABLED` (the default) to activate the BGP session of the virtual circuit, set to `DISABLED` to deactivate the virtual circuit. + enum: + - ENABLED + - DISABLED + type: string + crossConnectMappings: + description: | + An array of mappings, each containing properties for a cross-connect or + cross-connect group associated with this virtual circuit. + + The customer and provider can update different properties in the mapping + depending on the situation. See the description of the + [CrossConnectMapping](#/en/iaas/latest/CrossConnectMapping/). + items: + $ref: '#/components/schemas/CrossConnectMapping' + maximum: 2 + minimum: 0 + type: array + customerBgpAsn: + description: | + The BGP ASN of the network at the other end of the BGP + session from Oracle. + + If the BGP session is from the customer's edge router to Oracle, the + required value is the customer's ASN, and it can be updated only + by the customer. + + If the BGP session is from the provider's edge router to Oracle, the + required value is the provider's ASN, and it can be updated only + by the provider. + type: integer + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + gatewayId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the [dynamic routing gateway (DRG)](#/en/iaas/latest/Drg) + that this private virtual circuit uses. + + To be updated only by the customer who owns the virtual circuit. + maxLength: 255 + minLength: 1 + type: string + ipMtu: + description: The layer 3 IP MTU to use on this virtual circuit. + enum: + - MTU_1500 + - MTU_9000 + type: string + x-obmcs-top-level-enum: '#/definitions/VirtualCircuitIpMtu' + isBfdEnabled: + default: false + description: | + Set to `true` to enable BFD for IPv4 BGP peering, or set to `false` to disable BFD. If this is not set, the default is `false`. + type: boolean + isTransportMode: + default: false + description: | + Set to `true` for the virtual circuit to carry only encrypted traffic, or set to `false` for the virtual circuit to carry unencrypted traffic. If this is not set, the default is `false`. + type: boolean + providerServiceKeyName: + description: | + The service key name offered by the provider (if the customer is connecting via a provider). + maxLength: 255 + minLength: 1 + type: string + providerState: + description: | + The provider's state in relation to this virtual circuit. Relevant only + if the customer is using FastConnect via a provider. ACTIVE + means the provider has provisioned the virtual circuit from their + end. INACTIVE means the provider has not yet provisioned the virtual + circuit, or has de-provisioned it. + + To be updated only by the provider. + enum: + - ACTIVE + - INACTIVE + type: string + referenceComment: + description: | + Provider-supplied reference information about this virtual circuit. + Relevant only if the customer is using FastConnect via a provider. + + To be updated only by the provider. + type: string + routingPolicy: + description: | + The routing policy sets how routing information about the Oracle cloud is shared over a public virtual circuit. + Policies available are: `ORACLE_SERVICE_NETWORK`, `REGIONAL`, `MARKET_LEVEL`, and `GLOBAL`. + See [Route Filtering](/iaas/Content/Network/Concepts/routingonprem.htm#route_filtering) for details. + By default, routing information is shared for all routes in the same market. + items: + enum: + - ORACLE_SERVICE_NETWORK + - REGIONAL + - MARKET_LEVEL + - GLOBAL + type: string + maxItems: 16 + type: array + type: object + BulkAddVirtualCircuitPublicPrefixesDetails: + properties: + publicPrefixes: + description: The public IP prefixes (CIDRs) to add to the public virtual circuit. + items: + $ref: '#/components/schemas/CreateVirtualCircuitPublicPrefixDetails' + maximum: 50 + minimum: 0 + type: array + required: + - publicPrefixes + type: object + BulkDeleteVirtualCircuitPublicPrefixesDetails: + properties: + publicPrefixes: + description: | + The public IP prefixes (CIDRs) to remove from the public virtual circuit. + items: + $ref: '#/components/schemas/DeleteVirtualCircuitPublicPrefixDetails' + maximum: 50 + minimum: 0 + type: array + required: + - publicPrefixes + type: object + ChangeVirtualCircuitCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the + virtual circuit to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + VirtualCircuitAssociatedTunnelDetails: + description: Detailed private tunnel info associated with the virtual circuit. + properties: + ipsecConnectionId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of IPSec connection associated with the virtual circuit. + maxLength: 255 + minLength: 1 + type: string + tunnelId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec tunnel associated with the virtual circuit. + maxLength: 255 + minLength: 1 + type: string + tunnelType: + description: The type of the tunnel associated with the virtual circuit. + enum: + - IPSEC + type: string + required: + - tunnelType + - tunnelId + type: object + CrossConnectMappingDetailsCollection: + description: An array of CrossConnectMappingDetails + properties: + items: + description: CrossConnectMappingDetails items + items: + $ref: '#/components/schemas/CrossConnectMappingDetails' + maximum: 2 + minimum: 0 + type: array + required: + - items + type: object + VirtualCircuitPublicPrefix: + description: | + A public IP prefix and its details. With a public virtual circuit, the customer + specifies the customer-owned public IP prefixes to advertise across the connection. + For more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). + properties: + cidrBlock: + description: Publix IP prefix (CIDR) that the customer specified. + maxLength: 50 + minLength: 4 + type: string + verificationState: + description: | + Oracle must verify that the customer owns the public IP prefix before traffic + for that prefix can flow across the virtual circuit. Verification can take a + few business days. `IN_PROGRESS` means Oracle is verifying the prefix. `COMPLETED` + means verification succeeded. `FAILED` means verification failed and traffic for + this prefix will not flow across the connection. + enum: + - IN_PROGRESS + - COMPLETED + - FAILED + type: string + required: + - cidrBlock + - verificationState + type: object + Vlan: + description: | + A resource to be used only with the Oracle Cloud VMware Solution. + + Conceptually, a virtual LAN (VLAN) is a broadcast domain that is created + by partitioning and isolating a network at the data link layer (a *layer 2 network*). + VLANs work by using IEEE 802.1Q VLAN tags. Layer 2 traffic is forwarded within the + VLAN based on MAC learning. + + In the Networking service, a VLAN is an object within a VCN. You use VLANs to + partition the VCN at the data link layer (layer 2). A VLAN is analagous to a subnet, + which is an object for partitioning the VCN at the IP layer (layer 3). + properties: + availabilityDomain: + description: | + The availability domain of the VLAN. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + cidrBlock: + description: | + The range of IPv4 addresses that will be used for layer 3 communication with + hosts outside the VLAN. + + Example: `192.168.1.0/24` + maxLength: 32 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the VLAN. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The VLAN's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The VLAN's current state. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + - UPDATING + type: string + nsgIds: + description: | + A list of the OCIDs of the network security groups (NSGs) to use with this VLAN. + All VNICs in the VLAN belong to these NSGs. For more + information about NSGs, see + [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + routeTableId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table that the VLAN uses. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the VLAN was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the VLAN is in. + maxLength: 255 + minLength: 1 + type: string + vlanTag: + description: | + The IEEE 802.1Q VLAN tag of this VLAN. + + Example: `100` + format: int32 + type: integer + required: + - id + - compartmentId + - cidrBlock + - lifecycleState + - vcnId + type: object + CreateVlanDetails: + properties: + availabilityDomain: + description: | + The availability domain of the VLAN. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + cidrBlock: + description: | + The range of IPv4 addresses that will be used for layer 3 communication with + hosts outside the VLAN. The CIDR must maintain the following rules - + + 1. The CIDR block is valid and correctly formatted. + 2. The new range is within one of the parent VCN ranges. + + Example: `192.0.2.0/24` + maxLength: 32 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the VLAN. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + nsgIds: + description: | + A list of the OCIDs of the network security groups (NSGs) to add all VNICs in the VLAN to. For more + information about NSGs, see + [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the VLAN will use. If you don't provide a value, + the VLAN uses the VCN's default route table. + maxLength: 255 + minLength: 1 + type: string + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN to contain the VLAN. + maxLength: 255 + minLength: 1 + type: string + vlanTag: + description: | + The IEEE 802.1Q VLAN tag for this VLAN. The value must be unique across all + VLANs in the VCN. If you don't provide a value, Oracle assigns one. + You cannot change the value later. VLAN tag 0 is reserved for use by Oracle. + format: int32 + maximum: 4094 + minimum: 1 + type: integer + required: + - availabilityDomain + - compartmentId + - cidrBlock + - vcnId + type: object + UpdateVlanDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + nsgIds: + description: | + A list of the OCIDs of the network security groups (NSGs) to use with + this VLAN. All VNICs in the VLAN will belong to these NSGs. For more + information about NSGs, see + [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the VLAN will use. + maxLength: 255 + minLength: 1 + type: string + type: object + ChangeVlanCompartmentDetails: + description: The configuration details for the move operation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the VLAN to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + Vnic: + description: | + A virtual network interface card. Each VNIC resides in a subnet in a VCN. + An instance attaches to a VNIC to obtain a network connection into the VCN + through that subnet. Each instance has a *primary VNIC* that is automatically + created and attached during launch. You can add *secondary VNICs* to an + instance after it's launched. For more information, see + [Virtual Network Interface Cards (VNICs)](/iaas/Content/Network/Tasks/managingVNICs.htm). + + Each VNIC has a *primary private IP* that is automatically assigned during launch. + You can add *secondary private IPs* to a VNIC after it's created. For more + information, see [CreatePrivateIp](#/en/iaas/latest/PrivateIp/CreatePrivateIp) and + [IP Addresses](/iaas/Content/Network/Tasks/managingIPaddresses.htm). + + + If you are an Oracle Cloud VMware Solution customer, you will have secondary VNICs + that reside in a VLAN instead of a subnet. These VNICs have other differences, which + are called out in the descriptions of the relevant attributes in the `Vnic` object. + Also see [Vlan](#/en/iaas/latest/Vlan). + + To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, + talk to an administrator. If you're an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). + properties: + availabilityDomain: + description: | + The VNIC's availability domain. + + Example: `Uocm:PHX-AD-1` + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the VNIC. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + hostnameLabel: + description: | + The hostname for the VNIC's primary private IP. Used for DNS. The value is the hostname + portion of the primary private IP's fully qualified domain name (FQDN) + (for example, `bminstance1` in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`). + Must be unique across all VNICs in the subnet and comply with + [RFC 952](https://tools.ietf.org/html/rfc952) and + [RFC 1123](https://tools.ietf.org/html/rfc1123). + + For more information, see + [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). + + Example: `bminstance1` + maxLength: 63 + minLength: 1 + type: string + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC. + maxLength: 255 + minLength: 1 + type: string + ipv6Addresses: + description: | + List of IPv6 addresses assigned to the VNIC. + + Example: `2001:DB8::` + items: + maxLength: 45 + minLength: 1 + type: string + type: array + isPrimary: + description: | + Whether the VNIC is the primary VNIC (the VNIC that is automatically created + and attached during instance launch). + type: boolean + lifecycleState: + description: The current state of the VNIC. + enum: + - PROVISIONING + - AVAILABLE + - TERMINATING + - TERMINATED + type: string + macAddress: + description: | + The MAC address of the VNIC. + + If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution, + the MAC address is learned. If the VNIC belongs to a subnet, the + MAC address is a static, Oracle-provided value. + + Example: `00:00:00:00:00:01` + maxLength: 32 + minLength: 1 + type: string + nsgIds: + description: | + A list of the OCIDs of the network security groups that the VNIC belongs to. + + If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution (instead of + belonging to a subnet), the value of the `nsgIds` attribute is ignored. Instead, the + VNIC belongs to the NSGs that are associated with the VLAN itself. See [Vlan](#/en/iaas/latest/Vlan). + + For more information about NSGs, see + [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + privateIp: + description: | + The private IP address of the primary `privateIp` object on the VNIC. + The address is within the CIDR of the VNIC's subnet. + + Example: `10.0.3.3` + type: string + publicIp: + description: | + The public IP address of the VNIC, if one is assigned. + type: string + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see + [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). + maxLength: 255 + minLength: 0 + type: string + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). + type: object + description: | + [Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels + for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) + (ZPR) policy to control access to ZPR-supported resources. + + Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}` + type: object + skipSourceDestCheck: + description: | + Whether the source/destination check is disabled on the VNIC. + Defaults to `false`, which means the check is performed. For information + about why you would skip the source/destination check, see + [Using a Private IP as a Route Target](/iaas/Content/Network/Tasks/managingroutetables.htm#privateip). + + If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution (instead of + belonging to a subnet), the `skipSourceDestCheck` attribute is `true`. + This is because the source/destination check is always disabled for VNICs in a VLAN. + + Example: `true` + type: boolean + subnetId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet the VNIC is in. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the VNIC was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + vlanId: + description: | + If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution (instead of + belonging to a subnet), the `vlanId` is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN the VNIC is in. See + [Vlan](#/en/iaas/latest/Vlan). If the VNIC is instead in a subnet, `subnetId` has a value. + maxLength: 255 + minLength: 1 + type: string + required: + - availabilityDomain + - compartmentId + - id + - lifecycleState + - timeCreated + type: object + UpdateVnicDetails: + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + hostnameLabel: + description: | + The hostname for the VNIC's primary private IP. Used for DNS. The value is the hostname + portion of the primary private IP's fully qualified domain name (FQDN) + (for example, `bminstance1` in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`). + Must be unique across all VNICs in the subnet and comply with + [RFC 952](https://tools.ietf.org/html/rfc952) and + [RFC 1123](https://tools.ietf.org/html/rfc1123). + The value appears in the [Vnic](#/en/iaas/latest/Vnic/) object and also the + [PrivateIp](#/en/iaas/latest/PrivateIp/) object returned by + [ListPrivateIps](#/en/iaas/latest/PrivateIp/ListPrivateIps) and + [GetPrivateIp](#/en/iaas/latest/PrivateIp/GetPrivateIp). + + For more information, see + [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). + maxLength: 63 + minLength: 1 + type: string + nsgIds: + description: | + A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. Setting this as + an empty array removes the VNIC from all network security groups. + + If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution (instead of + belonging to a subnet), the value of the `nsgIds` attribute is ignored. Instead, the + VNIC belongs to the NSGs that are associated with the VLAN itself. See [Vlan](#/en/iaas/latest/Vlan). + + For more information about NSGs, see + [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see + [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). + maxLength: 255 + minLength: 0 + type: string + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). + type: object + description: | + [Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels + for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) + (ZPR) policy to control access to ZPR-supported resources. + + Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}` + type: object + skipSourceDestCheck: + description: | + Whether the source/destination check is disabled on the VNIC. + Defaults to `false`, which means the check is performed. For information about why you would + skip the source/destination check, see + [Using a Private IP as a Route Target](/iaas/Content/Network/Tasks/managingroutetables.htm#privateip). + + If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution (instead of + belonging to a subnet), the value of the `skipSourceDestCheck` attribute is ignored. + This is because the source/destination check is always disabled for VNICs in a VLAN. + + Example: `true` + type: boolean + type: object + Vtap: + description: | + A virtual test access point (VTAP) provides a way to mirror all traffic from a designated source to a selected target in order to facilitate troubleshooting, security analysis, and data monitoring. + A VTAP is functionally similar to a test access point (TAP) you might deploy in your on-premises network. + + A *[capture filter](#/en/iaas/latest/CaptureFilter)* contains a set of *[rules](#/en/iaas/latest/datatypes/CaptureFilterRuleDetails)* governing what traffic a VTAP mirrors. + properties: + captureFilterId: + description: | + The capture filter's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the `Vtap` resource. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + encapsulationProtocol: + description: | + Defines an encapsulation header type for the VTAP's mirrored traffic. + enum: + - VXLAN + 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 + id: + description: The VTAP's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). + maxLength: 255 + minLength: 1 + type: string + isVtapEnabled: + default: false + description: | + Used to start or stop a `Vtap` resource. + + * `TRUE` directs the VTAP to start mirroring traffic. + * `FALSE` (Default) directs the VTAP to stop mirroring traffic. + type: boolean + lifecycleState: + description: The VTAP's administrative lifecycle state. + enum: + - PROVISIONING + - AVAILABLE + - UPDATING + - TERMINATING + - TERMINATED + type: string + lifecycleStateDetails: + description: The VTAP's current running state. + enum: + - RUNNING + - STOPPED + type: string + maxPacketSize: + description: The maximum size of the packets to be included in the filter. + format: int32 + type: integer + sourceId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the source point where packets are captured. + maxLength: 255 + minLength: 1 + type: string + sourcePrivateEndpointIp: + description: | + The IP Address of the source private endpoint. + maxLength: 46 + minLength: 1 + type: string + sourcePrivateEndpointSubnetId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet that source private endpoint belongs to. + maxLength: 255 + minLength: 1 + type: string + sourceType: + description: | + The source type for the VTAP. + enum: + - VNIC + - SUBNET + - LOAD_BALANCER + - DB_SYSTEM + - EXADATA_VM_CLUSTER + - AUTONOMOUS_DATA_WAREHOUSE + type: string + targetId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the destination resource where mirrored packets are sent. + maxLength: 255 + minLength: 1 + type: string + targetIp: + description: | + The IP address of the destination resource where mirrored packets are sent. + maxLength: 46 + minLength: 1 + type: string + targetType: + description: | + The target type for the VTAP. + enum: + - VNIC + - NETWORK_LOAD_BALANCER + - IP_ADDRESS + type: string + timeCreated: + description: | + The date and time the VTAP was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2020-08-25T21:10:29.600Z` + format: date-time + type: string + trafficMode: + default: DEFAULT + description: Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT + enum: + - DEFAULT + - PRIORITY + type: string + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN containing the `Vtap` resource. + maxLength: 255 + minLength: 1 + type: string + vxlanNetworkIdentifier: + description: | + The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN. + format: int64 + type: integer + required: + - compartmentId + - vcnId + - id + - lifecycleState + - sourceId + - captureFilterId + type: object + CreateVtapDetails: + description: These details are included in a request to create a virtual test access point (VTAP). + properties: + captureFilterId: + description: | + The capture filter's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the `Vtap` resource. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + encapsulationProtocol: + description: | + Defines an encapsulation header type for the VTAP's mirrored traffic. + enum: + - VXLAN + 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 + isVtapEnabled: + default: false + description: | + Used to start or stop a `Vtap` resource. + + * `TRUE` directs the VTAP to start mirroring traffic. + * `FALSE` (Default) directs the VTAP to stop mirroring traffic. + type: boolean + maxPacketSize: + description: The maximum size of the packets to be included in the filter. + format: int32 + type: integer + sourceId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the source point where packets are captured. + maxLength: 255 + minLength: 1 + type: string + sourcePrivateEndpointIp: + description: | + The IP Address of the source private endpoint. + maxLength: 46 + minLength: 1 + type: string + sourcePrivateEndpointSubnetId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet that source private endpoint belongs to. + maxLength: 255 + minLength: 1 + type: string + sourceType: + description: | + The source type for the VTAP. + enum: + - VNIC + - SUBNET + - LOAD_BALANCER + - DB_SYSTEM + - EXADATA_VM_CLUSTER + - AUTONOMOUS_DATA_WAREHOUSE + type: string + targetId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the destination resource where mirrored packets are sent. + maxLength: 255 + minLength: 1 + type: string + targetIp: + description: | + The IP address of the destination resource where mirrored packets are sent. + maxLength: 46 + minLength: 1 + type: string + targetType: + description: | + The target type for the VTAP. + enum: + - VNIC + - NETWORK_LOAD_BALANCER + - IP_ADDRESS + type: string + trafficMode: + default: DEFAULT + description: Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT + enum: + - DEFAULT + - PRIORITY + type: string + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN containing the `Vtap` resource. + maxLength: 255 + minLength: 1 + type: string + vxlanNetworkIdentifier: + description: | + The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN. + format: int64 + type: integer + required: + - compartmentId + - vcnId + - sourceId + - captureFilterId + type: object + UpdateVtapDetails: + description: These details can be included in a request to update a virtual test access point (VTAP). + properties: + captureFilterId: + description: | + The capture filter's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + encapsulationProtocol: + description: | + Defines an encapsulation header type for the VTAP's mirrored traffic. + enum: + - VXLAN + 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 + isVtapEnabled: + default: false + description: | + Used to start or stop a `Vtap` resource. + + * `TRUE` directs the VTAP to start mirroring traffic. + * `FALSE` (Default) directs the VTAP to stop mirroring traffic. + type: boolean + maxPacketSize: + description: The maximum size of the packets to be included in the filter. + format: int32 + type: integer + sourceId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the source point where packets are captured. + maxLength: 255 + minLength: 1 + type: string + sourcePrivateEndpointIp: + description: | + The IP Address of the source private endpoint. + maxLength: 46 + minLength: 1 + type: string + sourcePrivateEndpointSubnetId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet that source private endpoint belongs to. + maxLength: 255 + minLength: 1 + type: string + sourceType: + description: | + The source type for the VTAP. + enum: + - VNIC + - SUBNET + - LOAD_BALANCER + - DB_SYSTEM + - EXADATA_VM_CLUSTER + - AUTONOMOUS_DATA_WAREHOUSE + type: string + targetId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the destination resource where mirrored packets are sent. + maxLength: 255 + minLength: 1 + type: string + targetIp: + description: | + The IP address of the destination resource where mirrored packets are sent. + maxLength: 46 + minLength: 1 + type: string + targetType: + description: | + The target type for the VTAP. + enum: + - VNIC + - NETWORK_LOAD_BALANCER + - IP_ADDRESS + type: string + trafficMode: + default: DEFAULT + description: Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT + enum: + - DEFAULT + - PRIORITY + type: string + vxlanNetworkIdentifier: + description: | + The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN. + format: int64 + type: integer + type: object + ChangeVtapCompartmentDetails: + description: These configuration details are used in the move operation when changing the compartment containing a virtual test access point (VTAP). + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the destination compartment for the VTAP move. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + Error: + properties: + code: + description: | + A short error code that defines the error, meant for programmatic parsing. See + [API Errors](/iaas/Content/API/References/apierrors.htm). + type: string + message: + description: A human-readable error message. + type: string + messageArguments: + additionalProperties: + type: string + description: | + The values to be substituted into the `originalMessageTemplate`, expressed as a string-to-string map. + type: object + originalMessage: + description: A human-readable error string in English. This value might be different from the `message` field. + type: string + originalMessageTemplate: + description: | + The template for the `originalMessage` in ICU message format, but without the values to be substituted. + type: string + required: + - code + - message + type: object + ByoasnSummary: + description: Information about a `Byoasn` resource. + properties: + asn: + description: The Autonomous System Number (ASN) you are importing to the Oracle cloud. + format: int64 + maximum: 4294967294 + minimum: 1 + type: integer + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the `Byoasn` resource. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `Byoasn` resource. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The `Byoasn` resource's current state. + type: string + x-obmcs-enumref: '#/definitions/Byoasn/lifecycleState' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + + Example: `{"CostCenter": "42"}` + type: object + description: | + System tags for this resource. Each key is predefined and scoped to a namespace. + Example: `{"foo-namespace": {"bar-key": "value"}}` + type: object + timeCreated: + description: | + The date and time the `Byoasn` resource was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + - compartmentId + - asn + - lifecycleState + type: object + ByoasnByoipRange: + description: Information about 'ByoipRange' that has `byoasn` as origin. + properties: + asPathPrependLength: + default: 1 + description: The as path prepend length. + minimum: 1 + type: integer + byoipRangeId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource to which the CIDR block belongs. + maxLength: 255 + minLength: 1 + type: string + cidrBlock: + description: The BYOIP CIDR block range or subrange allocated to an IP pool. This could be all or part of a BYOIP CIDR block. + maxLength: 18 + minLength: 9 + type: string + ipv6CidrBlock: + description: | + The IPv6 prefix being imported to the Oracle cloud. This prefix must be /48 or larger, and can be subdivided into sub-ranges used + across multiple VCNs. A BYOIPv6 prefix can be assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify + a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size. + maxLength: 45 + minLength: 1 + type: string + required: + - byoipRangeId + type: object + ByoipRangeSummary: + description: Information about a `ByoipRange` resource. + properties: + byoipRangeVcnIpv6Allocations: + description: | + A list of `ByoipRangeVcnIpv6AllocationSummary` objects. + items: + $ref: '#/components/schemas/ByoipRangeVcnIpv6AllocationSummary' + type: array + cidrBlock: + description: The public IPv4 address range you are importing to the Oracle cloud. + maxLength: 18 + minLength: 9 + type: string + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the `ByoipRange` resource. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource. + maxLength: 255 + minLength: 1 + type: string + ipv6CidrBlock: + description: | + The IPv6 prefix being imported to the Oracle cloud. This prefix must be /48 or larger, and can be subdivided into sub-ranges used + across multiple VCNs. A BYOIPv6 prefix can be assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify + a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size. + maxLength: 45 + minLength: 1 + type: string + lifecycleDetails: + description: The Byoip Range's current lifeCycle substate. + type: string + x-obmcs-enumref: '#/definitions/ByoipRange/lifecycleDetails' + lifecycleState: + description: The `ByoipRange` resource's current state. + type: string + x-obmcs-enumref: '#/definitions/ByoipRange/lifecycleState' + timeCreated: + description: | + The date and time the `ByoipRange` resource was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + type: object + ByoipRangeVcnIpv6AllocationSummary: + description: | + A summary of IPv6 prefix subranges currently allocated to a VCN. + properties: + byoipRangeId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource to which the CIDR block belongs. + maxLength: 255 + minLength: 1 + type: string + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the `ByoipRange`. + maxLength: 255 + minLength: 1 + type: string + ipv6CidrBlock: + description: | + The BYOIPv6 prefix range or subrange allocated to a VCN. This could be all or part of a BYOIPv6 prefix. + Each VCN allocation must be /64 or larger. + maxLength: 45 + minLength: 1 + type: string + vcnId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `Vcn` resource to which the ByoipRange belongs. + maxLength: 255 + minLength: 1 + type: string + type: object + ByoipRangeOriginAsn: + description: Information about the origin asn. + properties: + asPathPrependLength: + default: 1 + description: The as path prepend length. + minimum: 1 + type: integer + asn: + description: The Autonomous System Number (ASN) you are importing to the Oracle cloud. + format: int64 + maximum: 4294967294 + minimum: 1 + type: integer + byoasnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `Byoasn` resource. + maxLength: 255 + minLength: 1 + type: string + required: + - asn + type: object + ByoipAllocatedRangeSummary: + description: A summary of CIDR block subranges that are currently allocated to an IP pool. + properties: + cidrBlock: + description: The BYOIP CIDR block range or subrange allocated to an IP pool. This could be all or part of a BYOIP CIDR block. + maxLength: 18 + minLength: 9 + type: string + publicIpPoolId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IP pool containing the CIDR block. + maxLength: 255 + minLength: 1 + type: string + type: object + VtapCaptureFilterRuleDetails: + description: | + This resource contains the rules governing what traffic a VTAP mirrors. + properties: + destinationCidr: + description: | + Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target. + type: string + icmpOptions: + $ref: '#/components/schemas/IcmpOptions' + protocol: + description: | + The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. + Supported options are: + * 1 = ICMP + * 6 = TCP + * 17 = UDP + type: string + ruleAction: + description: | + Include or exclude packets meeting this definition from mirrored traffic. + enum: + - INCLUDE + - EXCLUDE + type: string + sourceCidr: + description: | + Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target. + type: string + tcpOptions: + $ref: '#/components/schemas/TcpOptions' + trafficDirection: + description: | + The traffic direction the VTAP is configured to mirror. + enum: + - INGRESS + - EGRESS + type: string + udpOptions: + $ref: '#/components/schemas/UdpOptions' + required: + - trafficDirection + type: object + CpeDeviceInfo: + description: Basic information about a particular CPE device type. + properties: + platformSoftwareVersion: + description: The platform or software version of the CPE device. + maxLength: 255 + minLength: 1 + type: string + vendor: + description: The vendor that makes the CPE device. + maxLength: 255 + minLength: 1 + type: string + type: object + CpeDeviceConfigQuestion: + description: | + An individual question that the customer can answer about the CPE device. + + The customer provides answers to these questions in + [UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig). + properties: + displayName: + description: | + A descriptive label for the question (for example, to display in a form in a graphical interface). + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + explanation: + description: | + A description or explanation of the question, to help the customer answer accurately. + maxLength: 255 + minLength: 1 + type: string + key: + description: | + A string that identifies the question. + maxLength: 255 + minLength: 1 + type: string + type: object + MacsecProperties: + description: Properties used for MACsec (if capable). + properties: + encryptionCipher: + description: Type of encryption cipher suite to use for the MACsec connection. + enum: + - AES128_GCM + - AES128_GCM_XPN + - AES256_GCM + - AES256_GCM_XPN + type: string + x-obmcs-top-level-enum: '#/definitions/MacsecEncryptionCipher' + isUnprotectedTrafficAllowed: + default: false + description: Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails. + type: boolean + primaryKey: + $ref: '#/components/schemas/MacsecKey' + state: + description: Indicates whether or not MACsec is enabled. + enum: + - ENABLED + - DISABLED + type: string + x-obmcs-top-level-enum: '#/definitions/MacsecState' + required: + - state + type: object + CreateMacsecProperties: + description: Properties used to configure MACsec (if capable). + properties: + encryptionCipher: + description: Type of encryption cipher suite to use for the MACsec connection. + enum: + - AES128_GCM + - AES128_GCM_XPN + - AES256_GCM + - AES256_GCM_XPN + type: string + x-obmcs-top-level-enum: '#/definitions/MacsecEncryptionCipher' + isUnprotectedTrafficAllowed: + default: false + description: Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails. + type: boolean + primaryKey: + $ref: '#/components/schemas/CreateMacsecKey' + state: + description: Indicates whether or not MACsec is enabled. + enum: + - ENABLED + - DISABLED + type: string + x-obmcs-top-level-enum: '#/definitions/MacsecState' + required: + - state + type: object + UpdateMacsecProperties: + description: Properties used to update MACsec settings. + properties: + encryptionCipher: + description: Type of encryption cipher suite to use for the MACsec connection. + enum: + - AES128_GCM + - AES128_GCM_XPN + - AES256_GCM + - AES256_GCM_XPN + type: string + x-obmcs-top-level-enum: '#/definitions/MacsecEncryptionCipher' + isUnprotectedTrafficAllowed: + default: false + description: Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails. + type: boolean + primaryKey: + $ref: '#/components/schemas/UpdateMacsecKey' + state: + description: Indicates whether or not MACsec is enabled. + enum: + - ENABLED + - DISABLED + type: string + x-obmcs-top-level-enum: '#/definitions/MacsecState' + required: + - state + type: object + DhcpOption: + description: | + A single DHCP option according to [RFC 1533](https://tools.ietf.org/html/rfc1533). + The two options available to use are [DhcpDnsOption](#/en/iaas/latest/DhcpDnsOption/) + and [DhcpSearchDomainOption](#/en/iaas/latest/DhcpSearchDomainOption/). For more + information, see [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm) + and [DHCP Options](/iaas/Content/Network/Tasks/managingDHCP.htm). + discriminator: + propertyName: type + properties: + type: + description: | + The specific DHCP option. Either `DomainNameServer` + (for [DhcpDnsOption](#/en/iaas/latest/DhcpDnsOption/)) or + `SearchDomain` (for [DhcpSearchDomainOption](#/en/iaas/latest/DhcpSearchDomainOption/)). + type: string + required: + - type + type: object + DrgAttachmentNetworkDetails: + discriminator: + propertyName: type + properties: + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network attached to the DRG. + maxLength: 255 + minLength: 1 + type: string + type: + enum: + - VCN + - IPSEC_TUNNEL + - VIRTUAL_CIRCUIT + - REMOTE_PEERING_CONNECTION + type: string + required: + - type + type: object + DrgAttachmentNetworkCreateDetails: + discriminator: + propertyName: type + properties: + id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network attached to the DRG. + maxLength: 255 + minLength: 1 + type: string + type: + enum: + - VCN + type: string + required: + - type + type: object + DrgAttachmentNetworkUpdateDetails: + discriminator: + propertyName: type + properties: + type: + enum: + - VCN + type: string + required: + - type + type: object + AddDrgRouteDistributionStatementDetails: + description: | + Details used to add a route distribution statement. + properties: + action: + description: | + Accept: import/export the route "as is" + enum: + - ACCEPT + type: string + matchCriteria: + description: | + The action is applied only if all of the match criteria is met. + items: + $ref: '#/components/schemas/DrgRouteDistributionMatchCriteria' + maxItems: 1 + minItems: 0 + type: array + priority: + description: | + This field is used to specify the priority of each statement in a route distribution. + The priority will be represented as a number between 0 and 65535 where a lower number + indicates a higher priority. When a route is processed, statements are applied in the order + defined by their priority. The first matching rule dictates the action that will be taken + on the route. + maximum: 65535 + minimum: 1 + type: integer + required: + - matchCriteria + - action + - priority + type: object + DrgRouteDistributionMatchCriteria: + description: | + The match criteria in a route distribution statement. The match criteria outlines which routes + should be imported or exported. + discriminator: + propertyName: matchType + properties: + matchType: + description: | + The type of the match criteria for a route distribution statement. + enum: + - DRG_ATTACHMENT_TYPE + - DRG_ATTACHMENT_ID + - MATCH_ALL + type: string + required: + - matchType + type: object + UpdateDrgRouteDistributionStatementDetails: + description: | + Route distribution statements to update in the route distribution. + properties: + id: + description: | + The Oracle-assigned ID of each route distribution statement to be updated. + maxLength: 255 + minLength: 1 + type: string + matchCriteria: + description: | + The action is applied only if all of the match criteria is met. + items: + $ref: '#/components/schemas/DrgRouteDistributionMatchCriteria' + maxItems: 1 + minItems: 0 + type: array + priority: + description: | + The priority of the statement you'd like to update. + maximum: 65535 + minimum: 1 + type: integer + required: + - id + type: object + AddDrgRouteRuleDetails: + description: | + Details needed when adding a DRG route rule. + properties: + destination: + description: | + This is the range of IP addresses used for matching when routing + traffic. Only CIDR_BLOCK values are allowed. + + Potential values: + * IP address range in CIDR notation. This can be an IPv4 CIDR block or IPv6 prefix. For example: `192.168.1.0/24` + or `2001:0db8:0123:45::/56`. + maxLength: 255 + minLength: 1 + type: string + destinationType: + description: | + Type of destination for the rule. + Allowed values: + * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation. + enum: + - CIDR_BLOCK + type: string + nextHopDrgAttachmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the next hop DRG attachment. The next hop DRG attachment is responsible + for reaching the network destination. + maxLength: 255 + minLength: 1 + type: string + required: + - destination + - nextHopDrgAttachmentId + - destinationType + type: object + UpdateDrgRouteRuleDetails: + description: | + Details used to update a route rule in the DRG route table. + properties: + destination: + description: | + The range of IP addresses used for matching when routing traffic. + + Potential values: + * IP address range in CIDR notation. Can be an IPv4 CIDR block or IPv6 prefix. For example: `192.168.1.0/24` + or `2001:0db8:0123:45::/56`. + maxLength: 255 + minLength: 1 + type: string + destinationType: + description: | + Type of destination for the rule. + Allowed values: + * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation. + enum: + - CIDR_BLOCK + type: string + id: + description: | + The Oracle-assigned ID of each DRG route rule to update. + maxLength: 255 + minLength: 1 + type: string + nextHopDrgAttachmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the next hop DRG attachment. The next hop DRG attachment is responsible + for reaching the network destination. + maxLength: 255 + minLength: 1 + type: string + required: + - id + type: object + DefaultDrgRouteTables: + description: | + The default DRG route table for this DRG. Each network type + has a default DRG route table. + + You can update a network type to use a different DRG route table, but + each network type must have a default DRG route table. You cannot delete + a default DRG route table. + properties: + ipsecTunnel: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the default DRG route table assigned to DRG attachments + of type IPSEC_TUNNEL on creation. + maxLength: 255 + minLength: 1 + type: string + remotePeeringConnection: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the default DRG route table to be assigned to DRG attachments + of type REMOTE_PEERING_CONNECTION on creation. + maxLength: 255 + minLength: 1 + type: string + vcn: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the default DRG route table to be assigned to DRG attachments + of type VCN on creation. + maxLength: 255 + minLength: 1 + type: string + virtualCircuit: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the default DRG route table to be assigned to DRG attachments + of type VIRTUAL_CIRCUIT on creation. + maxLength: 255 + minLength: 1 + type: string + type: object + AddressType: + description: Address type of the CIDR/IP within a VCN or subnet + enum: + - Private_IPv4 + - Oracle_Allocated_Public_IPv4 + - BYOIP_IPv4 + - ULA_IPv6 + - Oracle_Allocated_GUA_IPv6 + - BYOIP_IPv6 + type: string + InventoryVcnSummary: + description: Provides the summary of a VCN's IP Inventory data under specified compartments. + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + dnsDomainName: + description: DNS domain name of the VCN. + maxLength: 255 + minLength: 1 + type: string + inventorySubnetcollection: + description: | + Lists `Subnetcollection` objects + items: + $ref: '#/components/schemas/InventorySubnetSummary' + type: array + inventoryVcnCidrBlockCollection: + description: | + Lists `InventoryVcnCidrBlockSummary` objects. + items: + $ref: '#/components/schemas/InventoryVcnCidrBlockSummary' + type: array + region: + description: Region name of the VCN. + maxLength: 255 + minLength: 1 + type: string + resourceType: + description: Resource types of the VCN. + enum: + - VCN + type: string + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN . + maxLength: 255 + minLength: 1 + type: string + vcnName: + description: Name of the VCN. + maxLength: 255 + minLength: 1 + type: string + type: object + IpInventorySubnetResourceSummary: + description: | + Provides the IP Inventory details of a subnet and its associated resources. + properties: + addressType: + description: Address type of the allocated private IP address. + items: + $ref: '#/components/schemas/AddressType' + type: string + assignedResourceName: + description: Name of the created resource. + maxLength: 255 + minLength: 1 + type: string + assignedResourceType: + description: Type of the resource. + enum: + - Resource + type: string + assignedTime: + description: Assigned time of the private IP address. + format: date-time + type: string + associatedPublicIp: + description: Associated public IP address for the private IP address. + maxLength: 45 + minLength: 7 + type: string + associatedPublicIpPool: + description: Public IP address Pool the IP address is allocated from. + enum: + - ORACLE + - BYOIP + type: string + dnsHostName: + description: DNS hostname of the IP address. + maxLength: 255 + minLength: 1 + type: string + ipAddress: + description: Lists the allocated private IP address. + maxLength: 45 + minLength: 7 + type: string + ipAddressLifetime: + description: Lifetime of the allocated private IP address. + enum: + - Ephemeral + - Reserved + type: string + ipId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IP address. + maxLength: 255 + minLength: 1 + type: string + isPrimary: + default: false + description: Primary flag for IP Resource + type: boolean + parentCidr: + description: The address range the IP address is assigned from. + maxLength: 45 + minLength: 9 + type: string + publicIpLifetime: + description: Lifetime of the assigned public IP address. + enum: + - Ephemeral + - Reserved + type: string + type: object + IpInventoryCidrUtilizationSummary: + description: | + The CIDR utilization details of a subnet. + properties: + addressType: + description: Address type of the CIDR within a subnet. + items: + $ref: '#/components/schemas/AddressType' + type: string + cidr: + description: The CIDR range of a subnet. + maxLength: 45 + minLength: 1 + type: string + utilization: + description: The CIDR utilisation of a subnet. + format: float + maximum: 100 + minimum: 0 + type: number + type: object + IpInventoryVcnOverlapSummary: + description: | + Provides the VCN overlap details. + properties: + cidr: + description: CIDR prefix of the VCN. + maxLength: 45 + minLength: 1 + type: string + overlappingCidr: + description: The overlapping CIDR prefix. + maxLength: 45 + minLength: 1 + type: string + overlappingVcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN . + maxLength: 255 + minLength: 1 + type: string + overlappingVcnName: + description: Name of the overlapping VCN. + maxLength: 255 + minLength: 1 + type: string + type: object + AllowedPhaseOneParameters: + description: Allowed phase one parameters. + properties: + authenticationAlgorithms: + description: Allowed phase one authentication algorithms. + items: + maxLength: 50 + minLength: 1 + type: string + maxItems: 20 + type: array + dhGroups: + description: Allowed phase one Diffie-Hellman groups. + items: + maxLength: 50 + minLength: 1 + type: string + maxItems: 20 + type: array + encryptionAlgorithms: + description: Allowed phase one encryption algorithms. + items: + maxLength: 50 + minLength: 1 + type: string + maxItems: 20 + type: array + type: object + AllowedPhaseTwoParameters: + description: Allowed phase two parameters. + properties: + authenticationAlgorithms: + description: Allowed phase two authentication algorithms. + items: + maxLength: 50 + minLength: 1 + type: string + maxItems: 20 + type: array + encryptionAlgorithms: + description: Allowed phase two encryption algorithms. + items: + maxLength: 50 + minLength: 1 + type: string + maxItems: 20 + type: array + pfsDhGroups: + description: Allowed perfect forward secrecy Diffie-Hellman groups. + items: + maxLength: 50 + minLength: 1 + type: string + maxItems: 20 + type: array + type: object + DefaultPhaseOneParameters: + description: Default phase one parameters. + properties: + defaultAuthenticationAlgorithms: + description: Default phase one authentication algorithms. + items: + maxLength: 50 + minLength: 1 + type: string + maxItems: 20 + type: array + defaultDhGroups: + description: Default phase one Diffie-Hellman groups. + items: + maxLength: 50 + minLength: 1 + type: string + maxItems: 20 + type: array + defaultEncryptionAlgorithms: + description: Default phase one encryption algorithms. + items: + maxLength: 50 + minLength: 1 + type: string + maxItems: 20 + type: array + type: object + DefaultPhaseTwoParameters: + description: Default phase two parameters. + properties: + defaultAuthenticationAlgorithms: + description: Default phase two authentication algorithms. + items: + maxLength: 50 + minLength: 1 + type: string + maxItems: 20 + type: array + defaultEncryptionAlgorithms: + description: Default phase two encryption algorithms. + items: + maxLength: 50 + minLength: 1 + type: string + maxItems: 20 + type: array + defaultPfsDhGroup: + description: Default perfect forward secrecy Diffie-Hellman groups. + maxLength: 20 + minLength: 1 + type: string + type: object + CreateIPSecConnectionTunnelDetails: + properties: + associatedVirtualCircuits: + description: | + The list of virtual circuit [OCID](/iaas/Content/General/Concepts/identifiers.htm)s over which your network can reach this tunnel. + items: + maxLength: 255 + minLength: 1 + type: string + type: array + uniqueItems: true + bgpSessionConfig: + $ref: '#/components/schemas/CreateIPSecTunnelBgpSessionDetails' + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + dpdConfig: + $ref: '#/components/schemas/DpdConfig' + drgRouteTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table assigned to this attachment. + + The DRG route table manages traffic inside the DRG. + maxLength: 255 + minLength: 1 + type: string + encryptionDomainConfig: + $ref: '#/components/schemas/CreateIPSecTunnelEncryptionDomainDetails' + natTranslationEnabled: + description: | + By default (the `AUTO` setting), IKE sends packets with a source and destination port set to 500, + and when it detects that the port used to forward packets has changed (most likely because a NAT device + is between the CPE device and the Oracle VPN headend) it will try to negotiate the use of NAT-T. + + The `ENABLED` option sets the IKE protocol to use port 4500 instead of 500 and forces encapsulating traffic with the ESP protocol inside UDP packets. + + The `DISABLED` option directs IKE to completely refuse to negotiate NAT-T + even if it senses there may be a NAT device in use. + enum: + - ENABLED + - DISABLED + - AUTO + type: string + oracleInitiation: + description: | + Indicates whether the Oracle end of the IPSec connection is able to initiate starting up the IPSec tunnel. + enum: + - INITIATOR_OR_RESPONDER + - RESPONDER_ONLY + type: string + oracleTunnelIp: + description: | + The headend IP that you can choose on the Oracle side to terminate your private IPSec tunnel. + maxLength: 32 + minLength: 1 + type: string + phaseOneConfig: + $ref: '#/components/schemas/PhaseOneConfigDetails' + phaseTwoConfig: + $ref: '#/components/schemas/PhaseTwoConfigDetails' + routing: + description: | + The type of routing to use for this tunnel (BGP dynamic routing, static routing, or policy-based routing). + enum: + - BGP + - STATIC + - POLICY + type: string + sharedSecret: + description: | + The shared secret (pre-shared key) to use for the IPSec tunnel. Only numbers, letters, and + spaces are allowed. If you don't provide a value, + Oracle generates a value for you. You can specify your own shared secret later if + you like with [UpdateIPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/UpdateIPSecConnectionTunnelSharedSecret). + maxLength: 255 + minLength: 1 + type: string + type: object + TunnelConfig: + description: | + Deprecated. For tunnel information, instead see: + + * [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/) + * [IPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/) + properties: + ipAddress: + description: | + The IP address of Oracle's VPN headend. + + Example: `203.0.113.50 ` + maxLength: 46 + minLength: 1 + type: string + sharedSecret: + description: | + The shared secret of the IPSec tunnel. + maxLength: 255 + minLength: 1 + type: string + timeCreated: + description: | + The date and time the IPSec connection was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - ipAddress + - sharedSecret + type: object + TunnelStatus: + description: | + Deprecated. For tunnel information, instead see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/). + properties: + ipAddress: + description: | + The IP address of Oracle's VPN headend. + + Example: `203.0.113.50` + maxLength: 46 + minLength: 1 + type: string + lifecycleState: + description: The tunnel's current state. + enum: + - UP + - DOWN + - DOWN_FOR_MAINTENANCE + - PARTIAL_UP + type: string + timeCreated: + description: | + The date and time the IPSec connection was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + timeStateModified: + description: | + When the state of the tunnel last changed, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + required: + - ipAddress + type: object + BgpSessionInfo: + description: Information for establishing a BGP session for the IPSec tunnel. + properties: + bgpIpv6State: + description: | + The state of the BGP IPv6 session. + enum: + - UP + - DOWN + type: string + bgpState: + description: | + The state of the BGP session. + enum: + - UP + - DOWN + type: string + customerBgpAsn: + description: | + If the tunnel's `routing` attribute is set to `BGP` + (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this ASN + is required and used for the tunnel's BGP session. This is the ASN of the network on the + CPE end of the BGP session. Can be a 2-byte or 4-byte ASN. Uses "asplain" format. + + If the tunnel uses static routing, the `customerBgpAsn` must be null. + + Example: `12345` (2-byte) or `1587232876` (4-byte) + maxLength: 10 + minLength: 1 + type: string + customerInterfaceIp: + description: | + The IP address for the CPE end of the inside tunnel interface. + + If the tunnel's `routing` attribute is set to `BGP` + (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this IP address + is required and used for the tunnel's BGP session. + + If `routing` is instead set to `STATIC`, this IP address is optional. You can set this IP + address so you can troubleshoot or monitor the tunnel. + + The value must be a /30 or /31. + + Example: `10.0.0.5/31` + maxLength: 18 + type: string + customerInterfaceIpv6: + description: | + The IPv6 address for the CPE end of the inside tunnel interface. This IP address is optional. + + If the tunnel's `routing` attribute is set to `BGP` + (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this IP address + is used for the tunnel's BGP session. + + If `routing` is instead set to `STATIC`, you can set this IP + address to troubleshoot or monitor the tunnel. + + Only subnet masks from /64 up to /127 are allowed. + + Example: `2001:db8::1/64` + maxLength: 50 + type: string + oracleBgpAsn: + description: | + The Oracle BGP ASN. + maxLength: 10 + minLength: 1 + type: string + oracleInterfaceIp: + description: | + The IP address for the Oracle end of the inside tunnel interface. + + If the tunnel's `routing` attribute is set to `BGP` + (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this IP address + is required and used for the tunnel's BGP session. + + If `routing` is instead set to `STATIC`, this IP address is optional. You can set this IP + address so you can troubleshoot or monitor the tunnel. + + The value must be a /30 or /31. + + Example: `10.0.0.4/31` + maxLength: 18 + type: string + oracleInterfaceIpv6: + description: | + The IPv6 address for the Oracle end of the inside tunnel interface. This IP address is optional. + + If the tunnel's `routing` attribute is set to `BGP` + (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this IP address + is used for the tunnel's BGP session. + + If `routing` is instead set to `STATIC`, you can set this IP + address to troubleshoot or monitor the tunnel. + + Only subnet masks from /64 up to /127 are allowed. + + Example: `2001:db8::1/64` + maxLength: 50 + type: string + type: object + EncryptionDomainConfig: + description: Configuration information used by the encryption domain policy. + properties: + cpeTrafficSelector: + description: Lists IPv4 or IPv6-enabled subnets in your on-premises network. + items: + type: string + type: array + uniqueItems: true + oracleTrafficSelector: + description: Lists IPv4 or IPv6-enabled subnets in your Oracle tenancy. + items: + type: string + type: array + uniqueItems: true + type: object + TunnelPhaseOneDetails: + description: IPSec tunnel details specific to ISAKMP phase one. + properties: + customAuthenticationAlgorithm: + description: The proposed custom authentication algorithm. + maxLength: 255 + minLength: 1 + type: string + customDhGroup: + description: The proposed custom Diffie-Hellman group. + maxLength: 255 + minLength: 1 + type: string + customEncryptionAlgorithm: + description: The proposed custom encryption algorithm. + maxLength: 255 + minLength: 1 + type: string + isCustomPhaseOneConfig: + description: | + Indicates whether custom phase one configuration is enabled. + If this option is not enabled, default settings are proposed. + type: boolean + isIkeEstablished: + description: Indicates whether IKE phase one is established. + type: boolean + lifetime: + description: The total configured lifetime of the IKE security association. + format: int64 + type: integer + negotiatedAuthenticationAlgorithm: + description: The negotiated authentication algorithm. + maxLength: 255 + minLength: 1 + type: string + negotiatedDhGroup: + description: The negotiated Diffie-Hellman group. + maxLength: 255 + minLength: 1 + type: string + negotiatedEncryptionAlgorithm: + description: The negotiated encryption algorithm. + maxLength: 255 + minLength: 1 + type: string + remainingLifetime: + description: The remaining lifetime before the key is refreshed. + format: int64 + type: integer + remainingLifetimeLastRetrieved: + description: | + The date and time we retrieved the remaining lifetime, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + type: object + TunnelPhaseTwoDetails: + description: IPsec tunnel detail information specific to phase two. + properties: + customAuthenticationAlgorithm: + description: | + Phase two authentication algorithm proposed during tunnel negotiation. + maxLength: 255 + minLength: 1 + type: string + customEncryptionAlgorithm: + description: | + The proposed custom phase two encryption algorithm. + maxLength: 255 + minLength: 1 + type: string + dhGroup: + description: | + The proposed Diffie-Hellman group. + maxLength: 255 + minLength: 1 + type: string + isCustomPhaseTwoConfig: + description: | + Indicates whether custom phase two configuration is enabled. + If this option is not enabled, default settings are proposed. + type: boolean + isEspEstablished: + description: Indicates that ESP phase two is established. + type: boolean + isPfsEnabled: + description: Indicates that PFS (perfect forward secrecy) is enabled. + type: boolean + lifetime: + description: The total configured lifetime of the IKE security association. + format: int64 + type: integer + negotiatedAuthenticationAlgorithm: + description: The negotiated phase two authentication algorithm. + maxLength: 255 + minLength: 1 + type: string + negotiatedDhGroup: + description: The negotiated Diffie-Hellman group. + maxLength: 255 + minLength: 1 + type: string + negotiatedEncryptionAlgorithm: + description: The negotiated encryption algorithm. + maxLength: 255 + minLength: 1 + type: string + remainingLifetime: + description: The remaining lifetime before the key is refreshed. + format: int64 + type: integer + remainingLifetimeLastRetrieved: + description: | + The date and time the remaining lifetime was last retrieved, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + type: object + UpdateIPSecTunnelBgpSessionDetails: + properties: + customerBgpAsn: + description: | + The BGP ASN of the network on the CPE end of the BGP session. Can be a 2-byte or 4-byte ASN. + Uses "asplain" format. + + If you are switching the tunnel from using BGP dynamic routing to static routing, the + `customerBgpAsn` must be null. + + Example: `12345` (2-byte) or `1587232876` (4-byte) + maxLength: 10 + minLength: 1 + type: string + customerInterfaceIp: + description: | + The IP address for the CPE end of the inside tunnel interface. + + If the tunnel's `routing` attribute is set to `BGP` + (see [UpdateIPSecConnectionTunnelDetails](#/en/iaas/latest/datatypes/UpdateIPSecConnectionTunnelDetails)), this IP address + is used for the tunnel's BGP session. + + If `routing` is instead set to `STATIC`, you can set this IP address to troubleshoot or + monitor the tunnel. + + The value must be a /30 or /31. + + If you are switching the tunnel from using BGP dynamic routing to static routing and want + to remove the value for `customerInterfaceIp`, you can set the value to an empty string. + + Example: `10.0.0.5/31` + maxLength: 18 + type: string + customerInterfaceIpv6: + description: | + The IPv6 address for the CPE end of the inside tunnel interface. This IP address is optional. + + If the tunnel's `routing` attribute is set to `BGP` + (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this IP address + is used for the tunnel's BGP session. + + If `routing` is instead set to `STATIC`, you can set this IP + address to troubleshoot or monitor the tunnel. + + Only subnet masks from /64 up to /127 are allowed. + + Example: `2001:db8::1/64` + maxLength: 50 + type: string + oracleInterfaceIp: + description: | + The IP address for the Oracle end of the inside tunnel interface. + + If the tunnel's `routing` attribute is set to `BGP` + (see [UpdateIPSecConnectionTunnelDetails](#/en/iaas/latest/datatypes/UpdateIPSecConnectionTunnelDetails)), this IP address + is used for the tunnel's BGP session. + + If `routing` is instead set to `STATIC`, you can set this IP address to troubleshoot or + monitor the tunnel. + + The value must be a /30 or /31. + + If you are switching the tunnel from using BGP dynamic routing to static routing and want + to remove the value for `oracleInterfaceIp`, you can set the value to an empty string. + + Example: `10.0.0.4/31` + maxLength: 18 + type: string + oracleInterfaceIpv6: + description: | + The IPv6 address for the Oracle end of the inside tunnel interface. This IP address is optional. + + If the tunnel's `routing` attribute is set to `BGP` + (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this IP address + is used for the tunnel's BGP session. + + If `routing` is instead set to `STATIC`, you can set this IP + address to troubleshoot or monitor the tunnel. + + Only subnet masks from /64 up to /127 are allowed. + + Example: `2001:db8::1/64` + maxLength: 50 + type: string + type: object + DpdConfig: + description: | + These configuration details are used for dead peer detection (DPD). DPD periodically checks the stability of the connection to the customer premises (CPE), and may be used to detect that the link to the CPE has gone down. + properties: + dpdMode: + description: | + This option defines whether DPD can be initiated from the Oracle side of the connection. + enum: + - INITIATE_AND_RESPOND + - RESPOND_ONLY + type: string + dpdTimeoutInSec: + description: | + DPD timeout in seconds. This sets the longest interval between CPE device health messages before the IPSec connection indicates it has lost contact with the CPE. The default is 20 seconds. + type: integer + type: object + UpdateIPSecTunnelEncryptionDomainDetails: + description: | + Request to update a multi-encryption domain policy on the IPSec tunnel. + There can't be more than 50 security associations in use at one time. See [Encryption domain for policy-based + tunnels](/iaas/Content/Network/Tasks/ipsecencryptiondomains.htm#spi_policy_based_tunnel) for more. + properties: + cpeTrafficSelector: + description: Lists IPv4 or IPv6-enabled subnets in your on-premises network. + items: + type: string + minLength: 1 + type: array + uniqueItems: true + oracleTrafficSelector: + description: Lists IPv4 or IPv6-enabled subnets in your Oracle tenancy. + items: + type: string + minLength: 1 + type: array + uniqueItems: true + type: object + PhaseOneConfigDetails: + description: Configuration details for IKE phase one (ISAKMP) configuration parameters. + properties: + authenticationAlgorithm: + description: | + The custom authentication algorithm proposed during phase one tunnel negotiation. + enum: + - SHA2_384 + - SHA2_256 + - SHA1_96 + type: string + diffieHelmanGroup: + description: | + The custom Diffie-Hellman group proposed during phase one tunnel negotiation. + enum: + - GROUP2 + - GROUP5 + - GROUP14 + - GROUP19 + - GROUP20 + - GROUP24 + type: string + encryptionAlgorithm: + description: | + The custom encryption algorithm proposed during phase one tunnel negotiation. + enum: + - AES_256_CBC + - AES_192_CBC + - AES_128_CBC + type: string + isCustomPhaseOneConfig: + description: Indicates whether custom configuration is enabled for phase one options. + type: boolean + lifetimeInSeconds: + description: | + Internet key association (IKE) session key lifetime in seconds for IPSec phase one. The default is 28800 which is equivalent to 8 hours. + type: integer + type: object + PhaseTwoConfigDetails: + description: Configuration details for IPSec phase two configuration parameters. + properties: + authenticationAlgorithm: + description: | + The authentication algorithm proposed during phase two tunnel negotiation. + enum: + - HMAC_SHA2_256_128 + - HMAC_SHA1_128 + type: string + encryptionAlgorithm: + description: | + The encryption algorithm proposed during phase two tunnel negotiation. + enum: + - AES_256_GCM + - AES_192_GCM + - AES_128_GCM + - AES_256_CBC + - AES_192_CBC + - AES_128_CBC + type: string + isCustomPhaseTwoConfig: + description: Indicates whether custom configuration is enabled for phase two options. + type: boolean + isPfsEnabled: + description: Indicates whether perfect forward secrecy (PFS) is enabled. + type: boolean + lifetimeInSeconds: + description: | + Lifetime in seconds for the IPSec session key set in phase two. The default is 3600 which is equivalent to 1 hour. + type: integer + pfsDhGroup: + description: The Diffie-Hellman group used for PFS, if PFS is enabled. + enum: + - GROUP2 + - GROUP5 + - GROUP14 + - GROUP19 + - GROUP20 + - GROUP24 + type: string + type: object + CpeDeviceConfigAnswer: + description: | + An individual answer to a CPE device question. + + The answers correlate to the questions that are specific to the CPE device type (see the + `parameters` attribute of [CpeDeviceShapeDetail](#/en/iaas/latest/CpeDeviceShapeDetail/)). + properties: + key: + description: | + A string that identifies the question to be answered. See the `key` attribute in + [CpeDeviceConfigQuestion](#/en/iaas/latest/datatypes/CpeDeviceConfigQuestion). + maxLength: 255 + minLength: 1 + type: string + value: + description: The answer to the question. + type: string + type: object + BulkCreateIpv6sItem: + description: Secondary IPv6 object to use as part of bulk IPv6 object creation. + properties: + cidrPrefixLength: + default: 128 + description: Length of the CIDR range. Optional field to specify a flexible CIDR. + maximum: 128 + minimum: 80 + type: integer + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + ipAddress: + description: | + An IPv6 address of your choice. Must be an available IP address within + the subnet's CIDR. If you don't specify a value, Oracle automatically + assigns an IPv6 address from the subnet. The subnet is the one that + contains the VNIC you specify in `vnicId`. + + Example: `2001:DB8::` + maxLength: 45 + minLength: 1 + type: string + ipv6SubnetCidr: + description: | + The IPv6 prefix allocated to the subnet. This is required if more than one IPv6 prefix exists on the subnet. + maxLength: 45 + minLength: 1 + type: string + x-default-description: 'null' + isInternetAccessAllowed: + default: true + description: | + Whether the IPv6 can be used for internet communication. Allowed by default for an IPv6 in + a public subnet. Never allowed for an IPv6 in a private subnet. If the value is `true`, the + IPv6 uses its public IP address for internet communication. + + If `isInternetAccessAllowed` is set to `false`, the resulting `publicIpAddress` attribute + for the `Ipv6` is null. + + Example: `true` + type: boolean + lifetime: + default: EPHEMERAL + description: | + Lifetime of the IP address. + There are two types of IPs: + - Ephemeral + - Reserved + enum: + - EPHEMERAL + - RESERVED + type: string + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see + [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). + maxLength: 255 + minLength: 0 + type: string + type: object + BulkDeleteIpv6sItem: + description: A secondary IPv6 object to delete as part of a bulk deletion. + properties: + ipv6Id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6 to delete. + maxLength: 255 + minLength: 1 + type: string + required: + - ipv6Id + type: object + BulkDetachIpv6sItem: + description: A secondary IPv6 object to detach as part of a bulk detach operation. + properties: + ipv6Id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the secondary IPv6. + maxLength: 255 + minLength: 1 + type: string + required: + - ipv6Id + type: object + BulkUpdateIpv6sItem: + description: A secondary IPv6 object to update as part of a bulk update. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + ipv6Id: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6 object. + maxLength: 255 + minLength: 1 + type: string + isInternetAccessAllowed: + default: true + description: | + Whether the IPv6 can be used for internet communication. Allowed by default for an IPv6 in + a public subnet. Never allowed for an IPv6 in a private subnet. If the value is `true`, the + IPv6 uses its public IP address for internet communication. + + If `isInternetAccessAllowed` is set to `false`, the resulting `publicIpAddress` attribute + for the `Ipv6` is null. + + Example: `true` + type: boolean + lifetime: + default: EPHEMERAL + description: | + Lifetime of the IP address. + There are two types of IPs: + - Ephemeral + - Reserved + enum: + - EPHEMERAL + - RESERVED + type: string + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see + [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). + maxLength: 255 + minLength: 0 + type: string + required: + - ipv6Id + type: object + AddSecurityRuleDetails: + description: A rule for allowing inbound (INGRESS) or outbound (EGRESS) IP packets. + properties: + description: + description: | + An optional description of your choice for the rule. Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + destination: + description: | + Conceptually, this is the range of IP addresses that a packet originating from the instance + can go to. + + Allowed values: + + * An IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56` + IPv6 addressing is supported for all commercial and government regions. See + [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + + * The `cidrBlock` value for a [Service](#/en/iaas/latest/Service/), if you're + setting up a security rule for traffic destined for a particular `Service` through + a service gateway. For example: `oci-phx-objectstorage`. + + * The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/) in the same + VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control + traffic between VNICs in the same NSG. + type: string + destinationType: + description: | + Type of destination for the rule. Required if `direction` = `EGRESS`. + + Allowed values: + + * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation. + + * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a + [Service](#/en/iaas/latest/Service/) (the rule is for traffic destined for a + particular `Service` through a service gateway). + + * `NETWORK_SECURITY_GROUP`: If the rule's `destination` is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a + [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/). + enum: + - CIDR_BLOCK + - SERVICE_CIDR_BLOCK + - NETWORK_SECURITY_GROUP + type: string + direction: + description: | + Direction of the security rule. Set to `EGRESS` for rules to allow outbound IP packets, + or `INGRESS` for rules to allow inbound IP packets. + enum: + - EGRESS + - INGRESS + type: string + icmpOptions: + $ref: '#/components/schemas/IcmpOptions' + isStateless: + description: | + A stateless rule allows traffic in one direction. Remember to add a corresponding + stateless rule in the other direction if you need to support bidirectional traffic. For + example, if egress traffic allows TCP destination port 80, there should be an ingress + rule to allow TCP source port 80. Defaults to false, which means the rule is stateful + and a corresponding rule is not necessary for bidirectional traffic. + type: boolean + protocol: + description: | + The transport protocol. Specify either `all` or an IPv4 protocol number as + defined in + [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). + Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58"). + type: string + source: + description: | + Conceptually, this is the range of IP addresses that a packet coming into the instance + can come from. + + Allowed values: + + * An IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56` + IPv6 addressing is supported for all commercial and government regions. See + [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + + * The `cidrBlock` value for a [Service](#/en/iaas/latest/Service/), if you're + setting up a security rule for traffic coming from a particular `Service` through + a service gateway. For example: `oci-phx-objectstorage`. + + * The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/) in the same + VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control + traffic between VNICs in the same NSG. + type: string + sourceType: + description: | + Type of source for the rule. Required if `direction` = `INGRESS`. + + * `CIDR_BLOCK`: If the rule's `source` is an IP address range in CIDR notation. + + * `SERVICE_CIDR_BLOCK`: If the rule's `source` is the `cidrBlock` value for a + [Service](#/en/iaas/latest/Service/) (the rule is for traffic coming from a + particular `Service` through a service gateway). + + * `NETWORK_SECURITY_GROUP`: If the rule's `source` is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a + [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/). + enum: + - CIDR_BLOCK + - SERVICE_CIDR_BLOCK + - NETWORK_SECURITY_GROUP + type: string + tcpOptions: + $ref: '#/components/schemas/TcpOptions' + udpOptions: + $ref: '#/components/schemas/UdpOptions' + required: + - direction + - protocol + type: object + UpdateSecurityRuleDetails: + description: | + A rule for allowing inbound (`direction`= INGRESS) or outbound (`direction`= EGRESS) IP packets. + properties: + description: + description: | + An optional description of your choice for the rule. Avoid entering confidential information. + maxLength: 255 + minLength: 1 + type: string + destination: + description: | + Conceptually, this is the range of IP addresses that a packet originating from the instance + can go to. + + Allowed values: + + * An IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56` + IPv6 addressing is supported for all commercial and government regions. See + [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + + * The `cidrBlock` value for a [Service](#/en/iaas/latest/Service/), if you're + setting up a security rule for traffic destined for a particular `Service` through + a service gateway. For example: `oci-phx-objectstorage`. + + * The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/) in the same + VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control + traffic between VNICs in the same NSG. + type: string + destinationType: + description: | + Type of destination for the rule. Required if `direction` = `EGRESS`. + + Allowed values: + + * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation. + + * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a + [Service](#/en/iaas/latest/Service/) (the rule is for traffic destined for a + particular `Service` through a service gateway). + + * `NETWORK_SECURITY_GROUP`: If the rule's `destination` is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a + [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/). + enum: + - CIDR_BLOCK + - SERVICE_CIDR_BLOCK + - NETWORK_SECURITY_GROUP + type: string + direction: + description: | + Direction of the security rule. Set to `EGRESS` for rules to allow outbound IP packets, + or `INGRESS` for rules to allow inbound IP packets. + enum: + - EGRESS + - INGRESS + type: string + icmpOptions: + $ref: '#/components/schemas/IcmpOptions' + id: + description: | + The Oracle-assigned ID of the security rule that you want to update. You can't change this value. + + Example: `04ABEC` + maxLength: 255 + minLength: 1 + type: string + isStateless: + description: | + A stateless rule allows traffic in one direction. Remember to add a corresponding + stateless rule in the other direction if you need to support bidirectional traffic. For + example, if egress traffic allows TCP destination port 80, there should be an ingress + rule to allow TCP source port 80. Defaults to false, which means the rule is stateful + and a corresponding rule is not necessary for bidirectional traffic. + type: boolean + protocol: + description: | + The transport protocol. Specify either `all` or an IPv4 protocol number as + defined in + [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). + Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58"). + type: string + source: + description: | + Conceptually, this is the range of IP addresses that a packet coming into the instance + can come from. + + Allowed values: + + * An IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56` + IPv6 addressing is supported for all commercial and government regions. See + [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + + * The `cidrBlock` value for a [Service](#/en/iaas/latest/Service/), if you're + setting up a security rule for traffic coming from a particular `Service` through + a service gateway. For example: `oci-phx-objectstorage`. + + * The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/) in the same + VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control + traffic between VNICs in the same NSG. + type: string + sourceType: + description: | + Type of source for the rule. Required if `direction` = `INGRESS`. + + * `CIDR_BLOCK`: If the rule's `source` is an IP address range in CIDR notation. + + * `SERVICE_CIDR_BLOCK`: If the rule's `source` is the `cidrBlock` value for a + [Service](#/en/iaas/latest/Service/) (the rule is for traffic coming from a + particular `Service` through a service gateway). + + * `NETWORK_SECURITY_GROUP`: If the rule's `source` is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a + [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/). + enum: + - CIDR_BLOCK + - SERVICE_CIDR_BLOCK + - NETWORK_SECURITY_GROUP + type: string + tcpOptions: + $ref: '#/components/schemas/TcpOptions' + udpOptions: + $ref: '#/components/schemas/UdpOptions' + required: + - direction + - id + - protocol + type: object + IcmpOptions: + description: | + Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code + as defined in: + - [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) + - [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml) + + If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and + codes are allowed. If you do provide this object, the type is required and the code is optional. + To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 ("Destination + Unreachable") code 4 ("Fragmentation Needed and Don't Fragment was Set"). If you need to specify + multiple codes for a single type, create a separate security list rule for each. + properties: + code: + description: The ICMP code (optional). + maximum: 16 + minimum: 0 + type: integer + type: + description: The ICMP type. + maximum: 254 + minimum: 0 + type: integer + required: + - type + type: object + TcpOptions: + description: | + Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. + If you specify TCP as the protocol but omit this object, then all destination ports are allowed. + properties: + destinationPortRange: + $ref: '#/components/schemas/PortRange' + sourcePortRange: + $ref: '#/components/schemas/PortRange' + type: object + UdpOptions: + description: | + Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. + If you specify UDP as the protocol but omit this object, then all destination ports are allowed. + properties: + destinationPortRange: + $ref: '#/components/schemas/PortRange' + sourcePortRange: + $ref: '#/components/schemas/PortRange' + type: object + Topology: + description: Defines the representation of a virtual network topology. + discriminator: + propertyName: type + properties: + entities: + description: Lists entities comprising the virtual network topology. + items: + type: string + description: (opaque JSON object) + type: array + limitedEntities: + description: | + Lists entities that are limited during ingestion. + The values for the items in the list are the entity type names of the limitedEntities. + Example: `vcn` + items: + type: string + maxItems: 100 + type: array + relationships: + description: Lists relationships between entities in the virtual network topology. + items: + $ref: '#/components/schemas/TopologyEntityRelationship' + type: array + timeCreated: + description: Records when the virtual network topology was created, in [RFC3339](https://tools.ietf.org/html/rfc3339) format for date and time. + format: date-time + type: string + type: + description: Type of the topology object. + enum: + - NETWORKING + - VCN + - SUBNET + - PATH + type: string + required: + - type + - entities + - relationships + - limitedEntities + - timeCreated + type: object + BulkCreatePrivateIpItem: + description: An object used to create secondary private IPv4 addresses in a bulk operation. + properties: + cidrPrefixLength: + default: 32 + description: | + An optional field that when combined with the ipAddress field, will be used to allocate secondary IPv4 CIDRs. + The CIDR range created by this combination must be within the subnet's CIDR + and the CIDR range should not collide with any existing IPv4 address allocation. + The VNIC ID specified in the request object should not already been assigned more than the max IPv4 addresses. + If you don't specify a value, this option will be ignored. + + Example: 18 + maximum: 32 + minimum: 18 + type: integer + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + hostnameLabel: + description: | + The hostname for the private IP. Used for DNS. The value + is the hostname portion of the private IP's fully qualified domain name (FQDN) + (for example, `bminstance1` in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`). + Must be unique across all VNICs in the subnet and comply with + [RFC 952](https://tools.ietf.org/html/rfc952) and + [RFC 1123](https://tools.ietf.org/html/rfc1123). + + For more information, see + [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). + + Example: `bminstance1` + maxLength: 63 + minLength: 1 + type: string + ipAddress: + description: | + A private IP address of your choice. Must be an available IP address within + the subnet's CIDR. If you don't specify a value, Oracle automatically + assigns a private IP address from the subnet. + + Example: `10.0.3.3` + maxLength: 32 + minLength: 1 + type: string + ipv4SubnetCidrAtCreation: + description: | + Any one of the IPv4 CIDRs allocated to the subnet. + maxLength: 32 + minLength: 1 + type: string + lifetime: + default: EPHEMERAL + description: | + Lifetime of the IP address. + There are two types of IPs: + - Ephemeral + - Reserved + enum: + - EPHEMERAL + - RESERVED + type: string + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see + [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). + maxLength: 255 + minLength: 0 + type: string + type: object + BulkDeletePrivateIpItem: + description: Secondary private IPv4 address object to delete as part of a bulk operation. + properties: + privateIpId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the secondary Private IP. + maxLength: 255 + minLength: 1 + type: string + required: + - privateIpId + type: object + BulkDetachPrivateIpItem: + description: An object used to detatch secondary private IPv4 addresses with a bulk operation. + properties: + privateIpId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the secondary Private IP. + maxLength: 255 + minLength: 1 + type: string + required: + - privateIpId + type: object + BulkUpdatePrivateIpItem: + description: A secondary private IPv4 address object to update as part of a bulk operation. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + hostnameLabel: + description: | + The hostname for the private IP. Used for DNS. The value + is the hostname portion of the private IP's fully qualified domain name (FQDN) + (for example, `bminstance1` in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`). + Must be unique across all VNICs in the subnet and comply with + [RFC 952](https://tools.ietf.org/html/rfc952) and + [RFC 1123](https://tools.ietf.org/html/rfc1123). + + For more information, see + [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). + + Example: `bminstance1` + maxLength: 63 + minLength: 1 + type: string + lifetime: + default: EPHEMERAL + description: | + Lifetime of the IP address. + There are two types of IPs: + - Ephemeral + - Reserved + enum: + - EPHEMERAL + - RESERVED + type: string + privateIpId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the secondary Private IP. + maxLength: 255 + minLength: 1 + type: string + routeTableId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see + [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). + maxLength: 255 + minLength: 0 + type: string + required: + - privateIpId + type: object + PublicIpPoolSummary: + description: Summary information about a public IP pool. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the public IP pool. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. + Avoid entering confidential information. + 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The public IP pool's current state. + type: string + x-obmcs-enumref: '#/definitions/PublicIpPool/lifecycleState' + timeCreated: + description: | + The date and time the public IP pool was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). + + Example: `2016-08-25T21:10:29.600Z` + format: date-time + type: string + type: object + RouteRule: + description: | + A mapping between a destination IP address range and a virtual device to route matching + packets to (a target). + properties: + cidrBlock: + description: | + Deprecated. Instead use `destination` and `destinationType`. Requests that include both + `cidrBlock` and `destination` will be rejected. + + A destination IP address range in CIDR notation. Matching packets will + be routed to the indicated network entity (the target). + + Cannot be an IPv6 prefix. + + Example: `0.0.0.0/0` + maxLength: 18 + minLength: 9 + type: string + description: + description: | + An optional description of your choice for the rule. + maxLength: 255 + minLength: 1 + type: string + destination: + description: | + Conceptually, this is the range of IP addresses used for matching when routing + traffic. Required if you provide a `destinationType`. + + Allowed values: + + * IP address range in CIDR notation. Can be an IPv4 CIDR block or IPv6 prefix. For example: `192.168.1.0/24` + or `2001:0db8:0123:45::/56`. If you set this to an IPv6 prefix, the route rule's target + can only be a DRG or internet gateway. + IPv6 addressing is supported for all commercial and government regions. + See [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + + * The `cidrBlock` value for a [Service](#/en/iaas/latest/Service/), if you're + setting up a route rule for traffic destined for a particular `Service` through + a service gateway. For example: `oci-phx-objectstorage`. + maxLength: 255 + minLength: 1 + type: string + destinationType: + default: CIDR_BLOCK + description: | + Type of destination for the rule. Required if you provide a `destination`. + + * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation. + + * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a + [Service](#/en/iaas/latest/Service/) (the rule is for traffic destined for a + particular `Service` through a service gateway). + enum: + - CIDR_BLOCK + - SERVICE_CIDR_BLOCK + type: string + networkEntityId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the route rule's target. For information about the type of + targets you can specify, see + [Route Tables](/iaas/Content/Network/Tasks/managingroutetables.htm). + maxLength: 255 + minLength: 1 + type: string + routeType: + description: | + A route rule can be STATIC if manually added to the route table, LOCAL if added by OCI to the route table. + enum: + - STATIC + - LOCAL + type: string + required: + - networkEntityId + type: object + EgressSecurityRule: + description: A rule for allowing outbound IP packets. + properties: + description: + description: | + An optional description of your choice for the rule. + maxLength: 255 + minLength: 1 + type: string + destination: + description: | + Conceptually, this is the range of IP addresses that a packet originating from the instance + can go to. + + Allowed values: + + * IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56` + Note that IPv6 addressing is currently supported only in certain regions. See + [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + + * The `cidrBlock` value for a [Service](#/en/iaas/latest/Service/), if you're + setting up a security list rule for traffic destined for a particular `Service` through + a service gateway. For example: `oci-phx-objectstorage`. + type: string + destinationType: + default: CIDR_BLOCK + description: | + Type of destination for the rule. The default is `CIDR_BLOCK`. + + Allowed values: + + * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation. + + * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a + [Service](#/en/iaas/latest/Service/) (the rule is for traffic destined for a + particular `Service` through a service gateway). + enum: + - CIDR_BLOCK + - SERVICE_CIDR_BLOCK + type: string + icmpOptions: + $ref: '#/components/schemas/IcmpOptions' + isStateless: + description: | + A stateless rule allows traffic in one direction. Remember to add a corresponding + stateless rule in the other direction if you need to support bidirectional traffic. For + example, if egress traffic allows TCP destination port 80, there should be an ingress + rule to allow TCP source port 80. Defaults to false, which means the rule is stateful + and a corresponding rule is not necessary for bidirectional traffic. + type: boolean + protocol: + description: | + The transport protocol. Specify either `all` or an IPv4 protocol number as + defined in + [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). + Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58"). + type: string + tcpOptions: + $ref: '#/components/schemas/TcpOptions' + udpOptions: + $ref: '#/components/schemas/UdpOptions' + required: + - destination + - protocol + type: object + IngressSecurityRule: + description: A rule for allowing inbound IP packets. + properties: + description: + description: | + An optional description of your choice for the rule. + maxLength: 255 + minLength: 1 + type: string + icmpOptions: + $ref: '#/components/schemas/IcmpOptions' + isStateless: + description: | + A stateless rule allows traffic in one direction. Remember to add a corresponding + stateless rule in the other direction if you need to support bidirectional traffic. For + example, if ingress traffic allows TCP destination port 80, there should be an egress + rule to allow TCP source port 80. Defaults to false, which means the rule is stateful + and a corresponding rule is not necessary for bidirectional traffic. + type: boolean + protocol: + description: | + The transport protocol. Specify either `all` or an IPv4 protocol number as + defined in + [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). + Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58"). + type: string + source: + description: | + Conceptually, this is the range of IP addresses that a packet coming into the instance + can come from. + + Allowed values: + + * IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`. + IPv6 addressing is supported for all commercial and government regions. See + [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + + * The `cidrBlock` value for a [Service](#/en/iaas/latest/Service/), if you're + setting up a security list rule for traffic coming from a particular `Service` through + a service gateway. For example: `oci-phx-objectstorage`. + type: string + sourceType: + default: CIDR_BLOCK + description: | + Type of source for the rule. The default is `CIDR_BLOCK`. + + * `CIDR_BLOCK`: If the rule's `source` is an IP address range in CIDR notation. + + * `SERVICE_CIDR_BLOCK`: If the rule's `source` is the `cidrBlock` value for a + [Service](#/en/iaas/latest/Service/) (the rule is for traffic coming from a + particular `Service` through a service gateway). + enum: + - CIDR_BLOCK + - SERVICE_CIDR_BLOCK + type: string + tcpOptions: + $ref: '#/components/schemas/TcpOptions' + udpOptions: + $ref: '#/components/schemas/UdpOptions' + required: + - protocol + - source + type: object + ServiceIdResponseDetails: + properties: + serviceId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the service. + maxLength: 255 + minLength: 1 + type: string + serviceName: + description: The name of the service. + maxLength: 255 + minLength: 1 + type: string + required: + - serviceId + - serviceName + type: object + Byoipv6CidrDetails: + description: | + The list of one or more BYOIPv6 prefixes for the VCN that meets the following criteria: + - The prefix must be from a BYOIPv6 range. + - The IPv6 prefixes must be valid. + - Multiple prefix must not overlap each other or the on-premises network prefix. + - The number of prefixes must not exceed the limit of IPv6 prefixes allowed to a VCN. + properties: + byoipv6RangeId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource to which the CIDR block belongs. + maxLength: 255 + minLength: 1 + type: string + ipv6CidrBlock: + description: | + An IPv6 prefix required to create a VCN with a BYOIP prefix. It could be the whole prefix identified in `byoipv6RangeId`, or a subrange. + Example: `2001:0db8:0123::/48` + maxLength: 45 + minLength: 1 + type: string + required: + - byoipv6RangeId + - ipv6CidrBlock + type: object + CrossConnectMapping: + description: | + For use with Oracle Cloud Infrastructure FastConnect. Each + [VirtualCircuit](#/en/iaas/latest/VirtualCircuit/) runs on one or + more cross-connects or cross-connect groups. A `CrossConnectMapping` + contains the properties for an individual cross-connect or cross-connect group + associated with a given virtual circuit. + + The mapping includes information about the cross-connect or + cross-connect group, the VLAN, and the BGP peering session. + + If you're a customer who is colocated with Oracle, that means you own both + the virtual circuit and the physical connection it runs on (cross-connect or + cross-connect group), so you specify all the information in the mapping. There's + one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 + addresses. + + If you're a provider, then you own the physical connection that the customer's + virtual circuit runs on, so you contribute information about the cross-connect + or cross-connect group and VLAN. + + Who specifies the BGP peering information in the case of customer connection via + provider? If the BGP session goes from Oracle to the provider's edge router, then + the provider also specifies the BGP peering information. If the BGP session instead + goes from Oracle to the customer's edge router, then the customer specifies the BGP + peering information. There's one exception: for a public virtual circuit, Oracle + specifies the BGP IPv4 addresses. + + Every `CrossConnectMapping` must have BGP IPv4 peering addresses. BGP IPv6 peering + addresses are optional. If BGP IPv6 addresses are provided, the customer can + exchange IPv6 routes with Oracle. + properties: + bgpMd5AuthKey: + description: | + The key for BGP MD5 authentication. Only applicable if your system + requires MD5 authentication. If empty or not set (null), that + means you don't use BGP MD5 authentication. + maxLength: 255 + minLength: 1 + type: string + crossConnectOrCrossConnectGroupId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect or cross-connect group for this mapping. + Specified by the owner of the cross-connect or cross-connect group (the + customer if the customer is colocated with Oracle, or the provider if the + customer is connecting via provider). + maxLength: 255 + minLength: 1 + type: string + customerBgpPeeringIp: + description: | + The BGP IPv4 address for the router on the other end of the BGP session from + Oracle. Specified by the owner of that router. If the session goes from Oracle + to a customer, this is the BGP IPv4 address of the customer's edge router. If the + session goes from Oracle to a provider, this is the BGP IPv4 address of the + provider's edge router. Must use a subnet mask from /28 to /31. + + There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses. + + Example: `10.0.0.18/31` + maxLength: 46 + minLength: 7 + type: string + customerBgpPeeringIpv6: + description: | + The BGP IPv6 address for the router on the other end of the BGP session from + Oracle. Specified by the owner of that router. If the session goes from Oracle + to a customer, this is the BGP IPv6 address of the customer's edge router. If the + session goes from Oracle to a provider, this is the BGP IPv6 address of the + provider's edge router. Only subnet masks from /64 up to /127 are allowed. + + There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses. + + IPv6 addressing is supported for all commercial and government regions. See + [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + + Example: `2001:db8::1/64` + maxLength: 50 + minLength: 4 + type: string + oracleBgpPeeringIp: + description: | + The IPv4 address for Oracle's end of the BGP session. Must use a subnet mask from /28 to /31. + If the session goes from Oracle to a customer's edge router, + the customer specifies this information. If the session goes from Oracle to + a provider's edge router, the provider specifies this. + + There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses. + + Example: `10.0.0.19/31` + maxLength: 46 + minLength: 7 + type: string + oracleBgpPeeringIpv6: + description: | + The IPv6 address for Oracle's end of the BGP session. Only subnet masks from /64 up to /127 are allowed. + If the session goes from Oracle to a customer's edge router, + the customer specifies this information. If the session goes from Oracle to + a provider's edge router, the provider specifies this. + + There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses. + + Note that IPv6 addressing is currently supported only in certain regions. See + [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). + + Example: `2001:db8::2/64` + maxLength: 50 + minLength: 4 + type: string + vlan: + description: | + The number of the specific VLAN (on the cross-connect or cross-connect group) + that is assigned to this virtual circuit. Specified by the owner of the cross-connect + or cross-connect group (the customer if the customer is colocated with Oracle, or + the provider if the customer is connecting via provider). + + Example: `200` + maximum: 16777216 + minimum: 100 + type: integer + type: object + VirtualCircuitRedundancyMetadata: + description: | + This resource provides redundancy level details for the virtual circuit. For more about redundancy, see [FastConnect Redundancy Best Practices](/iaas/Content/Network/Concepts/fastconnectresiliency.htm). + properties: + configuredRedundancyLevel: + description: The configured redundancy level of the virtual circuit. + enum: + - DEVICE + - POP + - REGION + - NON_REDUNDANT + - PENDING + type: string + ipv4bgpSessionRedundancyStatus: + description: | + Indicates if the configured level is met for IPv4 BGP redundancy. + enum: + - CONFIGURATION_MATCH + - CONFIGURATION_MISMATCH + - NOT_MET_SLA + type: string + ipv6bgpSessionRedundancyStatus: + description: | + Indicates if the configured level is met for IPv6 BGP redundancy. + enum: + - CONFIGURATION_MATCH + - CONFIGURATION_MISMATCH + - NOT_MET_SLA + type: string + type: object + CreateVirtualCircuitPublicPrefixDetails: + properties: + cidrBlock: + description: | + An individual public IP prefix (CIDR) to add to the public virtual circuit. + All prefix sizes are allowed. + maxLength: 50 + minLength: 4 + type: string + required: + - cidrBlock + type: object + DeleteVirtualCircuitPublicPrefixDetails: + properties: + cidrBlock: + description: | + An individual public IP prefix (CIDR) to remove from the public virtual circuit. + maxLength: 50 + minLength: 4 + type: string + required: + - cidrBlock + type: object + CrossConnectMappingDetails: + description: | + For use with Oracle Cloud Infrastructure FastConnect. Each + [VirtualCircuit](#/en/iaas/latest/VirtualCircuit/) runs on one or + more cross-connects or cross-connect groups. A `CrossConnectMappingDetails` + contains the properties for an individual cross-connect or cross-connect group + associated with a given virtual circuit. + + The details includes information about the cross-connect or + cross-connect group, the VLAN, and the BGP peering session. + properties: + bgpMd5AuthKey: + description: | + The key for BGP MD5 authentication. Only applicable if your system + requires MD5 authentication. If empty or not set (null), that + means you don't use BGP MD5 authentication. + maxLength: 255 + minLength: 1 + type: string + crossConnectOrCrossConnectGroupId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect or cross-connect group for this mapping. + Specified by the owner of the cross-connect or cross-connect group (the + customer if the customer is colocated with Oracle, or the provider if the + customer is connecting via provider). + maxLength: 255 + minLength: 1 + type: string + customerBgpPeeringIp: + description: | + The BGP IPv4 address for the router on the other end of the BGP session from + Oracle. Specified by the owner of that router. If the session goes from Oracle + to a customer, this is the BGP IPv4 address of the customer's edge router. If the + session goes from Oracle to a provider, this is the BGP IPv4 address of the + provider's edge router. Must use a subnet mask from /28 to /31. + + There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses. + + Example: `10.0.0.18/31` + maxLength: 46 + minLength: 7 + type: string + customerBgpPeeringIpv6: + description: | + The BGP IPv6 address for the router on the other end of the BGP session from + Oracle. Specified by the owner of that router. If the session goes from Oracle + to a customer, this is the BGP IPv6 address of the customer's edge router. If the + session goes from Oracle to a provider, this is the BGP IPv6 address of the + provider's edge router. Only subnet masks from /64 up to /127 are allowed. + + There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses. + + Example: `2001:db8::1/64` + maxLength: 50 + minLength: 4 + type: string + ipv4BgpStatus: + description: The state of the Ipv4 BGP session. + enum: + - UP + - DOWN + type: string + ipv6BgpStatus: + description: The state of the Ipv6 BGP session. + enum: + - UP + - DOWN + type: string + ociLogicalDeviceName: + description: | + The FastConnect device that terminates the logical connection. + maxLength: 255 + minLength: 1 + type: string + oracleBgpPeeringIp: + description: | + The IPv4 address for Oracle's end of the BGP session. Must use a subnet mask from /28 to /31. + If the session goes from Oracle to a customer's edge router, + the customer specifies this information. If the session goes from Oracle to + a provider's edge router, the provider specifies this. + + There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses. + + Example: `10.0.0.19/31` + maxLength: 46 + minLength: 7 + type: string + oracleBgpPeeringIpv6: + description: | + The IPv6 address for Oracle's end of the BGP session. Only subnet masks from /64 up to /127 are allowed. + If the session goes from Oracle to a customer's edge router, + the customer specifies this information. If the session goes from Oracle to + a provider's edge router, the provider specifies this. + + There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses. + + Example: `2001:db8::2/64` + maxLength: 50 + minLength: 4 + type: string + vlan: + description: | + The number of the specific VLAN (on the cross-connect or cross-connect group) + that is assigned to this virtual circuit. Specified by the owner of the cross-connect + or cross-connect group (the customer if the customer is colocated with Oracle, or + the provider if the customer is connecting via provider). + + Example: `200` + maximum: 16777216 + minimum: 100 + type: integer + type: object + MacsecKey: + description: An object defining the Secrets-in-Vault OCIDs representing the MACsec key. + properties: + connectivityAssociationKeySecretId: + description: Secret [OCID](/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key. + maxLength: 255 + minLength: 1 + type: string + connectivityAssociationKeySecretVersion: + description: The secret version of the `connectivityAssociationKey` secret in Vault. + format: int64 + maximum: 65535 + minimum: 1 + type: integer + connectivityAssociationNameSecretId: + description: Secret [OCID](/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity association Key Name (CKN) of this MACsec key. + maxLength: 255 + minLength: 1 + type: string + connectivityAssociationNameSecretVersion: + description: The secret version of the connectivity association name secret in Vault. + format: int64 + maximum: 65535 + minimum: 1 + type: integer + required: + - connectivityAssociationNameSecretId + - connectivityAssociationKeySecretId + type: object + CreateMacsecKey: + description: Defines the secret [OCID](/iaas/Content/General/Concepts/identifiers.htm)s held in Vault that represent the MACsec key. + properties: + connectivityAssociationKeySecretId: + description: | + Secret [OCID](/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key. + + NOTE: Only the latest secret version will be used. + maxLength: 255 + minLength: 1 + type: string + connectivityAssociationNameSecretId: + description: | + Secret [OCID](/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity association Key Name (CKN) of this MACsec key. + + NOTE: Only the latest secret version will be used. + maxLength: 255 + minLength: 1 + type: string + required: + - connectivityAssociationNameSecretId + - connectivityAssociationKeySecretId + type: object + UpdateMacsecKey: + description: An object defining the OCID of the Secret held in Vault that represent the MACsec key. + properties: + connectivityAssociationKeySecretId: + description: | + Secret [OCID](/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key. + maxLength: 255 + minLength: 1 + type: string + connectivityAssociationKeySecretVersion: + description: The secret version of the connectivityAssociationKey secret in Vault. + format: int64 + maximum: 65535 + minimum: 1 + type: integer + connectivityAssociationNameSecretId: + description: | + Secret [OCID](/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key Name (CKN) of this MACsec key. + maxLength: 255 + minLength: 1 + type: string + connectivityAssociationNameSecretVersion: + description: The secret version of the connectivity association name secret in Vault. + format: int64 + maximum: 65535 + minimum: 1 + type: integer + required: + - connectivityAssociationNameSecretId + - connectivityAssociationNameSecretVersion + - connectivityAssociationKeySecretId + - connectivityAssociationKeySecretVersion + type: object + InventorySubnetSummary: + description: | + Lists subnet and its associated resources. + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + dnsDomainName: + description: DNS domain name of the subnet. + maxLength: 255 + minLength: 1 + type: string + inventoryResourceSummary: + description: | + Lists the `ResourceCollection` object. + items: + $ref: '#/components/schemas/InventoryResourceSummary' + type: array + inventorySubnetCidrCollection: + description: | + Lists CIDRs and utilization within the subnet. + items: + $ref: '#/components/schemas/InventorySubnetCidrBlockSummary' + type: array + region: + description: Region name of the subnet. + maxLength: 255 + minLength: 1 + type: string + resourceType: + description: Resource types of the subnet. + enum: + - Subnet + type: string + subnetId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet. + maxLength: 255 + minLength: 1 + type: string + subnetName: + description: Name of the subnet within a VCN. + maxLength: 255 + minLength: 1 + type: string + type: object + InventoryVcnCidrBlockSummary: + description: | + Lists the CIDRs and utilization within a VCN. + properties: + ipCidrBlock: + description: The CIDR prefix within a VCN. + maxLength: 45 + minLength: 1 + type: string + utilization: + description: The CIDR utilization of a VCN. + format: float + maximum: 100 + minimum: 0 + type: number + type: object + CreateIPSecTunnelBgpSessionDetails: + properties: + customerBgpAsn: + description: | + If the tunnel's `routing` attribute is set to `BGP` + (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this ASN + is required and used for the tunnel's BGP session. This is the ASN of the network on the + CPE end of the BGP session. Can be a 2-byte or 4-byte ASN. Uses "asplain" format. + + If the tunnel's `routing` attribute is set to `STATIC`, the `customerBgpAsn` must be null. + + Example: `12345` (2-byte) or `1587232876` (4-byte) + maxLength: 10 + minLength: 1 + type: string + customerInterfaceIp: + description: | + The IP address for the CPE end of the inside tunnel interface. + + If the tunnel's `routing` attribute is set to `BGP` + (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this IP address + is required and used for the tunnel's BGP session. + + If `routing` is instead set to `STATIC`, this IP address is optional. You can set this IP + address to troubleshoot or monitor the tunnel. + + The value must be a /30 or /31. + + Example: `10.0.0.5/31` + maxLength: 18 + minLength: 9 + type: string + customerInterfaceIpv6: + description: | + The IPv6 address for the CPE end of the inside tunnel interface. This IP address is optional. + + If the tunnel's `routing` attribute is set to `BGP` + (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this IP address + is used for the tunnel's BGP session. + + If `routing` is instead set to `STATIC`, you can set this IP + address to troubleshoot or monitor the tunnel. + + Only subnet masks from /64 up to /127 are allowed. + + Example: `2001:db8::1/64` + maxLength: 50 + minLength: 4 + type: string + oracleInterfaceIp: + description: | + The IP address for the Oracle end of the inside tunnel interface. + + If the tunnel's `routing` attribute is set to `BGP` + (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this IP address + is required and used for the tunnel's BGP session. + + If `routing` is instead set to `STATIC`, this IP address is optional. You can set this IP + address to troubleshoot or monitor the tunnel. + + The value must be a /30 or /31. + + Example: `10.0.0.4/31` + maxLength: 18 + minLength: 9 + type: string + oracleInterfaceIpv6: + description: | + The IPv6 address for the Oracle end of the inside tunnel interface. This IP address is optional. + + If the tunnel's `routing` attribute is set to `BGP` + (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this IP address + is used for the tunnel's BGP session. + + If `routing` is instead set to `STATIC`, you can set this IP + address to troubleshoot or monitor the tunnel. + + Only subnet masks from /64 up to /127 are allowed. + + Example: `2001:db8::1/64` + maxLength: 50 + minLength: 4 + type: string + type: object + CreateIPSecTunnelEncryptionDomainDetails: + description: | + Request to enable a multi-encryption domain policy on the IPSec tunnel. + There can't be more than 50 security associations in use at one time. See [Encryption domain for policy-based + tunnels](/iaas/Content/Network/Tasks/ipsecencryptiondomains.htm#spi_policy_based_tunnel) for more. + properties: + cpeTrafficSelector: + description: Lists IPv4 or IPv6-enabled subnets in your on-premises network. + items: + type: string + minLength: 1 + type: array + uniqueItems: true + oracleTrafficSelector: + description: Lists IPv4 or IPv6-enabled subnets in your Oracle tenancy. + items: + type: string + minLength: 1 + type: array + uniqueItems: true + type: object + PortRange: + properties: + max: + description: | + The maximum port number, which must not be less than the minimum port number. To specify + a single port number, set both the min and max to the same value. + maximum: 65535 + minimum: 1 + type: integer + min: + description: | + The minimum port number, which must not be greater than the maximum port number. + maximum: 65535 + minimum: 1 + type: integer + required: + - max + - min + type: object + TopologyEntityRelationship: + description: Defines the relationship between Virtual Network topology entities. + discriminator: + propertyName: type + properties: + id1: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the first entity in the relationship. + type: string + id2: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the second entity in the relationship. + type: string + type: + description: The type of relationship between the entities. + enum: + - CONTAINS + - ASSOCIATED_WITH + - ROUTES_TO + type: string + required: + - id1 + - id2 + - type + type: object + InventoryResourceSummary: + description: Lists resources and its properties under a given subnet. + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. + maxLength: 255 + minLength: 1 + type: string + ipAddressCollection: + description: | + Lists the 'IpAddressCollection' object. + items: + $ref: '#/components/schemas/InventoryIpAddressSummary' + type: array + macAddress: + description: Mac Address of IP Resource + maxLength: 255 + minLength: 1 + type: string + region: + description: The region name of the corresponding resource. + maxLength: 255 + minLength: 1 + type: string + resourceName: + description: The name of the resource created. + maxLength: 255 + minLength: 1 + type: string + resourceType: + description: Resource types of the resource. + enum: + - Resource + type: string + type: object + InventorySubnetCidrBlockSummary: + description: | + Lists CIDRs and utilization within a subnet. + properties: + ipCidrBlock: + description: The CIDR Prefix within a VCN. + maxLength: 45 + minLength: 1 + type: string + utilization: + description: The CIDR utilization of a VCN. + format: float + maximum: 100 + minimum: 0 + type: number + type: object + InventoryIpAddressSummary: + description: | + Provides the IP address and its corresponding VNIC ID, VNIC name, and DNS hostname. + properties: + dnsHostName: + description: The DNS hostname of the resource assigned with the IP address. + maxLength: 255 + minLength: 1 + type: string + ipAddress: + description: The IP address assigned from a subnet. + maxLength: 255 + minLength: 1 + type: string + vnicId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC. + maxLength: 255 + minLength: 1 + type: string + vnicName: + description: The name of the VNIC. + maxLength: 255 + minLength: 1 + type: string + type: object + ListAllowedPeerRegionsForRemotePeeringResponse: + type: object + properties: + allowed_peer_regions_for_remote_peering: + type: array + items: + $ref: '#/components/schemas/PeerRegionForRemotePeering' + ListCaptureFiltersResponse: + type: object + properties: + capture_filters: + type: array + items: + $ref: '#/components/schemas/CaptureFilter' + ListCpeDeviceShapesResponse: + type: object + properties: + cpe_device_shapes: + type: array + items: + $ref: '#/components/schemas/CpeDeviceShapeSummary' + ListCpesResponse: + type: object + properties: + cpes: + type: array + items: + $ref: '#/components/schemas/Cpe' + ListCrossConnectGroupsResponse: + type: object + properties: + cross_connect_groups: + type: array + items: + $ref: '#/components/schemas/CrossConnectGroup' + ListCrossConnectLocationsResponse: + type: object + properties: + cross_connect_locations: + type: array + items: + $ref: '#/components/schemas/CrossConnectLocation' + ListCrossconnectPortSpeedShapesResponse: + type: object + properties: + crossconnect_port_speed_shapes: + type: array + items: + $ref: '#/components/schemas/CrossConnectPortSpeedShape' + ListCrossConnectsResponse: + type: object + properties: + cross_connects: + type: array + items: + $ref: '#/components/schemas/CrossConnect' + ListDhcpOptionsResponse: + type: object + properties: + dhcp_options: + type: array + items: + $ref: '#/components/schemas/DhcpOptions' + ListDrgAttachmentsResponse: + type: object + properties: + drg_attachments: + type: array + items: + $ref: '#/components/schemas/DrgAttachment' + ListDrgRouteDistributionsResponse: + type: object + properties: + drg_route_distributions: + type: array + items: + $ref: '#/components/schemas/DrgRouteDistribution' + AddDrgRouteDistributionStatementsResponse: + type: object + properties: + add_drg_route_distribution_statements: + type: array + items: + $ref: '#/components/schemas/DrgRouteDistributionStatement' + UpdateDrgRouteDistributionStatementsResponse: + type: object + properties: + update_drg_route_distribution_statements: + type: array + items: + $ref: '#/components/schemas/DrgRouteDistributionStatement' + ListDrgRouteDistributionStatementsResponse: + type: object + properties: + drg_route_distribution_statements: + type: array + items: + $ref: '#/components/schemas/DrgRouteDistributionStatement' + ListDrgRouteTablesResponse: + type: object + properties: + drg_route_tables: + type: array + items: + $ref: '#/components/schemas/DrgRouteTable' + AddDrgRouteRulesResponse: + type: object + properties: + add_drg_route_rules: + type: array + items: + $ref: '#/components/schemas/DrgRouteRule' + UpdateDrgRouteRulesResponse: + type: object + properties: + update_drg_route_rules: + type: array + items: + $ref: '#/components/schemas/DrgRouteRule' + ListDrgRouteRulesResponse: + type: object + properties: + drg_route_rules: + type: array + items: + $ref: '#/components/schemas/DrgRouteRule' + ListDrgsResponse: + type: object + properties: + drgs: + type: array + items: + $ref: '#/components/schemas/Drg' + GetAllDrgAttachmentsResponse: + type: object + properties: + drg_attachments: + type: array + items: + $ref: '#/components/schemas/DrgAttachmentInfo' + ListFastConnectProviderServicesResponse: + type: object + properties: + fast_connect_provider_services: + type: array + items: + $ref: '#/components/schemas/FastConnectProviderService' + ListFastConnectProviderVirtualCircuitBandwidthShapesResponse: + type: object + properties: + fast_connect_provider_virtual_circuit_bandwidth_shapes: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitBandwidthShape' + ListInternetGatewaysResponse: + type: object + properties: + internet_gateways: + type: array + items: + $ref: '#/components/schemas/InternetGateway' + ListIPSecConnectionsResponse: + type: object + properties: + ipsec_connections: + type: array + items: + $ref: '#/components/schemas/IPSecConnection' + ListIPSecConnectionTunnelsResponse: + type: object + properties: + ipsec_connection_tunnels: + type: array + items: + $ref: '#/components/schemas/IPSecConnectionTunnel' + ListIPSecConnectionTunnelRoutesResponse: + type: object + properties: + ipsec_connection_tunnel_routes: + type: array + items: + $ref: '#/components/schemas/TunnelRouteSummary' + ListIPSecConnectionTunnelSecurityAssociationsResponse: + type: object + properties: + ipsec_connection_tunnel_security_associations: + type: array + items: + $ref: '#/components/schemas/TunnelSecurityAssociationSummary' + ListIpv6sResponse: + type: object + properties: + ipv6s: + type: array + items: + $ref: '#/components/schemas/Ipv6' + ListLocalPeeringGatewaysResponse: + type: object + properties: + local_peering_gateways: + type: array + items: + $ref: '#/components/schemas/LocalPeeringGateway' + ListNatGatewaysResponse: + type: object + properties: + nat_gateways: + type: array + items: + $ref: '#/components/schemas/NatGateway' + ListNetworkSecurityGroupsResponse: + type: object + properties: + network_security_groups: + type: array + items: + $ref: '#/components/schemas/NetworkSecurityGroup' + ListNetworkSecurityGroupSecurityRulesResponse: + type: object + properties: + network_security_group_security_rules: + type: array + items: + $ref: '#/components/schemas/SecurityRule' + ListNetworkSecurityGroupVnicsResponse: + type: object + properties: + network_security_group_vnics: + type: array + items: + $ref: '#/components/schemas/NetworkSecurityGroupVnic' + ListPrivateIpsResponse: + type: object + properties: + private_ips: + type: array + items: + $ref: '#/components/schemas/PrivateIp' + ListPublicIpsResponse: + type: object + properties: + public_ips: + type: array + items: + $ref: '#/components/schemas/PublicIp' + ListRemotePeeringConnectionsResponse: + type: object + properties: + remote_peering_connections: + type: array + items: + $ref: '#/components/schemas/RemotePeeringConnection' + ListRouteTablesResponse: + type: object + properties: + route_tables: + type: array + items: + $ref: '#/components/schemas/RouteTable' + ListSecurityListsResponse: + type: object + properties: + security_lists: + type: array + items: + $ref: '#/components/schemas/SecurityList' + ListServiceGatewaysResponse: + type: object + properties: + service_gateways: + type: array + items: + $ref: '#/components/schemas/ServiceGateway' + ListServicesResponse: + type: object + properties: + services: + type: array + items: + $ref: '#/components/schemas/Service' + ListSubnetsResponse: + type: object + properties: + subnets: + type: array + items: + $ref: '#/components/schemas/Subnet' + ListVcnsResponse: + type: object + properties: + vcns: + type: array + items: + $ref: '#/components/schemas/Vcn' + ListVirtualCircuitBandwidthShapesResponse: + type: object + properties: + virtual_circuit_bandwidth_shapes: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitBandwidthShape' + ListVirtualCircuitsResponse: + type: object + properties: + virtual_circuits: + type: array + items: + $ref: '#/components/schemas/VirtualCircuit' + ListVirtualCircuitAssociatedTunnelsResponse: + type: object + properties: + virtual_circuit_associated_tunnels: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitAssociatedTunnelDetails' + ListVirtualCircuitPublicPrefixesResponse: + type: object + properties: + virtual_circuit_public_prefixes: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitPublicPrefix' + ListVlansResponse: + type: object + properties: + vlans: + type: array + items: + $ref: '#/components/schemas/Vlan' + ListVtapsResponse: + type: object + properties: + vtaps: + type: array + items: + $ref: '#/components/schemas/Vtap' + responses: + '400': + description: Bad Request + 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' + '401': + description: Unauthorized + 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' + '403': + description: Forbidden + 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' + '404': + description: Not Found + 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' + '409': + description: Conflict + 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' + '412': + description: Precondition Failed + 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' + '429': + description: Too many requests + 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' + '500': + description: Internal Server 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' + DefaultError: + description: An error has occurred. + 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' + parameters: + RequestIdHeader: + description: | + Unique identifier for the request. + If you need to contact Oracle about a particular request, please provide the request ID. + in: header + name: opc-request-id + schema: + type: string + pattern: '[A-Za-z0-9\-_\.]+' + PaginationLimitQueryParam: + description: | + For list pagination. The maximum number of results per page, or items to return in a paginated + "List" call. For important details about how pagination works, see + [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + + Example: `50` + in: query + name: limit + x-default-description: The default maximum results per page varies by API. + schema: + type: integer + minimum: 1 + maximum: 100 + PaginationTokenQueryParam: + description: | + For list pagination. The value of the `opc-next-page` response header from the previous "List" + call. For important details about how pagination works, see + [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + in: query + name: page + schema: + type: string + minLength: 1 + maxLength: 4096 + FilterByDisplayNameQueryParam: + description: | + A filter to return only resources that match the given display name exactly. + in: query + name: displayName + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + FilterByLifecycleStateQueryParam: + description: | + A filter to return only resources that match the given lifecycle state name exactly. + in: query + name: lifecycleState + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + ByoasnSortByQueryParam: + description: | + The field to sort by, for byoasn List operation. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + default: TIMECREATED + SortOrderQueryParam: + description: | + The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order + is case sensitive. + in: query + name: sortOrder + required: false + x-default-description: The default sort order varies by API. + schema: + type: string + enum: + - ASC + - DESC + default: ASC + CompartmentIdQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. + in: query + name: compartmentId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + RetryTokenHeader: + description: | + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations (for example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + may be rejected). + in: header + name: opc-retry-token + schema: + type: string + minLength: 1 + maxLength: 64 + ByoasnIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `Byoasn` resource. + in: path + name: byoasnId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + 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 + schema: + type: string + SortByQueryParam: + description: | + The field to sort by. You can provide one sort order (`sortOrder`). Default order for + TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME + sort order is case sensitive. + + **Note:** In general, some "List" operations (for example, `ListInstances`) let you + optionally filter by availability domain if the scope of the resource type is within a + single availability domain. If you call one of these "List" operations without specifying + an availability domain, the resources are grouped by availability domain, then sorted. + in: query + name: sortBy + required: false + x-default-description: The default field to sort by varies by API. + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + ByoipRangeIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block. + in: path + name: byoipRangeId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + FilterByCaptureFilterLifecycleStateQueryParam: + description: | + A filter to return only resources that match the given capture filter lifecycle state. + The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/CaptureFilter/lifecycleState' + schema: + type: string + CaptureFilterIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the capture filter. + in: path + name: captureFilterId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + CpeDeviceShapeIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE device shape. + in: path + name: cpeDeviceShapeId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + CpeIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE. + in: path + name: cpeId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + CrossConnectGroupIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect group. + in: path + name: crossConnectGroupId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + CrossConnectGroupIdOptionalQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect group. + in: query + name: crossConnectGroupId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + CrossConnectIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect. + in: path + name: crossConnectId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + VcnIdOptionalQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN. + in: query + name: vcnId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + DhcpIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the set of DHCP options. + in: path + name: dhcpId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + DrgIdOptionalQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG. + in: query + name: drgId + required: false + x-default-description: '' + schema: + type: string + minLength: 1 + maxLength: 255 + NetworkIdQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource (virtual circuit, VCN, IPSec tunnel, or remote peering connection) attached to the DRG. + in: query + name: networkId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + DrgAttachmentTypeQueryParam: + description: The type for the network resource attached to the DRG. + in: query + name: attachmentType + required: false + schema: + type: string + enum: + - VCN + - VIRTUAL_CIRCUIT + - REMOTE_PEERING_CONNECTION + - IPSEC_TUNNEL + - ALL + default: VCN + DrgRouteTableIdQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table assigned to the DRG attachment. + in: query + name: drgRouteTableId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + DrgAttachmentIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment. + in: path + name: drgAttachmentId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + DrgIdQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG. + in: query + name: drgId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + DrgRouteDistributionIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution. + in: path + name: drgRouteDistributionId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ListDrgRouteDistributionStatementsSortByQueryParam: + description: The field to sort by. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + ImportDrgRouteDistributionIdQueryParam: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the import route distribution. + in: query + name: importDrgRouteDistributionId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + DrgRouteTableIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table. + in: path + name: drgRouteTableId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + RouteTypeQueryParam: + description: | + Static routes are specified through the DRG route table API. + Dynamic routes are learned by the DRG from the DRG attachments through various routing protocols. + in: query + name: routeType + required: false + schema: + type: string + enum: + - STATIC + - DYNAMIC + DrgIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG. + in: path + name: drgId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + CrossTenancyQueryParam: + description: Whether the DRG attachment lives in a different tenancy than the DRG. + in: query + name: isCrossTenancy + required: false + schema: + type: boolean + default: false + ProviderServiceIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the provider service. + in: path + name: providerServiceId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ProviderServiceKeyNamePathParam: + description: | + The provider service key that the provider gives you when you set up a virtual circuit connection + from the provider to Oracle Cloud Infrastructure. You can set up that connection and get your + provider service key at the provider's website or portal. For the portal location, see the `description` + attribute of the [FastConnectProviderService](#/en/iaas/latest/FastConnectProviderService/). + in: path + name: providerServiceKeyName + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + InternetGatewayIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the internet gateway. + in: path + name: igId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + SubnetIdPathParam: + description: Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet. + in: path + name: subnetId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + VcnIdPathParam: + description: Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN. + in: path + name: vcnId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + DataRequestIdPathParam: + description: Specify the ID of the resource. + in: path + name: dataRequestId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + CpeIdOptionalQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE. + in: query + name: cpeId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + IPSecConnectionIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection. + in: path + name: ipscId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + IPSecConnectionTunnelIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel. + in: path + name: tunnelId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + BgpRouteAdvertiserQueryParam: + description: | + Specifies the advertiser of the routes. If set to `ORACLE`, this returns only the + routes advertised by Oracle. When set to `CUSTOMER`, this returns only the + routes advertised by the CPE. + in: query + name: advertiser + required: false + x-default-description: 'null' + x-obmcs-enumref: '#/definitions/TunnelRouteSummary/advertiser' + schema: + type: string + IpAddressOptionalQueryParam: + description: | + An IP address. This could be either IPv4 or IPv6, depending on the resource. + Example: `10.0.3.3` + in: query + name: ipAddress + required: false + schema: + type: string + SubnetIdOptionalQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet. + in: query + name: subnetId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + VnicIdOptionalQueryParam: + description: The OCID of the VNIC. + in: query + name: vnicId + required: false + schema: + type: string + IpStateOptionalQueryParam: + description: State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED otherwise AVAILABLE + in: query + name: ipState + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + LifetimeOptionalQueryParam: + description: | + Lifetime of the IP address. + There are two types of IPs: + - Ephemeral + - Reserved + in: query + name: lifetime + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + Ipv6IdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6. + in: path + name: ipv6Id + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + LocalPeeringGatewayIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the local peering gateway. + in: path + name: localPeeringGatewayId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + NatGatewayIdPathParam: + description: The NAT gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm). + in: path + name: natGatewayId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + CompartmentIdOptionalQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. + in: query + name: compartmentId + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + VlanIdOptionalQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. + in: query + name: vlanId + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + NetworkSecurityGroupIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group. + in: path + name: networkSecurityGroupId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + SecurityRuleDirectionOptionalQueryParam: + description: | + Direction of the security rule. Set to `EGRESS` for rules that allow outbound IP packets, + or `INGRESS` for rules that allow inbound IP packets. + in: query + name: direction + required: false + schema: + type: string + enum: + - EGRESS + - INGRESS + ListNetworkSecurityGroupSecurityRulesSortByQueryParam: + description: The field to sort by. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + ListNetworkSecurityGroupVnicsSortByQueryParam: + description: The field to sort by. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMEASSOCIATED + AccessLevelQueryParam: + description: | + Valid values are `ANY` and `ACCESSIBLE`. The default is `ANY`. + Setting this to `ACCESSIBLE` returns only compartments for which a + user has INSPECT permissions, either directly or indirectly (permissions can be on a + resource in a subcompartment). A restricted set of fields is returned for compartments in which a user has + indirect INSPECT permissions. + + When set to `ANY` permissions are not checked. + in: query + name: accessLevel + x-default-description: ANY + schema: + type: string + enum: + - ANY + - ACCESSIBLE + QueryCompartmentSubtreeQueryParam: + description: | + When set to true, the hierarchy of compartments is traversed + and the specified compartment and its subcompartments are + inspected depending on the the setting of `accessLevel`. + Default is false. + in: query + name: queryCompartmentSubtree + x-default-description: false + schema: + type: boolean + IfNoneMatchHeader: + description: | + For querying if there is a cached value on the server. The If-None-Match HTTP request header + makes the request conditional. For GET and HEAD methods, the server will send back the requested + resource, with a 200 status, only if it doesn't have an ETag matching the given ones. + For other methods, the request will be processed only if the eventually existing resource's + ETag doesn't match any of the values listed. + in: header + name: if-none-match + x-default-description: '' + schema: + type: string + CacheControlHeader: + description: | + The Cache-Control HTTP header holds directives (instructions) + for caching in both requests and responses. + in: header + name: cache-control + x-default-description: '' + schema: + type: string + PrivateIpIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private IP or IPv6. + in: path + name: privateIpId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + FilterByByoipRangeIdQueryParam: + description: | + A filter to return only resources that match the given BYOIP CIDR block. + in: query + name: byoipRangeId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + PublicIpPoolIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool. + in: path + name: publicIpPoolId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + PublicIpScopeQueryParam: + description: | + Whether the public IP is regional or specific to a particular availability domain. + + * `REGION`: The public IP exists within a region and is assigned to a regional entity + (such as a [NatGateway](#/en/iaas/latest/NatGateway/)), or can be assigned to a private IP + in any availability domain in the region. Reserved public IPs have `scope` = `REGION`, as do + ephemeral public IPs assigned to a regional entity. + + * `AVAILABILITY_DOMAIN`: The public IP exists within the availability domain of the entity + it's assigned to, which is specified by the `availabilityDomain` property of the public IP object. + Ephemeral public IPs that are assigned to private IPs have `scope` = `AVAILABILITY_DOMAIN`. + in: query + name: scope + required: true + schema: + type: string + enum: + - REGION + - AVAILABILITY_DOMAIN + AvailabilityDomainQueryParam: + description: | + The name of the availability domain. + + Example: `Uocm:PHX-AD-1` + in: query + name: availabilityDomain + required: false + schema: + type: string + PublicIpLifetimeQueryParam: + description: | + A filter to return only public IPs that match given lifetime. + in: query + name: lifetime + required: false + schema: + type: string + enum: + - EPHEMERAL + - RESERVED + FilterByPublicIpPoolIdQueryParam: + description: | + A filter to return only resources that belong to the given public IP pool. + in: query + name: publicIpPoolId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + PublicIpIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP. + in: path + name: publicIpId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + RemotePeeringConnectionIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC). + in: path + name: remotePeeringConnectionId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + RouteTableIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table. + in: path + name: rtId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + SecurityListIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the security list. + in: path + name: securityListId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ServiceGatewayIdPathParam: + description: The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm). + in: path + name: serviceGatewayId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ServiceIdPathParam: + description: The service's [OCID](/iaas/Content/General/Concepts/identifiers.htm). + in: path + name: serviceId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + SubnetIdQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet. + in: query + name: subnetId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + VcnIdQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN. + in: query + name: vcnId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + VirtualCircuitIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the virtual circuit. + in: path + name: virtualCircuitId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + VlanIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. + in: path + name: vlanId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + VnicIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC. + in: path + name: vnicId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + VtapSourceIdOptionalQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VTAP source. + in: query + name: source + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + VtapTargetIdOptionalQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VTAP target. + in: query + name: targetId + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 255 + VtapTargetIpOptionalQueryParam: + description: The IP address of the VTAP target. + in: query + name: targetIp + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 46 + VtapIsEnabledOptionalQueryParam: + description: | + Indicates whether to list all VTAPs or only running VTAPs. + + * When `FALSE`, lists ALL running and stopped VTAPs. + * When `TRUE`, lists only running VTAPs (VTAPs where isVtapEnabled = `TRUE`). + in: query + name: isVtapEnabled + required: false + schema: + type: boolean + default: false + FilterByVtapLifecycleStateQueryParam: + description: | + A filter to return only resources that match the given VTAP administrative lifecycle state. + The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/Vtap/lifecycleState' + schema: + type: string + VtapIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VTAP. + in: path + name: vtapId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + x-stackQL-resources: + allowed_peer_regions_for_remote_peering: + id: oci.network.allowed_peer_regions_for_remote_peering + name: allowed_peer_regions_for_remote_peering + title: Allowed Peer Regions For Remote Peering + methods: + list: + operation: + $ref: '#/paths/~1allowedPeerRegionsForRemotePeering/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.allowed_peer_regions_for_remote_peering + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListAllowedPeerRegionsForRemotePeeringResponse' + transform: + body: |- + {{- $wrapped := printf "{\"allowed_peer_regions_for_remote_peering\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/allowed_peer_regions_for_remote_peering/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + byoasns: + id: oci.network.byoasns + name: byoasns + title: Byoasns + methods: + list: + operation: + $ref: '#/paths/~1byoasns/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1byoasns/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1byoasns~1{byoasnId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1byoasns~1{byoasnId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1byoasns~1{byoasnId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1byoasns~1{byoasnId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + validate_byoasn: + operation: + $ref: '#/paths/~1byoasns~1{byoasnId}~1actions~1validate/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/byoasns/methods/get' + - $ref: '#/components/x-stackQL-resources/byoasns/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/byoasns/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/byoasns/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/byoasns/methods/delete' + replace: [] + byoip_ranges: + id: oci.network.byoip_ranges + name: byoip_ranges + title: Byoip Ranges + methods: + list: + operation: + $ref: '#/paths/~1byoipRanges/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1byoipRanges/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1byoipRanges~1{byoipRangeId}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1byoipRanges~1{byoipRangeId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1byoipRanges~1{byoipRangeId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + advertise_byoip_range: + operation: + $ref: '#/paths/~1byoipRanges~1{byoipRangeId}~1actions~1advertise/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1byoipRanges~1{byoipRangeId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + set_origin_asn: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1byoipRanges~1{byoipRangeId}~1actions~1setOrigin~1byoasn/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + set_origin_asn_to_oracle: + operation: + $ref: '#/paths/~1byoipRanges~1{byoipRangeId}~1actions~1setOrigin~1oracleAsn/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + validate_byoip_range: + operation: + $ref: '#/paths/~1byoipRanges~1{byoipRangeId}~1actions~1validate/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + withdraw_byoip_range: + operation: + $ref: '#/paths/~1byoipRanges~1{byoipRangeId}~1actions~1withdraw/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/byoip_ranges/methods/get' + - $ref: '#/components/x-stackQL-resources/byoip_ranges/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/byoip_ranges/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/byoip_ranges/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/byoip_ranges/methods/delete' + replace: [] + byoip_allocated_ranges: + id: oci.network.byoip_allocated_ranges + name: byoip_allocated_ranges + title: Byoip Allocated Ranges + methods: + list: + operation: + $ref: '#/paths/~1byoipRanges~1{byoipRangeId}~1byoipAllocatedRanges/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/byoip_allocated_ranges/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + capture_filters: + id: oci.network.capture_filters + name: capture_filters + title: Capture Filters + methods: + list: + operation: + $ref: '#/paths/~1captureFilters/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.capture_filters + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListCaptureFiltersResponse' + transform: + body: |- + {{- $wrapped := printf "{\"capture_filters\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1captureFilters/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1captureFilters~1{captureFilterId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1captureFilters~1{captureFilterId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1captureFilters~1{captureFilterId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1captureFilters~1{captureFilterId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/capture_filters/methods/get' + - $ref: '#/components/x-stackQL-resources/capture_filters/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/capture_filters/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/capture_filters/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/capture_filters/methods/delete' + replace: [] + cpe_device_shapes: + id: oci.network.cpe_device_shapes + name: cpe_device_shapes + title: Cpe Device Shapes + methods: + list: + operation: + $ref: '#/paths/~1cpeDeviceShapes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.cpe_device_shapes + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListCpeDeviceShapesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"cpe_device_shapes\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1cpeDeviceShapes~1{cpeDeviceShapeId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cpe_device_shapes/methods/get' + - $ref: '#/components/x-stackQL-resources/cpe_device_shapes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + cpes: + id: oci.network.cpes + name: cpes + title: Cpes + methods: + list: + operation: + $ref: '#/paths/~1cpes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.cpes + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListCpesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"cpes\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cpes/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1cpes~1{cpeId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1cpes~1{cpeId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cpes~1{cpeId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1cpes~1{cpeId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cpes/methods/get' + - $ref: '#/components/x-stackQL-resources/cpes/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/cpes/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/cpes/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/cpes/methods/delete' + replace: [] + cpe_device_config_contents: + id: oci.network.cpe_device_config_contents + name: cpe_device_config_contents + title: Cpe Device Config Contents + methods: + get: + operation: + $ref: '#/paths/~1cpes~1{cpeId}~1cpeConfigContent/get' + response: + mediaType: text/plain; charset=utf-8 + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cpe_device_config_contents/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + cross_connect_groups: + id: oci.network.cross_connect_groups + name: cross_connect_groups + title: Cross Connect Groups + methods: + list: + operation: + $ref: '#/paths/~1crossConnectGroups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.cross_connect_groups + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListCrossConnectGroupsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"cross_connect_groups\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1crossConnectGroups/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1crossConnectGroups~1{crossConnectGroupId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1crossConnectGroups~1{crossConnectGroupId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1crossConnectGroups~1{crossConnectGroupId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1crossConnectGroups~1{crossConnectGroupId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cross_connect_groups/methods/get' + - $ref: '#/components/x-stackQL-resources/cross_connect_groups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/cross_connect_groups/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/cross_connect_groups/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/cross_connect_groups/methods/delete' + replace: [] + cross_connect_locations: + id: oci.network.cross_connect_locations + name: cross_connect_locations + title: Cross Connect Locations + methods: + list: + operation: + $ref: '#/paths/~1crossConnectLocations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.cross_connect_locations + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListCrossConnectLocationsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"cross_connect_locations\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cross_connect_locations/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + crossconnect_port_speed_shapes: + id: oci.network.crossconnect_port_speed_shapes + name: crossconnect_port_speed_shapes + title: Crossconnect Port Speed Shapes + methods: + list: + operation: + $ref: '#/paths/~1crossConnectPortSpeedShapes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.crossconnect_port_speed_shapes + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListCrossconnectPortSpeedShapesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"crossconnect_port_speed_shapes\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/crossconnect_port_speed_shapes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + cross_connects: + id: oci.network.cross_connects + name: cross_connects + title: Cross Connects + methods: + list: + operation: + $ref: '#/paths/~1crossConnects/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.cross_connects + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListCrossConnectsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"cross_connects\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1crossConnects/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1crossConnects~1{crossConnectId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1crossConnects~1{crossConnectId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1crossConnects~1{crossConnectId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1crossConnects~1{crossConnectId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cross_connects/methods/get' + - $ref: '#/components/x-stackQL-resources/cross_connects/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/cross_connects/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/cross_connects/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/cross_connects/methods/delete' + replace: [] + cross_connect_letter_of_authorities: + id: oci.network.cross_connect_letter_of_authorities + name: cross_connect_letter_of_authorities + title: Cross Connect Letter Of Authorities + methods: + get: + operation: + $ref: '#/paths/~1crossConnects~1{crossConnectId}~1letterOfAuthority/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cross_connect_letter_of_authorities/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + cross_connect_status: + id: oci.network.cross_connect_status + name: cross_connect_status + title: Cross Connect Status + methods: + get: + operation: + $ref: '#/paths/~1crossConnects~1{crossConnectId}~1status/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cross_connect_status/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + dhcp_options: + id: oci.network.dhcp_options + name: dhcp_options + title: Dhcp Options + methods: + list: + operation: + $ref: '#/paths/~1dhcps/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.dhcp_options + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDhcpOptionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"dhcp_options\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dhcps/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1dhcps~1{dhcpId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1dhcps~1{dhcpId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dhcps~1{dhcpId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1dhcps~1{dhcpId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dhcp_options/methods/get' + - $ref: '#/components/x-stackQL-resources/dhcp_options/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/dhcp_options/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/dhcp_options/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/dhcp_options/methods/delete' + replace: [] + drg_attachments: + id: oci.network.drg_attachments + name: drg_attachments + title: Drg Attachments + methods: + list: + operation: + $ref: '#/paths/~1drgAttachments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.drg_attachments + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDrgAttachmentsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"drg_attachments\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1drgAttachments/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1drgAttachments~1{drgAttachmentId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1drgAttachments~1{drgAttachmentId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1drgAttachments~1{drgAttachmentId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + remove_export_drg_route_distribution: + operation: + $ref: '#/paths/~1drgAttachments~1{drgAttachmentId}~1actions~1removeExportDrgRouteDistribution/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/drg_attachments/methods/get' + - $ref: '#/components/x-stackQL-resources/drg_attachments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/drg_attachments/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/drg_attachments/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/drg_attachments/methods/delete' + replace: [] + drg_route_distributions: + id: oci.network.drg_route_distributions + name: drg_route_distributions + title: Drg Route Distributions + methods: + list: + operation: + $ref: '#/paths/~1drgRouteDistributions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.drg_route_distributions + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDrgRouteDistributionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"drg_route_distributions\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1drgRouteDistributions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1drgRouteDistributions~1{drgRouteDistributionId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1drgRouteDistributions~1{drgRouteDistributionId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1drgRouteDistributions~1{drgRouteDistributionId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + add_drg_route_distribution_statements: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1drgRouteDistributions~1{drgRouteDistributionId}~1actions~1addDrgRouteDistributionStatements/post' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.add_drg_route_distribution_statements + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/AddDrgRouteDistributionStatementsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"add_drg_route_distribution_statements\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + remove_drg_route_distribution_statements: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1drgRouteDistributions~1{drgRouteDistributionId}~1actions~1removeDrgRouteDistributionStatements/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/drg_route_distributions/methods/get' + - $ref: '#/components/x-stackQL-resources/drg_route_distributions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/drg_route_distributions/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/drg_route_distributions/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/drg_route_distributions/methods/delete' + replace: [] + drg_route_distribution_statements: + id: oci.network.drg_route_distribution_statements + name: drg_route_distribution_statements + title: Drg Route Distribution Statements + methods: + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1drgRouteDistributions~1{drgRouteDistributionId}~1actions~1updateDrgRouteDistributionStatements/post' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.update_drg_route_distribution_statements + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/UpdateDrgRouteDistributionStatementsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"update_drg_route_distribution_statements\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + list: + operation: + $ref: '#/paths/~1drgRouteDistributions~1{drgRouteDistributionId}~1drgRouteDistributionStatements/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.drg_route_distribution_statements + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDrgRouteDistributionStatementsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"drg_route_distribution_statements\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/drg_route_distribution_statements/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/drg_route_distribution_statements/methods/update' + delete: [] + replace: [] + drg_route_tables: + id: oci.network.drg_route_tables + name: drg_route_tables + title: Drg Route Tables + methods: + list: + operation: + $ref: '#/paths/~1drgRouteTables/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.drg_route_tables + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDrgRouteTablesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"drg_route_tables\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1drgRouteTables/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1drgRouteTables~1{drgRouteTableId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1drgRouteTables~1{drgRouteTableId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1drgRouteTables~1{drgRouteTableId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + add_drg_route_rules: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1drgRouteTables~1{drgRouteTableId}~1actions~1addDrgRouteRules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.add_drg_route_rules + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/AddDrgRouteRulesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"add_drg_route_rules\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + remove_drg_route_rules: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1drgRouteTables~1{drgRouteTableId}~1actions~1removeDrgRouteRules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + remove_import_drg_route_distribution: + operation: + $ref: '#/paths/~1drgRouteTables~1{drgRouteTableId}~1actions~1removeImportDrgRouteDistribution/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/drg_route_tables/methods/get' + - $ref: '#/components/x-stackQL-resources/drg_route_tables/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/drg_route_tables/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/drg_route_tables/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/drg_route_tables/methods/delete' + replace: [] + drg_route_rules: + id: oci.network.drg_route_rules + name: drg_route_rules + title: Drg Route Rules + methods: + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1drgRouteTables~1{drgRouteTableId}~1actions~1updateDrgRouteRules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.update_drg_route_rules + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/UpdateDrgRouteRulesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"update_drg_route_rules\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + list: + operation: + $ref: '#/paths/~1drgRouteTables~1{drgRouteTableId}~1drgRouteRules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.drg_route_rules + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDrgRouteRulesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"drg_route_rules\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/drg_route_rules/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/drg_route_rules/methods/update' + delete: [] + replace: [] + drgs: + id: oci.network.drgs + name: drgs + title: Drgs + methods: + list: + operation: + $ref: '#/paths/~1drgs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.drgs + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListDrgsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"drgs\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1drgs/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1drgs~1{drgId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1drgs~1{drgId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1drgs~1{drgId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + get_all_drg_attachments: + operation: + $ref: '#/paths/~1drgs~1{drgId}~1actions~1getAllDrgAttachments/post' + response: + mediaType: application/json + openAPIDocKey: '202' + objectKey: $.drg_attachments + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/GetAllDrgAttachmentsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"drg_attachments\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + upgrade_drg: + operation: + $ref: '#/paths/~1drgs~1{drgId}~1actions~1upgrade/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/drgs/methods/get' + - $ref: '#/components/x-stackQL-resources/drgs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/drgs/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/drgs/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/drgs/methods/delete' + replace: [] + upgrade_status: + id: oci.network.upgrade_status + name: upgrade_status + title: Upgrade Status + methods: + get: + operation: + $ref: '#/paths/~1drgs~1{drgId}~1actions~1upgradeStatus/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/upgrade_status/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + drg_redundancy_status: + id: oci.network.drg_redundancy_status + name: drg_redundancy_status + title: Drg Redundancy Status + methods: + get: + operation: + $ref: '#/paths/~1drgs~1{drgId}~1redundancyStatus/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/drg_redundancy_status/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + fast_connect_provider_services: + id: oci.network.fast_connect_provider_services + name: fast_connect_provider_services + title: Fast Connect Provider Services + methods: + list: + operation: + $ref: '#/paths/~1fastConnectProviderServices/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.fast_connect_provider_services + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListFastConnectProviderServicesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"fast_connect_provider_services\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1fastConnectProviderServices~1{providerServiceId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/fast_connect_provider_services/methods/get' + - $ref: '#/components/x-stackQL-resources/fast_connect_provider_services/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + fast_connect_provider_service_keys: + id: oci.network.fast_connect_provider_service_keys + name: fast_connect_provider_service_keys + title: Fast Connect Provider Service Keys + methods: + get: + operation: + $ref: '#/paths/~1fastConnectProviderServices~1{providerServiceId}~1providerServiceKeys~1{providerServiceKeyName}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/fast_connect_provider_service_keys/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + fast_connect_provider_virtual_circuit_bandwidth_shapes: + id: oci.network.fast_connect_provider_virtual_circuit_bandwidth_shapes + name: fast_connect_provider_virtual_circuit_bandwidth_shapes + title: Fast Connect Provider Virtual Circuit Bandwidth Shapes + methods: + list: + operation: + $ref: '#/paths/~1fastConnectProviderServices~1{providerServiceId}~1virtualCircuitBandwidthShapes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.fast_connect_provider_virtual_circuit_bandwidth_shapes + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListFastConnectProviderVirtualCircuitBandwidthShapesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"fast_connect_provider_virtual_circuit_bandwidth_shapes\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/fast_connect_provider_virtual_circuit_bandwidth_shapes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + internet_gateways: + id: oci.network.internet_gateways + name: internet_gateways + title: Internet Gateways + methods: + list: + operation: + $ref: '#/paths/~1internetGateways/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.internet_gateways + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListInternetGatewaysResponse' + transform: + body: |- + {{- $wrapped := printf "{\"internet_gateways\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1internetGateways/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1internetGateways~1{igId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1internetGateways~1{igId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1internetGateways~1{igId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1internetGateways~1{igId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/internet_gateways/methods/get' + - $ref: '#/components/x-stackQL-resources/internet_gateways/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/internet_gateways/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/internet_gateways/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/internet_gateways/methods/delete' + replace: [] + ip_inventories: + id: oci.network.ip_inventories + name: ip_inventories + title: Ip Inventories + methods: + list_ip_inventory: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1ipInventory/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + subnet_ip_inventories: + id: oci.network.subnet_ip_inventories + name: subnet_ip_inventories + title: Subnet Ip Inventories + methods: + get: + operation: + $ref: '#/paths/~1ipInventory~1subnets~1{subnetId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/subnet_ip_inventories/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + subnet_cidr_utilizations: + id: oci.network.subnet_cidr_utilizations + name: subnet_cidr_utilizations + title: Subnet Cidr Utilizations + methods: + get: + operation: + $ref: '#/paths/~1ipInventory~1subnets~1{subnetId}~1cidrs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/subnet_cidr_utilizations/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + overlaps: + id: oci.network.overlaps + name: overlaps + title: Overlaps + methods: + get_vcn_overlap: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1ipInventory~1vcns~1{vcnId}~1overlaps/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + resource_ip_inventories: + id: oci.network.resource_ip_inventories + name: resource_ip_inventories + title: Resource Ip Inventories + methods: + get: + operation: + $ref: '#/paths/~1ipinventory~1DataRequestId~1{dataRequestId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/resource_ip_inventories/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + allowed_ike_ip_sec_parameters: + id: oci.network.allowed_ike_ip_sec_parameters + name: allowed_ike_ip_sec_parameters + title: Allowed Ike Ip Sec Parameters + methods: + get: + operation: + $ref: '#/paths/~1ipsecAlgorithms/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/allowed_ike_ip_sec_parameters/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + ip_sec_connections: + id: oci.network.ip_sec_connections + name: ip_sec_connections + title: Ip Sec Connections + methods: + list: + operation: + $ref: '#/paths/~1ipsecConnections/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.ipsec_connections + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListIPSecConnectionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"ipsec_connections\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1ipsecConnections/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1ipsecConnections~1{ipscId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1ipsecConnections~1{ipscId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1ipsecConnections~1{ipscId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1ipsecConnections~1{ipscId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ip_sec_connections/methods/get' + - $ref: '#/components/x-stackQL-resources/ip_sec_connections/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/ip_sec_connections/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/ip_sec_connections/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/ip_sec_connections/methods/delete' + replace: [] + ipsec_cpe_device_config_contents: + id: oci.network.ipsec_cpe_device_config_contents + name: ipsec_cpe_device_config_contents + title: Ipsec Cpe Device Config Contents + methods: + get: + operation: + $ref: '#/paths/~1ipsecConnections~1{ipscId}~1cpeConfigContent/get' + response: + mediaType: text/plain; charset=utf-8 + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ipsec_cpe_device_config_contents/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + ip_sec_connection_device_configs: + id: oci.network.ip_sec_connection_device_configs + name: ip_sec_connection_device_configs + title: Ip Sec Connection Device Configs + methods: + get: + operation: + $ref: '#/paths/~1ipsecConnections~1{ipscId}~1deviceConfig/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ip_sec_connection_device_configs/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + ip_sec_connection_device_status: + id: oci.network.ip_sec_connection_device_status + name: ip_sec_connection_device_status + title: Ip Sec Connection Device Status + methods: + get: + operation: + $ref: '#/paths/~1ipsecConnections~1{ipscId}~1deviceStatus/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ip_sec_connection_device_status/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + ip_sec_connection_tunnels: + id: oci.network.ip_sec_connection_tunnels + name: ip_sec_connection_tunnels + title: Ip Sec Connection Tunnels + methods: + list: + operation: + $ref: '#/paths/~1ipsecConnections~1{ipscId}~1tunnels/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.ipsec_connection_tunnels + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListIPSecConnectionTunnelsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"ipsec_connection_tunnels\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1ipsecConnections~1{ipscId}~1tunnels~1{tunnelId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1ipsecConnections~1{ipscId}~1tunnels~1{tunnelId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ip_sec_connection_tunnels/methods/get' + - $ref: '#/components/x-stackQL-resources/ip_sec_connection_tunnels/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/ip_sec_connection_tunnels/methods/update' + delete: [] + replace: [] + ip_sec_connection_tunnel_errors: + id: oci.network.ip_sec_connection_tunnel_errors + name: ip_sec_connection_tunnel_errors + title: Ip Sec Connection Tunnel Errors + methods: + get: + operation: + $ref: '#/paths/~1ipsecConnections~1{ipscId}~1tunnels~1{tunnelId}~1error/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ip_sec_connection_tunnel_errors/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + ip_sec_connection_tunnel_routes: + id: oci.network.ip_sec_connection_tunnel_routes + name: ip_sec_connection_tunnel_routes + title: Ip Sec Connection Tunnel Routes + methods: + list: + operation: + $ref: '#/paths/~1ipsecConnections~1{ipscId}~1tunnels~1{tunnelId}~1routes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.ipsec_connection_tunnel_routes + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListIPSecConnectionTunnelRoutesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"ipsec_connection_tunnel_routes\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ip_sec_connection_tunnel_routes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + ip_sec_connection_tunnel_shared_secrets: + id: oci.network.ip_sec_connection_tunnel_shared_secrets + name: ip_sec_connection_tunnel_shared_secrets + title: Ip Sec Connection Tunnel Shared Secrets + methods: + get: + operation: + $ref: '#/paths/~1ipsecConnections~1{ipscId}~1tunnels~1{tunnelId}~1sharedSecret/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1ipsecConnections~1{ipscId}~1tunnels~1{tunnelId}~1sharedSecret/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ip_sec_connection_tunnel_shared_secrets/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/ip_sec_connection_tunnel_shared_secrets/methods/update' + delete: [] + replace: [] + tunnel_cpe_device_configs: + id: oci.network.tunnel_cpe_device_configs + name: tunnel_cpe_device_configs + title: Tunnel Cpe Device Configs + methods: + get: + operation: + $ref: '#/paths/~1ipsecConnections~1{ipscId}~1tunnels~1{tunnelId}~1tunnelDeviceConfig/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1ipsecConnections~1{ipscId}~1tunnels~1{tunnelId}~1tunnelDeviceConfig/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tunnel_cpe_device_configs/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/tunnel_cpe_device_configs/methods/update' + delete: [] + replace: [] + tunnel_cpe_device_config_contents: + id: oci.network.tunnel_cpe_device_config_contents + name: tunnel_cpe_device_config_contents + title: Tunnel Cpe Device Config Contents + methods: + get: + operation: + $ref: '#/paths/~1ipsecConnections~1{ipscId}~1tunnels~1{tunnelId}~1tunnelDeviceConfig~1content/get' + response: + mediaType: text/plain; charset=utf-8 + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tunnel_cpe_device_config_contents/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + ip_sec_connection_tunnel_security_associations: + id: oci.network.ip_sec_connection_tunnel_security_associations + name: ip_sec_connection_tunnel_security_associations + title: Ip Sec Connection Tunnel Security Associations + methods: + list: + operation: + $ref: '#/paths/~1ipsecConnections~1{ipscId}~1tunnels~1{tunnelId}~1tunnelSecurityAssociations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.ipsec_connection_tunnel_security_associations + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListIPSecConnectionTunnelSecurityAssociationsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"ipsec_connection_tunnel_security_associations\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ip_sec_connection_tunnel_security_associations/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + ipv6s: + id: oci.network.ipv6s + name: ipv6s + title: Ipv6s + methods: + list: + operation: + $ref: '#/paths/~1ipv6/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.ipv6s + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListIpv6sResponse' + transform: + body: |- + {{- $wrapped := printf "{\"ipv6s\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1ipv6/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + bulk_create_ipv6s: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1ipv6~1actions~1bulkCreateIpv6s/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + bulk_delete_ipv6s: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1ipv6~1actions~1bulkDeleteIpv6s/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + bulk_detach_ipv6s: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1ipv6~1actions~1bulkDetachIpv6s/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + bulk_update_ipv6s: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1ipv6~1actions~1bulkUpdateIpv6s/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1ipv6~1{ipv6Id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1ipv6~1{ipv6Id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1ipv6~1{ipv6Id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + ipv6_vnic_detach: + operation: + $ref: '#/paths/~1ipv6~1{ipv6Id}~1actions~1detach/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ipv6s/methods/get' + - $ref: '#/components/x-stackQL-resources/ipv6s/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/ipv6s/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/ipv6s/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/ipv6s/methods/delete' + replace: [] + local_peering_gateways: + id: oci.network.local_peering_gateways + name: local_peering_gateways + title: Local Peering Gateways + methods: + list: + operation: + $ref: '#/paths/~1localPeeringGateways/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.local_peering_gateways + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListLocalPeeringGatewaysResponse' + transform: + body: |- + {{- $wrapped := printf "{\"local_peering_gateways\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1localPeeringGateways/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1localPeeringGateways~1{localPeeringGatewayId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1localPeeringGateways~1{localPeeringGatewayId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1localPeeringGateways~1{localPeeringGatewayId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1localPeeringGateways~1{localPeeringGatewayId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + connect_local_peering_gateways: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1localPeeringGateways~1{localPeeringGatewayId}~1actions~1connect/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/local_peering_gateways/methods/get' + - $ref: '#/components/x-stackQL-resources/local_peering_gateways/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/local_peering_gateways/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/local_peering_gateways/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/local_peering_gateways/methods/delete' + replace: [] + nat_gateways: + id: oci.network.nat_gateways + name: nat_gateways + title: Nat Gateways + methods: + list: + operation: + $ref: '#/paths/~1natGateways/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.nat_gateways + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListNatGatewaysResponse' + transform: + body: |- + {{- $wrapped := printf "{\"nat_gateways\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1natGateways/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1natGateways~1{natGatewayId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1natGateways~1{natGatewayId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1natGateways~1{natGatewayId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1natGateways~1{natGatewayId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/nat_gateways/methods/get' + - $ref: '#/components/x-stackQL-resources/nat_gateways/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/nat_gateways/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/nat_gateways/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/nat_gateways/methods/delete' + replace: [] + network_security_groups: + id: oci.network.network_security_groups + name: network_security_groups + title: Network Security Groups + methods: + list: + operation: + $ref: '#/paths/~1networkSecurityGroups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.network_security_groups + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListNetworkSecurityGroupsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"network_security_groups\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networkSecurityGroups/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1networkSecurityGroups~1{networkSecurityGroupId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1networkSecurityGroups~1{networkSecurityGroupId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networkSecurityGroups~1{networkSecurityGroupId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + add_network_security_group_security_rules: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networkSecurityGroups~1{networkSecurityGroupId}~1actions~1addSecurityRules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networkSecurityGroups~1{networkSecurityGroupId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + remove_network_security_group_security_rules: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networkSecurityGroups~1{networkSecurityGroupId}~1actions~1removeSecurityRules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/network_security_groups/methods/get' + - $ref: '#/components/x-stackQL-resources/network_security_groups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/network_security_groups/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/network_security_groups/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/network_security_groups/methods/delete' + replace: [] + network_security_group_security_rules: + id: oci.network.network_security_group_security_rules + name: network_security_group_security_rules + title: Network Security Group Security Rules + methods: + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1networkSecurityGroups~1{networkSecurityGroupId}~1actions~1updateSecurityRules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + list: + operation: + $ref: '#/paths/~1networkSecurityGroups~1{networkSecurityGroupId}~1securityRules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.network_security_group_security_rules + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListNetworkSecurityGroupSecurityRulesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"network_security_group_security_rules\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/network_security_group_security_rules/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/network_security_group_security_rules/methods/update' + delete: [] + replace: [] + network_security_group_vnics: + id: oci.network.network_security_group_vnics + name: network_security_group_vnics + title: Network Security Group Vnics + methods: + list: + operation: + $ref: '#/paths/~1networkSecurityGroups~1{networkSecurityGroupId}~1vnics/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.network_security_group_vnics + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListNetworkSecurityGroupVnicsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"network_security_group_vnics\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/network_security_group_vnics/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + networking_topologies: + id: oci.network.networking_topologies + name: networking_topologies + title: Networking Topologies + methods: + get: + operation: + $ref: '#/paths/~1networkingTopology/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/networking_topologies/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + private_ips: + id: oci.network.private_ips + name: private_ips + title: Private Ips + methods: + list: + operation: + $ref: '#/paths/~1privateIps/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.private_ips + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListPrivateIpsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"private_ips\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1privateIps/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + bulk_create_private_ips: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1privateIps~1actions~1bulkCreatePrivateIps/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + bulk_delete_private_ips: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1privateIps~1actions~1bulkDeletePrivateIps/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + bulk_detach_private_ips: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1privateIps~1actions~1bulkDetachPrivateIps/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + bulk_update_private_ips: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1privateIps~1actions~1bulkUpdatePrivateIps/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1privateIps~1{privateIpId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1privateIps~1{privateIpId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1privateIps~1{privateIpId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + private_ip_vnic_detach: + operation: + $ref: '#/paths/~1privateIps~1{privateIpId}~1actions~1detach/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/private_ips/methods/get' + - $ref: '#/components/x-stackQL-resources/private_ips/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/private_ips/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/private_ips/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/private_ips/methods/delete' + replace: [] + public_ip_pools: + id: oci.network.public_ip_pools + name: public_ip_pools + title: Public Ip Pools + methods: + list: + operation: + $ref: '#/paths/~1publicIpPools/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1publicIpPools/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1publicIpPools~1{publicIpPoolId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1publicIpPools~1{publicIpPoolId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1publicIpPools~1{publicIpPoolId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + add_public_ip_pool_capacity: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1publicIpPools~1{publicIpPoolId}~1actions~1addCapacity/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1publicIpPools~1{publicIpPoolId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + remove_public_ip_pool_capacity: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1publicIpPools~1{publicIpPoolId}~1actions~1removeCapacity/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/public_ip_pools/methods/get' + - $ref: '#/components/x-stackQL-resources/public_ip_pools/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/public_ip_pools/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/public_ip_pools/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/public_ip_pools/methods/delete' + replace: [] + public_ips: + id: oci.network.public_ips + name: public_ips + title: Public Ips + methods: + list: + operation: + $ref: '#/paths/~1publicIps/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.public_ips + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListPublicIpsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"public_ips\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1publicIps/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + get_public_ip_by_ip_address: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1publicIps~1actions~1getByIpAddress/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + get_public_ip_by_private_ip_id: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1publicIps~1actions~1getByPrivateIpId/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1publicIps~1{publicIpId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1publicIps~1{publicIpId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1publicIps~1{publicIpId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1publicIps~1{publicIpId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/public_ips/methods/get' + - $ref: '#/components/x-stackQL-resources/public_ips/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/public_ips/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/public_ips/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/public_ips/methods/delete' + replace: [] + remote_peering_connections: + id: oci.network.remote_peering_connections + name: remote_peering_connections + title: Remote Peering Connections + methods: + list: + operation: + $ref: '#/paths/~1remotePeeringConnections/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.remote_peering_connections + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListRemotePeeringConnectionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"remote_peering_connections\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1remotePeeringConnections/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1remotePeeringConnections~1{remotePeeringConnectionId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1remotePeeringConnections~1{remotePeeringConnectionId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1remotePeeringConnections~1{remotePeeringConnectionId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1remotePeeringConnections~1{remotePeeringConnectionId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + connect_remote_peering_connections: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1remotePeeringConnections~1{remotePeeringConnectionId}~1actions~1connect/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/remote_peering_connections/methods/get' + - $ref: '#/components/x-stackQL-resources/remote_peering_connections/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/remote_peering_connections/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/remote_peering_connections/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/remote_peering_connections/methods/delete' + replace: [] + route_tables: + id: oci.network.route_tables + name: route_tables + title: Route Tables + methods: + list: + operation: + $ref: '#/paths/~1routeTables/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.route_tables + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListRouteTablesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"route_tables\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1routeTables/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1routeTables~1{rtId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1routeTables~1{rtId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1routeTables~1{rtId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1routeTables~1{rtId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/route_tables/methods/get' + - $ref: '#/components/x-stackQL-resources/route_tables/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/route_tables/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/route_tables/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/route_tables/methods/delete' + replace: [] + security_lists: + id: oci.network.security_lists + name: security_lists + title: Security Lists + methods: + list: + operation: + $ref: '#/paths/~1securityLists/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.security_lists + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListSecurityListsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"security_lists\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1securityLists/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1securityLists~1{securityListId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1securityLists~1{securityListId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1securityLists~1{securityListId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1securityLists~1{securityListId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/security_lists/methods/get' + - $ref: '#/components/x-stackQL-resources/security_lists/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/security_lists/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/security_lists/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/security_lists/methods/delete' + replace: [] + service_gateways: + id: oci.network.service_gateways + name: service_gateways + title: Service Gateways + methods: + list: + operation: + $ref: '#/paths/~1serviceGateways/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.service_gateways + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListServiceGatewaysResponse' + transform: + body: |- + {{- $wrapped := printf "{\"service_gateways\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1serviceGateways/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1serviceGateways~1{serviceGatewayId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1serviceGateways~1{serviceGatewayId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1serviceGateways~1{serviceGatewayId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + attach: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1serviceGateways~1{serviceGatewayId}~1actions~1attachService/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1serviceGateways~1{serviceGatewayId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + detach_service_id: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1serviceGateways~1{serviceGatewayId}~1actions~1detachService/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/service_gateways/methods/get' + - $ref: '#/components/x-stackQL-resources/service_gateways/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/service_gateways/methods/attach' + - $ref: '#/components/x-stackQL-resources/service_gateways/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/service_gateways/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/service_gateways/methods/delete' + replace: [] + services: + id: oci.network.services + name: services + title: Services + methods: + list: + operation: + $ref: '#/paths/~1services/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.services + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListServicesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"services\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1services~1{serviceId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/services/methods/get' + - $ref: '#/components/x-stackQL-resources/services/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + subnet_topologies: + id: oci.network.subnet_topologies + name: subnet_topologies + title: Subnet Topologies + methods: + get: + operation: + $ref: '#/paths/~1subnetTopology/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/subnet_topologies/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + subnets: + id: oci.network.subnets + name: subnets + title: Subnets + methods: + list: + operation: + $ref: '#/paths/~1subnets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.subnets + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListSubnetsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"subnets\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1subnets/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1subnets~1{subnetId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1subnets~1{subnetId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1subnets~1{subnetId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + add_ipv4_subnet_cidr: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1subnets~1{subnetId}~1actions~1addIpv4Cidr/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + add_ipv6_subnet_cidr: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1subnets~1{subnetId}~1actions~1addIpv6Cidr/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1subnets~1{subnetId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + modify_ipv4_subnet_cidr: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1subnets~1{subnetId}~1actions~1modifyIpv4Cidr/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + remove_ipv4_subnet_cidr: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1subnets~1{subnetId}~1actions~1removeIpv4Cidr/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + remove_ipv6_subnet_cidr: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1subnets~1{subnetId}~1actions~1removeIpv6Cidr/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/subnets/methods/get' + - $ref: '#/components/x-stackQL-resources/subnets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/subnets/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/subnets/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/subnets/methods/delete' + replace: [] + vcn_topologies: + id: oci.network.vcn_topologies + name: vcn_topologies + title: Vcn Topologies + methods: + get: + operation: + $ref: '#/paths/~1vcnTopology/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/vcn_topologies/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + vcns: + id: oci.network.vcns + name: vcns + title: Vcns + methods: + list: + operation: + $ref: '#/paths/~1vcns/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.vcns + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVcnsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"vcns\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1vcns/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1vcns~1{vcnId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1vcns~1{vcnId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1vcns~1{vcnId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + add_vcn_cidr: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1vcns~1{vcnId}~1actions~1addCidr/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + add_ipv6_vcn_cidr: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1vcns~1{vcnId}~1actions~1addIpv6Cidr/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1vcns~1{vcnId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + modify_vcn_cidr: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1vcns~1{vcnId}~1actions~1modifyCidr/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + remove_vcn_cidr: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1vcns~1{vcnId}~1actions~1removeCidr/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + remove_ipv6_vcn_cidr: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1vcns~1{vcnId}~1actions~1removeIpv6Cidr/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/vcns/methods/get' + - $ref: '#/components/x-stackQL-resources/vcns/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/vcns/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/vcns/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/vcns/methods/delete' + replace: [] + virtual_circuit_bandwidth_shapes: + id: oci.network.virtual_circuit_bandwidth_shapes + name: virtual_circuit_bandwidth_shapes + title: Virtual Circuit Bandwidth Shapes + methods: + list: + operation: + $ref: '#/paths/~1virtualCircuitBandwidthShapes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.virtual_circuit_bandwidth_shapes + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVirtualCircuitBandwidthShapesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"virtual_circuit_bandwidth_shapes\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/virtual_circuit_bandwidth_shapes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + virtual_circuits: + id: oci.network.virtual_circuits + name: virtual_circuits + title: Virtual Circuits + methods: + list: + operation: + $ref: '#/paths/~1virtualCircuits/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.virtual_circuits + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVirtualCircuitsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"virtual_circuits\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1virtualCircuits/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1virtualCircuits~1{virtualCircuitId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1virtualCircuits~1{virtualCircuitId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1virtualCircuits~1{virtualCircuitId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + bulk_add_virtual_circuit_public_prefixes: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1virtualCircuits~1{virtualCircuitId}~1actions~1bulkAddPublicPrefixes/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + bulk_delete_virtual_circuit_public_prefixes: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1virtualCircuits~1{virtualCircuitId}~1actions~1bulkDeletePublicPrefixes/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1virtualCircuits~1{virtualCircuitId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/virtual_circuits/methods/get' + - $ref: '#/components/x-stackQL-resources/virtual_circuits/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/virtual_circuits/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/virtual_circuits/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/virtual_circuits/methods/delete' + replace: [] + virtual_circuit_associated_tunnels: + id: oci.network.virtual_circuit_associated_tunnels + name: virtual_circuit_associated_tunnels + title: Virtual Circuit Associated Tunnels + methods: + list: + operation: + $ref: '#/paths/~1virtualCircuits~1{virtualCircuitId}~1associatedTunnels/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.virtual_circuit_associated_tunnels + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVirtualCircuitAssociatedTunnelsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"virtual_circuit_associated_tunnels\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/virtual_circuit_associated_tunnels/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + cross_connect_mappings: + id: oci.network.cross_connect_mappings + name: cross_connect_mappings + title: Cross Connect Mappings + methods: + list: + operation: + $ref: '#/paths/~1virtualCircuits~1{virtualCircuitId}~1crossConnectMappings/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cross_connect_mappings/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + virtual_circuit_public_prefixes: + id: oci.network.virtual_circuit_public_prefixes + name: virtual_circuit_public_prefixes + title: Virtual Circuit Public Prefixes + methods: + list: + operation: + $ref: '#/paths/~1virtualCircuits~1{virtualCircuitId}~1publicPrefixes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.virtual_circuit_public_prefixes + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVirtualCircuitPublicPrefixesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"virtual_circuit_public_prefixes\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/virtual_circuit_public_prefixes/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + vlans: + id: oci.network.vlans + name: vlans + title: Vlans + methods: + list: + operation: + $ref: '#/paths/~1vlans/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.vlans + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVlansResponse' + transform: + body: |- + {{- $wrapped := printf "{\"vlans\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1vlans/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1vlans~1{vlanId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1vlans~1{vlanId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1vlans~1{vlanId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1vlans~1{vlanId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/vlans/methods/get' + - $ref: '#/components/x-stackQL-resources/vlans/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/vlans/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/vlans/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/vlans/methods/delete' + replace: [] + vnics: + id: oci.network.vnics + name: vnics + title: Vnics + methods: + get: + operation: + $ref: '#/paths/~1vnics~1{vnicId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1vnics~1{vnicId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/vnics/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/vnics/methods/update' + delete: [] + replace: [] + vtaps: + id: oci.network.vtaps + name: vtaps + title: Vtaps + methods: + list: + operation: + $ref: '#/paths/~1vtaps/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.vtaps + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListVtapsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"vtaps\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 100 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1vtaps/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1vtaps~1{vtapId}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1vtaps~1{vtapId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1vtaps~1{vtapId}/put' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1vtaps~1{vtapId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/vtaps/methods/get' + - $ref: '#/components/x-stackQL-resources/vtaps/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/vtaps/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/vtaps/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/vtaps/methods/delete' + replace: [] +servers: + - url: https://iaas.{region}.oraclecloud.com/20160918 + variables: + region: + default: us-ashburn-1 + description: OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. + x-stackQL-envVar: OCI_REGION +x-stackQL-config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: opc-next-page + location: header diff --git a/providers/src/oci/v00.00.00000/services/object_storage.yaml b/providers/src/oci/v00.00.00000/services/object_storage.yaml new file mode 100644 index 00000000..e2e11176 --- /dev/null +++ b/providers/src/oci/v00.00.00000/services/object_storage.yaml @@ -0,0 +1,10232 @@ +openapi: 3.0.0 +info: + title: object_storage API + description: oci object_storage API + version: '20160918' +paths: + /n/: + get: + description: | + Each Oracle Cloud Infrastructure tenant is assigned one unique and uneditable Object Storage namespace. The namespace + is a system-generated string assigned during account creation. For some older tenancies, the namespace string may be + the tenancy name in all lower-case letters. You cannot edit a namespace. + + GetNamespace returns the name of the Object Storage namespace for the user making the request. + If an optional compartmentId query parameter is provided, GetNamespace returns the namespace name of the corresponding + tenancy, provided the user has access to it. + operationId: GetNamespace + parameters: + - $ref: '#/components/parameters/ClientRequestIdHeader' + - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' + responses: + '200': + description: The requesting user's Object Storage namespace string. + content: + application/json: + schema: + pattern: '[A-Za-z][A-Za-z0-9\\-_\\.]+' + type: string + application-json: + examples: + response: + value: | + "ansh8lvru1zp" + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: GET Namespace Name + tags: + - objectStorage + x-example: | + GET /n/ HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 12 Aug 2016 22:42:15 GMT + authorization: <authorization and other headers> + x-related-resource: '#/definitions/Namespace' + /n/{namespaceName}: + get: + description: | + Gets the metadata for the Object Storage namespace, which contains defaultS3CompartmentId and + defaultSwiftCompartmentId. + + Any user with the OBJECTSTORAGE_NAMESPACE_READ permission will be able to see the current metadata. If you are + not authorized, talk to an administrator. If you are an administrator who needs to write policies + to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + operationId: GetNamespaceMetadata + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '200': + description: The default metadata. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/NamespaceMetadata' + application-json: + examples: + response: + value: | + [ + { + "namespace": "ansh8lvru1zp", + "defaultS3CompartmentId": "ocid.compartment.oc1..exampleuniquecompartmentS3ID", + "defaultSwiftCompartmentId": "ocid.compartment.oc1..exampleuniquecompartmentSwiftID" + } + ] + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: GET Namespace Metadata + tags: + - objectStorage + x-example: | + GET /n/<namespace_metadata> HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 12 Aug 2016 22:42:15 GMT + authorization: <authorization and other headers> + x-related-resource: '#/definitions/Namespace' + put: + description: | + By default, buckets created using the Amazon S3 Compatibility API or the Swift API are created in the root + compartment of the Oracle Cloud Infrastructure tenancy. + + You can change the default Swift/Amazon S3 compartmentId designation to a different compartmentId. All + subsequent bucket creations will use the new default compartment, but no previously created + buckets will be modified. A user must have OBJECTSTORAGE_NAMESPACE_UPDATE permission to make changes to the default + compartments for Amazon S3 and Swift. + operationId: UpdateNamespaceMetadata + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateNamespaceMetadataDetails' + description: Request object for update NamespaceMetadata. + required: true + responses: + '200': + description: The updated NamespaceMetadata information. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/NamespaceMetadata' + application-json: + examples: + response: + value: | + { + "name": "ansh8lvru1zp", + "defaultS3CompartmentId": "ocid.compartment.oc1..exampleuniquecompartmentS3ID", + "defaultSwiftCompartmentId": "ocid.compartment.oc1..exampleuniquecompartmentS3ID" + } + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: PUT Namespace + tags: + - objectStorage + x-example: | + PUT /n/<namespace_metadata> HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 12 Aug 2016 22:50:18 GMT + content-type: application/json + authorization: <authorization and other headers> + { + "defaultS3CompartmentId": "ocid.compartment.oc1..exampleuniquecompartmentS3ID", + "defaultSwiftCompartmentId": "ocid.compartment.oc1..exampleuniquecompartmentSwiftID" + } + x-related-resource: '#/definitions/Namespace' + /n/{namespaceName}/b/: + get: + description: | + Gets a list of all BucketSummary items in a compartment. A BucketSummary contains only summary fields for the bucket + and does not contain fields like the user-defined metadata. + + ListBuckets returns a BucketSummary containing at most 1000 buckets. To paginate through more buckets, use the returned + `opc-next-page` value with the `page` request parameter. + + To use this and other API operations, you must be authorized in an IAM policy. If you are not authorized, + talk to an administrator. If you are an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + operationId: ListBuckets + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/ListBucketFieldsQueryParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '200': + description: A page of BucketSummary objects. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-next-page: + description: | + For paginating a list of buckets. + In the GET request, set the limit to the number of buckets items that you want returned in the response. + If the `opc-next-page` header appears in the response, then this is a partial list and there are additional + buckets to get. Include the header's value as the `page` parameter in the subsequent GET request to get the + next batch of buckets. Repeat this process to retrieve the entire list of buckets. + By default, the page limit is set to 25 buckets per page, but you can specify a value from 1 to 1000. + + For more 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, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ListBucketsResponse' + application-json: + examples: + response: + value: | + [ + { + "namespace": "ansh8lvru1zp", + "name": "MyBucket_1", + "compartmentId": "ocid.compartment.oc1..exampleuniquecompartment1ID", + "createdBy": "ocid1.user.oc1..exampleuniqueuserID", + "timeCreated": "2016-08-09T01:11:38.639Z", + "etag": "dc450b1e-a22c-479a-aae2-a5903e519661" + }, + { + "namespace": "ansh8lvru1zp", + "name": "MyBucket_2", + "compartmentId": "ocid.compartment.oc1..exampleuniquecompartment2ID", + "createdBy": "ocid1.user.oc1..exampleuniqueuser2ID", + "timeCreated": "2016-08-09T00:41:50.236Z", + "etag": "31e21d43-41e8-42b0-beb8-cc0baa50ef94" + }, + { + "namespace": "ansh8lvru1zp", + "name": "MyBucket_3", + "compartmentId": "ocid.compartment.oc1..exampleuniquecompartment3ID", + "createdBy": "ocid1.user.oc1..exampleuniqueuserID", + "timeCreated": "2016-08-08T21:18:37.448Z", + "etag": "ed042fb0-a22f-48cc-a6d3-5590ee0bd0d2" + }, + { + "namespace": "ansh8lvru1zp", + "name": "MyBucket_4", + "compartmentId": "ocid.compartment.oc1..exampleuniquecompartment4ID", + "createdBy": "ocid1.user.oc1..exampleuniqueuserID", + "timeCreated": "2017-01-20T00:25:55.758Z", + "etag": "21edf865-d3d9-424f-8218-37188e803db8" + }, + { + "namespace": "ansh8lvru1zp", + "name": "MyBucket_5", + "compartmentId": "ocid.compartment.oc1..exampleuniquecompartment5ID", + "createdBy": "ocid1.user.oc1..exampleuniqueuserID", + "timeCreated": "2017-01-20T19:12:41.886Z", + "etag": "30d83c79-dd32-4c07-ace9-9240ed7083fd" + } + ] + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: List Buckets + tags: + - objectStorage + x-example: | + GET /n/<namespace_string>/b/ HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 20 Jan 2017 22:52:33 GMT + authorization: <authorization and other headers> + x-related-resource: '#/definitions/Bucket' + post: + description: | + Creates a bucket in the given namespace with a bucket name and optional user-defined metadata. Avoid entering + confidential information in bucket names. + operationId: CreateBucket + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBucketDetails' + description: Request object for creating a bucket. + required: true + responses: + '200': + description: The complete bucket representation, including fields set by the server. + headers: + ETag: + description: The entity tag (ETag) for the bucket that was created. + schema: + type: string + Location: + description: The full path to the bucket that was created. + schema: + type: string + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Bucket' + application-json: + examples: + response: + value: | + { + "namespace": "ansh8lvru1zp", + "name": "MyBucket6", + "compartmentId": "ocid.compartment.oc1..exampleuniquecompartmentID", + "id": "ocid1.bucket.oc1.iad.examplebucketID", + "createdBy": "ocid1.user.oc1..exampleuniqueuserID", + "timeCreated": "2016-08-09T01:11:38.639Z", + "metadata": {}, + "etag": "21edf865-d3d9-424f-8218-37188e803db8", + "freeformTags": {"Department" : "Finance"}, + "definedTags": + { + "MyTags": + { + "CostCenter": "42", + "Project": "Stealth", + "CreatedBy": "BillSmith", + "CreatedDate": "9/21/2017T14:00" + }, + "Audit": + { + "DataSensitivity": "PII", + "CageSecurity": "High", + "Simplicity": "complex" + } + } + } + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '409': + $ref: '#/components/responses/NotAuthorizedOrInternalConflict' + '411': + $ref: '#/components/responses/ContentLengthRequired' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Create Bucket + tags: + - objectStorage + x-example: | + POST /n/<namespace_string>/b/ HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 12 Aug 2016 22:50:18 GMT + x-content-sha256: GzeGbC8Ad9cEhdcnD2wjPiUej5TIHHw2I+uj4w7Jot4= + Content-Length: 148 + content-type: application/json + authorization: <authorization and other headers> + { + "compartmentId": "ocid.compartment.oc1..exampleuniquecompartmentID", + "namespace": "ansh8lvru1zp", + "objectEventsEnabled": true, + "name": "my-test-1", + "freeformTags": {"Department": "Finance"}, + "definedTags": + { + "MyTags": + { + "CostCenter": "42", + "Project": "Stealth", + "CreatedBy": "BillSmith", + "CreatedDate": "9/21/2017T14:00" + }, + "Audit": + { + "DataSensitivity": "PII", + "CageSecurity": "High", + "Simplicity": "complex" + } + } + } + x-related-resource: '#/definitions/Bucket' + /n/{namespaceName}/b/{bucketName}/: + delete: + description: | + Deletes a bucket if the bucket is already empty. If the bucket is not empty, use + [DeleteObject](#/en/objectstorage/20160918/Object/DeleteObject) first. In addition, + you cannot delete a bucket that has a multipart upload in progress or a pre-authenticated + request associated with that bucket. + operationId: DeleteBucket + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '204': + description: The response body is always empty. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '409': + $ref: '#/components/responses/NotAuthorizedOrInternalConflict' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: DELETE Bucket + tags: + - objectStorage + x-example: | + DELETE /n/<namespace_string>/b/<bucket_name> HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 12 Aug 2016 23:04:28 GMT + content-length: 0 + authorization: <authorization and other headers> + x-related-resource: '#/definitions/Bucket' + get: + description: | + Gets the current representation of the given bucket in the given Object Storage namespace. + operationId: GetBucket + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfNoneMatchHeaderExceptStar' + - $ref: '#/components/parameters/ClientRequestIdHeader' + - $ref: '#/components/parameters/GetBucketFieldsQueryParam' + responses: + '200': + description: A bucket representation for the requested bucket. + headers: + ETag: + description: The current entity tag (ETag) for the bucket. + schema: + type: string + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Bucket' + application-json: + examples: + response: + value: | + { + "namespace": "ansh8lvru1zp", + "name": "MyBucket", + "compartmentId": "ocid.compartment.oc1..exampleuniquecompartmentID", + "id": "ocid1.bucket.oc1.iad.examplebucketID", + "createdBy": "ocid1.user.oc1..exampleuniqueuserID", + "timeCreated": "2016-08-08T03:48:40.511Z", + "metadata": {}, + "etag": "9282a931-6367-4e8a-85d0-cfe9796b20ef", + "freeformTags": {"Department": "Finance"}, + "definedTags": + { + "MyTags": + { + "CostCenter": "42", + "Project": "Stealth", + "CreatedBy": "BillSmith", + "CreatedDate": "9/21/2017T14:00" + }, + "Audit": + { + "DataSensitivity": "PII", + "CageSecurity": "High", + "Simplicity": "complex" + } + } + } + '304': + description: Not Modified + headers: + ETag: + description: The current entity tag (ETag) for the bucket. + schema: + type: string + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: GET Bucket + tags: + - objectStorage + x-example: | + GET /n/<namespace_string>/b/<bucket_name> HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 12 Aug 2016 22:52:33 GMT + authorization: <authorization and other headers> + x-related-resource: '#/definitions/Bucket' + head: + description: | + Efficiently checks to see if a bucket exists and gets the current entity tag (ETag) for the bucket. + operationId: HeadBucket + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfNoneMatchHeaderExceptStar' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '200': + description: The bucket exists. + headers: + ETag: + description: The current entity tag (ETag) for the bucket. + schema: + type: string + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + '304': + description: Not Modified + headers: + ETag: + description: The current entity tag (ETag) for the bucket. + schema: + type: string + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: HEAD Bucket + tags: + - objectStorage + x-example: | + HEAD /n/<namespace_string>/b/<bucket_name> HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 12 Aug 2016 22:52:33 GMT + authorization: <authorization and other headers> + x-related-resource: '#/definitions/Bucket' + post: + description: | + Performs a partial or full update of a bucket's user-defined metadata. + + Use UpdateBucket to move a bucket from one compartment to another within the same tenancy. Supply the compartmentID + of the compartment that you want to move the bucket to. For more information about moving resources between compartments, + see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + operationId: UpdateBucket + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/ClientRequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBucketDetails' + description: Request object for updating a bucket. + required: true + responses: + '200': + description: The full representation of the bucket, including fields set by the server. + headers: + ETag: + description: The entity tag (ETag) for the updated bucket. + schema: + type: string + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Bucket' + application-json: + examples: + response: + value: | + { + "compartmentId": "ocid.compartment.oc1..exampleuniquecompartmentID", + "id": "ocid1.bucket.oc1.iad.examplebucketID", + "createdBy": "ocid1.user.oc1..exampleuniqueuserID", + "etag": "82361183-a765-4e51-be48-933518c6ee5a", + "metadata": + { + "foo": "bar" + }, + "name": "MyBucket", + "namespace": "ansh8lvru1zp", + "timeCreated": "2016-08-23T20:58:02.497Z", + "freeformTags": {"Department": "Finance"}, + "definedTags": + { + "MyTags": + { + "CostCenter": "42", + "Project": "Stealth", + "CreatedBy": "BillSmith", + "CreatedDate": "9/21/2017T14:00" + }, + "Audit": + { + "DataSensitivity": "PII", + "CageSecurity": "High", + "Simplicity": "complex" + } + } + } + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '409': + $ref: '#/components/responses/NotAuthorizedOrInternalConflict' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: POST Bucket + tags: + - objectStorage + x-example: | + POST /n/<namespace_string>/b/<bucket_name> HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.10.0 + date: Tue, 23 Aug 2016 21:01:55 GMT + x-content-sha256: XK0yY+agfR3IHWjFyQlO5LCU8IysvgpDdDGSRrb/xzA= + Content-Length: 80 + content-type: application/json + authorization: <authorization and other headers> + { + "namespace": "ansh8lvru1zp", + "name": "MyBucket", + "metadata": + { + "foo": "bar" + }, + "objectEventsEnabled": true, + "freeformTags": {"Department": "Finance"}, + "definedTags": + { + "MyTags": + { + "CostCenter": "42", + "Project": "Stealth", + "CreatedBy": "BillSmith", + "CreatedDate": "9/21/2017T14:00" + }, + "Audit": + { + "DataSensitivity": "PII", + "CageSecurity": "High", + "Simplicity": "complex" + } + } + } + x-related-resource: '#/definitions/Bucket' + /n/{namespaceName}/b/{bucketName}/actions/batchDeleteObjects: + post: + description: Deletes a batch of objects. + operationId: BatchDeleteObjects + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchDeleteObjectsDetails' + description: Details about batch of objects to be deleted. + required: true + responses: + '200': + description: Always returns this status code if the request was processed after validation, authentication and authorization. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/BatchDeleteObjectsResult' + application-json: + examples: + response: + value: | + { + "deleted": [ + { + "objectName": "object1", + "lastModified": "2016-08-09T01:11:38.639Z" + } + ], + "failures": [ + { + "objectName": "object2", + "status": 409, + "error": "conflict" + }, + { + "objectName": "object3", + "status": 412, + "error": "precondition failed" + } + ] + } + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Deletes a batch of objects. + tags: + - objectStorage + x-example: | + POST /n/example_namespace/b/example_bucket/actions/deleteObjects + Host: objectstorage.us-phoenix-1.oraclecloud.com + User-Agent: curl/7.43.0 + Accept: */* + Content-Type: application/json + Content-Length: 139 + Date: Fri, 31 Oct 2025 11:50:24 GMT + Authorization: <authorization_string> + { + "objects": [ + { + "objectName": "object1", + "ifMatch": "etag1" + }, + { + "objectName": "object2", + "ifMatch": "etag1" + }, + { + "objectName": "object3", + } + ], + "isSkipDeletedResult": false + } + x-related-resource: '#/definitions/Object' + /n/{namespaceName}/b/{bucketName}/actions/copyObject: + post: + description: | + Creates a request to copy an object within a region or to another region. + + See [Object Names](/Content/Object/Tasks/managingobjects.htm#namerequirements) + for object naming requirements. + operationId: CopyObject + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + - $ref: '#/components/parameters/OptionalSSECustomerAlgorithmHeader' + - $ref: '#/components/parameters/OptionalSSECustomerKeyHeader' + - $ref: '#/components/parameters/OptionalSSECustomerKeySHA256Header' + - $ref: '#/components/parameters/OptionalSrcSSECustomerAlgorithmHeader' + - $ref: '#/components/parameters/OptionalSrcSSECustomerKeyHeader' + - $ref: '#/components/parameters/OptionalSrcSSECustomerKeySHA256Header' + - $ref: '#/components/parameters/OptionalSSEKMSKeyIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CopyObjectDetails' + description: The source and destination of the object to be copied. + required: true + responses: + '202': + description: The request has been accepted for processing, but the processing has not completed. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. If you need to contact Oracle about a + particular request, provide this request ID. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Creates a copy object request. + tags: + - objectStorage + x-example: | + POST /n/<namespace>/b/<bucket_name>/actions/copyObject + Host: objectstorage.us-phoenix-1.oraclecloud.com + User-Agent: curl/7.43.0 + Accept: */* + Content-Type: application/json + Content-Length: 139 + Date: Fri, 10 Mar 2017 11:50:24 GMT + Authorization: <authorization and other headers> + { + "sourceObjectName": "backup.tar.gz", + "sourceObjectIfMatchETag": "*", + "destinationRegion": "uk-london-1", + "destinationNamespace": "ansh8lvru1zp", + "destinationBucket": "backup", + "destinationObjectName": "backup2.tar.gz", + "destinationObjectIfMatchETag": "*", + "destinationObjectIfNoneMatchETag": "*", + "destinationObjectMetadata": {"opc-meta-a" : "b"} + } + x-related-resource: '#/definitions/Object' + /n/{namespaceName}/b/{bucketName}/actions/makeBucketWritable: + post: + description: | + Stops replication to the destination bucket and removes the replication policy. When the replication + policy was created, this destination bucket became read-only except for new and changed objects replicated + automatically from the source bucket. MakeBucketWritable removes the replication policy. This bucket is no + longer the target for replication and is now writable, allowing users to make changes to bucket contents. + operationId: MakeBucketWritable + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '200': + description: The replication policy associated with the bucket is removed. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Stops the replication policy associated with a destination bucket. + tags: + - objectStorage + x-example: | + POST /n/<namespace_string>/b/<bucket_name>/actions/makeBucketWritable HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.10.0 + date: Fri, 19 Aug 2016 23:39:51 GMT + authorization: <authorization_string> + x-related-resource: '#/definitions/Replication' + /n/{namespaceName}/b/{bucketName}/actions/reencrypt: + post: + description: | + Re-encrypts the unique data encryption key that encrypts each object written to the bucket by using the most recent + version of the master encryption key assigned to the bucket. (All data encryption keys are encrypted by a master + encryption key. Master encryption keys are assigned to buckets and managed by Oracle by default, but you can assign + a key that you created and control through the Oracle Cloud Infrastructure Key Management service.) The kmsKeyId property + of the bucket determines which master encryption key is assigned to the bucket. If you assigned a different Key Management + master encryption key to the bucket, you can call this API to re-encrypt all data encryption keys with the newly + assigned key. Similarly, you might want to re-encrypt all data encryption keys if the assigned key has been rotated to + a new key version since objects were last added to the bucket. If you call this API and there is no kmsKeyId associated + with the bucket, the call will fail. + Also, if you set isBucketKeyEnabled, you might want to re-encrypt all data encryption keys + using the bucket key. This will help reduce calls to OCI Vault KMS when older objects are downloaded. + + Calling this API starts a work request task to re-encrypt the data encryption key of all objects in the bucket. Only + objects created before the time of the API call will be re-encrypted. The call can take a long time, depending on how many + objects are in the bucket and how big they are. This API returns a work request ID that you can use to retrieve the status + of the work request task. + All the versions of objects will be re-encrypted whether versioning is enabled or suspended at the bucket. + operationId: ReencryptBucket + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ReencryptBucketKeyOnlyQueryParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '202': + description: The request has been accepted for processing, but the processing is not yet done. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. If you need to contact Oracle about a + particular request, provide this request ID. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '409': + $ref: '#/components/responses/NotAuthorizedOrInternalConflict' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Re-encrypt Bucket Data Encryption Key + tags: + - objectStorage + x-example: | + POST /n/<namespace_string>/b/<bucket_name>/actions/reencrypt HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 12 Aug 2016 22:50:18 GMT + content-type: application/json + authorization: <authorization and other headers> + x-related-resource: '#/definitions/Bucket' + /n/{namespaceName}/b/{bucketName}/actions/reencrypt/{objectName}: + post: + description: | + Re-encrypts the data encryption keys that encrypt the object and its chunks. By default, when you create a bucket, the Object Storage + service manages the master encryption key used to encrypt each object's data encryption keys. The encryption mechanism that you specify for + the bucket applies to the objects it contains. + + You can alternatively employ one of these encryption strategies for an object: + + - You can assign a key that you created and control through the Oracle Cloud Infrastructure Vault service. + + - You can encrypt an object using your own encryption key. The key you supply is known as a customer-provided encryption key (SSE-C). + operationId: ReencryptObject + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ObjectPathParam' + - $ref: '#/components/parameters/VersionIdQueryParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ReencryptObjectDetails' + description: Request object for re-encrypting the data encryption key associated with an object. + required: true + responses: + '200': + description: The data encryption key of the object was successfully re-encrypted. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Re-encrypt the data encryption keys associated with an object + tags: + - objectStorage + x-example: | + POST /n/<namespace_string>/b/<bucket_name>/actions/reencrypt/<example_object> HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 12 Aug 2016 22:50:18 GMT + content-type: application/json + authorization: <authorization and other headers> + { + "kmsKeyId" : "ocid1.key.region1.sea.examplemaag4s.examples3wg32j37cvbyhs5edj3qxlblk6sevxr7faux4cbc5wyctpnsukva" + } + x-related-resource: '#/definitions/Object' + /n/{namespaceName}/b/{bucketName}/actions/renameObject: + post: + description: | + Rename an object in the given Object Storage namespace. + + See [Object Names](/Content/Object/Tasks/managingobjects.htm#namerequirements) + for object naming requirements. + operationId: RenameObject + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RenameObjectDetails' + description: The sourceName and newName of rename operation. Avoid entering confidential information. + required: true + responses: + '200': + description: The object was successfully renamed. + headers: + ETag: + description: The entity tag (ETag) for the object. + schema: + type: string + last-modified: + description: The time the object was modified, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). + schema: + type: string + format: date-time + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + version-id: + description: VersionId of the renamed object + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Rename Object + tags: + - objectStorage + x-example: | + POST /n/<namespace_string>/b/<bucket_name>/actions/renameObject HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 12 Aug 2016 22:50:18 GMT + content-type: application/json + authorization: <authorization and other headers> + { + "sourceName" : "SourceObjectName", + "newName" : "TargetObjectName", + "srcObjIfMatchETag": "*", + "newObjIfMatchETag": "*", + "newObjIfNoneMatchETag": "*" + } + x-related-resource: '#/definitions/Object' + /n/{namespaceName}/b/{bucketName}/actions/restoreObjects: + post: + description: | + Restores the object specified by the objectName parameter. + By default object will be restored for 24 hours. Duration can be configured using the hours parameter. + operationId: RestoreObjects + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RestoreObjectsDetails' + description: Request to restore object. + required: true + responses: + '200': + description: The object is already restored. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + '202': + description: Accepted the request. The object will be restored. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Restore Object + tags: + - objectStorage + x-example: | + POST /n/<namespace_string>/b/<bucket_name>/actions/restoreObjects HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 12 Aug 2017 23:01:51 GMT + authorization: <authorization and other headers> + { + "objectName" : "objectNameFoo" + "hours" : 48 + } + x-related-resource: '#/definitions/Object' + /n/{namespaceName}/b/{bucketName}/actions/updateObjectStorageTier: + post: + description: | + Changes the storage tier of the object specified by the objectName parameter. + operationId: UpdateObjectStorageTier + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateObjectStorageTierDetails' + description: The object name and the desired storage tier. + required: true + responses: + '200': + description: The object storage tier has been changed successfully. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Move the object into a different storage tier + tags: + - objectStorage + x-example: | + POST /n/<namespace_string>/b/<bucket_name>/actions/updateObjectStorageTier HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Wed, 19 Aug 2020 21:00:18 GMT + content-type: application/json + authorization: <authorization and other headers> + { + "objectName" : "objectNameFoo" + "storageTier" : "InfrequentAccess" + } + x-related-resource: '#/definitions/Object' + /n/{namespaceName}/b/{bucketName}/l: + delete: + description: | + Deletes the object lifecycle policy for the bucket. + operationId: DeleteObjectLifecyclePolicy + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The object lifecycle policy has been deleted successfully. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, + provide this request ID. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Delete object lifecycle policy + tags: + - objectStorage + x-example: | + DELETE /n/<namespace_string>/b/<bucket_name>/l + Host: objectstorage.us-phoenix-1.oraclecloud.com + User-Agent: curl/7.43.0 + Accept: */* + Date: Fri, 10 Mar 2017 11:50:24 GMT + Authorization: <authorization and other headers> + x-related-resource: '#/definitions/ObjectLifecyclePolicy' + get: + description: | + Gets the object lifecycle policy for the bucket. + operationId: GetObjectLifecyclePolicy + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '200': + description: The object lifecycle policy of the bucket. + headers: + ETag: + description: The entity tag (ETag) for the object lifecycle policy. + schema: + type: string + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, + provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectLifecyclePolicy' + application-json: + examples: + response: + value: | + { + "timeCreated": "2017-10-13T17:23:46.000Z", + "items": [ + { + "name": "sampleRule", + "action": "ARCHIVE", + "objectNameFilter": + { + "inclusionPrefixes": [ + "samplePrefix" + ], + "inclusionPatterns": [ + "*.txt", "*.log", "prefix*" + ], + "exclusionPatterns": [ + "*.pdf", "*.tmp" + ] + }, + "timeAmount": 3, + "timeUnit": "DAYS", + "isEnabled": false + } + ] + }, + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: GET object lifecycle policy + tags: + - objectStorage + x-example: | + GET /n/<namespace_string>/b/<bucket_name>/l + Host: objectstorage.us-phoenix-1.oraclecloud.com + User-Agent: curl/7.43.0 + Accept: */* + Date: Fri, 10 Mar 2017 11:50:24 GMT + Authorization: <authorization and other headers> + put: + description: | + Creates or replaces the object lifecycle policy for the bucket. + operationId: PutObjectLifecyclePolicy + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfNoneMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PutObjectLifecyclePolicyDetails' + description: The lifecycle policy to apply to the bucket. + required: true + responses: + '200': + description: The object lifecycle policy representation. + headers: + ETag: + description: The entity tag (ETag) for the object lifecycle policy. + schema: + type: string + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, + provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectLifecyclePolicy' + application-json: + examples: + response: + value: | + { + "timeCreated": "2017-10-13T17:23:46.000Z", + "items": [ + { + "name": "sampleRule", + "target" : "objects", + "action": "ARCHIVE", + "objectNameFilter": + { + "inclusionPrefixes": [ + "samplePrefix" + ], + "inclusionPatterns": [ + "*.txt", "*.log", "prefix*" + ], + "exclusionPatterns": [ + "*.pdf", "*.tmp" + ] + }, + "timeAmount": 3, + "timeUnit": "DAYS", + "isEnabled": false + }, + { + "name": "sampleRule2", + "target" : "previous-object-versions", + "action": "ARCHIVE", + "objectNameFilter": + { + "inclusionPrefixes": [ + "samplePrefix" + ], + "inclusionPatterns": [ + "*.txt", "*.log", "prefix*" + ], + "exclusionPatterns": [ + "*.pdf", "*.tmp" + ] + }, + "timeAmount": 3, + "timeUnit": "DAYS", + "isEnabled": false + } + ] + } + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Put object lifecycle policy. + tags: + - objectStorage + x-example: | + PUT /n/<namespace_string>/b/<bucket_name>/l + Host: objectstorage.us-phoenix-1.oraclecloud.com + User-Agent: curl/7.43.0 + Accept: */* + Content-Type: application/json + Content-Length: 139 + Date: Fri, 10 Mar 2017 11:50:24 GMT + Authorization: <authorization and other headers> + { + "items": [ + { + "name": "sampleRule", + "target" : "objects", + "action": "ARCHIVE", + "objectNameFilter": + { + "inclusionPrefixes": [ + "samplePrefix" + ], + "inclusionPatterns": [ + "*.txt", "*.log", "prefix*" + ], + "exclusionPatterns": [ + "*.pdf", "*.tmp" + ] + }, + "timeAmount": 3, + "timeUnit": "DAYS", + "isEnabled": false + }, + { + "name": "sampleRule2", + "target" : "objects", + "action": "DELETE", + "objectNameFilter": + { + "inclusionPrefixes": [ + "samplePrefix2" + ], + "inclusionPatterns": [ + "*.txt", "*.log", "prefix*" + ], + "exclusionPatterns": [ + "*.pdf", "*.tmp" + ] + }, + "timeAmount": 3, + "timeUnit": "DAYS", + "isEnabled": true + }, + { + "name": "sampleRule3", + "target" : "multipart-uploads", + "action": "ABORT", + "timeAmount": 7, + "timeUnit": "DAYS", + "isEnabled": true + + }, + { + "name": "sampleRule4", + "target" : "previous-object-versions", + "action": "ARCHIVE", + "objectNameFilter": + { + "inclusionPrefixes": [ + "samplePrefix4" + ], + "inclusionPatterns": [ + "*.txt", "*.log", "prefix*" + ], + "exclusionPatterns": [ + "*.pdf", "*.tmp" + ] + }, + "timeAmount": 3, + "timeUnit": "DAYS", + "isEnabled": false + }, + { + "name": "sampleRule5", + "target" : "previous-object-versions", + "action": "DELETE", + "objectNameFilter": + { + "inclusionPrefixes": [ + "samplePrefix5" + ], + "inclusionPatterns": [ + "*.txt", "*.log", "prefix*" + ], + "exclusionPatterns": [ + "*.pdf", "*.tmp" + ] + }, + "timeAmount": 3, + "timeUnit": "DAYS", + "isEnabled": true + }, + { + "name": "sampleRule6", + "action": "INFREQUENT_ACCESS", + "objectNameFilter": + { + "inclusionPatterns": [ + "*.xml" + ], + "exclusionPatterns": [ + "*.dat", "*.tmp" + ] + }, + "timeAmount": 3, + "timeUnit": "DAYS", + "isEnabled": true + } + ] + } + /n/{namespaceName}/b/{bucketName}/o: + get: + description: | + Lists the objects in a bucket. By default, ListObjects returns object names only. See the `fields` + parameter for other fields that you can optionally include in ListObjects response. + + ListObjects returns at most 1000 objects. To paginate through more objects, use the returned 'nextStartWith' + value with the 'start' parameter. To filter which objects ListObjects returns, use the 'start' and 'end' + parameters. + + To use this and other API operations, you must be authorized in an IAM policy. If you are not authorized, + talk to an administrator. If you are an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + operationId: ListObjects + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/PrefixQueryParam' + - $ref: '#/components/parameters/StartWithQueryParam' + - $ref: '#/components/parameters/EndBeforeQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/DelimiterQueryParam' + - $ref: '#/components/parameters/ObjectFieldsQueryParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + - $ref: '#/components/parameters/StartAfterQueryParam' + responses: + '200': + description: | + List of object summaries, including optional prefixes and, in a truncated response, the name of the object to + start next page of results. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ListObjects' + application-json: + examples: + response: + value: | + { + "objects": [ + { + "name": "1MB.data" + } + ] + } + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: List Objects + tags: + - objectStorage + x-example: | + GET /n/<namespace_string>/b/<bucket_name>/o HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 12 Aug 2016 23:00:25 GMT + authorization: <authorization and other headers> + x-related-resource: '#/definitions/Object' + /n/{namespaceName}/b/{bucketName}/o/{objectName}: + delete: + description: | + Deletes an object. + operationId: DeleteObject + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ObjectPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/ClientRequestIdHeader' + - $ref: '#/components/parameters/VersionIdQueryParam' + responses: + '204': + description: The object was successfully deleted. + headers: + is-delete-marker: + description: | + This is `true` if the deleted object is a delete marker, otherwise `false` + schema: + type: boolean + last-modified: + description: The time the object was deleted, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). + schema: + type: string + format: date-time + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + version-id: + description: | + The `versionId` of the delete marker created as a result of the DELETE Object. + If the request contains a specific `versionId`, then this response header will be the same as the requested `versionId` of the object that was deleted. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '409': + $ref: '#/components/responses/NotAuthorizedOrInternalConflict' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: DELETE Object + tags: + - objectStorage + x-example: | + DELETE /n/<namespace_string>/b/<bucket_name>/o/example_object HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 12 Aug 2016 23:01:51 GMT + content-length: 0 + authorization: <authorization and other headers> + x-related-resource: '#/definitions/Object' + get: + description: | + Gets the metadata and body of an object. + operationId: GetObject + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ObjectPathParam' + - $ref: '#/components/parameters/VersionIdQueryParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfNoneMatchHeaderExceptStar' + - $ref: '#/components/parameters/ClientRequestIdHeader' + - $ref: '#/components/parameters/RangeRequestHeader' + - $ref: '#/components/parameters/OptionalSSECustomerAlgorithmHeader' + - $ref: '#/components/parameters/OptionalSSECustomerKeyHeader' + - $ref: '#/components/parameters/OptionalSSECustomerKeySHA256Header' + - $ref: '#/components/parameters/ResponseContentDispositionQueryParam' + - $ref: '#/components/parameters/ResponseCacheControlQueryParam' + - $ref: '#/components/parameters/ResponseContentTypeQueryParam' + - $ref: '#/components/parameters/ResponseContentLanguageQueryParam' + - $ref: '#/components/parameters/ResponseContentEncodingQueryParam' + - $ref: '#/components/parameters/ResponseExpiresQueryParam' + responses: + '200': + description: The object metadata and bytes. + headers: + ETag: + description: The entity tag (ETag) for the object. + schema: + type: string + archival-state: + description: Archival state of an object. This field is set only for objects in Archive tier. + x-obmcs-top-level-enum: '#/definitions/ArchivalState' + schema: + type: string + enum: + - Archived + - Restoring + - Restored + cache-control: + description: Cache-Control header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.9). + schema: + type: string + content-disposition: + description: Content-Disposition header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-19.5.1). + schema: + type: string + content-encoding: + description: Content-Encoding header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.11). + schema: + type: string + content-language: + description: Content-Language header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.12). + schema: + type: string + content-length: + description: The object size in bytes. + schema: + type: integer + format: int64 + content-md5: + description: | + Content-MD5 header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.15). + Unavailable for objects uploaded using multipart upload. + schema: + type: string + content-range: + description: Content-Range header for range requests, per [RFC 7233](https://tools.ietf.org/html/rfc7233#section-4.2). + schema: + type: string + content-type: + description: Content-Type header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.17). + schema: + type: string + expires: + description: | + The date and time after which the object is no longer cached by a browser, proxy, or other caching entity. See + [RFC 2616](https://tools.ietf.org/rfc/rfc2616#section-14.21). + schema: + type: string + format: date-time + last-modified: + description: The object modification time, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). + schema: + type: string + format: date-time + opc-bucket-key-enabled: + description: True if bucket key was enabled and used to encrypt the object during upload or reencrypt. + schema: + type: boolean + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-meta-*: + description: The user-defined metadata for the object. + x-obmcs-header-collection: true + x-obmcs-prefix: opc-meta- + schema: + type: string + opc-multipart-md5: + description: | + Only applicable to objects uploaded using multipart upload. + Base-64 representation of the multipart object hash. + The multipart object hash is calculated by taking the MD5 hashes of the parts, + concatenating the binary representation of those hashes in order of their part numbers, + and then calculating the MD5 hash of the concatenated values. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + storage-tier: + description: The storage tier that the object is stored in. + x-obmcs-top-level-enum: '#/definitions/StorageTier' + schema: + type: string + enum: + - Standard + - InfrequentAccess + - Archive + time-of-archival: + description: Time that the object is returned to the archived state. This field is only present for restored objects. + schema: + type: string + format: date-time + version-id: + description: VersionId of the object + schema: + type: string + content: + application/json: + schema: + format: binary + type: string + application-json: + examples: + response: + value: | + { + "ETag": "3A63FDC17F6B9AADE053C20610AC801F", + "MD5": "36Gwtu9HoVxgCwlKk+VgAg==", + "Size": "12", + "Trace ID": "d13fe5a5-0358-9d32-a25c-d6864b5b9a64" + } + '206': + description: The object metadata and partial bytes. + headers: + ETag: + description: The entity tag (ETag) for the object. + schema: + type: string + archival-state: + description: Archival state of an object. This field is set only for objects in Archive tier. + x-obmcs-top-level-enum: '#/definitions/ArchivalState' + schema: + type: string + enum: + - Archived + - Restoring + - Restored + cache-control: + description: Cache-Control header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.9). + schema: + type: string + content-disposition: + description: Content-Disposition header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-19.5.1). + schema: + type: string + content-encoding: + description: Content-Encoding header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.11). + schema: + type: string + content-language: + description: Content-Language header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.12). + schema: + type: string + content-length: + description: The object size in bytes. + schema: + type: integer + format: int64 + content-md5: + description: | + Content-MD5 header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.15). + Unavailable for objects uploaded using multipart upload. + schema: + type: string + content-range: + description: Content-Range header for range requests, per [RFC 7233](https://tools.ietf.org/html/rfc7233#section-4.2). + schema: + type: string + content-type: + description: Content-Type header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.17). + schema: + type: string + expires: + description: | + The date and time after which the object is no longer cached by a browser, proxy, or other caching entity. See + [RFC 2616](https://tools.ietf.org/rfc/rfc2616#section-14.21). + schema: + type: string + format: date-time + last-modified: + description: The object modification time, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). + schema: + type: string + format: date-time + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-meta-*: + description: The user-defined metadata for the object. + x-obmcs-header-collection: true + x-obmcs-prefix: opc-meta- + schema: + type: string + opc-multipart-md5: + description: | + Only applicable to objects uploaded using multipart upload. + Base-64 representation of the multipart object hash. + The multipart object hash is calculated by taking the MD5 hashes of the parts, + concatenating the binary representation of those hashes in order of their part numbers, + and then calculating the MD5 hash of the concatenated values. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + storage-tier: + description: The storage tier that the object is stored in. + x-obmcs-top-level-enum: '#/definitions/StorageTier' + schema: + type: string + enum: + - Standard + - InfrequentAccess + - Archive + time-of-archival: + description: Time that the object is returned to the archived state. This field is only present for restored objects. + schema: + type: string + format: date-time + version-id: + description: VersionId of the object requested + schema: + type: string + content: + application/json: + schema: + format: binary + type: string + '304': + description: Not Modified + headers: + ETag: + description: The entity tag (ETag) for the object. + schema: + type: string + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '409': + $ref: '#/components/responses/NotAuthorizedOrInternalConflict' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: GET Object + tags: + - objectStorage + x-example: | + GET /n/<namespace_string>/b/<bucket_name>/o/dummy_object HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.10.0 + date: Fri, 19 Aug 2016 23:43:49 GMT + authorization: <authorization and other headers> + x-related-resource: '#/definitions/Object' + head: + description: | + Gets the user-defined metadata and entity tag (ETag) for an object. + operationId: HeadObject + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ObjectPathParam' + - $ref: '#/components/parameters/VersionIdQueryParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfNoneMatchHeaderExceptStar' + - $ref: '#/components/parameters/ClientRequestIdHeader' + - $ref: '#/components/parameters/OptionalSSECustomerAlgorithmHeader' + - $ref: '#/components/parameters/OptionalSSECustomerKeyHeader' + - $ref: '#/components/parameters/OptionalSSECustomerKeySHA256Header' + responses: + '200': + description: The object metadata and bytes. + headers: + ETag: + description: The entity tag (ETag) for the object. + schema: + type: string + archival-state: + description: Archival state of an object. This field is set only for objects in Archive tier. + x-obmcs-top-level-enum: '#/definitions/ArchivalState' + schema: + type: string + enum: + - Archived + - Restoring + - Restored + cache-control: + description: Cache-Control header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.9). + schema: + type: string + content-disposition: + description: Content-Disposition header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-19.5.1). + schema: + type: string + content-encoding: + description: Content-Encoding header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.11). + schema: + type: string + content-language: + description: Content-Language header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.12). + schema: + type: string + content-length: + description: The object size in bytes. + schema: + type: integer + format: int64 + content-md5: + description: | + Content-MD5 header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.15). + Unavailable for objects uploaded using multipart upload. + schema: + type: string + content-type: + description: Content-Type header, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.17). + schema: + type: string + last-modified: + description: The object modification time, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). + schema: + type: string + format: date-time + opc-bucket-key-enabled: + description: True if bucket key was enabled and used to encrypt the object during upload or reencrypt. + schema: + type: boolean + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-meta-*: + description: The user-defined metadata for the object. + x-obmcs-header-collection: true + x-obmcs-prefix: opc-meta- + schema: + type: string + opc-multipart-md5: + description: | + Only applicable to objects uploaded using multipart upload. + Base-64 representation of the multipart object hash. + The multipart object hash is calculated by taking the MD5 hashes of the parts, + concatenating the binary representation of those hashes in order of their part numbers, + and then calculating the MD5 hash of the concatenated values. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + storage-tier: + description: The storage tier that the object is stored in. + x-obmcs-top-level-enum: '#/definitions/StorageTier' + schema: + type: string + enum: + - Standard + - InfrequentAccess + - Archive + time-of-archival: + description: Time that the object is returned to the archived state. This field is only present for restored objects. + schema: + type: string + format: date-time + version-id: + description: VersionId of the object requested + schema: + type: string + '304': + description: Not Modified + headers: + ETag: + description: The entity tag (ETag) for the object. + schema: + type: string + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: HEAD Object + tags: + - objectStorage + x-example: | + HEAD /n/<namespace_string>/b/<bucket_name>/o/dummy_object HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.10.0 + date: Fri, 19 Aug 2016 23:39:51 GMT + authorization: <authorization and other headers> + x-related-resource: '#/definitions/Object' + put: + description: | + Creates a new object or overwrites an existing object with the same name. The maximum object size allowed by + PutObject is 50 GiB. + + See [Object Names](/Content/Object/Tasks/managingobjects.htm#namerequirements) + for object naming requirements. + + See [Special Instructions for Object Storage PUT](/Content/API/Concepts/signingrequests.htm#ObjectStoragePut) + for request signature requirements. + operationId: PutObject + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ObjectPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfNoneMatchHeader' + - $ref: '#/components/parameters/ClientRequestIdHeader' + - $ref: '#/components/parameters/Expect100ContinueHeader' + - $ref: '#/components/parameters/RequiredContentLengthHeader' + - $ref: '#/components/parameters/OptionalContentMD5Header' + - $ref: '#/components/parameters/ObjectAppendQueryParam' + - $ref: '#/components/parameters/OptionalContentTypeHeader' + - $ref: '#/components/parameters/OptionalContentLanguageHeader' + - $ref: '#/components/parameters/OptionalContentEncodingHeader' + - $ref: '#/components/parameters/OptionalContentDispositionHeader' + - $ref: '#/components/parameters/OptionalCacheControlHeader' + - $ref: '#/components/parameters/OptionalSSECustomerAlgorithmHeader' + - $ref: '#/components/parameters/OptionalSSECustomerKeyHeader' + - $ref: '#/components/parameters/OptionalSSECustomerKeySHA256Header' + - $ref: '#/components/parameters/OptionalSSEKMSKeyIdHeader' + - $ref: '#/components/parameters/OptionalStorageTierHeader' + - $ref: '#/components/parameters/OpcMetaHeader' + requestBody: + content: + application/json: + schema: + format: binary + type: string + description: The object to upload to the object store. + required: true + responses: + '200': + description: The object was successfully created. + headers: + ETag: + description: The entity tag (ETag) for the object. + schema: + type: string + append-offset: + description: The offset where the chunk was appended to, in bytes. If no object exists, 0 will be returned. This header is only returned for append operations. + schema: + type: integer + format: int64 + committed-chunk-count: + description: The number of chunks committed to the object. This can be used to manage how many more appends can be done. + schema: + type: integer + last-modified: + description: The time the object was modified, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). + schema: + type: string + format: date-time + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-content-md5: + description: The base64-encoded MD5 hash of the request body as computed by the server. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + version-id: + description: VersionId of the newly created object + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '409': + $ref: '#/components/responses/NotAuthorizedOrInternalConflict' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: PUT Object + tags: + - objectStorage + x-example: | + PUT /n/<namespace_string>/b/<bucket_name>/o/example_object HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + Connection: keep-alive + Accept-Encoding: gzip, deflate + Accept: */* + User-Agent: python-requests/2.11.0 + date: Fri, 12 Aug 2016 22:55:34 GMT + Content-Length: 128 + authorization: <authorization string> + x-obmcs-signing-strategy: exclude_body + x-related-resource: '#/definitions/Object' + /n/{namespaceName}/b/{bucketName}/objectversions: + get: + description: | + Lists the object versions in a bucket. + + ListObjectVersions returns an ObjectVersionCollection containing at most 1000 object versions. To paginate through + more object versions, use the returned `opc-next-page` value with the `page` request parameter. + + To use this and other API operations, you must be authorized in an IAM policy. If you are not authorized, + talk to an administrator. If you are an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + operationId: ListObjectVersions + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/PrefixQueryParam' + - $ref: '#/components/parameters/StartWithQueryParam' + - $ref: '#/components/parameters/EndBeforeQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/DelimiterQueryParam' + - $ref: '#/components/parameters/ObjectFieldsQueryParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + - $ref: '#/components/parameters/StartAfterQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: | + List of object version summaries, including optional prefixes and, in a truncated response, the `opc-next-page` to + start the next page of results. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-next-page: + description: | + For paginating a list of object versions. + In the GET request, set the limit to the number of object versions that you want returned in the response. + If the `opc-next-page` header appears in the response, then this is a partial list and there are + additional object versions to get. Include the header's value as the `page` parameter in the subsequent + GET request to get the next batch of object versions and prefixes. Repeat this process to retrieve the entire list of + object versions and prefixes. + + For more 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, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectVersionCollection' + application-json: + examples: + response: + value: | + { + "items": [ + { + "name": "1MB.data", + "versionId": "A_v1", + "isDeleteMarker": true, + "timeModified": "Thu Feb 27 16:22:54 PST 2020" + }, + { + "name": "2MB.data", + "versionId": "B_v1", + "isDeleteMarker": false, + "timeModified": "Thu Feb 27 16:22:54 PST 2020" + } + ] + } + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: List Object Versions + tags: + - objectStorage + x-example: | + GET /n/<namespace_string>/b/<bucket_name>/o/versions HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 12 Aug 2016 23:00:25 GMT + authorization: <authorization and other headers> + x-related-resource: '#/definitions/Object' + /n/{namespaceName}/b/{bucketName}/p/: + get: + description: | + Lists pre-authenticated requests for the bucket. + operationId: ListPreauthenticatedRequests + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ObjectNamePrefixQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '200': + description: Lists pre-authenticated requests metadata for this bucket and object. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-next-page: + description: | + For paginating a list of pre-authenticated requests. + In the GET request, set the limit to the number of pre-authenticated requests that you want returned in + the response. If the `opc-next-page` header appears in the response, then this is a partial list and there + are additional pre-authenticated requests to get. Include the header's value as the `page` parameter in + the subsequent GET request to get the next batch of pre-authenticated requests. Repeat this process to + retrieve the entire list of pre-authenticated requests. + + For more 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, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ListPreauthenticatedRequestsResponse' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: List Preauthenticated Requests + tags: + - objectStorage + x-related-resource: '#/definitions/PreauthenticatedRequest' + post: + description: | + Creates a pre-authenticated request specific to the bucket. + operationId: CreatePreauthenticatedRequest + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePreauthenticatedRequestDetails' + description: Information needed to create the pre-authenticated request. + required: true + responses: + '200': + description: The pre-authenticated request for the object was successfully created. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PreauthenticatedRequest' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '409': + $ref: '#/components/responses/NotAuthorizedOrInternalConflict' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Create Preauthenticated Request + tags: + - objectStorage + x-related-resource: '#/definitions/PreauthenticatedRequest' + /n/{namespaceName}/b/{bucketName}/p/{parId}: + delete: + description: Deletes the pre-authenticated request for the bucket. + operationId: DeletePreauthenticatedRequest + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/PreauthenticatedRequestIdPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '200': + description: Deletes the metadata for the specified pre-authenticated request. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: DELETE Preauthenticated Request + tags: + - objectStorage + x-related-resource: '#/definitions/PreauthenticatedRequest' + get: + description: Gets the pre-authenticated request for the bucket. + operationId: GetPreauthenticatedRequest + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/PreauthenticatedRequestIdPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '200': + description: Fetches the metadata for the specified pre-authenticated request. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PreauthenticatedRequestSummary' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: GET Preauthenticated Request + tags: + - objectStorage + x-related-resource: '#/definitions/PreauthenticatedRequest' + /n/{namespaceName}/b/{bucketName}/replicationPolicies: + get: + description: | + List the replication policies associated with a bucket. + operationId: ListReplicationPolicies + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationReplicationLimitQueryParam' + responses: + '200': + description: The list of replication policies. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-next-page: + description: | + For paginating a list of replication policies. + In the GET request, set the limit to the number of buckets items that you want returned in the response. + If the `opc-next-page` header appears in the response, then this is a partial list and there are additional + policies to get. Include the header's value as the `page` parameter in the subsequent GET request to get the + next batch of policies. Repeat this process to retrieve the entire list of policies. + + For more 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, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ListReplicationPoliciesResponse' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: List the replication policies associated with a bucket. + tags: + - objectStorage + x-example: | + GET /n/<namespace_string>/b/<bucket_name>/replicationPolicies + Host: objectstorage.us-phoenix-1.oraclecloud.com + User-Agent: curl/7.43.0 + Accept: */* + Date: Fri, 10 Mar 2017 11:50:24 GMT + Authorization: <authorization and other headers> + x-related-resource: '#/definitions/Replication' + post: + description: | + Creates a replication policy for the specified bucket. + operationId: CreateReplicationPolicy + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateReplicationPolicyDetails' + description: The replication policy. + required: true + responses: + '200': + description: The replication policy was created. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, + provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ReplicationPolicy' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '409': + $ref: '#/components/responses/NotAuthorizedOrInternalConflict' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Create replication policy. + tags: + - objectStorage + x-example: | + POST /n/<namespace_string>/b/<bucket_name>/replicationPolicies + Host: objectstorage.us-phoenix-1.oraclecloud.com + User-Agent: curl/7.43.0 + Accept: */* + Content-Type: application/json + Date: Fri, 10 Mar 2017 11:50:24 GMT + Authorization: <authorization and other headers> + { + "name": "mypolicy", + "destinationRegionName": "us-phoenix-1", + "destinationBucketName": "backup" + } + x-related-resource: '#/definitions/Replication' + /n/{namespaceName}/b/{bucketName}/replicationPolicies/{replicationId}: + delete: + description: | + Deletes the replication policy associated with the source bucket. + operationId: DeleteReplicationPolicy + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ReplicationIdPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '204': + description: The replication policy is being deleted. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, + provide this request ID. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Delete replication policy. + tags: + - objectStorage + x-example: | + DELETE /n/<namespace_string>/b/<bucket_name>/replicationPolicies/<replication_id> + Host: objectstorage.us-phoenix-1.oraclecloud.com + User-Agent: curl/7.43.0 + Accept: */* + Date: Fri, 10 Mar 2017 11:50:24 GMT + Authorization: <authorization and other headers> + x-related-resource: '#/definitions/Replication' + get: + description: | + Get the replication policy. + operationId: GetReplicationPolicy + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ReplicationIdPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '200': + description: The replication policy. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, + provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ReplicationPolicy' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Get replication policy. + tags: + - objectStorage + x-example: | + GET /n/<namespace_string>/b/<bucket_name>/replicationPolicies/<replication_id> + Host: objectstorage.us-phoenix-1.oraclecloud.com + User-Agent: curl/7.43.0 + Accept: */* + Date: Fri, 10 Mar 2017 11:50:24 GMT + Authorization: <authorization and other headers> + x-related-resource: '#/definitions/Replication' + /n/{namespaceName}/b/{bucketName}/replicationSources: + get: + description: | + List the replication sources of a destination bucket. + operationId: ListReplicationSources + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationReplicationLimitQueryParam' + responses: + '200': + description: The list of replication sources. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-next-page: + description: | + For paginating a list of replication sources. + In the GET request, set the limit to the number of items that you want returned in the response. + If the `opc-next-page` header appears in the response, then this is a partial list and there are additional + policies to get. Include the header's value as the `page` parameter in the subsequent GET request to get the + next batch of policies. Repeat this process to retrieve the entire list of sources. + + For more 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, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ListReplicationSourcesResponse' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: List the replication sources of a destination bucket. + tags: + - objectStorage + x-example: | + GET /n/<namespace_string>/b/<bucket_name>/replicationSources + Host: objectstorage.us-phoenix-1.oraclecloud.com + User-Agent: curl/7.43.0 + Accept: */* + Date: Fri, 10 Mar 2017 11:50:24 GMT + Authorization: <authorization and other headers> + x-related-resource: '#/definitions/Replication' + /n/{namespaceName}/b/{bucketName}/retentionRules: + get: + description: | + List the retention rules for a bucket. The retention rules are sorted based on creation time, + with the most recently created retention rule returned first. + operationId: ListRetentionRules + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: The list of retention rules. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-next-page: + description: | + Paginating a list of retention rules. + If the `opc-next-page` header appears in the response, it indicates that this is a partial list + of retention rules and there are additional rules to get. Include the value of this header as + the `page` parameter in a subsequent GET request to get the next set of retention rules. + Repeat this process to retrieve the entire list of retention rules. + + For more 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, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/RetentionRuleCollection' + application-json: + examples: + response: + value: | + { + "items": [ + { + "id": "1e32e9ae-2058-4e57-84f4-3f4636dec005", + "displayName": "retentionRule_1", + "duration": { + "timeAmount": 30, + "timeUnit": "DAYS" + }, + "timeRuleLocked": "2019-12-13T21:43:00.000Z", + "etag": "31e21d43-41e8-42b0-beb8-cc0baa50ef94", + "timeCreated": "2019-11-11T17:23:46.000Z", + "timeModified": "2019-11-11T17:23:46.000Z" + }, + { + "id": "2ae2fcce-5df9-4848-85cf-bee4c8b96e58", + "displayName": "retentionRule_2", + "duration": { + "timeAmount": 60, + "timeUnit": "DAYS" + }, + "timeRuleLocked": "2020-12-21T17:23:46.000Z", + "etag": "31e21d43-41e8-42b0-beb8-cc0baa50ef97", + "timeCreated": "2019-10-18T13:33:12.000Z", + "timeModified": "2019-11-08T06:48:51.000Z" + }, + { + "id": "f3fbb9d8-12f1-497f-9837-6f596106b6e3", + "displayName": "retentionRule_3", + "duration": { + "timeAmount": 90, + "timeUnit": "DAYS" + }, + "etag": "31e21d43-41e8-42b0-beb8-cc0baa50ef99", + "timeCreated": "2019-09-07T19:21:03.000Z", + "timeModified": "2019-11-30T19:37:46.000Z" + } + ] + } + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: List the retention rules for a bucket. + tags: + - objectStorage + x-example: | + GET /n/<namespace_string>/b/<bucket_name>/retentionRules + Host: objectstorage.us-phoenix-1.oraclecloud.com + User-Agent: curl/7.43.0 + Accept: */* + Date: Fri, 10 Nov 2019 11:50:24 GMT + Opc-Client-Request-Id: sampleOpcClientRequestIdForList + Authorization: <authorization and other headers> + x-related-resource: '#/definitions/RetentionRule' + post: + description: | + Creates a new retention rule in the specified bucket. The new rule will take effect typically within 30 seconds. + Note that a maximum of 100 rules are supported on a bucket. + operationId: CreateRetentionRule + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateRetentionRuleDetails' + description: The retention rule to create for the bucket. + required: true + responses: + '200': + description: The retention rule representation. + headers: + etag: + description: The entity tag (ETag) for the retention rule that was created. + schema: + type: string + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/RetentionRule' + application-json: + examples: + response: + value: | + { + "id": "1e32e9ae-2058-4e57-84f4-3f4636dec005", + "displayName": "sampleRetentionRule", + "duration": { + "timeAmount": 30, + "timeUnit": "DAYS" + }, + "timeRuleLocked": "2019-12-13T17:23:46.000Z", + "etag": "31e21d43-41e8-42b0-beb8-cc0baa50ef94", + "timeCreated": "2019-11-13T17:23:46.000Z", + "timeModified": "2019-11-13T17:23:46.000Z" + } + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '409': + $ref: '#/components/responses/NotAuthorizedOrInternalConflict' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Create a new retention rule. + tags: + - objectStorage + x-example: | + POST /n/<namespace_string>/b/<bucket_name>/retentionRules + Host: objectstorage.us-phoenix-1.oraclecloud.com + User-Agent: curl/7.43.0 + Accept: */* + Content-Type: application/json + Content-Length: 139 + Date: Fri, 10 Nov 2019 11:50:24 GMT + Opc-Client-Request-Id: sampleOpcClientRequestIdForCreate + Authorization: <authorization and other headers> + { + "displayName": "sampleRetentionRule", + "duration": { + "timeAmount": 30, + "timeUnit": "DAYS" + }, + "timeRuleLocked": "2019-12-13T17:23:46.000Z" + } + x-related-resource: '#/definitions/RetentionRule' + /n/{namespaceName}/b/{bucketName}/retentionRules/{retentionRuleId}: + delete: + description: Deletes the specified rule. The deletion takes effect typically within 30 seconds. + operationId: DeleteRetentionRule + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/RetentionRuleIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '204': + description: Specified retention rule has been deleted. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '409': + $ref: '#/components/responses/NotAuthorizedOrInternalConflict' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Delete the specified retention rule. + tags: + - objectStorage + x-example: | + DELETE /n/<namespace_string>/b/<bucket_name>/retentionRules//b/<retentionRuleId_string> HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept: */* + date: Fri, 12 Nov 2019 23:04:28 GMT + content-length: 0 + opc-client-request-id: sampleOpcClientRequestIdForDelete + authorization: <authorization and other headers> + x-related-resource: '#/definitions/RetentionRule' + get: + description: Get the specified retention rule. + operationId: GetRetentionRule + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/RetentionRuleIdPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '200': + description: The specified retention rule. + headers: + etag: + description: The entity tag (ETag) for the retention rule. + schema: + type: string + last-modified: + description: The time the retention rule was last modified, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29) + schema: + type: string + format: date-time + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/RetentionRule' + application-json: + examples: + response: + value: | + { + "id": "1e32e9ae-2058-4e57-84f4-3f4636dec005", + "displayName": "retentionRule_1", + "duration": { + "timeAmount": 30, + "timeUnit": "DAYS" + }, + "timeRuleLocked": "2019-12-13T21:43:00.000Z", + "etag": "31e21d43-41e8-42b0-beb8-cc0baa50ef94", + "timeCreated": "2019-11-11T17:23:46.000Z", + "timeModified": "2019-11-11T17:23:46.000Z" + } + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Get the specified retention rule. + tags: + - objectStorage + x-related-resource: '#/definitions/RetentionRule' + put: + description: | + Updates the specified retention rule. Rule changes take effect typically within 30 seconds. + operationId: UpdateRetentionRule + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/RetentionRuleIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/ClientRequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateRetentionRuleDetails' + description: Request object for updating the retention rule. + required: true + responses: + '200': + description: The updated RetentionRule information. + headers: + etag: + description: The entity tag (ETag) for the retention rule that was updated. + schema: + type: string + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/RetentionRule' + application-json: + examples: + response: + value: | + { + "id": "1e32e9ae-2058-4e57-84f4-3f4636dec005", + "displayName": "sampleRetentionRule", + "duration": { + "timeAmount": 30, + "timeUnit": "DAYS" + }, + "timeRuleLocked": "2019-12-23T17:23:46.000Z", + "etag": "31e21d43-41e8-42b0-beb8-cc0baa50ef94", + "timeCreated": "2019-11-13T17:23:46.000Z", + "timeModified": "2019-11-19T11:23:46.000Z" + } + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '409': + $ref: '#/components/responses/NotAuthorizedOrInternalConflict' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Update the specified retention rule. + tags: + - objectStorage + x-example: | + PUT /n/<namespace_string>/b/<bucket_name>/retentionRules/<retentionRuleId_string> HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 12 Nov 2019 22:50:18 GMT + content-type: application/json + authorization: <authorization and other headers> + { + "displayName": "sampleRetentionRule", + "duration": { + "timeUnit": "DAYS", + "timeAmount": 30 + }, + "timeRuleLocked": "2019-12-13T17:23:46.000Z" + } + x-related-resource: '#/definitions/RetentionRule' + /n/{namespaceName}/b/{bucketName}/u: + get: + description: | + Lists all of the in-progress multipart uploads for the given bucket in the given Object Storage namespace. + operationId: ListMultipartUploads + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '200': + description: The list of in-progress multipart uploads. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-next-page: + description: | + For paginating a list of multipart uploads. + In the GET request, set the limit to the number of multipart uploads that you want returned in the response. + If the `opc-next-page` header appears in the response, then this is a partial list and there are + additional multipart uploads to get. Include the header's value as the `page` parameter in the subsequent + GET request to get the next batch of objects. Repeat this process to retrieve the entire list of + multipart uploads. + + For more 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, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ListMultipartUploadsResponse' + application-json: + examples: + response: + value: | + [ + { + "namespace": "ansh8lvru1zp", + "bucket": "MyBucket", + "object": "MyObject1", + "uploadId": "c892336f-ccvb-1bb8-6e75-a5649fd91178" + }, + { + "namespace": "ansh8lvru1zp", + "bucket": "MyBucket", + "object": "MyObject2", + "uploadId": "a54f378a-49c0-acvb-189f-58959597453a" + } + ] + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: List Multipart Uploads + tags: + - objectStorage + x-example: | + GET /n/<namespace_string>/b/<bucket_name>/u HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + User-Agent: curl/7.43.0 + Accept: */* + Date: Fri, 10 Mar 2017 11:19:32 GMT + Authorization: <authorization and other headers> + x-related-resource: '#/definitions/MultipartUpload' + post: + description: | + Starts a new multipart upload to a specific object in the given bucket in the given namespace. + + See [Object Names](/Content/Object/Tasks/managingobjects.htm#namerequirements) + for object naming requirements. + operationId: CreateMultipartUpload + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfNoneMatchHeader' + - $ref: '#/components/parameters/ClientRequestIdHeader' + - $ref: '#/components/parameters/OptionalSSECustomerAlgorithmHeader' + - $ref: '#/components/parameters/OptionalSSECustomerKeyHeader' + - $ref: '#/components/parameters/OptionalSSECustomerKeySHA256Header' + - $ref: '#/components/parameters/OptionalSSEKMSKeyIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateMultipartUploadDetails' + description: Request object for creating a multipart upload. + required: true + responses: + '200': + description: The full details of the newly created multipart upload. + headers: + Location: + description: The full path to the new upload. + schema: + type: string + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/MultipartUpload' + application-json: + examples: + response: + value: | + { + "namespace": "ansh8lvru1zp", + "bucket": "MyBucket", + "object": "MyObject1", + "uploadId": "c892336f-ccvb-1bb8-6e75-a5649fd91178" + } + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '409': + $ref: '#/components/responses/NotAuthorizedOrInternalConflict' + '411': + $ref: '#/components/responses/ContentLengthRequired' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Create Multipart Upload + tags: + - objectStorage + x-example: | + POST /n/<namespace_string>/b/<bucket_name>/u HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + User-Agent: curl/7.43.0 + Accept: */* + Date: Fri, 10 Mar 2017 11:44:08 GMT + Authorization: <authorization and other headers> + { + "object": "example_object1" + } + x-related-resource: '#/definitions/MultipartUpload' + /n/{namespaceName}/b/{bucketName}/u/{objectName}: + delete: + description: | + Aborts an in-progress multipart upload and deletes all parts that have been uploaded. + operationId: AbortMultipartUpload + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ObjectPathParam' + - $ref: '#/components/parameters/UploadIdQueryParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '204': + description: The abort was successful. The response body is always empty. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '409': + $ref: '#/components/responses/NotAuthorizedOrInternalConflict' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Abort Multipart Upload + tags: + - objectStorage + x-example: | + DELETE /n/<namespace_string>/b/<bucket_name>/u/example_object2?uploadid=a54f378a-49c0-acvb-189f-58959597453a HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + User-Agent: curl/7.43.0 + Accept: */* + Date: Fri, 10 Mar 2017 11:53:13 GMT + Authorization: <authorization and other headers> + x-related-resource: '#/definitions/MultipartUpload' + get: + description: | + Lists the parts of an in-progress multipart upload. + operationId: ListMultipartUploadParts + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ObjectPathParam' + - $ref: '#/components/parameters/UploadIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '200': + description: The list of parts associated with the specified in-progress multipart upload. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-next-page: + description: | + For paginating a list of multipart upload parts. + In the GET request, set the limit to the number of multipart upload parts that you want returned in the + response. If the `opc-next-page` header appears in the response, then this is a partial list and there are + additional multipart upload parts to get. Include the header's value as the `page` parameter in the subsequent + GET request to get the next batch of multipart upload parts. Repeat this process to retrieve the entire list + of multipart upload parts. + + For more 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, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ListMultipartUploadPartsResponse' + application-json: + examples: + response: + value: | + [ + { + "partNumber": 1, + "etag": "3d240a5a-a2b0-45b2-bcvb-2ac6a02b422c", + "md5": "rvr3UC1SmUw7cvb2NqPN0g==", + "size": 8 + }, + { + "partNumber": 2, + "etag": "15de104e-7cvb-3513-8da1-3b5e75a65ad7", + "md5": "3poFVtJezCVBOi8RzhUB8Q==", + "size": 8 + } + ] + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: List Multipart Upload Parts + tags: + - objectStorage + x-example: | + GET /n/<namespace_string>/b/<bucket_name>/u/example_object2?uploadid=a54f378a-49c0-acvb-189f-58959597453a HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + User-Agent: curl/7.43.0 + Accept: */* + Date: Fri, 10 Mar 2017 11:50:55 GMT + Authorization: <authorization and other headers> + x-related-resource: '#/definitions/MultipartUpload' + post: + description: | + Commits a multipart upload, which involves checking part numbers and entity tags (ETags) of the parts, to create an aggregate object. + operationId: CommitMultipartUpload + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ObjectPathParam' + - $ref: '#/components/parameters/UploadIdQueryParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfNoneMatchHeader' + - $ref: '#/components/parameters/ClientRequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CommitMultipartUploadDetails' + description: The part numbers and entity tags (ETags) for the parts you want to commit. + required: true + responses: + '200': + description: The commit was successful. + headers: + ETag: + description: The entity tag (ETag) for the object. + schema: + type: string + last-modified: + description: The time the object was last modified, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). + schema: + type: string + format: date-time + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-multipart-md5: + description: | + Base-64 representation of the multipart object MD5 hash. + The multipart object hash is calculated by taking the MD5 hashes of the parts passed to this call, + concatenating the binary representation of those hashes in order of their part numbers, + and then calculating the MD5 hash of the concatenated values. The multipart object hash is followed + by a hyphen and the total number of parts (for example, '-6'). + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + version-id: + description: VersionId of the newly created object + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '409': + $ref: '#/components/responses/NotAuthorizedOrInternalConflict' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Commit Multipart Upload + tags: + - objectStorage + x-example: | + POST /n/<namespace_string>/b/<bucket_name>/u/example_object1?uploadid=c892336f-ccvb-1bb8-6e75-a5649fd91178 HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + User-Agent: curl/7.43.0 + Accept: */* + Content-Type: application/json + Content-Length: 139 + Date: Fri, 10 Mar 2017 11:50:24 GMT + Authorization: <authorization and other headers> + { + "partsToCommit": [ + { + "partNum": 1, + "etag": "3d240a5a-a2b0-45b2-bcvb-2ac6a02b422c" + }, + { + "partNum": 2, + "etag" : "15de104e-7cvb-3513-8da1-3b5e75a65ad7" + } + ] + } + x-related-resource: '#/definitions/MultipartUpload' + put: + description: | + Uploads a single part of a multipart upload. + operationId: UploadPart + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/BucketPathParam' + - $ref: '#/components/parameters/ObjectPathParam' + - $ref: '#/components/parameters/UploadIdQueryParam' + - $ref: '#/components/parameters/UploadPartNumberQueryParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfNoneMatchHeader' + - $ref: '#/components/parameters/Expect100ContinueHeader' + - $ref: '#/components/parameters/RequiredContentLengthHeader' + - $ref: '#/components/parameters/OptionalContentMD5Header' + - $ref: '#/components/parameters/OptionalSSECustomerAlgorithmHeader' + - $ref: '#/components/parameters/OptionalSSECustomerKeyHeader' + - $ref: '#/components/parameters/OptionalSSECustomerKeySHA256Header' + - $ref: '#/components/parameters/OptionalSSEKMSKeyIdHeader' + requestBody: + content: + application/json: + schema: + format: binary + type: string + description: The part being uploaded to the Object Storage service. + required: true + responses: + '200': + description: The upload of the part was successful. The response includes an ETag header. + headers: + ETag: + description: The entity tag (ETag) for the object. + schema: + type: string + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-content-md5: + description: The base64-encoded MD5 hash of the request body, as computed by the server. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '409': + $ref: '#/components/responses/NotAuthorizedOrInternalConflict' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Upload Multipart Object Part + tags: + - objectStorage + x-example: | + PUT /n/<namespace_string>/b/<bucket_name>/u/example_object2?uploadid=a54f378a-49c0-acvb-189f-58959597453a&uploadPartNum=1 HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + User-Agent: curl/7.43.0 + Accept: */* + Content-Length: 8 + Content-Type: application/x-www-form-urlencoded + Date: Fri, 10 Mar 2017 11:50:55 GMT + Authorization: <authorization and other headers> + x-obmcs-signing-strategy: exclude_body + x-related-resource: '#/definitions/MultipartUpload' + /n/{namespaceName}/inventoryRules: + get: + description: | + List the inventory rules. + operationId: ListInventoryRules + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '200': + description: The list of inventory rules. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-next-page: + description: | + Paginating a list of Inventory rules. + If the `opc-next-page` header appears in the response, it indicates that this is a partial list + of inventory rules and there are additional rules to get. Include the value of this header as + the `page` parameter in a subsequent GET request to get the next set of inventory rules. + Repeat this process to retrieve the entire list of inventory rules. + For more 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, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryRuleCollection' + application-json: + examples: + response: + value: | + { + "items": [ + { + "etag": "4445dd4a-9d79-414e-b393-307bb7bb5871", + "filter": { + "created-within-days": 100, + "exclusion-prefixes": [], + "inclusion-prefixes": [ + "_permanent_ost_tests/o/permanent-object/2025/01/01/00/02/07*" + ], + "object-types": [ + "OBJECT" + ] + }, + "id": "oir-fbe97d5a-2938-4f8b-b512-8ab3d88e310d", + "is-enabled": true, + "report": { + "format": "PARQUET", + "schema-fields": [ + "COMPARTMENT_ID" + ], + "target-bucket": "_permanent_ost_tests" + }, + "report-recurrences": "FREQ=MONTHLY", + "rule-name": "rule_name_1", + "rule-type": "OBJECT_RULE", + "time-created": "2025-01-31T01:32:16.373000+00:00", + "time-modified": "2025-01-31T01:32:16.373000+00:00" + }, + { + "etag": "824ca947-7485-4ac2-b009-87ccda3bab53", + "filter": { + "created-within-days": 100, + "exclusion-prefixes": [], + "inclusion-prefixes": [ + "_permanent_ost_tests/o/permanent-object/2025/01/01/00/02/07*" + ], + "object-types": [ + "OBJECT" + ] + }, + "id": "oir-a8dc0bf6-3e3b-4079-a8c4-40d153a11309", + "is-enabled": true, + "report": { + "format": "PARQUET", + "schema-fields": [ + "COMPARTMENT_ID" + ], + "target-bucket": "inv_target_bucket" + }, + "report-recurrences": "FREQ=MONTHLY", + "rule-name": "daily", + "rule-type": "OBJECT_RULE", + "time-created": "2025-01-31T08:24:30.710000+00:00", + "time-modified": "2025-01-31T08:24:30.710000+00:00" + }, + { + "etag": "154de92a-b711-498f-99c8-56754c20c94b", + "filter": { + "created-within-days": -1, + "exclusion-prefixes": [], + "inclusion-prefixes": [ + "bucket1/o/*" + ], + "object-types": [ + "OBJECT" + ] + }, + "id": "oir-edb87a59-b8cb-4bda-ba71-3abaeeb192fd", + "is-enabled": true, + "report": { + "format": "PARQUET", + "schema-fields": [ + "ETAG", + "SIZE" + ], + "target-bucket": "MyReports" + }, + "report-recurrences": "FREQ=MONTHLY", + "rule-name": "SampleRule_1", + "rule-type": "OBJECT_RULE", + "time-created": "2025-01-31T09:02:16.312000+00:00", + "time-modified": "2025-01-31T09:02:16.312000+00:00" + } + ] + } + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: List the inventory rules. + tags: + - objectStorage + x-example: | + GET /n/<namespace_string>/inventoryRules + Host: objectstorage.us-phoenix-1.oraclecloud.com + User-Agent: curl/7.43.0 + Accept: */* + Date: Fri, 10 Nov 2019 11:50:24 GMT + Opc-Client-Request-Id: sampleOpcClientRequestIdForList + Authorization: <authorization and other headers> + x-related-resource: '#/definitions/InventoryRule' + post: + description: | + Creates a new inventory rule in the namespace + operationId: CreateInventoryRule + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateInventoryRuleDetails' + description: The inventory rule to create in namespace. + required: true + responses: + '200': + description: The inventory rule representation. + headers: + etag: + description: The entity tag (ETag) for the inventory rule that was created. + schema: + type: string + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryRule' + application-json: + examples: + response: + value: | + { + "etag": "154de92a-b711-498f-99c8-56754c20c94b", + "filter": { + "created-within-days": -1, + "exclusion-prefixes": [], + "inclusion-prefixes": [ + "bucket1/o/*" + ], + "object-types": [ + "OBJECT" + ] + }, + "id": "oir-edb87a59-b8cb-4bda-ba71-3abaeeb192fd", + "is-enabled": true, + "report": { + "format": "PARQUET", + "schema-fields": [ + "ETAG", + "SIZE" + ], + "target-bucket": "MyReports" + }, + "report-recurrences": "FREQ=MONTHLY", + "rule-name": "SampleRule_1", + "rule-type": "OBJECT_RULE", + "time-created": "2025-01-31T09:02:16.312000+00:00", + "time-modified": "2025-01-31T09:02:16.312000+00:00" + } + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '409': + $ref: '#/components/responses/NotAuthorizedOrInternalConflict' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Create a new inventory rule. + tags: + - objectStorage + x-example: | + POST /n/<namespace_string>/inventoryRules + Host: objectstorage.us-phoenix-1.oraclecloud.com + User-Agent: curl/7.43.0 + Accept: */* + Content-Type: application/json + Content-Length: 139 + Date: Fri, 10 Nov 2019 11:50:24 GMT + Opc-Client-Request-Id: sampleOpcClientRequestIdForCreate + Authorization: <authorization and other headers> + { + "filter": { + "createdWithinDays": -1, + "exclusionPrefixes": [], + "inclusionPrefixes": [ + "bucket1/o/*" + ], + "objectTypes": [ + "OBJECT" + ] + }, + "isEnabled": true, + "namespaceName": "r1vqmshs0dzo", + "report": { + "format": "PARQUET", + "schemaFields": [ + "ETAG", + "SIZE" + ], + "targetBucket": "MyReports" + }, + "reportRecurrences": "FREQ=MONTHLY", + "ruleName": "SampleRule_1", + "ruleType": "OBJECT_RULE" + } + x-related-resource: '#/definitions/InventoryRule' + /n/{namespaceName}/inventoryRules/{inventoryRuleId}: + delete: + description: Deletes the specified rule. + operationId: DeleteInventoryRule + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/InventoryRuleIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '204': + description: Specified Inventory rule has been deleted. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '409': + $ref: '#/components/responses/NotAuthorizedOrInternalConflict' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Delete the specified inventory rule. + tags: + - objectStorage + x-example: | + DELETE /n/<namespace_string>/inventoryRules/<inventoryRuleId_string> HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept: */* + date: Fri, 12 Nov 2019 23:04:28 GMT + content-length: 0 + opc-client-request-id: sampleOpcClientRequestIdForDelete + authorization: <authorization and other headers> + x-related-resource: '#/definitions/InventoryRule' + get: + description: Get the specified inventory rule. + operationId: GetInventoryRule + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/InventoryRuleIdPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '200': + description: The specified inventory rule. + headers: + etag: + description: The entity tag (ETag) for the inventory rule. + schema: + type: string + last-modified: + description: The time the inventory rule was last modified, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29) + schema: + type: string + format: date-time + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryRule' + application-json: + examples: + response: + value: | + { + "etag": "154de92a-b711-498f-99c8-56754c20c94b", + "filter": { + "created-within-days": -1, + "exclusion-prefixes": [], + "inclusion-prefixes": [ + "bucket1/o/*" + ], + "object-types": [ + "OBJECT" + ] + }, + "id": "oir-edb87a59-b8cb-4bda-ba71-3abaeeb192fd", + "is-enabled": true, + "report": { + "format": "PARQUET", + "schema-fields": [ + "ETAG", + "SIZE" + ], + "target-bucket": "MyReports" + }, + "report-recurrences": "FREQ=MONTHLY", + "rule-name": "SampleRule_1", + "rule-type": "OBJECT_RULE", + "time-created": "2025-01-31T09:02:16.312000+00:00", + "time-modified": "2025-01-31T09:02:16.312000+00:00" + } + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Get the specified inventory rule. + tags: + - objectStorage + x-related-resource: '#/definitions/InventoryRule' + put: + description: | + Updates the specified inventory rule. Rule changes take effect typically within 30 seconds. + operationId: UpdateInventoryRule + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/InventoryRuleIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/ClientRequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateInventoryRuleDetails' + description: Request object for updating the inventory rule. + required: true + responses: + '200': + description: The updated InventoryRule information. + headers: + etag: + description: The entity tag (ETag) for the inventory rule that was updated. + schema: + type: string + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryRule' + application-json: + examples: + response: + value: | + { + "etag": "23b222ca-06d5-4588-9ba0-c3221f7143ce", + "filter": { + "created-within-days": 4, + "exclusion-prefixes": [ + "*/o/tmp*" + ], + "inclusion-prefixes": [ + "*/o/log*" + ], + "object-types": [ + "OBJECT" + ] + }, + "id": "oir-a6a172b5-42cb-4996-b01b-d6c83a409a4a", + "is-enabled": true, + "report": { + "format": "PARQUET", + "schema-fields": [ + "SIZE", + "COMPARTMENT_ID" + ], + "target-bucket": "destinationBucket" + }, + "report-recurrences": "FREQ=MONTHLY", + "rule-name": "SampleRuleUpdate", + "rule-type": "OBJECT_RULE", + "time-created": "2025-01-31T08:58:15.867000+00:00", + "time-modified": "2025-01-31T09:19:56.725000+00:00" + } + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '409': + $ref: '#/components/responses/NotAuthorizedOrInternalConflict' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Update the specified inventory rule. + tags: + - objectStorage + x-example: | + PUT /n/<namespace_string>/inventoryRules/<inventoryRuleId_string> HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 12 Nov 2019 22:50:18 GMT + content-type: application/json + authorization: <authorization and other headers> + { + "filter": { + "created-within-days": 4, + "exclusion-prefixes": [ + "*/o/tmp*" + ], + "inclusion-prefixes": [ + "*/o/log*" + ], + "object-types": [ + "OBJECT" + ] + }, + "inventoryRuleId": "oir-a6a172b5-42cb-4996-b01b-d6c83a409a4a", + "is-enabled": true, + "report": { + "format": "PARQUET", + "schema-fields": [ + "SIZE", + "COMPARTMENT_ID" + ], + "target-bucket": "destinationBucket" + }, + "report-recurrences": "FREQ=MONTHLY", + "rule-name": "SampleRuleUpdate", + "rule-type": "OBJECT_RULE" + } + x-related-resource: '#/definitions/InventoryRule' + /n/{namespaceName}/pe/: + get: + description: | + Gets a list of all PrivateEndpointSummary in a compartment associated with a namespace. + To use this and other API operations, you must be authorized in an IAM policy. If you are not authorized, + talk to an administrator. If you are an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + operationId: ListPrivateEndpoints + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/ListPrivateEndpointFieldsQueryParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + - $ref: '#/components/parameters/lifecycleState' + responses: + '200': + description: A page of PrivateEndpointSummary objects. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-next-page: + description: | + For paginating a list of PEs. + In the GET request, set the limit to the number of Private Endpoint items that you want returned in the response. + If the `opc-next-page` header appears in the response, then this is a partial list and there are additional + Private Endpoint's to get. Include the header's value as the `page` parameter in the subsequent GET request to get the + next batch of PEs. Repeat this process to retrieve the entire list of Private Endpoint's. + By default, the page limit is set to 25 Private Endpoint's per page, but you can specify a value from 1 to 1000. + For more 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, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ListPrivateEndpointsResponse' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: List Private Endpoints + tags: + - objectStorage + x-example: | + GET /n/<namespace_string>/pe/ HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 20 Jan 2017 22:52:33 GMT + authorization: <authorization and other headers> + post: + description: | + Create a PrivateEndpoint. + operationId: CreatePrivateEndpoint + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePrivateEndpointDetails' + description: Details to create a private endpoint. + required: true + responses: + '202': + description: The request has been accepted for processing, but the processing has not completed. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. If you need to contact Oracle about a + particular request, provide this request ID. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '409': + $ref: '#/components/responses/NotAuthorizedOrInternalConflict' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Create PrivateEndpoint + tags: + - objectStorage + x-example: | + POST /n/<namespace_string>/pe/ HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 12 Aug 2016 22:50:18 GMT + x-content-sha256: GzeGbC8Ad9cEhdcnD2wjPiUej5TIHHw2I+uj4w7Jot4= + Content-Length: 148 + content-type: application/json + authorization: <authorization and other headers> + { + "name": "my-new-private-endpoint-1", + "namespace": "unique_namespace", + "compartmentId": "ocid.compartment.oc1..exampleuniquecompartmentID", + "subnetId": "ocid.subnet.oc1..exampleuniquesubnetID", + "prefix": "myprefix", + "additionalPrefixes": ["myprefix-1", "myprefix-2"], + "accessTargets": [ + { + "namespace": "ns1", + "compartmentId": "comp1", + "bucket": "b1" + }, + { + "namespace": "ns2", + "compartmentId": "comp2", + "bucket" : "*" + }, + { + "namespace": "ns3", + "compartmentId": "*", + "bucket": "b2" + }, + { + "namespace": "ns4", + "compartmentId": "*", + "bucket": "*" + } + ], + "freeformTags": {"Department": "Finance"}, + "definedTags": + { + "MyTags": + { + "CostCenter": "42", + "Project": "Stealth", + "CreatedBy": "BillSmith", + "CreatedDate": "9/21/2017T14:00" + }, + "Audit": + { + "DataSensitivity": "PII", + "CageSecurity": "High", + "Simplicity": "complex" + } + } + } + x-related-resource: '#/definitions/PrivateEndpoint' + /n/{namespaceName}/pe/{peName}/: + delete: + description: | + Deletes a Private Endpoint if it exists in the given namespace. + operationId: DeletePrivateEndpoint + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/PrivateEndpointPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '202': + description: The request has been accepted for processing, but the processing is not yet done. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. If you need to contact Oracle about a + particular request, provide this request ID. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '409': + $ref: '#/components/responses/NotAuthorizedOrInternalConflict' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: DELETE Private Endpoint + tags: + - objectStorage + x-example: | + DELETE /n/<namespace_string>/pe/< HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 12 Aug 2016 23:04:28 GMT + content-length: 0 + authorization: <authorization and other headers> + x-related-resource: '#/definitions/PrivateEndpoint' + get: + description: | + Gets the current representation of the given Private Endpoint in the given Object Storage namespace. + operationId: GetPrivateEndpoint + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/PrivateEndpointPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/IfNoneMatchHeaderExceptStar' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '200': + description: A private endpoint representation for the requested private endpoint. + headers: + eTag: + description: The entity tag (ETag) for the Private Endpoint. + schema: + type: string + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PrivateEndpoint' + application-json: + examples: + response: + value: | + { + "name": "new_pe_1", + "namespace": "namespace_1", + "compartmentId": "ocid.compartment.oc1..exampleuniquecompartmentID", + "id": "ocid1.pe.oc1.iad.examplepeID", + "createdBy": "ocid1.user.oc1..exampleuniqueuserID", + "timeCreated": "2022-11-08T03:48:40.511Z", + "subnetId": "ocid.subnet.oc1..exampleuniquesubnetID", + "privateEndpointIp": "10.0.0.10", + "prefix": "myprefix", + "additionalPrefixes": ["myprefix-1", "myprefix-2"], + "etag": "9282a931-6367-4e8a-85d0-cfe9796b20ef", + "freeformTags": {"Department": "Finance"}, + "fqdns": { + "prefixFqdns": { + "objectStorageApiFqdn": "https://myprefix-namespace_1.private.customer-oci.objectstorage.r1.oci.oraclecloud.com", + "s3CompatibilityApiFqdn": "myprefix-namespace_1.private.customer-oci.compat.objectstorage.r1.oci.oraclecloud.com", + "swiftApiFqdn": "myprefix-namespace_1.private.customer-oci.swiftobjectstorage.r1.oci.oraclecloud.com" + }, + "additionalPrefixesFqdns": { + "addPrefix1": { + "objectStorageApiFqdn": "https://addPrefix1-namespace_1.private.customer-oci.objectstorage.r1.oci.oraclecloud.com", + "s3CompatibilityApiFqdn": "addPrefix1-namespace_1.private.customer-oci.compat.objectstorage.r1.oci.oraclecloud.com", + "swiftApiFqdn": "addPrefix1-namespace_1.private.customer-oci.swiftobjectstorage.r1.oci.oraclecloud.com" + }, + "addPrefix2": { + "objectStorageApiFqdn": "https://addPrefix2-namespace_2.private.customer-oci.objectstorage.r1.oci.oraclecloud.com", + "s3CompatibilityApiFqdn": "addPrefix2-namespace_2.private.customer-oci.compat.objectstorage.r1.oci.oraclecloud.com", + "swiftApiFqdn": "addPrefix2-namespace_2.private.customer-oci.swiftobjectstorage.r1.oci.oraclecloud.com" + } + } + }, + "definedTags": + { + "MyTags": + { + "CostCenter": "42", + "Project": "Stealth", + "CreatedBy": "BillSmith", + "CreatedDate": "9/21/2017T14:00" + }, + "Audit": + { + "DataSensitivity": "PII", + "CageSecurity": "High", + "Simplicity": "complex" + } + } + } + '304': + description: Not Modified + headers: + ETag: + description: The entity tag (ETag) for the Private Endpoint. + schema: + type: string + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Get PrivateEndpoint + tags: + - objectStorage + x-example: | + GET /n/<namespace_string>/pe/<pe_name> HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 12 Aug 2016 22:52:33 GMT + authorization: <authorization and other headers> + x-related-resource: '#/definitions/PrivateEndpoint' + post: + description: | + Performs a partial or full update of a user-defined data associated with the Private Endpoint. + + Use UpdatePrivateEndpoint to move a Private Endpoint from one compartment to another within the same tenancy. Supply the compartmentID + of the compartment that you want to move the Private Endpoint to. Or use it to update the name, subnetId, endpointFqdn or privateEndpointIp or accessTargets of the Private Endpoint. + For more information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + + This API follows replace semantics (rather than merge semantics). That means if the body provides values for + parameters and the resource has exisiting ones, this operation will replace those existing values. + operationId: UpdatePrivateEndpoint + parameters: + - $ref: '#/components/parameters/NamespacePathParam' + - $ref: '#/components/parameters/PrivateEndpointPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePrivateEndpointDetails' + description: Request object for updating the Private Endpoint. + required: true + responses: + '202': + description: The request has been accepted for processing, but the processing is not yet done. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. If you need to contact Oracle about a + particular request, provide this request ID. + schema: + type: string + content: + application-json: + examples: + response: + value: | + { + "name": "my-pe-1", + "namespace": "namespace_1", + "compartmentId": "ocid.compartment.oc1..exampleuniquecompartmentID", + "id": "ocid1.pe.oc1.iad.examplePEID", + "createdBy": "ocid1.user.oc1..exampleuniqueuserID", + "timeCreated": "2016-08-23T20:58:02.497Z", + "subnetId": "ocid.subnet.oc1..exampleuniquesubnetID", + "prefix": "myprefix", + "additionalPrefixes": ["myprefix-1", "myprefix-2"], + "etag": "82361183-a765-4e51-be48-933518c6ee5a", + "accessTargets": + [ + { + "namespace": "ns1", + "compartmentId": "comp1", + "bucket": "b1" + }, + { + "namespace": "ns2", + "compartmentId": "comp2", + "bucket": "*" + }, + { + "namespace": "ns3", + "compartmentId": "*", + "bucket": "b2" + }, + { + "namespace": "ns4", + "compartmentId": "*", + "bucket": "*" + } + ], + "freeformTags": {"Department": "Finance"}, + "definedTags": + { + "MyTags": + { + "CostCenter": "42", + "Project": "Stealth", + "CreatedBy": "BillSmith", + "CreatedDate": "9/21/2017T14:00" + }, + "Audit": + { + "DataSensitivity": "PII", + "CageSecurity": "High", + "Simplicity": "complex" + } + } + } + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '409': + $ref: '#/components/responses/NotAuthorizedOrInternalConflict' + '412': + $ref: '#/components/responses/PreconditionFailed' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: POST Private Endpoint + tags: + - objectStorage + x-example: | + POST /n/<namespace_string>/pe/<pe_name> HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.10.0 + date: Tue, 23 Aug 2016 21:01:55 GMT + x-content-sha256: XK0yY+agfR3IHWjFyQlO5LCU8IysvgpDdDGSRrb/xzA= + Content-Length: 80 + content-type: application/json + authorization: <authorization and other headers> + { + "name": "my-new-private-endpoint-1", + "namespace": "unique_namespace", + "compartmentId": "ocid.compartment.oc1..exampleuniquecompartmentID", + "subnetId": "ocid1.subnet.region1.sea..exampleSubnetId", + "privateEndpointIp": "10.0.0.10", + "prefix": "myprefix", + "additionalPrefixes": ["myprefix-1", "myprefix-2"], + "accessTargets": + [ + { + "namespace": "ns1", + "compartmentId": "comp1", + "bucket": "b1" + }, + { + "namespace": "ns2", + "compartmentId": "comp2", + "bucket": "*" + }, + { + "namespace": "ns3", + "compartmentId": "*", + "bucket": "b2" + }, + { + "namespace": "ns4", + "compartmentId": "*", + "bucket": "*" + }, + ], + "freeformTags": {"Department": "Finance"}, + "definedTags": + { + "MyTags": + { + "CostCenter": "42", + "Project": "Stealth", + "CreatedBy": "BillSmith", + "CreatedDate": "9/21/2017T14:00" + }, + "Audit": + { + "DataSensitivity": "PII", + "CageSecurity": "High", + "Simplicity": "complex" + } + } + } + x-related-resource: '#/definitions/PrivateEndpoint' + /workRequests: + get: + description: | + Lists the work requests in a compartment. + operationId: ListWorkRequests + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PrivateEndpointNameQueryParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + responses: + '200': + description: The list of work requests. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-next-page: + description: | + For paginating a list of work requests. + In the GET request, set the limit to the number of compartment work requests that you want returned in the + response. If the `opc-next-page` header appears in the response, then this is a partial list and there are + additional work requests to get. Include the header's value as the `page` parameter in the subsequent + GET request to get the next batch of work requests. Repeat this process to retrieve the entire list of work + requests. + + For more 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, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ListWorkRequestsResponse' + application-json: + examples: + response: + value: | + [ + { + "operationType": "COPY_OBJECT", + "status": "IN_PROGRESS", + "id": "f54527d6-029b-4221-9046-a811b7686202", + "resources": [ + { + "entityType": "object", + "actionType": "READ", + "entityUri": "/n/ansh8lvru1zp/b/backups/o/backup.tar.gz", + "metadata": { + "REGION": "us-phoenix-1", + "NAMESPACE": "ansh8lvru1zp", + "BUCKET": "backups", + "OBJECT": "backup.tar.gz" + } + }, + { + "entityType": "object", + "actionType": "WRITTEN", + "entityUri": "/n/ansh8lvru1zp/b/backups/o/backup2.tar.gz", + "metadata": { + "REGION": "us-phoenix-1", + "NAMESPACE": "ansh8lvru1zp", + "BUCKET": "backups", + "OBJECT": "backup2.tar.gz" + } + } + ], + "timeAccepted": "2017-10-13T17:23:46.000Z", + "timeStarted": "2017-10-13T17:23:52.198Z", + "percentComplete": 10.0 + } + ] + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: List Work Requests + tags: + - objectStorage + x-example: | + GET /WorkRequests?compartmentId=ocid.compartment.oc1..exampleuniqueID HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 12 Aug 2016 23:00:25 GMT + authorization: <authorization and other headers> + x-related-resource: '#/definitions/WorkRequest' + /workRequests/{workRequestId}: + delete: + description: | + Cancels a work request. + operationId: CancelWorkRequest + parameters: + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '202': + description: The request has been accepted for processing, but the processing has not completed. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, + provide this request ID. + schema: + type: string + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: Cancel a work request + tags: + - objectStorage + x-example: | + DELETE /WorkRequests/ HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.11.0 + date: Fri, 12 Aug 2016 23:01:51 GMT + content-length: 0 + authorization: <authorization and other headers> + x-related-resource: '#/definitions/WorkRequest' + get: + description: Gets the status of the work request for the given ID. + operationId: GetWorkRequest + parameters: + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '200': + description: The details of the work request. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + retry-after: + description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. + schema: + type: number + format: float + content: + application/json: + schema: + $ref: '#/components/schemas/WorkRequest' + application-json: + examples: + response: + value: | + { + "operationType": "COPY_OBJECT", + "status": "IN_PROGRESS", + "id": "f54527d6-029b-4221-9046-a811b7686202", + "resources": [ + { + "entityType": "object", + "actionType": "READ", + "entityUri": "/n/ansh8lvru1zp/b/backups/o/backup.tar.gz", + "metadata": { + "REGION": "us-phoenix-1", + "NAMESPACE": "ansh8lvru1zp", + "BUCKET": "backups", + "OBJECT": "backup.tar.gz" + } + }, + { + "entityType": "object", + "actionType": "WRITTEN", + "entityUri": "/n/ansh8lvru1zp/b/backups/o/backup2.tar.gz", + "metadata": { + "REGION": "us-phoenix-1", + "NAMESPACE": "ansh8lvru1zp", + "BUCKET": "backups", + "OBJECT": "backup2.tar.gz" + } + } + ], + "timeAccepted": "2017-10-13T17:23:46.000Z", + "timeStarted": "2017-10-13T17:23:52.198Z", + "percentComplete": 10.0 + } + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: GET Work Request Status + tags: + - objectStorage + x-example: | + GET /WorkRequests/example_work_request_id HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.10.0 + date: Fri, 19 Aug 2016 23:43:49 GMT + authorization: <authorization and other headers> + x-related-resource: '#/definitions/WorkRequest' + /workRequests/{workRequestId}/errors: + get: + description: Lists the errors of the work request with the given ID. + operationId: ListWorkRequestErrors + parameters: + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '200': + description: The errors of the work request. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-next-page: + description: | + For paginating a list of work request errors. + In the GET request, set the limit to the number of work request errors that you want returned in the + response. If the `opc-next-page` header appears in the response, then this is a partial list and there are + additional work request errors to get. Include the header's value as the `page` parameter in the subsequent + GET request to get the next batch of work request errors. Repeat this process to retrieve the entire list of work + request errors. + + For more 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, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ListWorkRequestErrorsResponse' + application-json: + examples: + response: + value: | + { + "errors": [ + { + "code": "NotAuthorizedOrNotFound", + "message": "This is an error", + "time": "2017-10-13T17:23:46.000Z" + }, + { + "code": "NotAuthorizedOrNotFound", + "message": "This is another error", + "time": "2017-10-13T17:23:47.000Z" + } + ] + } + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: List Work Request Errors + tags: + - objectStorage + x-example: | + GET /WorkRequests/example_work_request_id/errors HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.10.0 + date: Fri, 19 Aug 2016 23:43:49 GMT + authorization: <authorization and other headers> + x-related-resource: '#/definitions/WorkRequestError' + /workRequests/{workRequestId}/logs: + get: + description: Lists the logs of the work request with the given ID. + operationId: ListWorkRequestLogs + parameters: + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/ClientRequestIdHeader' + responses: + '200': + description: The logs of the work request. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-next-page: + description: | + For paginating a list of work request logs. + In the GET request, set the limit to the number of compartment work requests that you want returned in the + response. If the `opc-next-page` header appears in the response, then this is a partial list and there are + additional work requests to get. Include the header's value as the `page` parameter in the subsequent + GET request to get the next batch of work requests. Repeat this process to retrieve the entire list of work + requests. + + For more 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, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ListWorkRequestLogsResponse' + application-json: + examples: + response: + value: | + { + "logs": [ + { + "message": "This is a log", + "time": "2017-10-13T17:23:46.000Z" + }, + { + "message": "This is another log", + "time": "2017-10-13T17:23:47.000Z" + } + ] + } + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthenticated' + '404': + $ref: '#/components/responses/NotAuthorizedOrNotFound' + '408': + $ref: '#/components/responses/RequestTimeout' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + $ref: '#/components/responses/InternalServerError' + default: + $ref: '#/components/responses/Error' + summary: List Work Request Logs + tags: + - objectStorage + x-example: | + GET /WorkRequests/example_work_request_id/logs HTTP/1.1 + Host: objectstorage.us-phoenix-1.oraclecloud.com + connection: keep-alive + accept-encoding: gzip, deflate + accept: */* + user-agent: python-requests/2.10.0 + date: Fri, 19 Aug 2016 23:43:49 GMT + authorization: <authorization and other headers> + x-related-resource: '#/definitions/WorkRequestLogEntry' +components: + schemas: + NamespaceMetadata: + description: | + NamespaceMetadata maps a namespace string to defaultS3CompartmentId and defaultSwiftCompartmentId values. + properties: + defaultS3CompartmentId: + description: If the field is set, specifies the default compartment assignment for the Amazon S3 Compatibility API. + type: string + defaultSwiftCompartmentId: + description: If the field is set, specifies the default compartment assignment for the Swift API. + type: string + namespace: + description: The Object Storage namespace to which the metadata belongs. + type: string + required: + - namespace + - defaultS3CompartmentId + - defaultSwiftCompartmentId + type: object + UpdateNamespaceMetadataDetails: + description: | + UpdateNamespaceMetadataDetails is used to update the NamespaceMetadata. To update NamespaceMetadata, a user + must have OBJECTSTORAGE_NAMESPACE_UPDATE permission. + properties: + defaultS3CompartmentId: + description: The updated compartment id for use by an S3 client, if this field is set. + type: string + defaultSwiftCompartmentId: + description: The updated compartment id for use by a Swift client, if this field is set. + type: string + type: object + BucketSummary: + description: | + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, + talk to an administrator. If you are an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + bucketScope: + description: | + The bucket scope determines weather the bucket name must be unique within the tenancy and region (essentially the namespace) or across all tenancies in the region. The bucket scope also determines if the bucket supports S3 virtual-hosted style URL's or not. + + Allowed values: + NAMESPACE: Only supports path-style bucket access, bucket name only needs to be unique within the tenancy and region. + REGION: Supports both path-style and virtual-hosted URL style access, bucket name needs to be unique across all tenancies in the region. + type: string + x-obmcs-enumref: '#/definitions/Bucket/bucketScope' + compartmentId: + description: The compartment ID in which the bucket is authorized. + type: string + createdBy: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the user who created the bucket. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + etag: + description: The entity tag (ETag) for the bucket. + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + name: + description: | + The name of the bucket. Avoid entering confidential information. + Example: my-new-bucket1 + type: string + namespace: + description: The Object Storage namespace in which the bucket lives. + type: string + timeCreated: + description: The date and time the bucket was created, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). + format: date-time + type: string + required: + - namespace + - name + - compartmentId + - createdBy + - timeCreated + - etag + type: object + CreateBucketDetails: + description: | + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, + talk to an administrator. If you are an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + autoTiering: + description: | + Set the auto tiering status on the bucket. By default, a bucket is created with auto tiering `Disabled`. + Use this option to enable auto tiering during bucket creation. Objects in a bucket with auto tiering set to + `InfrequentAccess` are transitioned automatically between the 'Standard' and 'InfrequentAccess' + tiers based on the access pattern of the objects. + type: string + x-obmcs-enumref: '#/definitions/Bucket/autoTiering' + bucketScope: + description: | + The bucket scope determines weather the bucket name must be unique within the tenancy and region (essentially the namespace) or across all tenancies in the region. The bucket scope also determines if the bucket supports S3 virtual-hosted style URL's or not. + + Allowed values: + NAMESPACE: Only supports path-style bucket access, bucket name only needs to be unique within the tenancy and region. + REGION: Supports both path-style and virtual-hosted URL style access, bucket name needs to be unique across all tenancies in the region. + type: string + x-obmcs-enumref: '#/definitions/Bucket/bucketScope' + compartmentId: + description: The ID of the compartment in which to create the bucket. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + isBucketKeyEnabled: + description: | + Specifies whether Object Storage should use intermediate cached Bucket Encryption Keys with server-side + encryption using KMS (SSE-KMS) for new objects in the bucket. This reduces calls to OCI Vault Key Management + Service (KMS). Existing objects are not affected. + type: boolean + kmsKeyId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key + Management service to generate a data encryption key or to encrypt or decrypt a data encryption key. + type: string + metadata: + additionalProperties: + type: string + description: Arbitrary string, up to 4KB, of keys and values for user-defined metadata. + type: object + name: + description: | + The name of the bucket. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods. + Bucket names must be unique within an Object Storage namespace. Avoid entering confidential information. + example: Example: my-new-bucket1 + maxLength: 256 + minLength: 1 + type: string + objectEventsEnabled: + description: | + Whether or not events are emitted for object state changes in this bucket. By default, `objectEventsEnabled` is + set to `false`. Set `objectEventsEnabled` to `true` to emit events for object state changes. For more information + about events, see [Overview of Events](/Content/Events/Concepts/eventsoverview.htm). + type: boolean + publicAccessType: + description: | + The type of public access enabled on this bucket. + A bucket is set to `NoPublicAccess` by default, which only allows an authenticated caller to access the + bucket and its contents. When `ObjectRead` is enabled on the bucket, public access is allowed for the + `GetObject`, `HeadObject`, and `ListObjects` operations. When `ObjectReadWithoutList` is enabled on the bucket, + public access is allowed for the `GetObject` and `HeadObject` operations. + enum: + - NoPublicAccess + - ObjectRead + - ObjectReadWithoutList + type: string + storageTier: + description: | + The type of storage tier of this bucket. + A bucket is set to 'Standard' tier by default, which means the bucket will be put in the standard storage tier. + When 'Archive' tier type is set explicitly, the bucket is put in the Archive Storage tier. The 'storageTier' + property is immutable after bucket is created. + enum: + - Standard + - Archive + type: string + versioning: + description: | + Set the versioning status on the bucket. By default, a bucket is created with versioning `Disabled`. Use this option to enable versioning during bucket creation. Objects in a version enabled bucket are protected from overwrites and deletions. Previous versions of the same object will be available in the bucket. + enum: + - Enabled + - Disabled + type: string + required: + - name + - compartmentId + type: object + Bucket: + description: | + A bucket is a container for storing objects in a compartment within a namespace. A bucket is associated with a single compartment. + The compartment has policies that indicate what actions a user can perform on a bucket and all the objects in the bucket. For more + information, see [Managing Buckets](/Content/Object/Tasks/managingbuckets.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, + talk to an administrator. If you are an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + approximateCount: + description: | + The approximate number of objects in the bucket. Count statistics are reported periodically. You will see a + lag between what is displayed and the actual object count. + format: int64 + type: integer + approximateSize: + description: | + The approximate total size in bytes of all objects in the bucket. Size statistics are reported periodically. You will + see a lag between what is displayed and the actual size of the bucket. + format: int64 + type: integer + autoTiering: + description: | + The auto tiering status on the bucket. A bucket is created with auto tiering `Disabled` by default. + For auto tiering `InfrequentAccess`, objects are transitioned automatically between the 'Standard' + and 'InfrequentAccess' tiers based on the access pattern of the objects. + enum: + - Disabled + - InfrequentAccess + type: string + bucketScope: + description: | + The bucket scope determines weather the bucket name must be unique within the tenancy and region (essentially the namespace) or across all tenancies in the region. The bucket scope also determines if the bucket supports S3 virtual-hosted style URL's or not. + + Allowed values: + NAMESPACE: Only supports path-style bucket access, bucket name only needs to be unique within the tenancy and region. + REGION: Supports both path-style and virtual-hosted URL style access, bucket name needs to be unique across all tenancies in the region. + enum: + - NAMESPACE + - REGION + type: string + compartmentId: + description: The compartment ID in which the bucket is authorized. + type: string + createdBy: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the user who created the bucket. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + etag: + description: The entity tag (ETag) for the bucket. + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the bucket. + type: string + isBucketKeyEnabled: + description: | + Specifies whether Object Storage should use intermediate cached Bucket Encryption Keys with server-side + encryption using KMS (SSE-KMS) for new objects in the bucket. This reduces calls to OCI Vault Key Management + Service (KMS). Existing objects are not affected. + type: boolean + isReadOnly: + description: | + Whether or not this bucket is read only. By default, `isReadOnly` is set to `false`. This will + be set to 'true' when this bucket is configured as a destination in a replication policy. + type: boolean + kmsKeyId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key Management + service to generate a data encryption key or to encrypt or decrypt a data encryption key. + type: string + metadata: + additionalProperties: + type: string + description: Arbitrary string keys and values for user-defined metadata. + type: object + name: + description: | + The name of the bucket. Avoid entering confidential information. + Example: my-new-bucket1 + type: string + namespace: + description: The Object Storage namespace in which the bucket resides. + type: string + objectEventsEnabled: + description: | + Whether or not events are emitted for object state changes in this bucket. By default, `objectEventsEnabled` is + set to `false`. Set `objectEventsEnabled` to `true` to emit events for object state changes. For more information + about events, see [Overview of Events](/Content/Events/Concepts/eventsoverview.htm). + type: boolean + objectLifecyclePolicyEtag: + description: The entity tag (ETag) for the live object lifecycle policy on the bucket. + type: string + publicAccessType: + description: | + The type of public access enabled on this bucket. + A bucket is set to `NoPublicAccess` by default, which only allows an authenticated caller to access the + bucket and its contents. When `ObjectRead` is enabled on the bucket, public access is allowed for the + `GetObject`, `HeadObject`, and `ListObjects` operations. When `ObjectReadWithoutList` is enabled on the + bucket, public access is allowed for the `GetObject` and `HeadObject` operations. + enum: + - NoPublicAccess + - ObjectRead + - ObjectReadWithoutList + type: string + replicationEnabled: + description: | + Whether or not this bucket is a replication source. By default, `replicationEnabled` is set to `false`. This will + be set to 'true' when you create a replication policy for the bucket. + type: boolean + storageTier: + description: | + The storage tier type assigned to the bucket. A bucket is set to `Standard` tier by default, which means + objects uploaded or copied to the bucket will be in the standard storage tier. When the `Archive` tier type + is set explicitly for a bucket, objects uploaded or copied to the bucket will be stored in archive storage. + The `storageTier` property is immutable after bucket is created. + enum: + - Standard + - Archive + type: string + timeCreated: + description: The date and time the bucket was created, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). + format: date-time + type: string + versioning: + description: | + The versioning status on the bucket. A bucket is created with versioning `Disabled` by default. + For versioning `Enabled`, objects are protected from overwrites and deletes, by maintaining their version history. When versioning is `Suspended`, the previous versions will still remain but new versions will no longer be created when overwitten or deleted. + enum: + - Enabled + - Suspended + - Disabled + type: string + required: + - namespace + - name + - compartmentId + - createdBy + - timeCreated + - metadata + - etag + type: object + UpdateBucketDetails: + description: | + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, + talk to an administrator. If you are an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + autoTiering: + description: | + The auto tiering status on the bucket. If in state `InfrequentAccess`, objects are transitioned + automatically between the 'Standard' and 'InfrequentAccess' tiers based on the access pattern of the objects. + When auto tiering is `Disabled`, there will be no automatic transitions between storage tiers. + type: string + x-obmcs-enumref: '#/definitions/Bucket/autoTiering' + bucketScope: + description: | + The bucket scope determines weather the bucket name must be unique within the tenancy and region (essentially the namespace) or across all tenancies in the region. The bucket scope also determines if the bucket supports S3 virtual-hosted style URL's or not. + + Allowed values: + NAMESPACE: Only supports path-style bucket access, bucket name only needs to be unique within the tenancy and region. + REGION: Supports both path-style and virtual-hosted URL style access, bucket name needs to be unique across all tenancies in the region. + + BucketScope can only be updated from NAMESPACE to REGION, it cannot be updated from REGION to NAMESPACE. + Updating bucket scope is possible only if the bucket name is valid and there is no existing regionally unique + bucket with the same name. + type: string + x-obmcs-enumref: '#/definitions/Bucket/bucketScope' + compartmentId: + description: The compartmentId for the compartment to move the bucket to. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + isBucketKeyEnabled: + description: | + Specifies whether Object Storage should use intermediate cached Bucket Encryption Keys with server-side + encryption using KMS (SSE-KMS) for new objects in the bucket. This reduces calls to OCI Vault Key Management + Service (KMS). Existing objects are not affected. + type: boolean + kmsKeyId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the Key Management master encryption key to associate + with the specified bucket. If this value is empty, the Update operation will remove the associated key, if + there is one, from the bucket. (The bucket will continue to be encrypted, but with an encryption key managed + by Oracle.) + type: string + metadata: + additionalProperties: + type: string + description: Arbitrary string, up to 4KB, of keys and values for user-defined metadata. + type: object + name: + description: | + The name of the bucket. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods. + Bucket names must be unique within an Object Storage namespace. Avoid entering confidential information. + Example: my-new-bucket1 + type: string + namespace: + description: The Object Storage namespace in which the bucket lives. + type: string + objectEventsEnabled: + description: | + Whether or not events are emitted for object state changes in this bucket. By default, `objectEventsEnabled` is + set to `false`. Set `objectEventsEnabled` to `true` to emit events for object state changes. For more information + about events, see [Overview of Events](/Content/Events/Concepts/eventsoverview.htm). + type: boolean + publicAccessType: + description: | + The type of public access enabled on this bucket. A bucket is set to `NoPublicAccess` by default, which only allows an + authenticated caller to access the bucket and its contents. When `ObjectRead` is enabled on the bucket, public access + is allowed for the `GetObject`, `HeadObject`, and `ListObjects` operations. When `ObjectReadWithoutList` is enabled + on the bucket, public access is allowed for the `GetObject` and `HeadObject` operations. + enum: + - NoPublicAccess + - ObjectRead + - ObjectReadWithoutList + type: string + versioning: + description: | + The versioning status on the bucket. If in state `Enabled`, multiple versions of the same object can be kept in the bucket. + When the object is overwritten or deleted, previous versions will still be available. When versioning is `Suspended`, the previous versions will still remain but new versions will no longer be created when overwitten or deleted. + Versioning cannot be disabled on a bucket once enabled. + enum: + - Enabled + - Suspended + type: string + type: object + BatchDeleteObjectsDetails: + description: | + Batch delete request details. + properties: + isSkipDeletedResult: + default: false + description: | + Specifies whether to skip the details of successfully deleted objects in the response. If specified true + then only the details of failed deletes will be available in the response. Defaults to false. + type: boolean + objects: + description: | + The list of the objects to delete. + items: + $ref: '#/components/schemas/BatchDeleteObjectIdentifier' + maxItems: 1000 + type: array + required: + - objects + type: object + BatchDeleteObjectsResult: + description: | + Result of a batch delete operation. + properties: + deleted: + description: | + Details of successfully deleted objects. + items: + $ref: '#/components/schemas/DeletedObjectResult' + type: array + failed: + description: | + Details of failed delete operations. + items: + $ref: '#/components/schemas/FailedObjectResult' + type: array + required: + - deleted + type: object + CopyObjectDetails: + description: | + The parameters required by Object Storage to process a request to copy an object to another bucket. + + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, + talk to an administrator. If you are an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + destinationBucket: + description: The destination bucket the object will be copied to. + type: string + destinationNamespace: + description: The destination Object Storage namespace the object will be copied to. + type: string + destinationObjectIfMatchETag: + description: | + The entity tag (ETag) to match against that of the destination object (an object intended to be overwritten). + Used to confirm that the destination object stored under a given name is the version of that object + storing a specified entity tag. + type: string + destinationObjectIfNoneMatchETag: + description: | + The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should fail + if the object already exists in the destination bucket. + type: string + destinationObjectMetadata: + additionalProperties: + type: string + description: | + Arbitrary string keys and values for the user-defined metadata for the object. Keys must be in + "opc-meta-*" format. Avoid entering confidential information. Metadata key-value pairs entered + in this field are assigned to the destination object. If you enter no metadata values, the destination + object will inherit any existing metadata values associated with the source object. + type: object + destinationObjectName: + description: The name of the destination object resulting from the copy operation. Avoid entering confidential information. + type: string + destinationObjectStorageTier: + description: | + The storage tier that the object should be stored in. If not specified, the object will be stored in + the same storage tier as the bucket. + enum: + - Standard + - InfrequentAccess + - Archive + type: string + x-obmcs-top-level-enum: '#/definitions/StorageTier' + destinationRegion: + description: The destination region the object will be copied to, for example "us-ashburn-1". + type: string + sourceObjectIfMatchETag: + description: | + The entity tag (ETag) to match against that of the source object. Used to confirm that the source object + with a given name is the version of that object storing a specified ETag. + type: string + sourceObjectName: + description: The name of the object to be copied. + type: string + sourceVersionId: + description: VersionId of the object to copy. If not provided then current version is copied by default. + type: string + required: + - sourceObjectName + - destinationRegion + - destinationNamespace + - destinationBucket + - destinationObjectName + type: object + ReencryptObjectDetails: + description: | + The details used to re-encrypt the data encryption keys associated with an object. + You can only specify either a kmsKeyId or an sseCustomerKey in the request payload, not both. + If the request payload is empty, the object is encrypted using the encryption key assigned to the + bucket. The bucket encryption mechanism can either be a master encryption key managed by Oracle or the Vault service. + + - The sseCustomerKey field specifies the customer-provided encryption key (SSE-C) that will be used to re-encrypt the data encryption keys of the + object and its chunks. + + - The sourceSSECustomerKey field specifies information about the customer-provided encryption key that is currently + associated with the object source. Specify a value for the sourceSSECustomerKey only if the object + is encrypted with a customer-provided encryption key. + properties: + kmsKeyId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the master encryption key used to call the Vault + service to re-encrypt the data encryption keys associated with the object and its chunks. If the kmsKeyId value is + empty, whether null or an empty string, the API will perform re-encryption by using the kmsKeyId associated with the + bucket or the master encryption key managed by Oracle, depending on the bucket encryption mechanism. + type: string + sourceSseCustomerKey: + $ref: '#/components/schemas/SSECustomerKeyDetails' + sseCustomerKey: + $ref: '#/components/schemas/SSECustomerKeyDetails' + type: object + RenameObjectDetails: + description: | + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, + talk to an administrator. If you are an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + newName: + description: The new name of the source object. Avoid entering confidential information. + type: string + newObjIfMatchETag: + description: The if-match entity tag (ETag) of the new object. + type: string + newObjIfNoneMatchETag: + description: | + The if-none-match entity tag (ETag) of the new object. The only valid value is '*', which indicates + request should fail if the new object already exists. + type: string + sourceName: + description: The name of the source object to be renamed. + type: string + srcObjIfMatchETag: + description: The if-match entity tag (ETag) of the source object. + type: string + required: + - sourceName + - newName + type: object + RestoreObjectsDetails: + properties: + hours: + description: | + The number of hours for which this object will be restored. + By default objects will be restored for 24 hours. You can instead configure the duration using the hours parameter. + maximum: 240 + minimum: 1 + type: integer + objectName: + description: An object that is in an archive storage tier and needs to be restored. + type: string + versionId: + description: | + The versionId of the object to restore. Current object version is used by default. + type: string + required: + - objectName + type: object + UpdateObjectStorageTierDetails: + description: | + To change the storage tier of an object, we specify the object name and the desired + storage tier in the body. Objects can be moved between Standard and InfrequentAccess + tiers and from Standard or InfrequentAccess tier to Archive tier. If a version id is + specified, only the specified version of the object is moved to a different storage + tier, else the current version is used. + properties: + objectName: + description: An object for which the storage tier needs to be changed. + type: string + storageTier: + description: The storage tier that the object should be moved to. + enum: + - Standard + - InfrequentAccess + - Archive + type: string + x-obmcs-top-level-enum: '#/definitions/StorageTier' + versionId: + description: | + The versionId of the object. Current object version is used by default. + type: string + required: + - objectName + - storageTier + type: object + ObjectLifecyclePolicy: + description: | + The collection of lifecycle policy rules that together form the object lifecycle policy of a given bucket. + properties: + items: + description: | + The live lifecycle policy on the bucket. + + For an example of this value, see the + [PutObjectLifecyclePolicy API documentation](/iaas/api/#/en/objectstorage/20160918/ObjectLifecyclePolicy/PutObjectLifecyclePolicy). + items: + $ref: '#/components/schemas/ObjectLifecycleRule' + type: array + timeCreated: + description: | + The date and time the object lifecycle policy was created, as described in + [RFC 3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + type: object + PutObjectLifecyclePolicyDetails: + description: | + Creates a new object lifecycle policy for a bucket. + properties: + items: + description: The bucket's set of lifecycle policy rules. + items: + $ref: '#/components/schemas/ObjectLifecycleRule' + type: array + type: object + ListObjects: + description: | + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, + talk to an administrator. If you are an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + nextStartWith: + description: | + The name of the object to use in the `start` parameter to obtain the next page of + a truncated ListObjects response. Avoid entering confidential information. + Example: test/object1.log + type: string + objects: + description: | + An array of object summaries. + items: + $ref: '#/components/schemas/ObjectSummary' + type: array + prefixes: + description: | + Prefixes that are common to the results returned by the request if the request specified a delimiter. + items: + type: string + type: array + required: + - objects + type: object + ObjectVersionCollection: + description: | + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, + talk to an administrator. If you are an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + items: + description: | + An array of object version summaries. + items: + $ref: '#/components/schemas/ObjectVersionSummary' + type: array + prefixes: + description: | + Prefixes that are common to the results returned by the request if the request specified a delimiter. + items: + type: string + type: array + required: + - items + type: object + PreauthenticatedRequestSummary: + description: | + Get summary information about pre-authenticated requests. + properties: + accessType: + description: The operation that can be performed on this resource. + enum: + - ObjectRead + - ObjectWrite + - ObjectReadWrite + - AnyObjectWrite + - AnyObjectRead + - AnyObjectReadWrite + type: string + bucketListingAction: + description: | + Specifies whether a list operation is allowed on a PAR with accessType "AnyObjectRead" or "AnyObjectReadWrite". + Deny: Prevents the user from performing a list operation. + ListObjects: Authorizes the user to perform a list operation. + type: string + x-obmcs-enumref: '#/definitions/PreauthenticatedRequest/bucketListingAction' + id: + description: The unique identifier to use when directly addressing the pre-authenticated request. + type: string + name: + description: The user-provided name of the pre-authenticated request. + type: string + objectName: + description: | + The name of object that is being granted access to by the pre-authenticated request. This can be null and if it is, + the pre-authenticated request grants access to the entire bucket. + type: string + timeCreated: + description: | + The date when the pre-authenticated request was created as per [RFC 3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + timeExpires: + description: | + The expiration date for the pre-authenticated request as per [RFC 3339](https://tools.ietf.org/html/rfc3339). After this date the pre-authenticated request will no longer be valid. + format: date-time + type: string + required: + - id + - name + - accessType + - timeExpires + - timeCreated + type: object + CreatePreauthenticatedRequestDetails: + properties: + accessType: + description: The operation that can be performed on this resource. + enum: + - ObjectRead + - ObjectWrite + - ObjectReadWrite + - AnyObjectWrite + - AnyObjectRead + - AnyObjectReadWrite + type: string + bucketListingAction: + default: Deny + description: | + Specifies whether a list operation is allowed on a PAR with accessType "AnyObjectRead" or "AnyObjectReadWrite". + Deny: Prevents the user from performing a list operation. + ListObjects: Authorizes the user to perform a list operation. + type: string + x-obmcs-enumref: '#/definitions/PreauthenticatedRequest/bucketListingAction' + name: + description: | + A user-specified name for the pre-authenticated request. Names can be helpful in managing pre-authenticated requests. + Avoid entering confidential information. + type: string + objectName: + description: | + The name of the object that is being granted access to by the pre-authenticated request. Avoid entering confidential + information. The object name can be null and if so, the pre-authenticated request grants access to the entire bucket + if the access type allows that. The object name can be a prefix as well, in that case pre-authenticated request + grants access to all the objects within the bucket starting with that prefix provided that we have the correct access type. + type: string + x-default-description: object name is required for "ObjectRead", "ObjectWrite" or "ObjectReadWrite" accessType. It is optional and can be passed as a prefix for all other accessTypes, by default "null" will be assigned + timeExpires: + description: | + The expiration date for the pre-authenticated request as per [RFC 3339](https://tools.ietf.org/html/rfc3339). + After this date the pre-authenticated request will no longer be valid. + format: date-time + type: string + required: + - name + - accessType + - timeExpires + type: object + PreauthenticatedRequest: + description: | + Pre-authenticated requests provide a way to let users access a bucket or an object without having their own credentials. + When you create a pre-authenticated request, a unique URL is generated. Users in your organization, partners, or third + parties can use this URL to access the targets identified in the pre-authenticated request. + See [Using Pre-Authenticated Requests](/Content/Object/Tasks/usingpreauthenticatedrequests.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an + administrator. If you are an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + accessType: + description: The operation that can be performed on this resource. + enum: + - ObjectRead + - ObjectWrite + - ObjectReadWrite + - AnyObjectWrite + - AnyObjectRead + - AnyObjectReadWrite + type: string + accessUri: + description: The URI to embed in the URL when using the pre-authenticated request. + type: string + bucketListingAction: + description: | + Specifies whether a list operation is allowed on a PAR with accessType "AnyObjectRead" or "AnyObjectReadWrite". + Deny: Prevents the user from performing a list operation. + ListObjects: Authorizes the user to perform a list operation. + enum: + - Deny + - ListObjects + type: string + id: + description: The unique identifier to use when directly addressing the pre-authenticated request. + type: string + name: + description: The user-provided name of the pre-authenticated request. + type: string + objectName: + description: | + The name of the object that is being granted access to by the pre-authenticated request. Avoid entering confidential + information. The object name can be null and if so, the pre-authenticated request grants access to the entire bucket. + Example: test/object1.log + type: string + timeCreated: + description: | + The date when the pre-authenticated request was created as per specification + [RFC 3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + timeExpires: + description: | + The expiration date for the pre-authenticated request as per [RFC 3339](https://tools.ietf.org/html/rfc3339). After + this date the pre-authenticated request will no longer be valid. + format: date-time + type: string + required: + - id + - name + - accessUri + - accessType + - timeExpires + - timeCreated + type: object + ReplicationPolicySummary: + description: The summary of a replication policy. + properties: + destinationBucketName: + description: | + The bucket to replicate to in the destination region. Replication policy creation does not automatically + create a destination bucket. Create the destination bucket before creating the policy. + maxLength: 256 + minLength: 1 + type: string + destinationRegionName: + description: The destination region to replicate to, for example "us-ashburn-1". + maxLength: 64 + minLength: 1 + type: string + id: + description: The id of the replication policy. + type: string + name: + description: The name of the policy. + maxLength: 256 + minLength: 1 + type: string + status: + description: | + The replication status of the policy. If the status is CLIENT_ERROR, once the user fixes the issue + described in the status message, the status will become ACTIVE. + enum: + - ACTIVE + - CLIENT_ERROR + type: string + statusMessage: + description: A human-readable description of the status. + type: string + timeCreated: + description: | + The date when the replication policy was created as per [RFC 3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + timeLastSync: + description: | + Changes made to the source bucket before this time has been replicated. + format: date-time + type: string + required: + - id + - name + - destinationRegionName + - destinationBucketName + - timeCreated + - timeLastSync + - status + - statusMessage + type: object + CreateReplicationPolicyDetails: + description: The details to create a replication policy. + properties: + destinationBucketName: + description: | + The bucket to replicate to in the destination region. Replication policy creation does not automatically + create a destination bucket. Create the destination bucket before creating the policy. + maxLength: 256 + minLength: 1 + type: string + destinationRegionName: + description: The destination region to replicate to, for example "us-ashburn-1". + maxLength: 64 + minLength: 1 + type: string + name: + description: The name of the policy. Avoid entering confidential information. + maxLength: 256 + minLength: 1 + type: string + required: + - name + - destinationRegionName + - destinationBucketName + type: object + ReplicationPolicy: + description: The details of a replication policy. + example: + application-json: | + { + "name": "mypolicy", + "destinationRegionName": "us-phoenix-1", + "destinationBucketName": "backup", + "id": "a54f378a-49c0-acvb-189f-58959597453a", + "timeCreated": "2017-10-13T17:23:46.000Z", + "timeLastSync": "2019-10-13T17:23:46.000Z", + "status": "ACTIVE", + "statusMessage": "Replication is ongoing." + } + properties: + destinationBucketName: + description: | + The bucket to replicate to in the destination region. Replication policy creation does not automatically + create a destination bucket. Create the destination bucket before creating the policy. + maxLength: 256 + minLength: 1 + type: string + destinationRegionName: + description: The destination region to replicate to, for example "us-ashburn-1". + maxLength: 64 + minLength: 1 + type: string + id: + description: The id of the replication policy. + type: string + name: + description: The name of the policy. + maxLength: 256 + minLength: 1 + type: string + status: + description: | + The replication status of the policy. If the status is CLIENT_ERROR, once the user fixes the issue + described in the status message, the status will become ACTIVE. + enum: + - ACTIVE + - CLIENT_ERROR + type: string + statusMessage: + description: A human-readable description of the status. + type: string + timeCreated: + description: | + The date when the replication policy was created as per [RFC 3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + timeLastSync: + description: | + Changes made to the source bucket before this time has been replicated. + format: date-time + type: string + required: + - id + - name + - destinationRegionName + - destinationBucketName + - timeCreated + - timeLastSync + - status + - statusMessage + type: object + ReplicationSource: + description: The details of a replication source bucket that replicates to a target destination bucket. + properties: + policyName: + description: The name of the policy. + maxLength: 256 + minLength: 1 + type: string + sourceBucketName: + description: The source bucket replicating data from. + maxLength: 256 + minLength: 1 + type: string + sourceRegionName: + description: The source region replicating data from, for example "us-ashburn-1". + maxLength: 64 + minLength: 1 + type: string + required: + - policyName + - sourceRegionName + - sourceBucketName + type: object + RetentionRuleCollection: + description: Retention rule collection. + properties: + items: + description: | + An array of retention rule summaries. + items: + $ref: '#/components/schemas/RetentionRuleSummary' + type: array + required: + - items + type: object + CreateRetentionRuleDetails: + description: The details to create a retention rule. + type: object + properties: + displayName: + description: | + A user-specified name for the retention rule. Names can be helpful in identifying retention rules. + Avoid entering confidential information. + type: string + duration: + $ref: '#/components/schemas/Duration' + timeRuleLocked: + description: | + The date and time as per [RFC 3339](https://tools.ietf.org/html/rfc3339) after which this rule is locked + and can only be deleted by deleting the bucket. Once a rule is locked, only increases in the duration are + allowed and no other properties can be changed. This property cannot be updated for rules that are in a + locked state. Specifying it when a duration is not specified is considered an error. + format: date-time + type: string + RetentionRule: + description: The details of a retention rule. + properties: + displayName: + description: User specified name for the retention rule. + type: string + duration: + $ref: '#/components/schemas/Duration' + etag: + description: The entity tag (ETag) for the retention rule. + type: string + id: + description: Unique identifier for the retention rule. + type: string + timeCreated: + description: The date and time that the retention rule was created as per [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + timeModified: + description: The date and time that the retention rule was modified as per [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + timeRuleLocked: + description: | + The date and time as per [RFC 3339](https://tools.ietf.org/html/rfc3339) after which this rule becomes locked. + and can only be deleted by deleting the bucket. + format: date-time + type: string + required: + - id + - displayName + - etag + - timeCreated + - timeModified + type: object + UpdateRetentionRuleDetails: + description: The details to update a retention rule. + type: object + properties: + displayName: + description: | + A user-specified name for the retention rule. Names can be helpful in identifying retention rules. + Avoid entering confidential information. + type: string + duration: + $ref: '#/components/schemas/Duration' + timeRuleLocked: + description: | + The date and time as per [RFC 3339](https://tools.ietf.org/html/rfc3339) after which this rule is locked + and can only be deleted by deleting the bucket. Once a rule is locked, only increases in the duration are + allowed and no other properties can be changed. This property cannot be updated for rules that are in a + locked state. Specifying it when a duration is not specified is considered an error. + format: date-time + type: string + MultipartUpload: + description: | + Multipart uploads provide efficient and resilient uploads, especially for large objects. Multipart uploads also accommodate + objects that are too large for a single upload operation. With multipart uploads, individual parts of an object can be + uploaded in parallel to reduce the amount of time you spend uploading. Multipart uploads can also minimize the impact + of network failures by letting you retry a failed part upload instead of requiring you to retry an entire object upload. + See [Using Multipart Uploads](/Content/Object/Tasks/usingmultipartuploads.htm). + + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, + talk to an administrator. If you are an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + bucket: + description: The bucket in which the in-progress multipart upload is stored. + type: string + namespace: + description: The Object Storage namespace in which the in-progress multipart upload is stored. + type: string + object: + description: The object name of the in-progress multipart upload. + type: string + storageTier: + description: The storage tier that the object is stored in. + enum: + - Standard + - InfrequentAccess + - Archive + type: string + x-obmcs-top-level-enum: '#/definitions/StorageTier' + timeCreated: + description: The date and time the upload was created, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). + format: date-time + type: string + uploadId: + description: The unique identifier for the in-progress multipart upload. + type: string + required: + - namespace + - bucket + - object + - uploadId + - timeCreated + type: object + CreateMultipartUploadDetails: + description: | + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, + talk to an administrator. If you are an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + cacheControl: + description: | + The optional Cache-Control header that defines the caching behavior value to be returned in GetObject and + HeadObject responses. Specifying values for this header has no effect on Object Storage behavior. Programs + that read the object determine what to do based on the value provided. + For example, you could use this header to identify objects that require caching restrictions. + type: string + contentDisposition: + description: | + The optional Content-Disposition header that defines presentational information for the object to be + returned in GetObject and HeadObject responses. Specifying values for this header has no effect on Object + Storage behavior. Programs that read the object determine what to do based on the value provided. + For example, you could use this header to let users download objects with custom filenames in a browser. + type: string + contentEncoding: + description: | + The optional Content-Encoding header that defines the content encodings that were applied to the object to + upload. Specifying values for this header has no effect on Object Storage behavior. Programs that read the + object determine what to do based on the value provided. For example, you could use this header to determine + what decoding mechanisms need to be applied to obtain the media-type specified by the Content-Type header of + the object. + type: string + contentLanguage: + description: | + The optional Content-Language header that defines the content language of the object to upload. Specifying + values for this header has no effect on Object Storage behavior. Programs that read the object determine what + to do based on the value provided. For example, you could use this header to identify and differentiate objects + based on a particular language. + type: string + contentType: + description: | + The optional Content-Type header that defines the standard MIME type format of the object to upload. + Specifying values for this header has no effect on Object Storage behavior. Programs that read the object + determine what to do based on the value provided. For example, you could use this header to identify and + perform special operations on text only objects. + type: string + metadata: + additionalProperties: + type: string + description: | + Arbitrary string keys and values for the user-defined metadata for the object. + Keys must be in "opc-meta-*" format. Avoid entering confidential information. + type: object + object: + description: | + The name of the object to which this multi-part upload is targeted. Avoid entering confidential information. + Example: test/object1.log + type: string + storageTier: + description: | + The storage tier that the object should be stored in. If not specified, the object will be stored in + the same storage tier as the bucket. + enum: + - Standard + - InfrequentAccess + - Archive + type: string + x-obmcs-top-level-enum: '#/definitions/StorageTier' + required: + - object + type: object + MultipartUploadPartSummary: + description: | + Gets summary information about multipart uploads. + + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, + talk to an administrator. If you are an administrator who needs to write policies to give users access, + see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + etag: + description: The current entity tag (ETag) for the part. + type: string + md5: + description: The MD5 hash of the bytes of the part. + type: string + partNumber: + description: The part number for this part. + type: integer + size: + description: The size of the part in bytes. + format: int64 + type: integer + required: + - etag + - md5 + - size + - partNumber + type: object + CommitMultipartUploadDetails: + description: | + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, + talk to an administrator. If you are an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + partsToCommit: + description: The part numbers and entity tags (ETags) for the parts to be committed. + items: + $ref: '#/components/schemas/CommitMultipartUploadPartDetails' + type: array + partsToExclude: + description: | + The part numbers for the parts to be excluded from the completed object. + Each part created for this upload must be in either partsToExclude or partsToCommit, but cannot be in both. + items: + type: integer + type: array + required: + - partsToCommit + type: object + InventoryRuleCollection: + description: Inventory rule collection. + properties: + items: + description: | + An array of inventory rule summaries. + items: + $ref: '#/components/schemas/InventoryRuleSummary' + type: array + required: + - items + type: object + CreateInventoryRuleDetails: + description: The details to create a inventory rule. + type: object + properties: + filter: + $ref: '#/components/schemas/RuleFilter' + isEnabled: + default: true + description: | + A Boolean that determines whether this rule is currently enabled. + type: boolean + report: + $ref: '#/components/schemas/Report' + reportRecurrences: + default: FREQ=MONTHLY + description: | + Defines the recurring times for report generation using iCal RFC 5545 format. + The report will be generated based on the provided frequency (e.g., daily, weekly, monthly). + Supported values: + - FREQ=DAILY (Daily recurrence) + - FREQ=WEEKLY (Weekly recurrence without specifying days) + - FREQ=MONTHLY (Monthly recurrence without specifying days, default value) + The recurrence is based purely on the frequency (e.g., daily, weekly, monthly), + with no support for finer details like specific days or intervals. + format: x-obmcs-recurring-time + type: string + ruleName: + description: | + The user-defined name for the inventory rule. + - Must be unique within the tenancy's Object Storage namespace. + - Must be between 1 and 256 characters in length. + - Valid characters are uppercase and lowercase letters, numbers, hyphens (-), underscores (_), and periods (.). + maxLength: 256 + minLength: 1 + type: string + ruleType: + default: OBJECT_RULE + description: | + The inventory rule type. + enum: + - BUCKET_RULE + - OBJECT_RULE + type: string + required: + - ruleName + - filter + - report + InventoryRule: + description: The details of a inventory rule. + type: object + properties: + filter: + $ref: '#/components/schemas/RuleFilter' + isEnabled: + default: true + description: | + A Boolean that determines whether this rule is currently enabled. + type: boolean + report: + $ref: '#/components/schemas/Report' + reportRecurrences: + default: FREQ=MONTHLY + description: | + Defines the recurring times for report generation using iCal RFC 5545 format. + The report will be generated based on the provided frequency (e.g., daily, weekly, monthly). + Supported values: + - FREQ=DAILY (Daily recurrence) + - FREQ=WEEKLY (Weekly recurrence without specifying days) + - FREQ=MONTHLY (Monthly recurrence without specifying days, default value) + The recurrence is based purely on the frequency (e.g., daily, weekly, monthly), + with no support for finer details like specific days or intervals. + format: x-obmcs-recurring-time + type: string + ruleName: + description: | + The user-defined name for the inventory rule. + - Must be unique within the tenancy's Object Storage namespace. + - Must be between 1 and 256 characters in length. + - Valid characters are uppercase and lowercase letters, numbers, hyphens (-), underscores (_), and periods (.). + maxLength: 256 + minLength: 1 + type: string + ruleType: + default: OBJECT_RULE + description: | + The inventory rule type. + enum: + - BUCKET_RULE + - OBJECT_RULE + type: string + etag: + description: The entity tag (ETag) for the inventory rule. + type: string + id: + description: Unique identifier for the inventory rule. + type: string + timeCreated: + description: The date and time that the inventory rule was created as per [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + timeModified: + description: The date and time that the inventory rule was modified as per [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + required: + - ruleName + - filter + - report + - id + - etag + - timeCreated + - timeModified + UpdateInventoryRuleDetails: + description: The details to update a inventory rule. + type: object + properties: + filter: + $ref: '#/components/schemas/RuleFilter' + isEnabled: + default: true + description: | + A Boolean that determines whether this rule is currently enabled. + type: boolean + report: + $ref: '#/components/schemas/Report' + reportRecurrences: + default: FREQ=MONTHLY + description: | + Defines the recurring times for report generation using iCal RFC 5545 format. + The report will be generated based on the provided frequency (e.g., daily, weekly, monthly). + Supported values: + - FREQ=DAILY (Daily recurrence) + - FREQ=WEEKLY (Weekly recurrence without specifying days) + - FREQ=MONTHLY (Monthly recurrence without specifying days, default value) + The recurrence is based purely on the frequency (e.g., daily, weekly, monthly), + with no support for finer details like specific days or intervals. + format: x-obmcs-recurring-time + type: string + ruleName: + description: | + The user-defined name for the inventory rule. + - Must be unique within the tenancy's Object Storage namespace. + - Must be between 1 and 256 characters in length. + - Valid characters are uppercase and lowercase letters, numbers, hyphens (-), underscores (_), and periods (.). + maxLength: 256 + minLength: 1 + type: string + ruleType: + default: OBJECT_RULE + description: | + The inventory rule type. + enum: + - BUCKET_RULE + - OBJECT_RULE + type: string + required: + - ruleName + - filter + - report + PrivateEndpointSummary: + description: | + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, + talk to an administrator. If you are an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + compartmentId: + description: The compartment ID in which the Private Endpoint is authorized. + type: string + createdBy: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the user who created the Private Endpoint. + type: string + etag: + description: The entity tag for the Private Endpoint. + type: string + fqdns: + $ref: '#/components/schemas/fqdns' + lifecycleState: + description: The summaries of Private Endpoints' lifecycle state. + type: string + x-obmcs-enumref: '#/definitions/PrivateEndpoint/lifecycleState' + name: + description: | + The name given to the Private Endpoint. Avoid entering confidential information. + Example: my-new-pe1 + type: string + namespace: + description: The Object Storage namespace with which the Private Endpoint is associated. + type: string + prefix: + description: | + A prefix to use for the private endpoint. The customer VCN's DNS records are + updated with this prefix. The prefix input from the customer will be the first sub-domain in the endpointFqdn. + Example: If the prefix chosen is "abc", then the endpointFqdn will be 'abc.private.objectstorage..oraclecloud.com' + maxLength: 63 + minLength: 1 + type: string + timeCreated: + description: The date and time the Private Endpoint was created, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). + format: date-time + type: string + timeModified: + description: The date and time the Private Endpoint was updated, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). + format: date-time + type: string + required: + - name + - namespace + - compartmentId + - createdBy + - timeCreated + - timeModified + - prefix + - etag + - fqdns + - lifecycleState + type: object + CreatePrivateEndpointDetails: + description: | + Details to create a private endpoint + properties: + accessTargets: + description: | + A list of targets that can be accessed by the private endpoint. + items: + $ref: '#/components/schemas/AccessTargetDetails' + maxItems: 10 + type: array + uniqueItems: true + additionalPrefixes: + description: | + A list of additional prefix that you can provide along with any other prefix. These resulting endpointFqdn's are added to the + customer VCN's DNS record. + items: + maxLength: 63 + minLength: 1 + type: string + maxItems: 10 + type: array + uniqueItems: true + compartmentId: + description: The ID of the compartment in which to create the Private Endpoint. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + name: + description: | + This name associated with the endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, + underscores, and periods. + Example: my-new-private-endpoint1 + maxLength: 256 + minLength: 1 + type: string + nsgIds: + description: | + A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to. + For more information about NSGs, see + [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + prefix: + description: | + A prefix to use for the private endpoint. The customer VCN's DNS records are + updated with this prefix. The prefix input from the customer will be the first sub-domain in the endpointFqdn. + Example: If the prefix chosen is "abc", then the endpointFqdn will be 'abc.private.objectstorage..oraclecloud.com' + maxLength: 63 + minLength: 1 + type: string + privateEndpointIp: + description: | + The private IP address to assign to this private endpoint. If you provide a value, + it must be an available IP address in the customer's subnet. If it's not available, an error + is returned. + + If you do not provide a value, an available IP address in the subnet is automatically chosen. + maxLength: 46 + minLength: 1 + type: string + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". + (opaque JSON object) + type: string + description: | + Key-value pair representing a security attribute key and value, scoped to a namespace. + + Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` + type: object + description: | + Security attributes for Private Endpoint resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). + + Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` + type: object + subnetId: + description: | + The OCID of the customer's subnet where the private endpoint VNIC will reside. + maxLength: 256 + minLength: 1 + type: string + required: + - name + - compartmentId + - subnetId + - prefix + - accessTargets + type: object + PrivateEndpoint: + description: | + A private endpoint makes your service accessible through a private IP in the customer's private network. A private endpoint has a name and is associated with a namespace and a single compartment. + properties: + accessTargets: + description: | + A list of targets that can be accessed by the private endpoint. At least one or more access targets is required for a private endpoint. + items: + $ref: '#/components/schemas/AccessTargetDetails' + maxItems: 10 + type: array + uniqueItems: true + additionalPrefixes: + description: | + A list of additional prefix that you can provide along with any other prefix. These resulting endpointFqdn's are added to the + customer VCN's DNS record. + items: + maxLength: 63 + minLength: 1 + type: string + maxItems: 10 + type: array + uniqueItems: true + compartmentId: + description: The compartment which is associated with the Private Endpoint. + type: string + createdBy: + description: The [OCID](/Content/General/Concepts/identifiers.htm) of the user who created the Private Endpoint. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + etag: + description: The entity tag (ETag) for the Private Endpoint. + type: string + fqdns: + $ref: '#/components/schemas/fqdns' + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the PrivateEndpoint. + type: string + lifecycleState: + description: The Private Endpoint's lifecycle state. + enum: + - CREATING + - ACTIVE + - INACTIVE + - UPDATING + - DELETING + - DELETED + - FAILED + type: string + name: + description: | + This name associated with the endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, + underscores, and periods. + Example: my-new-private-endpoint1 + type: string + namespace: + description: The Object Storage namespace associated with the private enpoint. + type: string + nsgIds: + description: | + A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to. + For more information about NSGs, see + [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/). + items: + maxLength: 255 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + prefix: + description: | + A prefix to use for the private endpoint. The customer VCN's DNS records are + updated with this prefix. The prefix input from the customer will be the first sub-domain in the endpointFqdn. + Example: If the prefix chosen is "abc", then the endpointFqdn will be 'abc.private.objectstorage..oraclecloud.com' + maxLength: 63 + minLength: 1 + type: string + privateEndpointIp: + description: | + The private IP address to assign to this private endpoint. If you provide a value, + it must be an available IP address in the customer's subnet. If it's not available, an error + is returned. + + If you do not provide a value, an available IP address in the subnet is automatically chosen. + maxLength: 46 + minLength: 1 + type: string + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". + (opaque JSON object) + type: string + description: | + Key-value pair representing a security attribute key and value, scoped to a namespace. + + Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` + type: object + description: | + Security attributes for Private Endpoint resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). + + Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` + type: object + subnetId: + description: | + The OCID of the customer's subnet where the private endpoint VNIC will reside. + maxLength: 256 + minLength: 1 + type: string + timeCreated: + description: The date and time the Private Endpoint was created, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). + format: date-time + type: string + timeModified: + description: The date and time the Private Endpoint was updated, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). + format: date-time + type: string + required: + - name + - namespace + - compartmentId + - createdBy + - timeCreated + - timeModified + - subnetId + - privateEndpointIp + - prefix + - fqdns + - etag + - accessTargets + type: object + UpdatePrivateEndpointDetails: + description: | + Information that can be updated for a private endpoint. + properties: + accessTargets: + description: | + A list of targets that can be accessed by the private endpoint. + items: + $ref: '#/components/schemas/AccessTargetDetails' + maxItems: 10 + type: array + uniqueItems: true + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + name: + description: | + This name associated with the endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, + underscores, and periods. + Example: my-new-private-endpoint1 + maxLength: 256 + minLength: 1 + type: string + namespace: + description: The Object Storage namespace which will associated with the private endpoint. + type: string + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". + (opaque JSON object) + type: string + description: | + Key-value pair representing a security attribute key and value, scoped to a namespace. + + Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` + type: object + description: | + Security attributes for Private Endpoint resource. Each key is predefined and scoped to a namespace. + For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). + + Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` + type: object + type: object + WorkRequestSummary: + description: A summary of the status of a work request. + properties: + compartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. Work + requests are scoped to the same compartment as the resource the work request affects. + + If the work request affects multiple resources and those resources are not in the same compartment, the OCID of + the primary resource is used. For example, you can copy an object in a bucket in one compartment to a bucket in + another compartment. In this case, the OCID of the source compartment is used. + type: string + id: + description: The id of the work request. + type: string + operationType: + description: The type of work request. + enum: + - COPY_OBJECT + - REENCRYPT + - PRIVATE_ENDPOINT_CREATE + - PRIVATE_ENDPOINT_UPDATE + - PRIVATE_ENDPOINT_DELETE + type: string + percentComplete: + description: Percentage of the work request completed. + format: float + type: number + resources: + items: + $ref: '#/components/schemas/WorkRequestResource' + type: array + status: + description: The status of a specified work request. + enum: + - ACCEPTED + - IN_PROGRESS + - FAILED + - COMPLETED + - CANCELING + - CANCELED + type: string + timeAccepted: + description: | + The date and time the work request was created, as described in + [RFC 3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + timeFinished: + description: | + The date and time the work request was finished, as described in + [RFC 3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + timeStarted: + description: | + The date and time the work request was started, as described in + [RFC 3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + type: object + WorkRequest: + description: A description of workRequest status. + properties: + compartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. Work + requests are scoped to the same compartment as the resource the work request affects. + + If the work request affects multiple resources and those resources are not in the same compartment, the OCID of + the primary resource is used. For example, you can copy an object in a bucket in one compartment to a bucket in + another compartment. In this case, the OCID of the source compartment is used. + type: string + id: + description: The id of the work request. + type: string + operationType: + description: The type of work request. + enum: + - COPY_OBJECT + - REENCRYPT + - PRIVATE_ENDPOINT_CREATE + - PRIVATE_ENDPOINT_UPDATE + - PRIVATE_ENDPOINT_DELETE + type: string + percentComplete: + description: Percentage of the work request completed. + format: float + type: number + resources: + items: + $ref: '#/components/schemas/WorkRequestResource' + type: array + status: + description: The status of the specified work request. + enum: + - ACCEPTED + - IN_PROGRESS + - FAILED + - COMPLETED + - CANCELING + - CANCELED + type: string + timeAccepted: + description: | + The date and time the work request was created, as described in + [RFC 3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + timeFinished: + description: | + The date and time the work request was finished, as described in + [RFC 3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + timeStarted: + description: | + The date and time the work request was started, as described in + [RFC 3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + type: object + WorkRequestError: + properties: + code: + description: | + A machine-usable code for the error that occurred. For the list of error codes, + see [API Errors](/Content/API/References/apierrors.htm). + type: string + message: + description: A human-readable description of the issue that produced the error. + type: string + timestamp: + description: The time the error occurred. + format: date-time + type: string + type: object + WorkRequestLogEntry: + properties: + message: + description: Human-readable log message. + type: string + timestamp: + description: | + The date and time the log message was written, as described in + [RFC 3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + type: object + Error: + properties: + code: + description: A short error code meant for programmatic parsing that defines the error. + type: string + message: + description: A human-readable error string. + type: string + required: + - code + - message + type: object + BatchDeleteObjectIdentifier: + description: | + Delete object details. + properties: + ifMatch: + description: | + The entity tag (ETag) to match. Avoid entering confidential information. + Example: etag1 + maxLength: 64 + minLength: 1 + type: string + objectName: + description: | + The name of the object to delete. Avoid entering confidential information. + Example: test/object1.log + maxLength: 1024 + minLength: 1 + type: string + required: + - objectName + type: object + DeletedObjectResult: + description: | + Delete object details. + properties: + objectName: + description: | + The name of the deleted object. Avoid entering confidential information. + Example: test/object1.log + type: string + timeLastModified: + description: The time the object was deleted, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). + format: date-time + type: string + required: + - objectName + - timeLastModified + type: object + FailedObjectResult: + description: | + Failed object details. + properties: + errorMessage: + description: Detailed error message on why the delete/update was failed. + type: string + objectName: + description: | + The name of the object. + Example: test/object1.log + type: string + statusCode: + description: | + HTTP status code for the failure. + Example: 409 + type: integer + required: + - objectName + - statusCode + - errorMessage + type: object + SSECustomerKeyDetails: + description: | + Specifies the details of the customer-provided encryption key (SSE-C) associated with an object. + properties: + algorithm: + description: | + Specifies the encryption algorithm. The only supported value is "AES256". + enum: + - AES256 + type: string + key: + description: | + Specifies the base64-encoded 256-bit encryption key to use to encrypt or decrypt the object data. + type: string + keySha256: + description: | + Specifies the base64-encoded SHA256 hash of the encryption key. This value is used to check the integrity + of the encryption key. + type: string + required: + - algorithm + - key + - keySha256 + type: object + ObjectLifecycleRule: + description: | + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, + talk to an administrator. If you are an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + action: + description: | + The action of the object lifecycle policy rule. + Rules using the action 'ARCHIVE' move objects from Standard and InfrequentAccess storage tiers + into the [Archive storage tier](/Content/Archive/Concepts/archivestorageoverview.htm). + Rules using the action 'INFREQUENT_ACCESS' move objects from Standard storage tier into the + Infrequent Access Storage tier. Objects that are already in InfrequentAccess tier or in Archive + tier are left untouched. + Rules using the action 'DELETE' permanently delete objects from buckets. + Rules using 'ABORT' abort the uncommitted multipart-uploads and permanently delete their parts from buckets. + type: string + isEnabled: + description: A Boolean that determines whether this rule is currently enabled. + type: boolean + name: + description: The name of the lifecycle rule to be applied. + type: string + objectNameFilter: + $ref: '#/components/schemas/ObjectNameFilter' + target: + default: objects + description: | + The target of the object lifecycle policy rule. The values of target can be either "objects", + "multipart-uploads" or "previous-object-versions". + This field when declared as "objects" is used to specify ARCHIVE, INFREQUENT_ACCESS + or DELETE rule for objects. + This field when declared as "previous-object-versions" is used to specify ARCHIVE, + INFREQUENT_ACCESS or DELETE rule for previous versions of existing objects. + This field when declared as "multipart-uploads" is used to specify the ABORT (only) rule for + uncommitted multipart-uploads. + type: string + timeAmount: + description: | + Specifies the age of objects to apply the rule to. The timeAmount is interpreted in units defined by the + timeUnit parameter, and is calculated in relation to each object's Last-Modified time. + format: int64 + type: integer + timeUnit: + description: | + The unit that should be used to interpret timeAmount. Days are defined as starting and ending at midnight UTC. + Years are defined as 365.2425 days long and likewise round up to the next midnight UTC. + enum: + - DAYS + - YEARS + type: string + required: + - name + - action + - timeAmount + - timeUnit + - isEnabled + type: object + ObjectSummary: + description: | + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, + talk to an administrator. If you are an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + archivalState: + description: Archival state of an object. This field is set only for objects in Archive tier. + enum: + - Archived + - Restoring + - Restored + type: string + x-obmcs-top-level-enum: '#/definitions/ArchivalState' + etag: + description: The current entity tag (ETag) for the object. + type: string + md5: + description: Base64-encoded MD5 hash of the object data. + type: string + name: + description: | + The name of the object. Avoid entering confidential information. + Example: test/object1.log + type: string + size: + description: Size of the object in bytes. + format: int64 + type: integer + storageTier: + description: The storage tier that the object is stored in. + enum: + - Standard + - InfrequentAccess + - Archive + type: string + x-obmcs-top-level-enum: '#/definitions/StorageTier' + timeCreated: + description: The date and time the object was created, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). + format: date-time + type: string + timeModified: + description: The date and time the object was modified, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.29. + format: date-time + type: string + required: + - name + type: object + ObjectVersionSummary: + description: | + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, + talk to an administrator. If you are an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + archivalState: + description: Archival state of an object. This field is set only for objects in Archive tier. + enum: + - Archived + - Restoring + - Restored + type: string + x-obmcs-top-level-enum: '#/definitions/ArchivalState' + etag: + description: The current entity tag (ETag) for the object. + type: string + isDeleteMarker: + description: This flag will indicate if the version is deleted or not. + type: boolean + md5: + description: Base64-encoded MD5 hash of the object data. + type: string + name: + description: | + The name of the object. Avoid entering confidential information. + Example: test/object1.log + type: string + size: + description: Size of the object in bytes. + format: int64 + type: integer + storageTier: + description: The storage tier that the object is stored in. + enum: + - Standard + - InfrequentAccess + - Archive + type: string + x-obmcs-top-level-enum: '#/definitions/StorageTier' + timeCreated: + description: The date and time the object was created, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). + format: date-time + type: string + timeModified: + description: The date and time the object was modified, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616#section-14.29). + format: date-time + type: string + versionId: + description: VersionId of the object. + type: string + required: + - name + - versionId + - isDeleteMarker + - timeModified + type: object + RetentionRuleSummary: + description: The summary of a retention rule. + type: object + properties: + displayName: + description: User specified name for the retention rule. + type: string + duration: + $ref: '#/components/schemas/Duration' + etag: + description: The entity tag (ETag) for the retention rule. + type: string + id: + description: Unique identifier for the retention rule. + type: string + timeCreated: + description: The date and time that the retention rule was created as per [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + timeModified: + description: The date and time that the retention rule was modified as per [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + timeRuleLocked: + description: | + The date and time as per [RFC 3339](https://tools.ietf.org/html/rfc3339) after which this rule becomes locked. + and can only be deleted by deleting the bucket. + format: date-time + type: string + required: + - id + - displayName + - etag + - timeCreated + - timeModified + RetentionRuleDetails: + description: The details to create or update a retention rule. + properties: + displayName: + description: | + A user-specified name for the retention rule. Names can be helpful in identifying retention rules. + Avoid entering confidential information. + type: string + duration: + $ref: '#/components/schemas/Duration' + timeRuleLocked: + description: | + The date and time as per [RFC 3339](https://tools.ietf.org/html/rfc3339) after which this rule is locked + and can only be deleted by deleting the bucket. Once a rule is locked, only increases in the duration are + allowed and no other properties can be changed. This property cannot be updated for rules that are in a + locked state. Specifying it when a duration is not specified is considered an error. + format: date-time + type: string + type: object + Duration: + description: | + The amount of time that objects in the bucket should be preserved for and which is calculated in relation to + each object's Last-Modified timestamp. If duration is not present, then there is no time limit and the objects + in the bucket will be preserved indefinitely. + properties: + timeAmount: + description: | + The timeAmount is interpreted in units defined by the timeUnit parameter, and is calculated in relation + to each object's Last-Modified timestamp. + format: int64 + type: integer + timeUnit: + description: The unit that should be used to interpret timeAmount. + enum: + - YEARS + - DAYS + type: string + required: + - timeAmount + - timeUnit + type: object + CommitMultipartUploadPartDetails: + description: | + To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, + talk to an administrator. If you are an administrator who needs to write policies to give users access, see + [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm). + properties: + etag: + description: The entity tag (ETag) returned when this part was uploaded. + type: string + partNum: + description: The part number for this part. + type: integer + required: + - partNum + - etag + type: object + InventoryRuleSummary: + description: The summary of a inventory rule. + type: object + properties: + filter: + $ref: '#/components/schemas/RuleFilter' + isEnabled: + default: true + description: | + A Boolean that determines whether this rule is currently enabled. + type: boolean + report: + $ref: '#/components/schemas/Report' + reportRecurrences: + default: FREQ=MONTHLY + description: | + Defines the recurring times for report generation using iCal RFC 5545 format. + The report will be generated based on the provided frequency (e.g., daily, weekly, monthly). + Supported values: + - FREQ=DAILY (Daily recurrence) + - FREQ=WEEKLY (Weekly recurrence without specifying days) + - FREQ=MONTHLY (Monthly recurrence without specifying days, default value) + The recurrence is based purely on the frequency (e.g., daily, weekly, monthly), + with no support for finer details like specific days or intervals. + format: x-obmcs-recurring-time + type: string + ruleName: + description: | + The user-defined name for the inventory rule. + - Must be unique within the tenancy's Object Storage namespace. + - Must be between 1 and 256 characters in length. + - Valid characters are uppercase and lowercase letters, numbers, hyphens (-), underscores (_), and periods (.). + maxLength: 256 + minLength: 1 + type: string + ruleType: + default: OBJECT_RULE + description: | + The inventory rule type. + enum: + - BUCKET_RULE + - OBJECT_RULE + type: string + etag: + description: The entity tag (ETag) for the inventory rule. + type: string + id: + description: Unique identifier for the inventory rule. + type: string + timeCreated: + description: The date and time that the inventory rule was created as per [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + timeModified: + description: The date and time that the inventory rule was modified as per [RFC3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + required: + - ruleName + - filter + - report + - id + - etag + - timeCreated + - timeModified + InventoryRuleDetails: + description: The details of a inventory rule. + properties: + filter: + $ref: '#/components/schemas/RuleFilter' + isEnabled: + default: true + description: | + A Boolean that determines whether this rule is currently enabled. + type: boolean + report: + $ref: '#/components/schemas/Report' + reportRecurrences: + default: FREQ=MONTHLY + description: | + Defines the recurring times for report generation using iCal RFC 5545 format. + The report will be generated based on the provided frequency (e.g., daily, weekly, monthly). + Supported values: + - FREQ=DAILY (Daily recurrence) + - FREQ=WEEKLY (Weekly recurrence without specifying days) + - FREQ=MONTHLY (Monthly recurrence without specifying days, default value) + The recurrence is based purely on the frequency (e.g., daily, weekly, monthly), + with no support for finer details like specific days or intervals. + format: x-obmcs-recurring-time + type: string + ruleName: + description: | + The user-defined name for the inventory rule. + - Must be unique within the tenancy's Object Storage namespace. + - Must be between 1 and 256 characters in length. + - Valid characters are uppercase and lowercase letters, numbers, hyphens (-), underscores (_), and periods (.). + maxLength: 256 + minLength: 1 + type: string + ruleType: + default: OBJECT_RULE + description: | + The inventory rule type. + enum: + - BUCKET_RULE + - OBJECT_RULE + type: string + required: + - ruleName + - filter + - report + type: object + fqdns: + description: | + The object representing FQDN details formed using prefix and additionalPrefixes. + properties: + additionalPrefixesFqdns: + additionalProperties: + $ref: '#/components/schemas/prefixFqdns' + description: | + An object containing FQDNs formed using additionalPrefixes. + type: object + prefixFqdns: + $ref: '#/components/schemas/prefixFqdns' + type: object + AccessTargetDetails: + description: | + Details of the targets that can be accessed by the private endpoint. + properties: + bucket: + description: | + The name of the bucket. Avoid entering confidential information. Wildcards ('*') are allowed. If value is '*', it means all buckets in the specified namespace and compartment can be accessed. It cannot be a regex. + Example: my-new-bucket1 + maxLength: 256 + minLength: 1 + type: string + compartmentId: + description: The compartment ID which the private endpoint can access. Wildcards ('*') are allowed. If value is '*', it means all compartments in the specified namespace can be accessed. It cannot be a regex. + maxLength: 255 + minLength: 1 + type: string + namespace: + description: The Object Storage namespace which the private endpoint can access. Wildcards ('*') are allowed. If value is '*', it means all namespaces can be accessed. It cannot be a regex. + maxLength: 1024 + minLength: 1 + type: string + required: + - namespace + - compartmentId + - bucket + type: object + WorkRequestResource: + properties: + actionType: + description: The status of the work request. + enum: + - CREATED + - UPDATED + - DELETED + - RELATED + - IN_PROGRESS + - READ + - WRITTEN + type: string + entityType: + description: The resource type the work request affects. + type: string + entityUri: + description: The URI path that you can use for a GET request to access the resource metadata. + type: string + identifier: + description: The resource type identifier. + type: string + metadata: + additionalProperties: + type: string + description: The metadata of the resource. + type: object + type: object + ObjectNameFilter: + description: | + A filter that compares object names to a set of prefixes or patterns to determine if a rule applies to a + given object. The filter can contain include glob patterns, exclude glob patterns and inclusion prefixes. + The inclusion prefixes property is kept for backward compatibility. It is recommended to use inclusion patterns + instead of prefixes. Exclusions take precedence over inclusions. + properties: + exclusionPatterns: + description: | + An array of glob patterns to match the object names to exclude. An empty array is ignored. Exclusion + patterns take precedence over inclusion patterns. + A Glob pattern is a sequence of characters to match text. Any character that appears in the pattern, other + than the special pattern characters described below, matches itself. + Glob patterns must be between 1 and 1024 characters. + + The special pattern characters have the following meanings: + + \ Escapes the following character + * Matches any string of characters. + ? Matches any single character . + [...] Matches a group of characters. A group of characters can be: + A set of characters, for example: [Zafg9@]. This matches any character in the brackets. + A range of characters, for example: [a-z]. This matches any character in the range. + [a-f] is equivalent to [abcdef]. + For character ranges only the CHARACTER-CHARACTER pattern is supported. + [ab-yz] is not valid + [a-mn-z] is not valid + Character ranges can not start with ^ or : + To include a '-' in the range, make it the first or last character. + items: + maxLength: 1024 + minLength: 1 + type: string + maxItems: 1000 + type: array + inclusionPatterns: + description: | + An array of glob patterns to match the object names to include. An empty array includes all objects in the + bucket. Exclusion patterns take precedence over inclusion patterns. + A Glob pattern is a sequence of characters to match text. Any character that appears in the pattern, other + than the special pattern characters described below, matches itself. + Glob patterns must be between 1 and 1024 characters. + + The special pattern characters have the following meanings: + + \ Escapes the following character + * Matches any string of characters. + ? Matches any single character . + [...] Matches a group of characters. A group of characters can be: + A set of characters, for example: [Zafg9@]. This matches any character in the brackets. + A range of characters, for example: [a-z]. This matches any character in the range. + [a-f] is equivalent to [abcdef]. + For character ranges only the CHARACTER-CHARACTER pattern is supported. + [ab-yz] is not valid + [a-mn-z] is not valid + Character ranges can not start with ^ or : + To include a '-' in the range, make it the first or last character. + items: + maxLength: 1024 + minLength: 1 + type: string + maxItems: 1000 + type: array + inclusionPrefixes: + description: | + An array of object name prefixes that the rule will apply to. An empty array means to include all objects. + items: + type: string + type: array + type: object + RuleFilter: + description: Defines rule filter. + properties: + createdWithinDays: + default: -1 + description: | + Objects created within the last createdWithinDays days (inclusive) will be considered. + For example, a value of 3 includes objects created within the last three days. + During report generation, the calculation is based on the report generation start time, rounded up to the next full day. + The object age is calculated relative to this adjusted start time. + This parameter is optional. If not provided, the value is assumed to be -1, + meaning no filtering based on object age will be applied, and all objects will be included in the report regardless of their creation date. + A value of -1 explicitly indicates that all objects should be included. + type: integer + exclusionPrefixes: + description: | + An array of prefixes that the rule will exclude. + If the array is not provided, no exclusions will be applied, and all objects will be considered. + Any object matching any Exclude filter will be excluded, regardless of matching Include filters. + Exclude filters take precedence over Include filters. + items: + maxLength: 1024 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + inclusionPrefixes: + description: | + An array of prefixes to which the rule will apply. + If the array is not provided, the rule applies to all prefixes. + If one or more prefixes are specified, only buckets/objects matching any of the specified prefixes will be included. + Objects matching any Include filter will be included unless excluded by an Exclude filter. + In case of overlap, Exclude filters take precedence over Include filters. + items: + maxLength: 1024 + minLength: 1 + type: string + maxItems: 5 + type: array + uniqueItems: true + objectTypes: + description: | + An array of object types to be included in report. + items: + default: OBJECT + enum: + - OBJECT + type: string + maxItems: 1 + minItems: 1 + type: array + uniqueItems: true + type: object + Report: + description: Defines output report. + properties: + format: + default: PARQUET + description: | + The inventory report format specification + enum: + - PARQUET + type: string + schemaFields: + description: | + An array of fields to be included in report. + The valid schemaFields for 'object' rules are: + - SIZE + - ETAG + - TIME_CREATED + - MD5_CHECKSUM + - TIME_MODIFIED + - STORAGE_TIER + - ARCHIVAL_STATE + - COMPARTMENT_ID + - CREATED_BY + The valid schemaFields for 'bucket' rules are: + - ETAG + - TIME_CREATED + - TIME_MODIFIED + - COMPARTMENT_ID + - CREATED_BY + - DEFINED_TAGS + - FREEFORM_TAGS + items: + enum: + - SIZE + - ETAG + - TIME_CREATED + - MD5_CHECKSUM + - TIME_MODIFIED + - STORAGE_TIER + - ARCHIVAL_STATE + - COMPARTMENT_ID + - CREATED_BY + - DEFINED_TAGS + - FREEFORM_TAGS + type: string + minItems: 1 + type: array + uniqueItems: true + targetBucket: + description: | + The target bucket name to upload the generated report. Create the target bucket before creating the rule. + maxLength: 256 + minLength: 1 + type: string + required: + - schemaFields + - targetBucket + type: object + prefixFqdns: + description: | + An object containing FQDNs + properties: + objectStorageApiFqdn: + description: | + ObjectStorage API FQDN + maxLength: 2048 + minimum: 1 + type: string + s3CompatibilityApiFqdn: + description: | + S3 Compatibility API FQDN + maxLength: 2048 + minimum: 1 + type: string + swiftApiFqdn: + description: | + Swift API FQDN + maxLength: 2048 + minimum: 1 + type: string + type: object + PatternDetails: + description: | + Specifying inclusion and exclusion patterns. + properties: + exclusionPatterns: + description: | + An array of glob patterns to match the object names to exclude. An empty array is ignored. Exclusion + patterns take precedence over inclusion patterns. + A Glob pattern is a sequence of characters to match text. Any character that appears in the pattern, other + than the special pattern characters described below, matches itself. + Glob patterns must be between 1 and 1024 characters. + + The special pattern characters have the following meanings: + + \ Escapes the following character + * Matches any string of characters. + ? Matches any single character . + [...] Matches a group of characters. A group of characters can be: + A set of characters, for example: [Zafg9@]. This matches any character in the brackets. + A range of characters, for example: [a-z]. This matches any character in the range. + [a-f] is equivalent to [abcdef]. + For character ranges only the CHARACTER-CHARACTER pattern is supported. + [ab-yz] is not valid + [a-mn-z] is not valid + Character ranges can not start with ^ or : + To include a '-' in the range, make it the first or last character. + items: + maxLength: 1024 + minLength: 1 + type: string + maxItems: 1000 + type: array + inclusionPatterns: + description: | + An array of glob patterns to match the object names to include. An empty array includes all objects in the + bucket. Exclusion patterns take precedence over inclusion patterns. + A Glob pattern is a sequence of characters to match text. Any character that appears in the pattern, other + than the special pattern characters described below, matches itself. + Glob patterns must be between 1 and 1024 characters. + + The special pattern characters have the following meanings: + + \ Escapes the following character + * Matches any string of characters. + ? Matches any single character . + [...] Matches a group of characters. A group of characters can be: + A set of characters, for example: [Zafg9@]. This matches any character in the brackets. + A range of characters, for example: [a-z]. This matches any character in the range. + [a-f] is equivalent to [abcdef]. + For character ranges only the CHARACTER-CHARACTER pattern is supported. + [ab-yz] is not valid + [a-mn-z] is not valid + Character ranges can not start with ^ or : + To include a '-' in the range, make it the first or last character. + items: + maxLength: 1024 + minLength: 1 + type: string + maxItems: 1000 + type: array + type: object + ListBucketsResponse: + type: object + properties: + buckets: + type: array + items: + $ref: '#/components/schemas/BucketSummary' + ListPreauthenticatedRequestsResponse: + type: object + properties: + preauthenticated_requests: + type: array + items: + $ref: '#/components/schemas/PreauthenticatedRequestSummary' + ListReplicationPoliciesResponse: + type: object + properties: + replication_policies: + type: array + items: + $ref: '#/components/schemas/ReplicationPolicySummary' + ListReplicationSourcesResponse: + type: object + properties: + replication_sources: + type: array + items: + $ref: '#/components/schemas/ReplicationSource' + ListMultipartUploadsResponse: + type: object + properties: + multipart_uploads: + type: array + items: + $ref: '#/components/schemas/MultipartUpload' + ListMultipartUploadPartsResponse: + type: object + properties: + multipart_upload_parts: + type: array + items: + $ref: '#/components/schemas/MultipartUploadPartSummary' + ListPrivateEndpointsResponse: + type: object + properties: + private_endpoints: + type: array + items: + $ref: '#/components/schemas/PrivateEndpointSummary' + ListWorkRequestsResponse: + type: object + properties: + work_requests: + type: array + items: + $ref: '#/components/schemas/WorkRequestSummary' + ListWorkRequestErrorsResponse: + type: object + properties: + work_request_errors: + type: array + items: + $ref: '#/components/schemas/WorkRequestError' + ListWorkRequestLogsResponse: + type: object + properties: + work_request_logs: + type: array + items: + $ref: '#/components/schemas/WorkRequestLogEntry' + GetNamespaceTransformed: + type: object + properties: + namespace: + type: string + description: The Object Storage namespace of the tenancy (top-level bucket container). + responses: + BadRequest: + description: Bad Request + 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' + NotAuthenticated: + description: Unauthorized + 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' + RequestTimeout: + description: Request Timeout + 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' + TooManyRequests: + description: Too Many Requests + 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' + InternalServerError: + description: Internal Server 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' + Error: + description: A description of an error that occurred. + headers: + opc-client-request-id: + description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular + request, provide this request ID. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + NotAuthorizedOrNotFound: + description: Not Found + 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' + NotAuthorizedOrInternalConflict: + description: Conflict + 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' + ContentLengthRequired: + description: Content-Length Required + 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' + PreconditionFailed: + description: Precondition Failed + 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' + Forbidden: + description: Forbidden + 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' + parameters: + ClientRequestIdHeader: + description: The client request ID for tracing. + in: header + name: opc-client-request-id + schema: + type: string + OptionalCompartmentIdQueryParam: + description: | + This is an optional field representing either the tenancy [OCID](/Content/General/Concepts/identifiers.htm) or the compartment + [OCID](/Content/General/Concepts/identifiers.htm) within the tenancy whose Object Storage namespace is to be retrieved. + in: query + name: compartmentId + schema: + type: string + NamespacePathParam: + description: The Object Storage namespace used for the request. + in: path + name: namespaceName + required: true + schema: + type: string + minLength: 1 + pattern: '[A-Za-z][A-Za-z0-9\\-_\\.]+' + CompartmentIdQueryParam: + description: The ID of the compartment in which to list buckets. + in: query + name: compartmentId + required: true + schema: + type: string + PaginationLimitQueryParam: + description: | + For list pagination. The maximum number of results per page, or items to return in a paginated + "List" call. For important details about how pagination works, see + [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + in: query + name: limit + schema: + type: integer + minimum: 1 + maximum: 1000 + PaginationTokenQueryParam: + description: | + For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important + details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + in: query + name: page + schema: + type: string + minLength: 1 + maxLength: 1024 + ListBucketFieldsQueryParam: + description: | + Bucket summary in list of buckets includes the 'namespace', 'name', 'compartmentId', 'createdBy', 'timeCreated', + and 'etag' fields. This parameter can also include 'tags' (freeformTags and definedTags). The only supported value of this parameter is 'tags' for now. Example 'tags'. + in: query + name: fields + style: form + explode: false + schema: + type: array + items: + enum: + - tags + type: string + BucketPathParam: + description: | + The name of the bucket. Avoid entering confidential information. + Example: `my-new-bucket1` + in: path + name: bucketName + required: true + schema: + type: string + minLength: 1 + pattern: '[A-Za-z0-9\\-_\\.]+' + IfMatchHeader: + description: | + The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of + the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload + the resource. + in: header + name: if-match + schema: + type: string + IfNoneMatchHeaderExceptStar: + description: | + The entity tag (ETag) to avoid matching. Wildcards ('*') are not allowed. If the specified ETag does not + match the ETag of the existing resource, the request returns the expected response. If the ETag matches + the ETag of the existing resource, the request returns an HTTP 304 status without a response body. + in: header + name: if-none-match + schema: + type: string + GetBucketFieldsQueryParam: + description: | + Bucket summary includes the 'namespace', 'name', 'compartmentId', 'createdBy', 'timeCreated', + and 'etag' fields. This parameter can also include 'approximateCount' (approximate number of objects), 'approximateSize' + (total approximate size in bytes of all objects) and 'autoTiering' (state of auto tiering on the bucket). + For example 'approximateCount,approximateSize,autoTiering'. + in: query + name: fields + style: form + explode: false + schema: + type: array + items: + enum: + - approximateCount + - approximateSize + - autoTiering + type: string + x-obmcs-inline-enum: false + OptionalSSECustomerAlgorithmHeader: + description: | + The optional header that specifies "AES256" as the encryption algorithm. For more information, see + [Using Your Own Keys for Server-Side Encryption](/Content/Object/Tasks/usingyourencryptionkeys.htm). + in: header + name: opc-sse-customer-algorithm + x-default-description: 'null' + schema: + type: string + OptionalSSECustomerKeyHeader: + description: | + The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or + decrypt the data. For more information, see + [Using Your Own Keys for Server-Side Encryption](/Content/Object/Tasks/usingyourencryptionkeys.htm). + in: header + name: opc-sse-customer-key + x-default-description: 'null' + schema: + type: string + OptionalSSECustomerKeySHA256Header: + description: | + The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This + value is used to check the integrity of the encryption key. For more information, see + [Using Your Own Keys for Server-Side Encryption](/Content/Object/Tasks/usingyourencryptionkeys.htm). + in: header + name: opc-sse-customer-key-sha256 + x-default-description: 'null' + schema: + type: string + OptionalSrcSSECustomerAlgorithmHeader: + description: | + The optional header that specifies "AES256" as the encryption algorithm to use to decrypt the source + object. For more information, see + [Using Your Own Keys for Server-Side Encryption](/Content/Object/Tasks/usingyourencryptionkeys.htm). + in: header + name: opc-source-sse-customer-algorithm + x-default-description: 'null' + schema: + type: string + OptionalSrcSSECustomerKeyHeader: + description: | + The optional header that specifies the base64-encoded 256-bit encryption key to use to decrypt + the source object. For more information, see + [Using Your Own Keys for Server-Side Encryption](/Content/Object/Tasks/usingyourencryptionkeys.htm). + in: header + name: opc-source-sse-customer-key + x-default-description: 'null' + schema: + type: string + OptionalSrcSSECustomerKeySHA256Header: + description: | + The optional header that specifies the base64-encoded SHA256 hash of the encryption key used to + decrypt the source object. This value is used to check the integrity of the encryption key. For + more information, see + [Using Your Own Keys for Server-Side Encryption](/Content/Object/Tasks/usingyourencryptionkeys.htm). + in: header + name: opc-source-sse-customer-key-sha256 + x-default-description: 'null' + schema: + type: string + OptionalSSEKMSKeyIdHeader: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key + Management service to generate a data encryption key or to encrypt or decrypt a data encryption key. + in: header + name: opc-sse-kms-key-id + x-default-description: 'null' + schema: + type: string + ReencryptBucketKeyOnlyQueryParam: + description: If true, reencrypt only the intermediate bucket keys and skip everything else in the bucket. + in: query + name: isReencryptBucketKeyOnly + required: false + schema: + type: boolean + default: false + ObjectPathParam: + description: | + The name of the object. Avoid entering confidential information. + Example: `test/object1.log` + in: path + name: objectName + required: true + schema: + type: string + minLength: 1 + maxLength: 1024 + pattern: '[^\\r\\n\\00#\\?]+' + VersionIdQueryParam: + description: VersionId used to identify a particular version of the object + in: query + name: versionId + required: false + schema: + type: string + pattern: '[A-Za-z][A-Za-z0-9\\-_\\.]+' + IfNoneMatchHeader: + description: | + The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should + fail if the resource already exists. + in: header + name: if-none-match + schema: + type: string + minLength: 0 + maxLength: 1 + pattern: ^[*]$ + PrefixQueryParam: + description: The string to use for matching against the start of object names in a list query. + in: query + name: prefix + schema: + type: string + StartWithQueryParam: + description: Returns object names which are lexicographically greater than or equal to this parameter. + in: query + name: start + schema: + type: string + EndBeforeQueryParam: + description: Returns object names which are lexicographically strictly less than this parameter. + in: query + name: end + schema: + type: string + DelimiterQueryParam: + description: | + When this parameter is set, only objects whose names do not contain the delimiter character + (after an optionally specified prefix) are returned in the objects key of the response body. + Scanned objects whose names contain the delimiter have the part of their name up to the first + occurrence of the delimiter (including the optional prefix) returned as a set of prefixes. + Note that only '/' is a supported delimiter character at this time. + in: query + name: delimiter + schema: + type: string + ObjectFieldsQueryParam: + description: | + Object summary by default includes only the 'name' field. Use this parameter to also + include 'size' (object size in bytes), 'etag', 'md5', 'timeCreated' (object creation date and time), + 'timeModified' (object modification date and time), 'storageTier' and 'archivalState' fields. + Specify the value of this parameter as a comma-separated, case-insensitive list of those field names. + For example 'name,etag,timeCreated,md5,timeModified,storageTier,archivalState'. + in: query + name: fields + x-obmcs-inline-enum: false + schema: + type: string + enum: + - name + - size + - etag + - timeCreated + - md5 + - timeModified + - storageTier + - archivalState + StartAfterQueryParam: + description: Returns object names which are lexicographically strictly greater than this parameter. + in: query + name: startAfter + schema: + type: string + RangeRequestHeader: + description: | + Optional byte range to fetch, as described in [RFC 7233](https://tools.ietf.org/html/rfc7233#section-2.1). + Note that only a single range of bytes is supported. + in: header + name: range + schema: + type: string + ResponseContentDispositionQueryParam: + description: Specify this query parameter to override the value of the Content-Disposition response header in the GetObject response. + in: query + name: httpResponseContentDisposition + required: false + schema: + type: string + ResponseCacheControlQueryParam: + description: Specify this query parameter to override the Cache-Control response header in the GetObject response. + in: query + name: httpResponseCacheControl + required: false + schema: + type: string + ResponseContentTypeQueryParam: + description: Specify this query parameter to override the Content-Type response header in the GetObject response. + in: query + name: httpResponseContentType + required: false + schema: + type: string + ResponseContentLanguageQueryParam: + description: Specify this query parameter to override the Content-Language response header in the GetObject response. + in: query + name: httpResponseContentLanguage + required: false + schema: + type: string + ResponseContentEncodingQueryParam: + description: Specify this query parameter to override the Content-Encoding response header in the GetObject response. + in: query + name: httpResponseContentEncoding + required: false + schema: + type: string + ResponseExpiresQueryParam: + description: Specify this query parameter to override the Expires response header in the GetObject response. + in: query + name: httpResponseExpires + required: false + schema: + type: string + Expect100ContinueHeader: + description: | + A value of `100-continue` requests preliminary verification of the request method, path, and headers before the request body is sent. + If no error results from such verification, the server will send a 100 (Continue) interim response to indicate readiness for the request body. + The only allowed value for this parameter is "100-Continue" (case-insensitive). + in: header + name: Expect + x-default-description: | + If you do not supply this parameter, the service will accept the entire request body first, before verifying the request. + If there is an error, accepting the entire request body first may have a negative performance impact. + If you do supply this parameter, but with a value other than "100-Continue" (case-insensitive), you will receive a 400 (Bad Request) response. + schema: + type: string + pattern: ^(100-[cC][oO][nN][tT][iI][nN][uU][eE])?$ + RequiredContentLengthHeader: + description: The content length of the body. + in: header + name: Content-Length + required: true + schema: + type: integer + format: int64 + OptionalContentMD5Header: + description: | + The optional header that defines the base64-encoded MD5 hash of the body. If the optional Content-MD5 header is present, Object + Storage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the + MD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error + is returned with the message: + + "The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)" + in: header + name: Content-MD5 + schema: + type: string + ObjectAppendQueryParam: + description: | + The option to commit a new chunk of data to the end of an existing object. If the object doesn't exist, it'll create a new one. + The maximum size of the data to append to an object in a single append request is 512MB. Each object can only be appended up to 10,000 times. + in: query + name: isAppend + required: false + schema: + type: boolean + OptionalContentTypeHeader: + description: | + The optional Content-Type header that defines the standard MIME type format of the object. Content type defaults to + 'application/octet-stream' if not specified in the PutObject call. In the OCI CLI, you can set this value to 'auto' + to have the CLI infer the content type from the file name. Specifying values for this header has no effect on Object + Storage behavior. Programs that read the object determine what to do based on the value provided. For example, you + could use this header to identify and perform special operations on text only objects. + in: header + name: Content-Type + schema: + type: string + OptionalContentLanguageHeader: + description: | + The optional Content-Language header that defines the content language of the object to upload. Specifying + values for this header has no effect on Object Storage behavior. Programs that read the object determine what + to do based on the value provided. For example, you could use this header to identify and differentiate objects + based on a particular language. + in: header + name: Content-Language + schema: + type: string + OptionalContentEncodingHeader: + description: | + The optional Content-Encoding header that defines the content encodings that were applied to the object to + upload. Specifying values for this header has no effect on Object Storage behavior. Programs that read the + object determine what to do based on the value provided. For example, you could use this header to determine + what decoding mechanisms need to be applied to obtain the media-type specified by the Content-Type header of + the object. + in: header + name: Content-Encoding + schema: + type: string + OptionalContentDispositionHeader: + description: | + The optional Content-Disposition header that defines presentational information for the object to be + returned in GetObject and HeadObject responses. Specifying values for this header has no effect on Object + Storage behavior. Programs that read the object determine what to do based on the value provided. + For example, you could use this header to let users download objects with custom filenames in a browser. + in: header + name: Content-Disposition + schema: + type: string + OptionalCacheControlHeader: + description: | + The optional Cache-Control header that defines the caching behavior value to be returned in GetObject and + HeadObject responses. Specifying values for this header has no effect on Object Storage behavior. Programs + that read the object determine what to do based on the value provided. + For example, you could use this header to identify objects that require caching restrictions. + in: header + name: Cache-Control + schema: + type: string + OptionalStorageTierHeader: + description: | + The storage tier that the object should be stored in. If not specified, the object will be stored in + the same storage tier as the bucket. + in: header + name: storage-tier + required: false + x-obmcs-top-level-enum: '#/definitions/StorageTier' + schema: + type: string + enum: + - Standard + - InfrequentAccess + - Archive + OpcMetaHeader: + description: Optional user-defined metadata key and value. + in: header + name: opc-meta-* + x-obmcs-header-collection: true + x-obmcs-prefix: opc-meta- + schema: + type: string + ObjectNamePrefixQueryParam: + description: User-specified object name prefixes can be used to query and return a list of pre-authenticated requests. + in: query + name: objectNamePrefix + schema: + type: string + PreauthenticatedRequestIdPathParam: + description: | + The unique identifier for the pre-authenticated request. This can be used to manage operations against + the pre-authenticated request, such as GET or DELETE. + in: path + name: parId + required: true + schema: + type: string + PaginationReplicationLimitQueryParam: + description: | + For list pagination. The maximum number of results per page, or items to return in a paginated + "List" call. For important details about how pagination works, see + [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + in: query + name: limit + schema: + type: integer + minimum: 1 + maximum: 1000 + default: 100 + ReplicationIdPathParam: + description: The ID of the replication policy. + in: path + name: replicationId + required: true + schema: + type: string + RetentionRuleIdPathParam: + description: The ID of the retention rule. + in: path + name: retentionRuleId + required: true + schema: + type: string + UploadIdQueryParam: + description: The upload ID for a multipart upload. + in: query + name: uploadId + required: true + schema: + type: string + UploadPartNumberQueryParam: + description: The part number that identifies the object part currently being uploaded. + in: query + name: uploadPartNum + required: true + schema: + type: integer + minimum: 1 + maximum: 10000 + InventoryRuleIdPathParam: + description: The ID of the inventory rule. + in: path + name: inventoryRuleId + required: true + schema: + type: string + ListPrivateEndpointFieldsQueryParam: + description: | + PrivateEndpoint summary in list of PrivateEndpoints includes the 'namespace', 'name', 'compartmentId', + 'createdBy', 'timeCreated', 'timeModified' and 'etag' fields. + This parameter can also include 'tags' (freeformTags and definedTags). + The only supported value of this parameter is 'tags' for now. Example 'tags'. + in: query + name: fields + style: form + explode: false + schema: + type: array + items: + enum: + - tags + type: string + lifecycleState: + description: The lifecycle state of the Private Endpoint + in: query + name: lifecycleState + x-obmcs-enumref: '#/definitions/PrivateEndpoint/lifecycleState' + schema: + type: string + PrivateEndpointPathParam: + description: | + The name of the private endpoint. Avoid entering confidential information. + Example: `my-new-pe-1` + in: path + name: peName + required: true + schema: + type: string + minLength: 1 + pattern: '[A-Za-z0-9\\-_\\.]+' + PrivateEndpointNameQueryParam: + description: The name of the privateEndpoint for which to list work requests. + in: query + name: privateEndpointName + schema: + type: string + WorkRequestIdPathParam: + description: The ID of the asynchronous request. + in: path + name: workRequestId + required: true + schema: + type: string + x-stackQL-resources: + namespaces: + id: oci.object_storage.namespaces + name: namespaces + title: Namespaces + methods: + get: + operation: + $ref: '#/paths/~1n~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/GetNamespaceTransformed' + transform: + type: golang_template_text_v0.1.0 + body: |- + {{- $ns := getRegexpFirstMatch . "\"([^\"]+)\"" -}} + {"namespace": "{{ $ns }}"} + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + namespace_metadatas: + id: oci.object_storage.namespace_metadatas + name: namespace_metadatas + title: Namespace Metadatas + methods: + get: + operation: + $ref: '#/paths/~1n~1{namespaceName}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1n~1{namespaceName}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/namespace_metadatas/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/namespace_metadatas/methods/update' + delete: [] + replace: [] + buckets: + id: oci.object_storage.buckets + name: buckets + title: Buckets + methods: + list: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.buckets + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListBucketsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"buckets\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + config: + queryParamPushdown: + select: + paramName: fields + delimiter: ',' + supportedColumns: + - approximateCount + - approximate_count + - approximateSize + - approximate_size + - autoTiering + - auto_tiering + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/buckets/methods/get' + - $ref: '#/components/x-stackQL-resources/buckets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/buckets/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/buckets/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/buckets/methods/delete' + replace: [] + bs: + id: oci.object_storage.bs + name: bs + title: Bs + methods: + batch_delete_objects: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1actions~1batchDeleteObjects/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + copy_object: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1actions~1copyObject/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + make_bucket_writable: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1actions~1makeBucketWritable/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + reencrypt_bucket: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1actions~1reencrypt/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + reencrypt_object: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1actions~1reencrypt~1{objectName}/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + rename_object: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1actions~1renameObject/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + restore_objects: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1actions~1restoreObjects/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + object_storage_tiers: + id: oci.object_storage.object_storage_tiers + name: object_storage_tiers + title: Object Storage Tiers + methods: + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1actions~1updateObjectStorageTier/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/object_storage_tiers/methods/update' + delete: [] + replace: [] + object_lifecycle_policies: + id: oci.object_storage.object_lifecycle_policies + name: object_lifecycle_policies + title: Object Lifecycle Policies + methods: + delete: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1l/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1l/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/object_lifecycle_policies/methods/get' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/object_lifecycle_policies/methods/delete' + replace: [] + ls: + id: oci.object_storage.ls + name: ls + title: Ls + methods: + put_object_lifecycle_policy: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1l/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + objects: + id: oci.object_storage.objects + name: objects + title: Objects + methods: + list: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1o/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.objects + config: + pagination: + requestToken: + key: start + location: query + responseToken: + key: nextStartWith + location: body + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + select: + paramName: fields + delimiter: ',' + supportedColumns: + - name + - size + - etag + - timeCreated + - time_created + - md5 + - md_5 + - timeModified + - time_modified + - storageTier + - storage_tier + - archivalState + - archival_state + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1o~1{objectName}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/objects/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/objects/methods/delete' + replace: [] + object_versions: + id: oci.object_storage.object_versions + name: object_versions + title: Object Versions + methods: + list: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1objectversions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + select: + paramName: fields + delimiter: ',' + supportedColumns: + - name + - size + - etag + - timeCreated + - time_created + - md5 + - md_5 + - timeModified + - time_modified + - storageTier + - storage_tier + - archivalState + - archival_state + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/object_versions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + preauthenticated_requests: + id: oci.object_storage.preauthenticated_requests + name: preauthenticated_requests + title: Preauthenticated Requests + methods: + list: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1p~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.preauthenticated_requests + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListPreauthenticatedRequestsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"preauthenticated_requests\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1p~1/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1p~1{parId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1p~1{parId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/preauthenticated_requests/methods/get' + - $ref: '#/components/x-stackQL-resources/preauthenticated_requests/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/preauthenticated_requests/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/preauthenticated_requests/methods/delete' + replace: [] + replication_policies: + id: oci.object_storage.replication_policies + name: replication_policies + title: Replication Policies + methods: + list: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1replicationPolicies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.replication_policies + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListReplicationPoliciesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"replication_policies\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1replicationPolicies/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1replicationPolicies~1{replicationId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1replicationPolicies~1{replicationId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/replication_policies/methods/get' + - $ref: '#/components/x-stackQL-resources/replication_policies/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/replication_policies/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/replication_policies/methods/delete' + replace: [] + replication_sources: + id: oci.object_storage.replication_sources + name: replication_sources + title: Replication Sources + methods: + list: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1replicationSources/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.replication_sources + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListReplicationSourcesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"replication_sources\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/replication_sources/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + retention_rules: + id: oci.object_storage.retention_rules + name: retention_rules + title: Retention Rules + methods: + list: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1retentionRules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1retentionRules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1retentionRules~1{retentionRuleId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1retentionRules~1{retentionRuleId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1retentionRules~1{retentionRuleId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/retention_rules/methods/get' + - $ref: '#/components/x-stackQL-resources/retention_rules/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/retention_rules/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/retention_rules/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/retention_rules/methods/delete' + replace: [] + multipart_uploads: + id: oci.object_storage.multipart_uploads + name: multipart_uploads + title: Multipart Uploads + methods: + list: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1u/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.multipart_uploads + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListMultipartUploadsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"multipart_uploads\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1u/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/multipart_uploads/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/multipart_uploads/methods/create' + update: [] + delete: [] + replace: [] + us: + id: oci.object_storage.us + name: us + title: Us + methods: + abort_multipart_upload: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1u~1{objectName}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + commit_multipart_upload: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1u~1{objectName}/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + multipart_upload_parts: + id: oci.object_storage.multipart_upload_parts + name: multipart_upload_parts + title: Multipart Upload Parts + methods: + list: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1b~1{bucketName}~1u~1{objectName}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.multipart_upload_parts + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListMultipartUploadPartsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"multipart_upload_parts\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/multipart_upload_parts/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + inventory_rules: + id: oci.object_storage.inventory_rules + name: inventory_rules + title: Inventory Rules + methods: + list: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1inventoryRules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1n~1{namespaceName}~1inventoryRules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1inventoryRules~1{inventoryRuleId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1inventoryRules~1{inventoryRuleId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1n~1{namespaceName}~1inventoryRules~1{inventoryRuleId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/inventory_rules/methods/get' + - $ref: '#/components/x-stackQL-resources/inventory_rules/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/inventory_rules/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/inventory_rules/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/inventory_rules/methods/delete' + replace: [] + private_endpoints: + id: oci.object_storage.private_endpoints + name: private_endpoints + title: Private Endpoints + methods: + list: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1pe~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.private_endpoints + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListPrivateEndpointsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"private_endpoints\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1n~1{namespaceName}~1pe~1/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1pe~1{peName}~1/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1n~1{namespaceName}~1pe~1{peName}~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1n~1{namespaceName}~1pe~1{peName}~1/post' + response: + mediaType: application-json + openAPIDocKey: '202' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/private_endpoints/methods/get' + - $ref: '#/components/x-stackQL-resources/private_endpoints/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/private_endpoints/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/private_endpoints/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/private_endpoints/methods/delete' + replace: [] + work_requests: + id: oci.object_storage.work_requests + name: work_requests + title: Work Requests + methods: + list: + operation: + $ref: '#/paths/~1workRequests/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.work_requests + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListWorkRequestsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"work_requests\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + cancel_work_request: + operation: + $ref: '#/paths/~1workRequests~1{workRequestId}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1workRequests~1{workRequestId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/work_requests/methods/get' + - $ref: '#/components/x-stackQL-resources/work_requests/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + work_request_errors: + id: oci.object_storage.work_request_errors + name: work_request_errors + title: Work Request Errors + methods: + list: + operation: + $ref: '#/paths/~1workRequests~1{workRequestId}~1errors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.work_request_errors + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListWorkRequestErrorsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"work_request_errors\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/work_request_errors/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + work_request_logs: + id: oci.object_storage.work_request_logs + name: work_request_logs + title: Work Request Logs + methods: + list: + operation: + $ref: '#/paths/~1workRequests~1{workRequestId}~1logs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.work_request_logs + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListWorkRequestLogsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"work_request_logs\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/work_request_logs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://objectstorage.{region}.oraclecloud.com + variables: + region: + default: us-ashburn-1 + description: OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. + x-stackQL-envVar: OCI_REGION +x-stackQL-config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: opc-next-page + location: header diff --git a/providers/src/oci/v00.00.00000/services/resource_manager.yaml b/providers/src/oci/v00.00.00000/services/resource_manager.yaml new file mode 100644 index 00000000..c8fca491 --- /dev/null +++ b/providers/src/oci/v00.00.00000/services/resource_manager.yaml @@ -0,0 +1,7612 @@ +openapi: 3.0.0 +info: + title: resource_manager API + description: oci resource_manager API + version: '20180917' +paths: + /configurationSourceProviders: + get: + description: | + Lists configuration source providers according to the specified filter. + For more information, see + [Listing Configuration Source Providers](/iaas/Content/ResourceManager/Tasks/list-csp.htm). + - For `compartmentId`, lists all configuration source providers in the matching compartment. + - For `configurationSourceProviderId`, lists the matching configuration source provider. + operationId: ListConfigurationSourceProviders + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/IdForConfigurationSourceProviderQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/FilterByConfigSourceProviderTypeQueryParam' + responses: + '200': + description: The request was accepted for processing. + headers: + opc-next-page: + description: | + Retrieves the next page of paginated list items. If the `opc-next-page` + header appears in the response, additional pages of results remain. + To receive the next page, include the header value in the `page` param. + If the `opc-next-page` header does not appear in the response, there + are no more list items to get. For more information about list pagination, + see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigurationSourceProviderCollection' + '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/DefaultError' + summary: Lists configuration source providers. + tags: + - ResourceManager + x-example: | + Sample 1: List all configuration source providers in a compartment, sorted by display name + + GET /20180917/configurationSourceProviders?compartmentId=<compartment_OCID>&sortBy=displayName + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + Sample 2: List the specified configuration source provider in a compartment + + GET /20180917/configurationSourceProviders?configurationSourceProviderId=<configurationsourceprovider_OCIDD> + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + Sample 3: List the configuration source providers in a compartment, filtered by config source provider type (GitHub/GitLab) + + GET /20180917/configurationSourceProviders?compartmentId=<compartment_OCID>&configSourceProviderType=<config_source_provider_type>&sortBy=displayName + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ConfigurationSourceProviderSummary' + post: + description: | + Creates a configuration source provider in the specified compartment. + For more information, see + [Creating a Configuration Source Provider](/iaas/Content/ResourceManager/Tasks/create-csp.htm). + operationId: CreateConfigurationSourceProvider + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateConfigurationSourceProviderDetails' + description: The properties for creating a ConfigurationSourceProvider. + required: true + responses: + '200': + description: The request was accepted for processing. + headers: + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigurationSourceProvider' + '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/DefaultError' + summary: Creates a configuration source provider in the specified compartment. + tags: + - ResourceManager + x-example: | + POST /20180917/configurationSourceProviders + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "My Configuration Source Provider", + "description": "Example Git Source", + "configSourceProviderType": "GITLAB_ACCESS_TOKEN", + "apiEndpoint": "https://gitlab.com", + "accessToken": "<token>", + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Project": "DC1" + } + } + } + /configurationSourceProviders/{configurationSourceProviderId}: + delete: + description: | + Deletes the specified configuration source provider. + For more information, see + [Deleting a Configuration Source Provider](/iaas/Content/ResourceManager/Tasks/delete-csp.htm). + operationId: DeleteConfigurationSourceProvider + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/IfMatchHeaderParam' + - $ref: '#/components/parameters/ConfigurationSourceProviderIdPathParam' + responses: + '204': + description: The request was accepted for processing. + headers: + opc-request-id: + description: Unique identifier for 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/DefaultError' + summary: Deletes the specified configuration source provider. + tags: + - ResourceManager + x-example: | + DELETE /20180917/configurationSourceProviders/<configurationsourceprovider_OCID> + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ConfigurationSourceProvider' + get: + description: | + Gets the properties of the specified configuration source provider. + For more information, see + [Getting a Configuration Source Provider's Details](/iaas/Content/ResourceManager/Tasks/get-csp.htm). + operationId: GetConfigurationSourceProvider + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/ConfigurationSourceProviderIdPathParam' + responses: + '200': + description: The request was accepted for processing. + headers: + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigurationSourceProvider' + '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/DefaultError' + summary: Gets the properties of the specified configuration source provider. + tags: + - ResourceManager + x-example: | + GET /20180917/configurationSourceProviders/<configurationsourceprovider_OCID> + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the properties of the specified configuration source provider. + For more information, see + [Updating a Configuration Source Provider](/iaas/Content/ResourceManager/Tasks/update-csp.htm). + operationId: UpdateConfigurationSourceProvider + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/IfMatchHeaderParam' + - $ref: '#/components/parameters/ConfigurationSourceProviderIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateConfigurationSourceProviderDetails' + description: | + Updated information provided for the ConfigurationSourceProvider. + required: true + responses: + '200': + description: The request was accepted for processing. + headers: + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigurationSourceProvider' + '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/DefaultError' + summary: Updates the properties of the specified configuration source provider. + tags: + - ResourceManager + x-example: | + PUT /20180917/configurationSourceProviders/<configurationsourceprovider_OCID> + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName": "My Renamed Configuration Source Provider" + } + /configurationSourceProviders/{configurationSourceProviderId}/actions/changeCompartment: + post: + description: | + Moves a configuration source provider into a different compartment within the same tenancy. + For more information, see + [Moving a Configuration Source Provider](/iaas/Content/ResourceManager/Tasks/change-compartment-csp.htm). + operationId: ChangeConfigurationSourceProviderCompartment + parameters: + - $ref: '#/components/parameters/IfMatchHeaderParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' + - $ref: '#/components/parameters/ConfigurationSourceProviderIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeConfigurationSourceProviderCompartmentDetails' + description: Defines the properties of changeConfigurationSourceProviderCompartment operation. + required: true + responses: + '204': + description: The request to move the configuration source provider to a different compartment was accepted for processing. + headers: + opc-request-id: + description: Unique identifier for 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/DefaultError' + summary: Moves a ConfigurationSourceProvider into a different compartment. When provided, If-Match is checked against ETag values of the ConfigurationSourceProvider. + tags: + - ResourceManager + x-example: | + POST /20180917/configurationSourceProviders/<configurationsourceprovider_OCID>/actions/changeCompartment + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "<compartment_OCID>" + } + x-related-resource: '#/definitions/ConfigurationSourceProvider' + /jobs: + get: + description: | + Lists jobs according to the specified filter. By default, the list is ordered by time created. + For more information, see + [Listing Jobs](/iaas/Content/ResourceManager/Tasks/list-jobs.htm). + + - To list all jobs in a stack, provide the stack [OCID](/iaas/Content/General/Concepts/identifiers.htm). + - To list all jobs in a compartment, provide the compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm). + - To return a specific job, provide the job [OCID](/iaas/Content/General/Concepts/identifiers.htm). (Equivalent to [GetStack](#/en/resourcemanager/latest/Stack/GetStack).) + operationId: ListJobs + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/StackIdQueryParam' + - $ref: '#/components/parameters/IdForJobQueryParam' + - description: | + A filter that returns all resources that match the specified lifecycle state. + The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/Job/lifecycleState' + schema: + type: string + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: A list of jobs. + headers: + opc-next-page: + description: | + Retrieves the next page of paginated list items. If the `opc-next-page` + header appears in the response, additional pages of results remain. + To receive the next page, include the header value in the `page` param. + If the `opc-next-page` header does not appear in the response, there + are no more list items to get. For more information about list pagination, + see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ListJobsResponse' + '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/DefaultError' + summary: | + List all jobs related to a stack or compartment. By default, the list is ordered by time created. + You can alter the ordering by using `SortByQueryParam` and `SortOrderQueryParam`. + tags: + - ResourceManager + x-example: | + Sample 1: List jobs in a compartment. + + GET /20180917/jobs/<job_OCID>/logs&compartmentId=<compartment_OCID> + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + Sample 2: List jobs in a stack. + + GET /20180917/jobs/<job_OCID>/logs&stackId=<stack_OCID> + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + post: + description: | + Creates a job. + For more information, see + [Creating a Job](/iaas/Content/ResourceManager/Tasks/create-job.htm). + operationId: CreateJob + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateJobDetails' + description: The properties for a request to create a job. + required: true + responses: + '200': + description: Successful operation. + headers: + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Job' + '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/DefaultError' + summary: Create a Job. + tags: + - ResourceManager + x-example: | + POST /20180917/jobs + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName": "Job Display Name", + "stackId": "ocid1.ormstack.oc1..<unique_ID>", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "operation": "APPLY", + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Owner": "Operations" + } + } + } + /jobs/{jobId}: + delete: + description: | + Indicates the intention to cancel the specified job. + Cancellation of the job is not immediate, and may be delayed, + or may not happen at all. + You can optionally choose forced cancellation by setting `isForced` to true. + A forced cancellation can result in an incorrect state file. + For example, the state file might not reflect the exact state of the provisioned resources. + For more information, see + [Canceling a Job](/iaas/Content/ResourceManager/Tasks/cancel-job.htm). + operationId: CancelJob + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/IfMatchHeaderParam' + - $ref: '#/components/parameters/JobIdPathParam' + - $ref: '#/components/parameters/IsForcedQueryParam' + responses: + '202': + description: Confirmation that the job cancellation has begun. + headers: + opc-request-id: + description: Unique identifier for 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/DefaultError' + summary: Cancel a Job + tags: + - ResourceManager + x-example: | + DELETE /20180917/jobs/<job_OCID> + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Job' + get: + description: | + Gets the properties of the specified job. + For more information, see + [Getting a Job's Details](/iaas/Content/ResourceManager/Tasks/get-job.htm). + operationId: GetJob + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/JobIdPathParam' + responses: + '200': + description: A job object. + headers: + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Job' + '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/DefaultError' + summary: Get details of a specific job. + tags: + - ResourceManager + x-example: | + GET /20180917/jobs/<job_OCID> + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the specified job. + For more information, see + [Updating a Job](/iaas/Content/ResourceManager/Tasks/update-job.htm). + operationId: UpdateJob + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/IfMatchHeaderParam' + - $ref: '#/components/parameters/JobIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateJobDetails' + description: Updates properties for the specified job. + required: true + responses: + '200': + description: Returns the updated job object. + headers: + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Job' + '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/DefaultError' + summary: Update a Job. + tags: + - ResourceManager + x-example: | + PUT /20180917/jobs/<job_OCID> + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName": "example_job", + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Owner": "Operations" + } + } + } + /jobs/{jobId}/associatedResources: + get: + description: | + Gets the list of resources associated with the specified job. + For more information, see + [Listing Job Resources](/iaas/Content/ResourceManager/Tasks/list-job-resources.htm). + operationId: ListJobAssociatedResources + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/JobIdPathParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/TerraformResourceTypeQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: A list of associated resources. + headers: + opc-next-page: + description: | + Retrieves the next page of paginated list items. If the `opc-next-page` + header appears in the response, additional pages of results remain. + To receive the next page, include the header value in the `page` param. + If the `opc-next-page` header does not appear in the response, there + are no more list items to get. For more information about list pagination, + see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AssociatedResourcesCollection' + '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/DefaultError' + summary: Gets the list of resources associated with the specified job. + tags: + - ResourceManager + x-example: | + Sample 1: Gets all the resources associated with the given job + + GET /20180917/jobs/<job_OCID>/associatedResources + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + Sample 2: Gets compute instances (`oci_core_instance`) associated with the given job + + GET /20180917/jobs/<job_OCID>/associatedResource?resourceType=oci_core_instance + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AssociatedResourceSummary' + /jobs/{jobId}/detailedLogContent: + get: + description: | + Returns the Terraform detailed log content for the specified job in plain text. + [Learn about Terraform detailed log.](https://www.terraform.io/docs/internals/debugging.html) + For more information, see + [Getting Detailed Log Content for a Job](/iaas/Content/ResourceManager/Tasks/get-job-detailed-log-content.htm). + operationId: GetJobDetailedLogContent + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/JobIdPathParam' + responses: + '200': + description: Successfully returned the Terraform detailed log content for the job. + headers: + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + text/plain; charset=utf-8: + schema: + type: string + '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/DefaultError' + summary: Gets job detailed log content. + tags: + - ResourceManager + x-related-resource: '#/definitions/Job' + /jobs/{jobId}/logs: + get: + description: | + Returns console log entries for the specified job in JSON format. + For more information, see + [Getting Logs for a Job](/iaas/Content/ResourceManager/Tasks/get-job-logs.htm). + operationId: GetJobLogs + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/JobIdPathParam' + - description: | + A filter that returns only logs of a specified type. + in: query + name: type + required: false + explode: true + schema: + type: array + items: + type: string + x-obmcs-enumref: '#/definitions/LogEntry/type' + - description: | + A filter that returns only log entries that match a given severity level or greater. + in: query + name: levelGreaterThanOrEqualTo + required: false + x-obmcs-enumref: '#/definitions/LogEntry/level' + schema: + type: string + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/LogTimestampGreaterThanOrEqualToQueryParam' + - $ref: '#/components/parameters/LogTimestampLessThanOrEqualToQueryParam' + responses: + '200': + description: An array of log entries. + headers: + opc-next-page: + description: | + Retrieves the next page of paginated list items. If the `opc-next-page` + header appears in the response, additional pages of results remain. + To receive the next page, include the header value in the `page` param. + If the `opc-next-page` header does not appear in the response, there + are no more list items to get. For more information about list pagination, + see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/GetJobLogsResponse' + '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/DefaultError' + summary: Gets log entries for a job + tags: + - ResourceManager + x-example: | + Sample 1: List log entries for the specified job that are at error level or greater. + + GET /20180917/jobs/<job_OCID>/logs&levelGreaterThanOrEqualTo=ERROR + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + Sample 2: List log entries for the specified job that have timestamps equal to or greater than midnight on February 1st. + + GET /20180917/jobs/<job_OCID>/logs&timestampGreaterThanOrEqualTo=2020-02-01T12:00:00.000Z + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Job' + /jobs/{jobId}/logs/content: + get: + description: | + Returns the raw log file for the specified job in text format. + The file includes a maximum of 100,000 log entries. + For more information, see + [Getting Logs Content for a Job](/iaas/Content/ResourceManager/Tasks/get-job-logs-content.htm). + operationId: GetJobLogsContent + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/JobIdPathParam' + responses: + '200': + description: Logs. + headers: + opc-request-id: + description: Unique identifier for the request + schema: + type: string + content: + text/plain; charset=utf-8: + schema: + type: string + '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/DefaultError' + summary: Gets the raw logs for a job. + tags: + - ResourceManager + x-example: | + GET /20180917/jobs/<job_OCID>/logs/content + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Job' + /jobs/{jobId}/outputs: + get: + description: | + Gets the list of outputs associated with the specified job. + For more information, see + [Listing Job Outputs](/iaas/Content/ResourceManager/Tasks/list-job-outputs.htm). + operationId: ListJobOutputs + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/JobIdPathParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: A list of job outputs. + headers: + opc-next-page: + description: | + Retrieves the next page of paginated list items. If the `opc-next-page` + header appears in the response, additional pages of results remain. + To receive the next page, include the header value in the `page` param. + If the `opc-next-page` header does not appear in the response, there + are no more list items to get. For more information about list pagination, + see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/JobOutputsCollection' + '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/DefaultError' + summary: Gets the list of outputs associated with the specified job. + tags: + - ResourceManager + x-example: | + Sample 1: Gets all the outputs associated with the given job + + GET /20180917/jobs/<job_OCID>/outputs + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/JobOutputSummary' + /jobs/{jobId}/tfConfig: + get: + description: | + Returns the Terraform configuration for the specified job in zip format. + If no zip file is found, returns an error. + For more information, see + [Getting a Job Terraform Configuration](/iaas/Content/ResourceManager/Tasks/get-job-tf-config.htm). + operationId: GetJobTfConfig + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/JobIdPathParam' + responses: + '200': + description: Terraform configuration. + headers: + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/zip: + schema: + format: binary + type: string + '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/DefaultError' + summary: Get zipped Terraform configuration used for a specific job. + tags: + - ResourceManager + x-example: | + GET /20180917/jobs/<job_OCID>/tfConfig + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Job' + /jobs/{jobId}/tfPlan: + get: + description: | + Returns the output of the specified Terraform plan job in binary or JSON format. + For more information, see + [Getting the Terraform Output for a Plan Job](/iaas/Content/ResourceManager/Tasks/get-job-tf-plan.htm). + operationId: GetJobTfPlan + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/JobIdPathParam' + - $ref: '#/components/parameters/TfPlanFormatQueryParam' + responses: + '200': + description: Successfully returned output of the plan job. + headers: + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/octet-stream: + schema: + format: binary + type: string + '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/DefaultError' + summary: Gets terraform plan output file with contents in binary or json format + tags: + - ResourceManager + x-example: | + Sample 1: Binary format option for downloading Terraform plan output + + GET /20180917/jobs/<job_OCID>/tfPlan?tfPlanFormat=BINARY + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + Sample 2: JSON format option for downloading Terraform plan output + + GET /20180917/jobs/<job_OCID>/tfPlan?tfPlanFormat=JSON + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Job' + /jobs/{jobId}/tfState: + get: + description: | + Returns the Terraform state for the specified job. + For more information, see + [Getting a Job Terraform Configuration](/iaas/Content/ResourceManager/Tasks/get-job-tf-config.htm). + operationId: GetJobTfState + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/JobIdPathParam' + responses: + '200': + description: A Terraform state. + headers: + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/octet-stream: + schema: + format: binary + type: string + '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/DefaultError' + summary: Get Terraform state output from a specified job. + tags: + - ResourceManager + x-example: | + GET /20180917/jobs/<job_OCID>/tfState + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Job' + /privateEndpoints: + get: + description: | + Lists private endpoints according to the specified filter. + For more information, see + [Listing Private Endpoints](/iaas/Content/ResourceManager/Tasks/list-private-endpoints.htm). + - For `compartmentId`, lists all private endpoints in the matching compartment. + - For `privateEndpointId`, lists the matching private endpoint. + operationId: ListPrivateEndpoints + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PrivateEndpointIdQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/FilterByVcnIdQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: Successfully retrieved the list of private endpoints. + headers: + opc-next-page: + description: | + Retrieves the next page of paginated list items. If the `opc-next-page` + header appears in the response, additional pages of results remain. + To receive the next page, include the header value in the `page` param. + If the `opc-next-page` header does not appear in the response, there + are no more list items to get. For more information about list pagination, + see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + schema: + type: string + opc-request-id: + description: | + Unique Oracle-assigned identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PrivateEndpointCollection' + '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/DefaultError' + summary: Lists private endpoints according to specified filter. + tags: + - ResourceManager + x-example: | + Sample 1: List all private endpoints in a compartment, sorted by display name + + GET /20180917/privateEndpoints?compartmentId=<compartment_OCID>&sortBy=displayName + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + Sample 2: List the specified private endpoint in its compartment + + GET /20180917/privateEndpoints?compartmentId=<compartment_OCID>&privateEndpointId=<privateendpoint_OCID> + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + Sample 3: List private endpoints in the specified compartment, filtered by VCN + + GET /20180917/privateEndpoints?compartmentId=<compartment_OCID>&vcnId=<vcn_OCID> + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + Sample 4: List the specified private endpoint + + GET /20180917/privateEndpoints?privateEndpointId=<privateendpoint_OCID> + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/PrivateEndpointSummary' + post: + description: | + Creates a private endpoint in the specified compartment. + For more information, see + [Creating a Private Endpoint](/iaas/Content/ResourceManager/Tasks/create-private-endpoints.htm). + operationId: CreatePrivateEndpoint + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePrivateEndpointDetails' + description: Creation details for a private endpoint. + required: true + responses: + '200': + description: Successfully accepted the request. The private endpoint will be created. + headers: + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + opc-work-request-id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PrivateEndpoint' + '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/DefaultError' + summary: Creates a private endpoint in the specified compartment. + tags: + - ResourceManager + x-example: | + POST /20180917/privateEndpoints + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<compartment_OCID>", + "displayName": "My Private Endpoint", + "description": "Example Private Endpoint", + "vcnId": "ocid1.vcn.oc1.phx.<vcn_OCID>", + "subnetId": "ocid1.subnet.oc1.phx.<subnet_OCID>", + "nsgIdList": ["ocid1.networksecuritygroup.oc1.phx.<nsg1_OCID>","ocid1.networksecuritygroup.oc1.phx.<nsg2_OCID>"], + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Owner": "Operations" + } + }, + "securityAttributes": { + "oracle-zpr": { + "MaxEgressCount": { + "mode": "enforce", + "value": "45" + } + } + } + } + /privateEndpoints/{privateEndpointId}: + delete: + description: | + Deletes the specified private endpoint. + For more information, see + [Deleting a Private Endpoint](/iaas/Content/ResourceManager/Tasks/delete-private-endpoints.htm). + operationId: DeletePrivateEndpoint + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/IfMatchHeaderParam' + - $ref: '#/components/parameters/PrivateEndpointIdPathParam' + responses: + '204': + description: The private endpoint was deleted. + headers: + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + opc-work-request-id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work 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/DefaultError' + summary: Deletes the specified private endpoint. + tags: + - ResourceManager + x-example: | + DELETE /20180917/privateEndpoints/<privateendpoint_OCID> + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/PrivateEndpoint' + get: + description: | + Gets the specified private endpoint. + For more information, see + [Getting a Private Endpoint's Details](/iaas/Content/ResourceManager/Tasks/get-private-endpoints.htm). + operationId: GetPrivateEndpoint + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/PrivateEndpointIdPathParam' + responses: + '200': + description: Successfully retrieved the private endpoint. + headers: + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PrivateEndpoint' + '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/DefaultError' + summary: Gets the specified private endpoint. + tags: + - ResourceManager + x-example: | + GET /20180917/privateEndpoints/<privateendpoint_OCID> + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other header> + put: + description: | + Updates the specified private endpoint. + For more information, see + [Updating a Private Endpoint](/iaas/Content/ResourceManager/Tasks/update-private-endpoints.htm). + operationId: UpdatePrivateEndpoint + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/IfMatchHeaderParam' + - $ref: '#/components/parameters/PrivateEndpointIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePrivateEndpointDetails' + description: Update details for a private endpoint. + required: true + responses: + '200': + description: Successfully accepted the request. The private endpoint will be updated. + headers: + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + opc-work-request-id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PrivateEndpoint' + '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/DefaultError' + summary: Updates the specified private endpoint. + tags: + - ResourceManager + x-example: | + PUT /20180917/privateEndpoints/<privateendpoint_OCID> + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName" : "My renamed private endpoint", + "description" : "My updated private endpoint description" + } + /privateEndpoints/{privateEndpointId}/actions/changeCompartment: + post: + description: | + Moves a private endpoint to a different compartment within the same tenancy. + For more information, see + [Moving a Private Endpoint](/iaas/Content/ResourceManager/Tasks/move-private-endpoints.htm). + operationId: ChangePrivateEndpointCompartment + parameters: + - $ref: '#/components/parameters/IfMatchHeaderParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' + - $ref: '#/components/parameters/PrivateEndpointIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangePrivateEndpointCompartmentDetails' + description: Defines the properties of changePrivateEndpointCompartment operation. + required: true + responses: + '204': + description: Successfully accepted the request. The private endpoint will be moved to the specified compartment. + headers: + opc-request-id: + description: Unique identifier for 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/DefaultError' + summary: Moves a private endpoint into a different compartment. When provided, If-Match is checked against ETag values of the private endpoint. + tags: + - ResourceManager + x-example: | + POST /20180917/privateEndpoints/<privateendpoint_OCID>/actions/changeCompartment + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "<compartment_OCID>" + } + x-related-resource: '#/definitions/PrivateEndpoint' + /privateEndpoints/{privateEndpointId}/reachableIp: + get: + description: | + Gets the reachable, or alternative, IP address for a nonpublic IP address that is associated with the private endpoint. + Resource Manager uses this IP address to connect to nonpublic resources through the associated private endpoint. + For more information, see + [Getting the Reachable IP Address for a Private Endpoint](/iaas/Content/ResourceManager/Tasks/get-private-endpoint-reachable-ip.htm). + operationId: GetReachableIp + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/PrivateIpQueryParam' + - $ref: '#/components/parameters/PrivateEndpointIdPathParam' + - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' + responses: + '200': + description: Successfully retrieved the IP address. + headers: + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ReachableIp' + '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/DefaultError' + summary: Gets the alternative IP address of the private resource. + tags: + - ResourceManager + x-example: | + GET /20180917/privateEndpoints/<privateendpoint_OCID>/reachableIp?privateIp=10.0.0.0 + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ReachableIp' + /resourceDiscoveryServices: + get: + description: | + Returns a list of supported services for [Resource Discovery](/iaas/Content/ResourceManager/Concepts/resource-discovery.htm). + For reference on service names, see the [Terraform provider documentation](https://www.terraform.io/docs/providers/oci/guides/resource_discovery.html#services). + For more information, see + [Listing Resource Discovery Services](/iaas/Content/ResourceManager/Tasks/list-discovery-services.htm). + operationId: ListResourceDiscoveryServices + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + responses: + '200': + description: A list of supported Resource Discovery services. + 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/ResourceDiscoveryServiceCollection' + '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/DefaultError' + summary: Lists supported Resource Discovery services. + tags: + - ResourceManager + x-example: | + GET /20180917/resourceDiscoveryServices + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Stack' + /stacks: + get: + description: | + Lists stacks according to the specified filter. + For more information, see + [Listing Stacks](/iaas/Content/ResourceManager/Tasks/list-stacks.htm). + - If called using the compartment ID, returns all stacks in the specified compartment. + - If called using the stack ID, returns the specified stack. (See also [GetStack](#/en/resourcemanager/latest/Stack/GetStack).) + operationId: ListStacks + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/IdForStackQueryParam' + - description: | + A filter that returns only those resources that match the specified + lifecycle state. The state value is case-insensitive. + For more information about stack lifecycle states, see + [Key Concepts](/iaas/Content/ResourceManager/Concepts/resourcemanager.htm#concepts__StackStates). + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/Stack/lifecycleState' + schema: + type: string + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: A list of stacks. + headers: + opc-next-page: + description: | + Retrieves the next page of paginated list items. If the `opc-next-page` + header appears in the response, additional pages of results remain. + To receive the next page, include the header value in the `page` param. + If the `opc-next-page` header does not appear in the response, there + are no more list items to get. For more information about list pagination, + see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ListStacksResponse' + '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/DefaultError' + summary: Returns a stack or list of stacks. + tags: + - ResourceManager + x-example: | + GET /20180917/stacks&compartmentId=<compartment_OCID> + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + post: + description: | + Creates a stack in the specified compartment. + You can create a stack from a Terraform configuration. + The Terraform configuration can be directly uploaded or referenced from a source code control system. + You can also create a stack from an existing compartment, which generates a Terraform configuration. + You can also upload the Terraform configuration from an Object Storage bucket. + For more information, see + [Creating a Stack](/iaas/Content/ResourceManager/Tasks/create-stack.htm). + operationId: CreateStack + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateStackDetails' + description: The properties for creating a stack. + required: true + responses: + '200': + description: The newly created Stack object. + headers: + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + opc-work-request-id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + schema: + type: string + maxLength: 255 + content: + application/json: + schema: + $ref: '#/components/schemas/Stack' + '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/DefaultError' + summary: Creates a Stack. + tags: + - ResourceManager + x-example: | + Sample 1: Zip file using Terraform version 1.5.x + + POST /20180917/stacks + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "terraformVersion": "1.5.x", + "displayName": "My Zip Configuration", + "configSource": { + "configSourceType": "ZIP_UPLOAD", + "zipFileBase64Encoded": "<zip_file_content_encoded_in_base64_format>", + "workingDirectory": "<file_path_to_directory>" + }, + } + + Sample 2: GitHub + + POST /20180917/stacks + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "My GitHub Configuration", + "configSource": { + "configSourceType": "GIT_CONFIG_SOURCE", + "configurationSourceProviderId": "ocid1.ormconfigsourceprovider.oc1..<unique_ID>", + "repositoryUrl": "https://github.com/user/repo.git", + "branchName": "MyBranch", + "workingDirectory": "<file_path_to_directory>", + } + } + + Sample 3: Bucket + + POST /20180917/stacks + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "My Bucket Terraform Configuration", + "configSource": { + "configSourceType": "OBJECT_STORAGE_CONFIG_SOURCE", + "region": "us-phoenix-1", + "namespace": "<bucket_namespace>", + "bucketName": "<bucket_name>" + } + } + + + Sample 4: Existing compartment (resource discovery) + + POST /20180917/stacks + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "My Compartment Configuration", + "configSource": { + "configSourceType": "COMPARTMENT_CONFIG_SOURCE", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "region": "us-phoenix-1" + } + } + + Sample 5: Custom Terraform provider for existing compartment (resource discovery) + POST /20180917/stacks + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "My Compartment Configuration with Custom Provider", + "configSource": { + "configSourceType": "COMPARTMENT_CONFIG_SOURCE", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "region": "us-phoenix-1" + }, + "customTerraformProvider": { + "region": "us-phoenix-1", + "namespace": "<bucket_namespace>", + "bucketName": "<bucket_name>" + } + } + + Sample 6: DevOps repository + POST /20180917/stacks + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "terraformVersion": "1.5.x", + "displayName": "My DevOps Stack", + "configSource": { + "configSourceType": "DEVOPS_CONFIG_SOURCE", + "projectId": "ocid1.devopsproject.oc1..<unique_ID>", + "repositoryId": "ocid1.devopsrepository.oc1..<unique_ID>", + "branchName": "MyBranch", + "workingDirectory": "<file_path_to_directory>", + } + } + /stacks/{stackId}: + delete: + description: | + Deletes the specified stack. + For more information, see + [Deleting a Stack](/iaas/Content/ResourceManager/Tasks/delete-stack.htm). + operationId: DeleteStack + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/IfMatchHeaderParam' + - $ref: '#/components/parameters/StackIdPathParam' + responses: + '204': + description: Success + headers: + opc-request-id: + description: Unique identifier for 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/DefaultError' + summary: Deletes a stack + tags: + - ResourceManager + x-example: | + DELETE /20180917/stacks/<stack_OCID> + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Stack' + get: + description: | + Gets the specified stack. + For more information, see + [Getting a Stack's Details](/iaas/Content/ResourceManager/Tasks/get-stack.htm). + operationId: GetStack + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/StackIdPathParam' + responses: + '200': + description: Returns the Stack object. + headers: + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Stack' + '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/DefaultError' + summary: Gets a stack by ID. + tags: + - ResourceManager + x-example: | + GET /20180917/stacks/<stack_OCID> + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the specified stack. + Use `UpdateStack` when you update your Terraform configuration + and want your changes to be reflected in the execution plan. + For more information, see + [Updating a Stack](/iaas/Content/ResourceManager/Tasks/update-stack.htm). + operationId: UpdateStack + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/IfMatchHeaderParam' + - $ref: '#/components/parameters/StackIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateStackDetails' + description: | + The details for updating a stack. + required: true + responses: + '200': + description: Returns the updated stack. + headers: + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Stack' + '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/DefaultError' + summary: Updates the specified stack object. + tags: + - ResourceManager + x-example: | + PUT /20180917/stacks/<stack_OCID> + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "terraformVersion": "1.5.x", + "displayName": "My Zip Configuration", + "configSource": { + "configSourceType": "ZIP_UPLOAD", + "zipFileBase64Encoded": "<zip_file_content_encoded_in_base64_format>", + "workingDirectory": "<file_path_to_directory>" + }, + } + /stacks/{stackId}/actions/changeCompartment: + post: + description: | + Moves a stack (and its associated jobs) into a different compartment within the same tenancy. + For more information, see + [Moving a Stack](/iaas/Content/ResourceManager/Tasks/change-compartment-stack.htm). + operationId: ChangeStackCompartment + parameters: + - $ref: '#/components/parameters/IfMatchHeaderParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' + - $ref: '#/components/parameters/StackIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeStackCompartmentDetails' + description: Defines the properties of changeStackCompartment operation. + required: true + responses: + '202': + description: Returns no content. Header contains work request id. + headers: + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + opc-work-request-id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work 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/DefaultError' + summary: Moves a Stack and it's associated Jobs into a different compartment. When provided, If-Match is checked against ETag values of the Stack. + tags: + - ResourceManager + x-example: | + POST /20180917/stacks/<stack_OCID>/actions/changeCompartment + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>" + } + x-related-resource: '#/definitions/Stack' + /stacks/{stackId}/actions/detectDrift: + post: + description: | + Checks drift status for the specified stack. + For more information, see + [Detecting Drift](/iaas/Content/ResourceManager/Tasks/detect-drift.htm). + operationId: DetectStackDrift + parameters: + - $ref: '#/components/parameters/IfMatchHeaderParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' + - $ref: '#/components/parameters/StackIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DetectStackDriftDetails' + description: The details for detecting drift in a stack + responses: + '202': + description: Returns no content. Header contains work request id. + headers: + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + opc-work-request-id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: | + Checks drift status for the specified stack. + tags: + - ResourceManager + x-example: | + POST /20180917/stacks/<stack_OCID>/actions/detectDrift + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Stack' + /stacks/{stackId}/actions/listResourceDriftDetails: + post: + description: | + Lists drift status details for each resource defined in the specified stack. + The drift status details for a given resource indicate differences, if any, between the actual state + and the expected (defined) state for that resource. + The drift status details correspond to the specified work request (`workRequestId`). + If no work request is specified, then the drift status details correspond to the latest completed work request for the stack. + For more information, see + [Listing Drift Status](/iaas/Content/ResourceManager/Tasks/list-drift.htm). + operationId: ListStackResourceDriftDetails + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/StackIdPathParam' + - $ref: '#/components/parameters/WorkRequestIdQueryParam' + - description: | + A filter that returns only resources that match the given drift status. The value is case-insensitive. + in: query + name: resourceDriftStatus + required: false + explode: true + schema: + type: array + items: + type: string + x-obmcs-enumref: '#/definitions/StackResourceDriftSummary/resourceDriftStatus' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: Drift status details for resources in the stack. + headers: + opc-next-page: + description: | + Retrieves the next page of paginated list items. If the `opc-next-page` + header appears in the response, additional pages of results remain. + To receive the next page, include the header value in the `page` param. + If the `opc-next-page` header does not appear in the response, there + are no more list items to get. For more information about list pagination, + see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/StackResourceDriftCollection' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Lists drift status details for each resource defined in the specified stack. + tags: + - ResourceManager + x-example: | + POST /20180917/stacks/<stack_OCID>/actions/listResourceDriftDetails + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/StackResourceDriftSummary' + /stacks/{stackId}/associatedResources: + get: + description: | + Gets the list of resources associated with the specified stack. + For more information, see + [Listing Stack Resources](/iaas/Content/ResourceManager/Tasks/list-stack-resources.htm). + operationId: ListStackAssociatedResources + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/StackIdPathParam' + - $ref: '#/components/parameters/TerraformResourceTypeQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: A list of associated resources. + headers: + opc-next-page: + description: | + Retrieves the next page of paginated list items. If the `opc-next-page` + header appears in the response, additional pages of results remain. + To receive the next page, include the header value in the `page` param. + If the `opc-next-page` header does not appear in the response, there + are no more list items to get. For more information about list pagination, + see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AssociatedResourcesCollection' + '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/DefaultError' + summary: Gets the list of resources associated with the specified stack. + tags: + - ResourceManager + x-example: | + Sample 1: Gets all the resources associated with the given stack + + GET /20180917/stacks/<stack_OCID>/associatedResource + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + Sample 2: Gets compute instances (`oci_core_instance`) associated with the given stack + + GET /20180917/stacks/<stack_OCID>/associatedResource?resourceType=oci_core_instance + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/AssociatedResourceSummary' + /stacks/{stackId}/tfConfig: + get: + description: | + Returns the Terraform configuration file for the specified stack in zip format. + Returns an error if no zip file is found. + For more information, see + [Getting a Stack Terraform Configuration](/iaas/Content/ResourceManager/Tasks/get-stack-tf-config.htm). + operationId: GetStackTfConfig + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/StackIdPathParam' + responses: + '200': + description: Terraform configuration zip file. + headers: + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/zip: + schema: + format: binary + type: string + '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/DefaultError' + summary: Gets the stack's zipped Terraform configuration + tags: + - ResourceManager + x-example: | + GET /20180917/stacks/<stack_OCID>/tfConfig + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Stack' + /stacks/{stackId}/tfState: + get: + description: | + Returns the Terraform state for the specified stack. + For more information, see + [Getting a Stack State File](/iaas/Content/ResourceManager/Tasks/get-stack-tf-state.htm). + operationId: GetStackTfState + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/StackIdPathParam' + responses: + '200': + description: A Terraform state. + headers: + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/octet-stream: + schema: + format: binary + type: string + '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/DefaultError' + summary: Get Terraform state of the specified stack. + tags: + - ResourceManager + x-example: | + GET /20180917/stacks/<stack_OCID>/tfState + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Stack' + /templateCategories: + get: + description: | + Lists template categories. + For more information, see + [Listing Template Categories](/iaas/Content/ResourceManager/Tasks/list-template-categories.htm). + operationId: ListTemplateCategories + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: A list of template categories. + headers: + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateCategorySummaryCollection' + '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/DefaultError' + summary: Lists template categories. + tags: + - ResourceManager + x-example: | + GET /20180917/templateCategories + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-obmcs-authz-declarations: + authorizationRequired: false + x-related-resource: '#/definitions/TemplateCategorySummary' + /templates: + get: + description: | + Lists templates according to the specified filter. + The attributes `compartmentId` and `templateCategoryId` are required unless `templateId` is specified. + For more information, see + [Listing Templates](/iaas/Content/ResourceManager/Tasks/list-template.htm). + operationId: ListTemplates + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/TemplateCategoryIdQueryParam' + - $ref: '#/components/parameters/TemplateIdQueryParam' + - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + responses: + '200': + description: A list of templates. + headers: + opc-next-page: + description: | + Retrieves the next page of paginated list items. If the `opc-next-page` + header appears in the response, additional pages of results remain. + To receive the next page, include the header value in the `page` param. + If the `opc-next-page` header does not appear in the response, there + are no more list items to get. For more information about list pagination, + see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateSummaryCollection' + '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/DefaultError' + summary: Lists templates according to the specified filter. + tags: + - ResourceManager + x-example: | + Sample 1: Quickstart templates + + GET /20180917/templates&compartmentId=<compartment_OCID>&templateCategoryId=0 + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + Sample 2: Private templates + + GET /20180917/templates&compartmentId=<compartment_OCID>&templateCategoryId=3 + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Template' + post: + description: | + Creates a private template in the specified compartment. + For more information, see + [Creating a Private Template](/iaas/Content/ResourceManager/Tasks/create-template.htm). + operationId: CreateTemplate + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTemplateDetails' + description: The configuration details for creating a template. + required: true + responses: + '200': + description: The newly created template. + headers: + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Template' + '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/DefaultError' + summary: Creates a private template in the specified compartment. + tags: + - ResourceManager + x-example: | + POST /20180917/templates + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "My Template", + "description": "My Template Description", + "longDescription": "My Template Long Description" + "zipFileBase64Encoded": "<zip_file_content_encoded_in_base64_format>", + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Owner": "Operations" + } + } + } + /templates/{templateId}: + delete: + description: | + Deletes the specified template. + For more information, see + [Deleting a Private Template](/iaas/Content/ResourceManager/Tasks/delete-template.htm). + operationId: DeleteTemplate + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/IfMatchHeaderParam' + - $ref: '#/components/parameters/TemplateIdPathParam' + responses: + '204': + description: The template was deleted. + headers: + opc-request-id: + description: Unique identifier for 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/DefaultError' + summary: Deletes the specified template. + tags: + - ResourceManager + x-related-resource: '#/definitions/Template' + get: + description: | + Gets the specified template. + For more information, see + [Getting a Private Template's Details](/iaas/Content/ResourceManager/Tasks/get-template.htm). + operationId: GetTemplate + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/TemplateIdPathParam' + responses: + '200': + description: Returns the template. + headers: + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Template' + '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/DefaultError' + summary: Gets the specified template. + tags: + - ResourceManager + x-example: | + GET /20180917/templates/ + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the specified template. + For more information, see + [Updating a Private Template](/iaas/Content/ResourceManager/Tasks/update-template.htm). + operationId: UpdateTemplate + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/IfMatchHeaderParam' + - $ref: '#/components/parameters/TemplateIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateTemplateDetails' + description: | + The details for updating a template. + required: true + responses: + '200': + description: Returns the updated template object. + headers: + etag: + description: For optimistic concurrency control. See `if-match`. + schema: + type: string + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Template' + '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/DefaultError' + summary: Updates the specified template. + tags: + - ResourceManager + x-example: | + PUT /20180917/templates?templateId=<template_OCID> + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "displayName": "Template Display Name", + "description": "Brief description of the template", + "longDescription": "Detailed description of the template. This description is displayed in the Console page listing templates when the template is expanded..", + "logoFileBase64Encoded": "binary string", + "zipFileBase64Encoded": "binary string", + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Owner": "Operations" + } + } + } + /templates/{templateId}/actions/changeCompartment: + post: + description: | + Moves a template into a different compartment within the same tenancy. + For more information, see + [Moving a Private Template](/iaas/Content/ResourceManager/Tasks/change-compartment-template.htm). + operationId: ChangeTemplateCompartment + parameters: + - $ref: '#/components/parameters/IfMatchHeaderParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' + - $ref: '#/components/parameters/TemplateIdPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeTemplateCompartmentDetails' + description: The details for moving a template to a different compartment. + required: true + responses: + '204': + description: The request to move the template to a different compartment. + headers: + opc-request-id: + description: Unique identifier for 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/DefaultError' + summary: Moves a template into a different compartment. When provided, If-Match is checked against ETag values of the Template. + tags: + - ResourceManager + x-example: | + POST /20180917/templates/<template_OCID>/actions/changeCompartment + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "<compartment_OCID>" + } + x-related-resource: '#/definitions/Template' + /templates/{templateId}/logo: + get: + description: | + Returns the Terraform logo file in .logo format for the specified template. + Returns an error if no logo file is found. + For more information, see + [Getting a Private Template's Logo](/iaas/Content/ResourceManager/Tasks/get-template-logo.htm). + operationId: GetTemplateLogo + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/TemplateIdPathParam' + responses: + '200': + description: Terraform logo file. + headers: + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + image/png: + schema: + format: binary + type: string + '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/DefaultError' + summary: Gets the template's logo file + tags: + - ResourceManager + x-related-resource: '#/definitions/Template' + /templates/{templateId}/tfConfig: + get: + description: | + Returns the Terraform configuration file in zip format for the specified template. + Returns an error if no zip file is found. + For more information, see + [Getting a Private Template's Terraform Configuration](/iaas/Content/ResourceManager/Tasks/get-template-tf-config.htm). + operationId: GetTemplateTfConfig + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/TemplateIdPathParam' + responses: + '200': + description: Terraform configuration zip file. + headers: + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + application/zip: + schema: + format: binary + type: string + '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/DefaultError' + summary: Gets the template's zipped Terraform configuration + tags: + - ResourceManager + x-related-resource: '#/definitions/Template' + /terraformVersions: + get: + description: | + Returns a list of supported Terraform versions for use with stacks. + For more information, see + [Listing Terraform Versions](/iaas/Content/ResourceManager/Tasks/list-tf-versions.htm). + operationId: ListTerraformVersions + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + responses: + '200': + description: A list of supported Terraform versions. + 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/TerraformVersionCollection' + '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/DefaultError' + summary: Lists supported Terraform versions. + tags: + - ResourceManager + x-example: | + GET /20180917/terraformVersions + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Stack' + /workRequests: + get: + description: | + Lists the work requests in the specified compartment or for the specified resource. + For more information, see + [Listing Work Requests](/iaas/Content/ResourceManager/Tasks/list-work-request.htm). + operationId: ListWorkRequests + parameters: + - $ref: '#/components/parameters/RequiredCompartmentIdQueryParam' + - $ref: '#/components/parameters/ResourceIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: List of work requests + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there might be additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For more information about list pagination, + 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/ListWorkRequestsResponse' + '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/DefaultError' + summary: Lists work requests + tags: + - ResourceManager + x-example: | + GET /20180917/workRequests&compartmentId=<compartment_OCID> + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/WorkRequest' + /workRequests/{workRequestId}: + get: + description: | + Returns the specified work request. + For more information, see + [Getting a Work Request's Details](/iaas/Content/ResourceManager/Tasks/get-work-request.htm). + operationId: GetWorkRequest + parameters: + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: Work request + 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/WorkRequest' + '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/DefaultError' + summary: Get Work Request + tags: + - ResourceManager + x-example: | + GET /20180917/workRequests/<workrequest_OCID> + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/WorkRequest' + /workRequests/{workRequestId}/errors: + get: + description: | + Returns a paginated list of errors for the specified work request. + For more information, see + [Listing Errors for a Work Request](/iaas/Content/ResourceManager/Tasks/list-work-request-errors.htm). + operationId: ListWorkRequestErrors + parameters: + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: List of work request errors. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there might be additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For more information about list pagination, + 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/ListWorkRequestErrorsResponse' + '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/DefaultError' + summary: Lists work request errors + tags: + - ResourceManager + x-example: | + GET /20180917/workRequests/<workrequest_OCID>/errors + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/WorkRequest' + /workRequests/{workRequestId}/logs: + get: + description: | + Returns a paginated list of logs for the specified work request. + For more information, see + [Listing Logs for a Work Request](/iaas/Content/ResourceManager/Tasks/list-work-request-logs.htm). + operationId: ListWorkRequestLogs + parameters: + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: List of work request logs. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there might be additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For more information about list pagination, + 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/ListWorkRequestLogsResponse' + '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/DefaultError' + summary: Lists work request logs + tags: + - ResourceManager + x-example: | + GET /20180917/workRequests/<workrequest_OCID>/logs + Host: resourcemanager.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/WorkRequest' +components: + schemas: + ConfigurationSourceProviderCollection: + description: | + Collection of configuration source providers. + properties: + items: + description: Collection of configuration source providers. + items: + $ref: '#/components/schemas/ConfigurationSourceProviderSummary' + type: array + type: object + CreateConfigurationSourceProviderDetails: + description: | + Creation details for a configuration source provider. + discriminator: + propertyName: configSourceProviderType + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where + you want to create the configuration source provider. + type: string + configSourceProviderType: + description: | + The type of configuration source provider. + The `GITLAB_ACCESS_TOKEN` type corresponds to GitLab. + The `GITHUB_ACCESS_TOKEN` type corresponds to GitHub. + The `BITBUCKET_CLOUD_ACCESS_TOKEN` type corresponds to Bitbucket Cloud. + For Bitbucket Cloud, create requests must provide Atlassian account `email` and `secretId` containing an API token. + The `BITBUCKET_SERVER_ACCESS_TOKEN` type corresponds to Bitbucket Server. + type: string + x-obmcs-enumref: '#/definitions/ConfigurationSourceProvider/configSourceProviderType' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the string data type is supported. + (opaque JSON object) + type: string + 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 + description: + description: Description of the configuration source provider. Avoid entering confidential information. + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + maxLength: 255 + type: string + freeformTags: + additionalProperties: + type: string + description: | + Free-form tags associated with the resource. Each tag is a 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 + privateServerConfigDetails: + $ref: '#/components/schemas/PrivateServerConfigDetails' + required: + - configSourceProviderType + type: object + x-example: | + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "My Configuration Source Provider", + "description": "Example Git Source", + "configSourceProviderType": "GITLAB_ACCESS_TOKEN", + "apiEndpoint": "https://gitlab.com", + "accessToken": "<token>", + "privateServerConfigDetails": { + "privateEndpointId": "ocid1.ormprivateendpoint.oc1..<unique_ID>", + "certificateId": "ocid1.certificate.oc1..<unique_ID>" + }, + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Project": "DC1" + } + } + } + ConfigurationSourceProvider: + description: | + The properties that define a configuration source provider. + For more information, see + [Managing Configuration Source Providers](/iaas/Content/ResourceManager/Tasks/managingconfigurationsourceproviders.htm). + discriminator: + propertyName: configSourceProviderType + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where the configuration source provider is located. + type: string + configSourceProviderType: + description: | + The type of configuration source provider. + The `BITBUCKET_CLOUD_ACCESS_TOKEN` type corresponds to Bitbucket Cloud. + The `BITBUCKET_SERVER_ACCESS_TOKEN` type corresponds to Bitbucket Server. + The `GITLAB_ACCESS_TOKEN` type corresponds to GitLab. + The `GITHUB_ACCESS_TOKEN` type corresponds to GitHub. + enum: + - BITBUCKET_CLOUD_ACCESS_TOKEN + - BITBUCKET_SERVER_ACCESS_TOKEN + - GITLAB_ACCESS_TOKEN + - GITHUB_ACCESS_TOKEN + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the string data type is supported. + (opaque JSON object) + type: string + 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 + description: + description: Description of the configuration source provider. + maxLength: 400 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + maxLength: 255 + type: string + email: + description: Atlassian account email used for Bitbucket Cloud API token authentication. + type: string + freeformTags: + additionalProperties: + type: string + description: | + Free-form tags associated with the resource. Each tag is a 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the configuration source provider. + type: string + isMigrationRequired: + description: | + Indicates whether this configuration source provider uses legacy Bitbucket Cloud username/app-password credentials and must be migrated. + type: boolean + lifecycleState: + description: | + The current lifecycle state of the configuration source provider. + For more information about configuration source provider lifecycle states in Resource Manager, see + [Key Concepts](/iaas/Content/ResourceManager/Concepts/resourcemanager.htm#concepts__CSPStates). + enum: + - ACTIVE + type: string + privateServerConfigDetails: + $ref: '#/components/schemas/PrivateServerConfigDetails' + secretId: + description: Secret ocid which is used to authorize the user. + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. + For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). + Example: `{orcl-cloud: {free-tier-retain: true}}` + type: object + timeCreated: + description: | + The date and time when the configuration source provider was created. + Format is defined by RFC3339. + Example: `2020-01-25T21:10:29.600Z` + format: date-time + type: string + username: + description: Username which is used to authorize the user. + type: string + required: + - configSourceProviderType + type: object + x-example: | + { + "id": "ocid1.configSourceProvider.oc1..<unique_ID>", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "My Configuration Source Provider", + "description": "Example Git Source", + "timeCreated": "2019-10-02T19:18:44.437Z", + "lifecycleState": "ACTIVE", + "configSourceProviderType": "GITLAB_ACCESS_TOKEN", + "apiEndpoint": "https://gitlab.com", + "privateServerConfigDetails": { + "privateEndpointId": "ocid1.ormprivateendpoint.oc1..<unique_ID>", + "sslCertificateId": "ocid1.certificate.oc1..<unique_ID>" + }, + + "email": "myuser@example.com", + "secretId": "ocid1.secret.oc1..<unique_ID>", + + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Project": "DC1" + } + } + } + UpdateConfigurationSourceProviderDetails: + description: | + Update details for a configuration source provider. + discriminator: + propertyName: configSourceProviderType + properties: + configSourceProviderType: + description: | + The type of configuration source provider. + The `BITBUCKET_CLOUD_ACCESS_TOKEN` type corresponds to Bitbucket Cloud. + For Bitbucket Cloud, update requests must provide Atlassian account `email` and `secretId` containing an API token. + The `BITBUCKET_SERVER_ACCESS_TOKEN` type corresponds to Bitbucket Server. + The `GITLAB_ACCESS_TOKEN` type corresponds to GitLab. + The `GITHUB_ACCESS_TOKEN` type corresponds to GitHub. + type: string + x-obmcs-enumref: '#/definitions/ConfigurationSourceProvider/configSourceProviderType' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the string data type is supported. + (opaque JSON object) + type: string + 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 + description: + description: Description of the configuration source provider. Avoid entering confidential information. + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + maxLength: 255 + type: string + freeformTags: + additionalProperties: + type: string + description: | + Free-form tags associated with the resource. Each tag is a 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 + privateServerConfigDetails: + $ref: '#/components/schemas/PrivateServerConfigDetails' + type: object + x-example: | + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "My Configuration Source Provider", + "description": "Example Git Source", + "configSourceProviderType": "GITLAB_ACCESS_TOKEN", + "apiEndpoint": "https://gitlab.com", + "accessToken": "<token>", + "privateServerConfigDetails": { + "privateEndpointId": "ocid1.ormprivateendpoint.oc1..<unique_ID>", + "certificateId": "ocid1.certificate.oc1..<unique_ID>" + }, + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Project": "DC1" + } + } + } + ChangeConfigurationSourceProviderCompartmentDetails: + description: | + Compartment details for moving a configuration source provider. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment + to move the configuration source provider to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + x-example: | + { + "compartmentId": "<compartment_OCID>" + } + JobSummary: + description: Summary information for a job. + properties: + applyJobPlanResolution: + $ref: '#/components/schemas/ApplyJobPlanResolution' + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where the stack of the associated job resides. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the string data type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + maxLength: 255 + type: string + freeformTags: + additionalProperties: + type: string + description: | + Free-form tags associated with the resource. Each tag is a 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job. + type: string + jobOperationDetails: + $ref: '#/components/schemas/JobOperationDetailsSummary' + lifecycleState: + description: | + Current state of the specified job. + For more information about job lifecycle states in Resource Manager, see + [Key Concepts](/iaas/Content/ResourceManager/Concepts/resourcemanager.htm#concepts__JobStates). + type: string + x-obmcs-enumref: '#/definitions/Job/lifecycleState' + operation: + description: The type of job executing + type: string + x-obmcs-enumref: '#/definitions/Job/operation' + resolvedPlanJobId: + description: | + Deprecated. Use the property `executionPlanJobId` in `jobOperationDetails` instead. + The plan job [OCID](/iaas/Content/General/Concepts/identifiers.htm) that was used (if this was an apply job and was not auto-approved). + type: string + stackId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the stack that is associated with the specified job. + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. + For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). + Example: `{orcl-cloud: {free-tier-retain: true}}` + type: object + timeCreated: + description: | + The date and time the job was created. + Format is defined by RFC3339. + Example: `2020-01-25T21:10:29.600Z` + format: date-time + type: string + timeFinished: + description: | + The date and time the job succeeded or failed. + Format is defined by RFC3339. + Example: `2020-01-25T21:10:29.600Z` + format: date-time + type: string + type: object + x-example: | + { + "id": "ocid1.ormjob.oc1..<unique_ID>", + "stackId": "ocid1.ormstack.oc1..<unique_ID>", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "Job Display Name", + "operation": "APPLY", + "jobOperationDetails": { + "operation": "APPLY", + "executionPlanStrategy": "FROM_PLAN_JOB_ID", + "executionPlanJobId": "ocid1.ormjob.oc1..<unique_ID>" + }, + "applyJobPlanResolution": { + "planJobId": "ocid1.ormjob.oc1..<unique_ID>" + }, + "timeCreated": "2018-10-02T19:18:44.437Z", + "timeFinished": "2018-10-02T19:18:44.439Z", + "lifecycleState": "SUCCEEDED", + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Owner": "Operations" + } + } + } + CreateJobDetails: + description: | + Creation details for a job for running inside the specified stack. + properties: + applyJobPlanResolution: + $ref: '#/components/schemas/ApplyJobPlanResolution' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + maxLength: 255 + type: string + freeformTags: + additionalProperties: + type: string + description: | + Free-form tags associated with this resource. Each tag is a 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 + jobOperationDetails: + $ref: '#/components/schemas/CreateJobOperationDetails' + operation: + description: Terraform-specific operation to execute. + type: string + x-obmcs-enumref: '#/definitions/Job/operation' + stackId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the stack that is associated with the current job. + type: string + required: + - stackId + type: object + x-example: | + { + "displayName": "Job Display Name", + "stackId": "ocid1.ormstack.oc1..<unique_ID>", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "operation": "APPLY", + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Owner": "Operations" + } + } + } + Job: + description: | + The properties of a job. + A job performs the actions that are defined in your Terraform configuration. + For instructions on managing jobs, see + [Managing Jobs](/iaas/Content/ResourceManager/Tasks/jobs.htm). + For more information about jobs, see + [Key Concepts](/iaas/Content/ResourceManager/Concepts/resourcemanager.htm#concepts__jobdefinition). + properties: + applyJobPlanResolution: + $ref: '#/components/schemas/ApplyJobPlanResolution' + cancellationDetails: + $ref: '#/components/schemas/CancellationDetails' + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the job's associated stack resides. + type: string + configSource: + $ref: '#/components/schemas/ConfigSourceRecord' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the string data type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + maxLength: 255 + type: string + failureDetails: + $ref: '#/components/schemas/FailureDetails' + freeformTags: + additionalProperties: + type: string + description: | + Free-form tags associated with the resource. Each tag is a 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job. + type: string + isProviderUpgradeRequired: + default: false + description: | + Specifies whether or not to upgrade provider versions. + Within the version constraints of your Terraform configuration, use the latest versions available from the source of Terraform providers. + For more information about this option, see [Dependency Lock File (terraform.io)](https://www.terraform.io/language/files/dependency-lock). + type: boolean + isThirdPartyProviderExperienceEnabled: + description: | + When `true`, the stack sources third-party Terraform providers from + [Terraform Registry](https://registry.terraform.io/browse/providers) and allows + [custom providers](#/en/resourcemanager/latest/datatypes/CustomTerraformProvider). + For more information about stack sourcing of third-party Terraform providers, see + [Third-party Provider Configuration](/iaas/Content/ResourceManager/Concepts/terraformconfigresourcemanager.htm#third-party-providers). + type: boolean + jobOperationDetails: + $ref: '#/components/schemas/JobOperationDetails' + lifecycleState: + description: | + Current state of the specified job. + For more information about job lifecycle states in Resource Manager, see + [Key Concepts](/iaas/Content/ResourceManager/Concepts/resourcemanager.htm#concepts__JobStates). + enum: + - ACCEPTED + - IN_PROGRESS + - FAILED + - SUCCEEDED + - CANCELING + - CANCELED + type: string + operation: + description: The type of job executing. + enum: + - PLAN + - APPLY + - DESTROY + - IMPORT_TF_STATE + - PLAN_ROLLBACK + - APPLY_ROLLBACK + type: string + resolvedPlanJobId: + description: | + Deprecated. Use the property `executionPlanJobId` in `jobOperationDetails` instead. + The plan job [OCID](/iaas/Content/General/Concepts/identifiers.htm) that was used (if this was an apply job and was not auto-approved). + type: string + stackId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the stack that is associated with the job. + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. + For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). + Example: `{orcl-cloud: {free-tier-retain: true}}` + type: object + timeCreated: + description: | + The date and time when the job was created. + Format is defined by RFC3339. + Example: `2020-01-25T21:10:29.600Z` + format: date-time + type: string + timeFinished: + description: | + The date and time when the job stopped running, irrespective of whether the job ran successfully. + Format is defined by RFC3339. + Example: `2020-01-25T21:10:29.600Z` + format: date-time + type: string + variables: + additionalProperties: + type: string + description: | + Terraform variables associated with this resource. + Maximum number of variables supported is 250. + The maximum size of each variable, including both name and value, is 8192 bytes. + Example: `{"CompartmentId": "compartment-id-value"}` + maxProperties: 250 + type: object + workingDirectory: + description: | + File path to the directory to use for running Terraform. + If not specified, the root directory is used. + Required when using a zip Terraform configuration (`configSourceType` value of `ZIP_UPLOAD`) that contains folders. + Ignored for the `configSourceType` value of `COMPARTMENT_CONFIG_SOURCE`. + For more information about required and recommended file structure, see + [File Structure (Terraform Configurations for Resource Manager)](/iaas/Content/ResourceManager/Concepts/terraformconfigresourcemanager.htm#filestructure). + type: string + type: object + x-example: | + { + "id": "ocid1.ormjob.oc1..<unique_ID>", + "stackId": "ocid1.ormstackoc1..<unique_ID>", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "Job Display Name", + "operation": "Apply", + "jobOperationDetails": { + "operation": "APPLY", + "executionPlanStrategy": "FROM_PLAN_JOB_ID", + "executionPlanJobId": "ocid1.ormjob.oc1..<unique_ID>" + }, + "applyJobPlanResolution": { + "planJobId": "ocid1.ormjob.oc1..<unique_ID>" + }, + "resolvedPlanJobId": "ocid1.ormjob.oc1..<unique_ID>", + "timeCreated": "2018-10-02T19:18:44.437Z", + "timeFinished": "2018-10-02T19:18:44.439Z", + "lifecycleState": "IN_PROGRESS", + "workingDirectory": "<file_path_to_directory>", + "variables": { + "additionalProp1": "myVariable01", + "additionalProp2": "myVariable02" + }, + "configSource": { + "configSourceType": "GIT_CONFIG_SOURCE", + "workingDirectory": "<file_path_to_directory>", + "configurationSourceProviderId": "ocid1.ormconfigsourceprovider.oc1..<unique_ID>", + "branchName": "MyBranch", + "repositoryUrl":"https://github.com/user/repo.git", + "commitId": "2dc979a95e86abb211eda8515e1655dfa4275a00" + }, + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Owner": "Operations" + } + } + } + UpdateJobDetails: + description: | + Update details for a job. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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: | + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + maxLength: 255 + type: string + freeformTags: + additionalProperties: + type: string + description: | + Free-form tags associated with this resource. Each tag is a 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 + x-example: | + { + "displayName": "example_job", + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Owner": "Operations" + } + } + } + AssociatedResourcesCollection: + description: | + The list of associated resources for the indicated stack or job. + properties: + items: + description: Collection of resources associated with a stack or job. + items: + $ref: '#/components/schemas/AssociatedResourceSummary' + type: array + required: + - items + type: object + LogEntry: + description: Log entry for an operation resulting from a job's execution. + properties: + level: + description: Specifies the severity level of the log entry. + enum: + - TRACE + - DEBUG + - INFO + - WARN + - ERROR + - FATAL + type: string + message: + description: The log entry value. + type: string + timestamp: + description: | + The date and time of the log entry. + Format is defined by RFC3339. + Example: `2020-01-25T21:10:29.600Z` + format: date-time + type: string + type: + description: Specifies the log type for the log entry. + enum: + - TERRAFORM_CONSOLE + type: string + type: object + x-example: | + { + "type": "TERRAFORM_CONSOLE", + "level": "TRACE", + "timestamp": "2018-10-09T19:54:55.857Z", + "message": "<log_entry>" + } + JobOutputsCollection: + description: | + The list of outputs associated with a job. + properties: + items: + description: A list of output summaries. + items: + $ref: '#/components/schemas/JobOutputSummary' + type: array + required: + - items + type: object + PrivateEndpointCollection: + description: | + A list of private endpoints that match filter criteria, if any. Results contain `PrivateEndpointSummary` objects. + properties: + items: + description: A list of private endpoints. + items: + $ref: '#/components/schemas/PrivateEndpointSummary' + type: array + required: + - items + type: object + CreatePrivateEndpointDetails: + description: | + Creation details for a private endpoint. + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this private endpoint. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the string data type is supported. + (opaque JSON object) + type: string + 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 + description: + description: Description of the private endpoint. Avoid entering confidential information. + maxLength: 500 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + maxLength: 255 + type: string + dnsZones: + description: | + DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver. + items: + type: string + maxItems: 5 + type: array + freeformTags: + additionalProperties: + type: string + description: | + Free-form tags associated with the resource. Each tag is a 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 + isUsedWithConfigurationSourceProvider: + description: When `true`, allows the private endpoint to be used with a configuration source provider. + type: boolean + nsgIdList: + description: | + The [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of + [network security groups (NSGs)](/iaas/Content/Network/Concepts/networksecuritygroups.htm) + for the private endpoint. + Order does not matter. + items: + type: string + type: array + subnetId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet within the VCN for the private endpoint. + type: string + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN for the private endpoint. + type: string + required: + - compartmentId + - displayName + - vcnId + - subnetId + type: object + x-example: | + { + "compartmentId": "ocid1.compartment.oc1..<compartment_OCID>", + "displayName": "My Private Endpoint", + "description": "Example Private Endpoint", + "vcnId": "ocid1.vcn.oc1.phx.<vcn_OCID>", + "subnetId": "ocid1.subnet.oc1.phx.<subnet_OCID>", + "dnsZones": ["abc.oraclevcn.com", "def.oraclevcn.com"], + "nsgIdList": ["ocid1.networksecuritygroup.oc1.phx.<nsg1_OCID>","ocid1.networksecuritygroup.oc1.phx.<nsg2_OCID>"], + "isUsedWithConfigurationSourceProvider": true, + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Owner": "Operations" + } + }, + "securityAttributes": { + "oracle-zpr": { + "MaxEgressCount": { + "mode": "enforce", + "value": "45" + } + } + } + } + PrivateEndpoint: + description: | + A private endpoint allowing Resource Manager to access nonpublic cloud resources. For more information about private endpoints, see [Managing Private Endpoints](/iaas/Content/ResourceManager/Tasks/private-endpoints.htm). + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this private endpoint. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the string data type is supported. + (opaque JSON object) + type: string + 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 + description: + description: Description of the private endpoint. Avoid entering confidential information. + maxLength: 500 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + maxLength: 255 + type: string + dnsZones: + description: | + DNS zones to use for accessing private Git servers. + For private Git server instructions, see + [Private Git Server](/iaas/Content/ResourceManager/Tasks/private-endpoints.htm#private-git). + Specify DNS fully qualified domain names (FQDNs); DNS Proxy forwards related DNS FQDN queries to the consumer DNS resolver. + For DNS FQDNs not specified, queries go to service provider VCN resolver. + Example: `abc.oraclevcn.com` + items: + type: string + maxItems: 5 + type: array + freeformTags: + additionalProperties: + type: string + description: | + Free-form tags associated with the resource. Each tag is a 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. + type: string + isUsedWithConfigurationSourceProvider: + description: When `true`, allows the private endpoint to be used with a configuration source provider. + type: boolean + lifecycleState: + description: | + The current lifecycle state of the private endpoint. + enum: + - ACTIVE + - CREATING + - DELETING + - DELETED + - FAILED + type: string + nsgIdList: + description: | + The [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of + [network security groups (NSGs)](/iaas/Content/Network/Concepts/networksecuritygroups.htm) + for the private endpoint. + Order does not matter. + items: + type: string + type: array + sourceIps: + description: The source IP addresses that Resource Manager uses to connect to your network. Automatically assigned by Resource Manager. + items: + type: string + type: array + subnetId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet within the VCN for the private endpoint. + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. + For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). + Example: `{orcl-cloud: {free-tier-retain: true}}` + type: object + timeCreated: + description: | + The date and time at which the private endpoint was created. + Format is defined by RFC3339. + Example: `2020-11-25T21:10:29.600Z` + format: date-time + type: string + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN for the private endpoint. + type: string + required: + - id + - compartmentId + - vcnId + - subnetId + type: object + x-example: | + { + "id": "ocid1.ormprivateendpoint.oc1..<unique_ID>", + "compartmentId": "ocid1.compartment.oc1..<compartment_OCID>", + "displayName": "My Private Endpoint", + "description": "Example Private Endpoint", + "vcnId": "ocid1.vcn.oc1.phx.<vcn_OCID>", + "subnetId": "ocid1.subnet.oc1.phx.<subnet_OCID>", + "sourceIps": ["10.0.0.0", "10.0.0.1"], + "lifecycleState": "ACTIVE", + "timeCreated": "2020-10-02T19:18:44.437Z", + "nsgIdList": ["ocid1.networksecuritygroup.oc1.phx.<nsg1_OCID>","ocid1.networksecuritygroup.oc1.phx.<nsg2_OCID>"], + "isUsedWithConfigurationSourceProvider": true, + "freeformTags": { + "additionalProp1": "{"Department": "Finance"}", + }, + "dnsZones": ["abc.oraclevcn.com", "def.oraclevcn.com"] + "definedTags": { + "ProjectTags": { + "Owner": "Operations" + } + }, + "securityAttributes": { + "oracle-zpr": { + "MaxEgressCount": { + "mode": "enforce", + "value": "45" + } + } + } + } + UpdatePrivateEndpointDetails: + description: | + Update details for a private endpoint. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the string data type is supported. + (opaque JSON object) + type: string + 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 + description: + description: Description of the private endpoint. Avoid entering confidential information. + maxLength: 500 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + maxLength: 255 + type: string + dnsZones: + description: | + DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver. + items: + type: string + maxItems: 5 + type: array + freeformTags: + additionalProperties: + type: string + description: | + Free-form tags associated with the resource. Each tag is a 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 + isUsedWithConfigurationSourceProvider: + description: When `true`, allows the private endpoint to be used with a configuration source provider. + type: boolean + nsgIdList: + description: | + The [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of + [network security groups (NSGs)](/iaas/Content/Network/Concepts/networksecuritygroups.htm) + for the private endpoint. + Order does not matter. + items: + type: string + type: array + subnetId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet within the VCN for the private endpoint. + type: string + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN for the private endpoint. + type: string + type: object + x-example: | + { + "displayName": "My Private Endpoint", + "description": "Example Private Endpoint", + "vcnId": "ocid1.vcn.oc1.phx.<vcn_OCID>", + "subnetId": "ocid1.subnet.oc1.phx.<subnet_OCID>", + "dnsZones": ["abc.oraclevcn.com", "def.oraclevcn.com"], + "nsgIdList": ["ocid1.networksecuritygroup.oc1.phx.<nsg1_OCID>","ocid1.networksecuritygroup.oc1.phx.<nsg2_OCID>"], + "isUsedWithConfigurationSourceProvider": true, + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Owner": "Operations" + } + }, + "securityAttributes": { + "oracle-zpr": { + "MaxEgressCount": { + "mode": "enforce", + "value": "45" + } + } + } + } + ChangePrivateEndpointCompartmentDetails: + description: | + Compartment details for moving a private endpoint. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment + to move the private endpoint to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + x-example: | + { + "compartmentId": "<compartment_OCID>" + } + ReachableIp: + description: | + The reachable, or alternative, IP address for a nonpublic IP address that is associated with the private endpoint. + Resource Manager uses this IP address to connect to nonpublic resources through the associated private endpoint. + properties: + ipAddress: + description: | + Reachable IP address associated with the private endpoint. + type: string + required: + - ipAddress + type: object + x-example: | + { + "ipAddress": "254.0.0.0" + } + ResourceDiscoveryServiceCollection: + description: | + The list of [services supported for use with Resource Discovery](https://www.terraform.io/docs/providers/oci/guides/resource_discovery.html#services). + properties: + items: + description: Collection of supported services for Resource Discovery. + items: + $ref: '#/components/schemas/ResourceDiscoveryServiceSummary' + type: array + required: + - items + type: object + StackSummary: + description: | + Summary information for a stack. + properties: + compartmentId: + description: Unique identifier of the compartment in which the stack resides. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the string data type is supported. + (opaque JSON object) + type: string + 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 + description: + description: General description of the stack. + maxLength: 400 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + maxLength: 255 + type: string + freeformTags: + additionalProperties: + type: string + description: | + Free-form tags associated with the resource. Each tag is a 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 + id: + description: Unique identifier of the specified stack. + type: string + lifecycleState: + description: | + The current lifecycle state of the stack. + For more information about stack lifecycle states in Resource Manager, see + [Key Concepts](/iaas/Content/ResourceManager/Concepts/resourcemanager.htm#concepts__StackStates). + type: string + x-obmcs-enumref: '#/definitions/Stack/lifecycleState' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. + For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). + Example: `{orcl-cloud: {free-tier-retain: true}}` + type: object + terraformVersion: + description: | + The version of Terraform specified for the stack. Example: `1.5.x` + maxLength: 255 + type: string + timeCreated: + description: | + The date and time when the stack was created. + Format is defined by RFC3339. + Example: `2020-01-25T21:10:29.600Z` + format: date-time + type: string + type: object + x-example: | + { + "id": "ocid1.ormstack.oc1..<unique_ID>", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "Stack Display Name", + "description": "Brief description of the stack.", + "timeCreated": "2018-10-02T19:18:44.437Z", + "lifecycleState": "ACTIVE", + "terraformVersion": "1.5.x", + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Project": "DC1" + } + }, + } + CreateStackDetails: + description: | + Creation details for a stack. + properties: + compartmentId: + description: Unique identifier ([OCID](/iaas/Content/General/Concepts/identifiers.htm)) of the compartment in which the stack resides. + type: string + configSource: + $ref: '#/components/schemas/CreateConfigSourceDetails' + customTerraformProvider: + $ref: '#/components/schemas/CustomTerraformProvider' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing a defined tag key and value, scoped to a namespace. + Example: `{"CostCenter": "42"}` + type: object + description: | + Defined tags associated with 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 + description: + description: Description of the stack. + maxLength: 400 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + maxLength: 255 + type: string + freeformTags: + additionalProperties: + type: string + description: | + Free-form tags associated with 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 + terraformVersion: + description: | + The version of Terraform to use with the stack. Example: `1.5.x` + maxLength: 255 + type: string + variables: + additionalProperties: + type: string + description: | + Terraform variables associated with this resource. + Maximum number of variables supported is 250. + The maximum size of each variable, including both name and value, is 8192 bytes. + Example: `{"CompartmentId": "compartment-id-value"}` + maxProperties: 250 + type: object + required: + - compartmentId + - configSource + type: object + x-example: | + Sample 1: Zip file using Terraform version 1.5.x + + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "terraformVersion": "1.5.x", + "displayName": "My Zip Configuration", + "configSource": { + "configSourceType": "ZIP_UPLOAD", + "zipFileBase64Encoded": "<zip_file_content_encoded_in_base64_format>", + "workingDirectory": "<file_path_to_directory>" + }, + } + + Sample 2: GitHub + + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "My GitHub Configuration", + "configSource": { + "configSourceType": "GIT_CONFIG_SOURCE", + "configurationSourceProviderId": "ocid1.ormconfigsourceprovider.oc1..<unique_ID>", + "repositoryUrl": "https://github.com/user/repo.git", + "branchName": "MyBranch", + "workingDirectory": "<file_path_to_directory>", + } + } + + Sample 3: Bucket + + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "My Bucket Terraform Configuration", + "configSource": { + "configSourceType": "OBJECT_STORAGE_CONFIG_SOURCE", + "region": "us-phoenix-1", + "namespace": "<bucket_namespace>", + "bucketName": "<bucket_name>" + } + } + + + Sample 4: Existing compartment (resource discovery) + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "My Compartment Configuration", + "configSource": { + "configSourceType": "COMPARTMENT_CONFIG_SOURCE", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "region": "us-phoenix-1" + } + } + + Sample 5: Custom Terraform provider for existing compartment (resource discovery) + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "My Compartment Configuration with Custom Provider", + "configSource": { + "configSourceType": "COMPARTMENT_CONFIG_SOURCE", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "region": "us-phoenix-1" + }, + "customTerraformProvider": { + "region": "us-phoenix-1", + "namespace": "<bucket_namespace>", + "bucketName": "<bucket_name>" + } + } + + Sample 6: DevOps repository + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "terraformVersion": "1.5.x", + "displayName": "My DevOps Stack", + "configSource": { + "configSourceType": "DEVOPS_CONFIG_SOURCE", + "projectId": "ocid1.devopsproject.oc1..<unique_ID>", + "repositoryId": "ocid1.devopsrepository.oc1..<unique_ID>", + "branchName": "MyBranch", + "workingDirectory": "<file_path_to_directory>", + } + } + Stack: + description: | + The properties that define a stack. + A stack is the collection of Oracle Cloud Infrastructure resources corresponding to a given Terraform configuration. + For instructions on managing stacks, see + [Managing Stacks](/iaas/Content/ResourceManager/Tasks/stacks.htm). + For more information about stacks, see + [Key Concepts](/iaas/Content/ResourceManager/Concepts/resourcemanager.htm#concepts__stackdefinition). + properties: + compartmentId: + description: Unique identifier ([OCID](/iaas/Content/General/Concepts/identifiers.htm)) for the compartment where the stack is located. + type: string + configSource: + $ref: '#/components/schemas/ConfigSource' + customTerraformProvider: + $ref: '#/components/schemas/CustomTerraformProvider' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the string data type is supported. + (opaque JSON object) + type: string + 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 + description: + description: Description of the stack. + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + maxLength: 255 + type: string + freeformTags: + additionalProperties: + type: string + description: | + Free-form tags associated with the resource. Each tag is a 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 + id: + description: Unique identifier ([OCID](/iaas/Content/General/Concepts/identifiers.htm)) for the stack. + type: string + isThirdPartyProviderExperienceEnabled: + description: | + When `true`, the stack sources third-party Terraform providers from + [Terraform Registry](https://registry.terraform.io/browse/providers) and allows + [custom providers](#/en/resourcemanager/latest/datatypes/CustomTerraformProvider). + For more information about stack sourcing of third-party Terraform providers, see + [Third-party Provider Configuration](/iaas/Content/ResourceManager/Concepts/terraformconfigresourcemanager.htm#third-party-providers). + type: boolean + lifecycleState: + description: | + The current lifecycle state of the stack. + For more information about stack lifecycle states in Resource Manager, see + [Key Concepts](/iaas/Content/ResourceManager/Concepts/resourcemanager.htm#concepts__StackStates). + enum: + - CREATING + - ACTIVE + - DELETING + - DELETED + - FAILED + type: string + stackDriftStatus: + description: | + Drift status of the stack. + Drift refers to differences between the actual (current) state of the stack and the expected (defined) state of the stack. + enum: + - NOT_CHECKED + - IN_SYNC + - DRIFTED + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. + For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). + Example: `{orcl-cloud: {free-tier-retain: true}}` + type: object + terraformVersion: + description: | + The version of Terraform specified for the stack. Example: `1.5.x` + maxLength: 255 + type: string + timeCreated: + description: | + The date and time at which the stack was created. + Format is defined by RFC3339. + Example: `2020-01-25T21:10:29.600Z` + format: date-time + type: string + timeDriftLastChecked: + description: | + The date and time when the drift detection was last executed. + Format is defined by RFC3339. + Example: `2020-01-25T21:10:29.600Z` + format: date-time + type: string + variables: + additionalProperties: + type: string + description: | + Terraform variables associated with this resource. + Maximum number of variables supported is 250. + The maximum size of each variable, including both name and value, is 8192 bytes. + Example: `{"CompartmentId": "compartment-id-value"}` + maxProperties: 250 + type: object + type: object + x-example: | + { + "id": "ocid1.ormstackoc1..<unique_ID>", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "Stack Display Name", + "description": "Brief description of the stack.", + "timeCreated": "2018-10-02T19:18:44.437Z", + "lifecycleState": "CREATING" + "configSource": { + "configSourceType": "ZIP_UPLOAD" + "workingDirectory": "<file_path_to_directory>" + }, + "customTerraformProvider" : { + "region": "us-phoenix-1", + "namespace": "<bucket_namespace>", + "bucketName": "<bucket_name>" + }, + "isThirdPartyProviderExperienceEnabled": true, + "variables": { + "additionalProp1": "myVariable01" + "additionalProp2": "myVariable02" + }, + "terraformVersion": "1.5.x", + "stackDriftStatus": "DRIFTED", + "timeDriftLastChecked": "2019-10-02T19:18:44.437Z", + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Project": "DC1" + } + }, + } + UpdateStackDetails: + description: | + Update details for a stack. + properties: + configSource: + $ref: '#/components/schemas/UpdateConfigSourceDetails' + customTerraformProvider: + $ref: '#/components/schemas/CustomTerraformProvider' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String data type is supported. + (opaque JSON object) + type: string + 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 + description: + description: Description of the stack. + maxLength: 400 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + maxLength: 255 + type: string + freeformTags: + additionalProperties: + type: string + description: | + Free-form tags associated with 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 + isThirdPartyProviderExperienceEnabled: + description: | + When `true`, changes the stack's sourcing of third-party Terraform providers to + [Terraform Registry](https://registry.terraform.io/browse/providers) and allows + [custom providers](#/en/resourcemanager/latest/datatypes/CustomTerraformProvider). + Applies to older stacks. + Once set to `true`, cannot be reverted. + For more information about stack sourcing of third-party Terraform providers, see + [Third-party Provider Configuration](/iaas/Content/ResourceManager/Concepts/terraformconfigresourcemanager.htm#third-party-providers). + type: boolean + terraformVersion: + description: | + The version of Terraform to use with the stack. Example: `1.5.x` + maxLength: 255 + type: string + variables: + additionalProperties: + type: string + description: | + Terraform variables associated with this resource. + The maximum number of variables supported is 250. + The maximum size of each variable, including both name and value, is 8192 bytes. + Example: `{"CompartmentId": "compartment-id-value"}` + maxProperties: 250 + type: object + type: object + x-example: | + { + "displayName": "Stack Display Name", + "description": "Brief description of the stack.", + "configSource": { + "configSourceType": "ZIP_UPLOAD", + "workingDirectory": "<file_path_to_directory>" + }, + "customTerraformProvider" : { + "region": "us-phoenix-1", + "namespace": "<bucket_namespace>", + "bucketName": "<bucket_name>" + }, + "isThirdPartyProviderExperienceEnabled": true, + "variables": { + "additionalProp1": "myVariable01", + "additionalProp2": "myVariable02" + }, + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Project": "DC1" + } + } + } + ChangeStackCompartmentDetails: + description: Compartment details for moving a stack. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment + into which the Stack should be moved. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + x-example: | + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>" + } + DetectStackDriftDetails: + description: | + Details for detecting drift in a stack. + properties: + isProviderUpgradeRequired: + default: false + description: | + Specifies whether or not to upgrade provider versions. + Within the version constraints of your Terraform configuration, use the latest versions available from the source of Terraform providers. + For more information about this option, see [Dependency Lock File (terraform.io)](https://www.terraform.io/language/files/dependency-lock). + type: boolean + resourceAddresses: + description: | + The list of resources in the specified stack to detect drift for. Each resource is identified by a resource address, + which is a string derived from the resource type and name specified in the stack's Terraform configuration plus an optional index. + For example, the resource address for the fourth Compute instance with the name "test_instance" is oci_core_instance.test_instance[3]. + For more details and examples of resource addresses, see the Terraform documentation at [Resource spec](https://www.terraform.io/docs/internals/resource-addressing.html#examples). + items: + maxLength: 512 + type: string + maxItems: 10 + type: array + uniqueItems: true + type: object + StackResourceDriftCollection: + description: | + Drift status details for resources in the stack. + properties: + items: + description: Collection of drift status details for all resources defined in the stack. + items: + $ref: '#/components/schemas/StackResourceDriftSummary' + type: array + required: + - items + type: object + TemplateCategorySummaryCollection: + description: | + Results of a `ListTemplateCategories` operation. + properties: + items: + description: A list of template categories. + items: + $ref: '#/components/schemas/TemplateCategorySummary' + type: array + required: + - items + type: object + TemplateSummaryCollection: + description: | + Results of a `ListTemplates` operation. + properties: + items: + description: A list of template summaries. + items: + $ref: '#/components/schemas/TemplateSummary' + type: array + required: + - items + type: object + CreateTemplateDetails: + description: | + Creation details for a template. + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this template. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the string data type is supported. + (opaque JSON object) + type: string + 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 + description: + description: Description of the template. Avoid entering confidential information. + maxLength: 500 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + maxLength: 255 + type: string + freeformTags: + additionalProperties: + type: string + description: | + Free-form tags associated with the resource. Each tag is a 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 + logoFileBase64Encoded: + description: | + Base64-encoded logo to use as the template icon. + Template icon file requirements: PNG format, 50 KB maximum, 110 x 110 pixels. + type: string + longDescription: + description: Detailed description of the template. This description is displayed in the Console page listing templates when the template is expanded. Avoid entering confidential information. + maxLength: 5000 + type: string + templateConfigSource: + $ref: '#/components/schemas/CreateTemplateConfigSourceDetails' + required: + - compartmentId + - displayName + - description + - templateConfigSource + type: object + x-example: | + { + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "Template Display Name", + "description": "Brief description of the template", + "longDescription": "Detailed description of the template. This description is displayed in the Console page listing templates when the template is expanded.", + "logoFileBase64Encoded": "binary string", + "templateConfigSource": { + "templateConfigSourceType": "ZIP_UPLOAD", + "zipFileBase64Encoded": "<zip_file_content_encoded_in_base64_format>", + }, + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Owner": "Operations" + } + } + } + Template: + description: | + The properties that define a template. A template is a pre-built Terraform configuration that provisions a set of resources used in a common scenario. + properties: + categoryId: + description: | + Unique identifier for the category where the template is located. + Possible values are `0` (Quick Starts), `1` (Service), `2` (Architecture), and `3` (Private). + type: string + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this template. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the string data type is supported. + (opaque JSON object) + type: string + 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 + description: + description: Brief description of the template. + maxLength: 500 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + maxLength: 255 + type: string + freeformTags: + additionalProperties: + type: string + description: | + Free-form tags associated with the resource. Each tag is a 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 + id: + description: Unique identifier ([OCID](/iaas/Content/General/Concepts/identifiers.htm)) for the template. + type: string + isFreeTier: + description: whether the template will work for free tier tenancy. + type: boolean + lifecycleState: + description: | + The current lifecycle state of the template. + enum: + - ACTIVE + type: string + longDescription: + description: Detailed description of the template. This description is displayed in the Console page listing templates when the template is expanded. Avoid entering confidential information. + maxLength: 5000 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. + For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). + Example: `{orcl-cloud: {free-tier-retain: true}}` + type: object + templateConfigSource: + $ref: '#/components/schemas/TemplateConfigSource' + timeCreated: + description: | + The date and time at which the template was created. + Format is defined by RFC3339. + Example: `2020-11-25T21:10:29.600Z` + format: date-time + type: string + required: + - id + type: object + x-example: | + { + "id": "ocid1.template.oc1..<unique_ID>", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "categoryId": "1", + "displayName": "Template Display Name", + "description": "Brief description of the template.", + "longDescription": "Detailed description of the template. This description is displayed in the Console page listing templates when the template is expanded.", + "timeCreated": "2020-10-02T19:18:44.437Z", + "templateConfigSource": { + "templateConfigSourceType": "ZIP_UPLOAD" + }, + "lifecycleState": "ACTIVE", + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Owner": "Operations" + } + } + } + UpdateTemplateDetails: + description: | + Update details for a template. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the string data type is supported. + (opaque JSON object) + type: string + 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 + description: + description: Description of the template. Avoid entering confidential information. + maxLength: 500 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + maxLength: 255 + type: string + freeformTags: + additionalProperties: + type: string + description: | + Free-form tags associated with the resource. Each tag is a 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 + logoFileBase64Encoded: + description: Base64-encoded logo for the template. + type: string + longDescription: + description: Detailed description of the template. This description is displayed in the Console page listing templates when the template is expanded. Avoid entering confidential information. + maxLength: 5000 + type: string + templateConfigSource: + $ref: '#/components/schemas/UpdateTemplateConfigSourceDetails' + type: object + x-example: | + { + "displayName": "Template Display Name", + "description": "Brief description of the template", + "longDescription": "Detailed description of the template. This description is displayed in the Console page listing templates when the template is expanded.", + "logoFileBase64Encoded": "binary string", + "templateConfigSource": { + "templateConfigSourceType": "ZIP_UPLOAD", + "zipFileBase64Encoded": "<zip_file_content_encoded_in_base64_format>", + }, + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Owner": "DC1" + } + } + } + ChangeTemplateCompartmentDetails: + description: | + Compartment details for moving a template. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment + to move the configuration source provider to. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + x-example: | + { + "compartmentId": "<compartment_OCID>" + } + TerraformVersionCollection: + description: | + The list of Terraform versions supported for use with stacks. + properties: + items: + description: Collection of supported Terraform versions. + items: + $ref: '#/components/schemas/TerraformVersionSummary' + type: array + required: + - items + type: object + WorkRequestSummary: + description: A summary of the status of a work request. + properties: + compartmentId: + description: Unique identifier ([OCID](/iaas/Content/General/Concepts/identifiers.htm)) of the compartment that contains the work request. + type: string + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) identifying this work request. + type: string + operationType: + description: The asynchronous operation tracked by this work request. + type: string + x-obmcs-enumref: '#/definitions/WorkRequest/operationType' + percentComplete: + description: Percentage of the work request completed. + format: float + type: number + resources: + description: The resources affected by this work request. + items: + $ref: '#/components/schemas/WorkRequestResource' + type: array + status: + description: The status of the specified work request. + type: string + x-obmcs-enumref: '#/definitions/WorkRequest/status' + timeAccepted: + description: | + The date and time when the work request was created. + Format is defined by RFC3339. + Example: `2020-01-25T21:10:29.600Z` + format: date-time + type: string + timeFinished: + description: | + The date and time when the work request reached a terminal state (FAILED or SUCCEEDED). + Format is defined by RFC3339. + Example: `2020-01-25T21:10:29.600Z` + format: date-time + type: string + timeStarted: + description: | + The date and time when the work request transitioned from ACCEPTED to IN_PROGRESS. + Format is defined by RFC3339. + Example: `2020-01-25T21:10:29.600Z` + format: date-time + type: string + required: + - operationType + - status + - id + - compartmentId + - resources + - percentComplete + - timeAccepted + x-example: | + { + "operationType": "CREATE_STACK_FROM_COMPARTMENT", + "status": "ACCEPTED", + "id": "ocid1.ormworkrequest.oc1..<unique_ID>", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "resources": [ + { + "actionType": "IN_PROGRESS", + "entityType": "ormstack", + "identifier": "ocid1.ormstack.oci..<unique_ID>", + "entityUri": /latest/stacks/ocid1.ormstack.oc1..<unique_ID>" + } + ], + "percentComplete": 0, + "timeAccepted": "2020-01-25T21:10:29.600Z" + } + type: object + WorkRequest: + description: The status of a work request. + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this work request. + type: string + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) identifying this work request. + type: string + operationType: + description: The asynchronous operation tracked by this work request. + enum: + - CHANGE_STACK_COMPARTMENT + - CREATE_STACK_FROM_COMPARTMENT + - DRIFT_DETECTION + - CREATE_PRIVATE_ENDPOINT + - UPDATE_PRIVATE_ENDPOINT + - DELETE_PRIVATE_ENDPOINT + type: string + percentComplete: + description: The amount of work done relative to the total amount of work. + format: float + type: number + resources: + description: The resources affected by this work request. + items: + $ref: '#/components/schemas/WorkRequestResource' + type: array + status: + description: The status of the work request. + enum: + - ACCEPTED + - IN_PROGRESS + - FAILED + - SUCCEEDED + type: string + timeAccepted: + description: | + The date and time when the work request was created. + Format is defined by RFC3339. + Example: `2020-01-25T21:10:29.600Z` + format: date-time + type: string + timeFinished: + description: | + The date and time when the work request reached a terminal state (FAILED or SUCCEEDED). + Format is defined by RFC3339. + Example: `2020-01-25T21:10:29.600Z` + format: date-time + type: string + timeStarted: + description: | + The date and time when the work request transitioned from ACCEPTED to IN_PROGRESS. + Format is defined by RFC3339. + Example: `2020-01-25T21:10:29.600Z` + format: date-time + type: string + required: + - operationType + - status + - id + - compartmentId + - resources + - percentComplete + - timeAccepted + x-example: | + { + "operationType": "CREATE_STACK_FROM_COMPARTMENT", + "status": "ACCEPTED", + "id": "ocid1.ormworkrequest.oc1..<unique_ID>", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "resources": [ + { + "actionType": "IN_PROGRESS", + "entityType": "ormstack", + "identifier": "ocid1.ormstack.oci..<unique_ID>", + "entityUri": /latest/stacks/ocid1.ormstack.oc1..<unique_ID>" + } + ], + "percentComplete": 0, + "timeAccepted": "2020-01-25T21:10:29.600Z" + } + type: object + WorkRequestError: + description: An error encountered while executing a work request. + properties: + code: + description: A short error code that defines the error, meant for programmatic parsing. + type: string + message: + description: A human-readable error string. + type: string + timestamp: + description: | + The date and time when the error happened. + Format is defined by RFC3339. + Example: `2020-01-25T21:10:29.600Z` + format: date-time + type: string + required: + - code + - message + - timestamp + x-example: | + { + "code": "500", + "message": "WorkRequest Failed", + "timestamp": "2020-05-19T09:39:13.238Z" + } + type: object + WorkRequestLogEntry: + description: A log message from the execution of a work request. + properties: + message: + description: A human-readable log message. + type: string + timestamp: + description: | + The date and time when the log message was written. + Format is defined by RFC3339. + Example: `2020-01-25T21:10:29.600Z` + format: date-time + type: string + required: + - message + - timestamp + x-example: | + { + "message": "INFO 2020/10/22 17:04:55.414012 [INFO] discovering resources with data source 'oci_analytics_analytics_instances", + "timestamp": "2020-10-22T17:04:55.423Z" + } + type: object + ConfigurationSourceProviderSummary: + description: | + Summary information for a configuration source provider. + discriminator: + propertyName: configSourceProviderType + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where the configuration source provider is located. + type: string + configSourceProviderType: + description: | + The type of configuration source provider. + The `BITBUCKET_CLOUD_ACCESS_TOKEN` type corresponds to Bitbucket Cloud. + The `BITBUCKET_SERVER_ACCESS_TOKEN` type corresponds to Bitbucket Server. + The `GITLAB_ACCESS_TOKEN` type corresponds to GitLab. + The `GITHUB_ACCESS_TOKEN` type corresponds to GitHub. + type: string + x-obmcs-enumref: '#/definitions/ConfigurationSourceProvider/configSourceProviderType' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the string data type is supported. + (opaque JSON object) + type: string + 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 + description: + description: General description of the configuration source provider. + maxLength: 400 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + maxLength: 255 + type: string + freeformTags: + additionalProperties: + type: string + description: | + Free-form tags associated with the resource. Each tag is a 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the configuration source provider. + type: string + isMigrationRequired: + description: | + Indicates whether this configuration source provider uses legacy Bitbucket Cloud username/app-password credentials and must be migrated. + type: boolean + lifecycleState: + description: | + Current state of the specified configuration source provider. + For more information about configuration source provider lifecycle states in Resource Manager, see + [Key Concepts](/iaas/Content/ResourceManager/Concepts/resourcemanager.htm#concepts__CSPStates). + type: string + x-obmcs-enumref: '#/definitions/ConfigurationSourceProvider/lifecycleState' + privateServerConfigDetails: + $ref: '#/components/schemas/PrivateServerConfigDetails' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. + For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). + Example: `{orcl-cloud: {free-tier-retain: true}}` + type: object + timeCreated: + description: | + The date and time when the configuration source provider was created. + Format is defined by RFC3339. + Example: `2020-01-25T21:10:29.600Z` + format: date-time + type: string + required: + - configSourceProviderType + x-example: | + { + "id": "ocid1.configSourceProvider.oc1..<unique_ID>", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "My Configuration Source Provider", + "description": Example Git Source", + "timeCreated": "2019-10-02T19:18:44.437Z", + "lifecycleState": "ACTIVE", + "configSourceProviderType": "GITLAB_ACCESS_TOKEN", + "apiEndpoint": "https://gitlab.com", + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Project": "DC1" + } + } + } + type: object + Error: + description: Error that occurs during the execution of a job. + properties: + code: + description: | + A short error code that defines the error, meant for programmatic parsing. + For more information, see [API Errors](/iaas/Content/API/References/apierrors.htm). + type: string + message: + description: A human-readable error string. + type: string + required: + - code + - message + type: object + PrivateServerConfigDetails: + description: | + Details about a private endpoint associated with the configuration source provider. + properties: + certificateId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a certificate associated with the configuration source provider. + type: string + privateEndpointId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a private endpoint associated with the configuration source provider. + type: string + required: + - privateEndpointId + type: object + x-example: | + { + "privateEndpointId": "ocid1.ormprivateendpoint.oc1..<unique_ID>", + "sslCertificateId": "ocid1.certificate.oc1..<unique_ID>" + } + ApplyJobPlanResolution: + description: | + Deprecated. Use the property `executionPlanStrategy` in `jobOperationDetails` instead. + properties: + isAutoApproved: + description: | + Specifies whether to use the configuration directly, without reference to a Plan job. + `True` if using the configuration directly. Note that it is not necessary + for a Plan job to have run successfully. + type: boolean + isUseLatestJobId: + description: | + Specifies whether to use the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the most recently run plan job. + `True` if using the latest job [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be a plan job that completed successfully. + type: boolean + planJobId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) that specifies the most recently executed plan job. + type: string + type: object + JobOperationDetailsSummary: + description: | + A summary of job details that is specific to the operation type. + discriminator: + propertyName: operation + properties: + operation: + description: Terraform-specific operation to execute. + type: string + x-obmcs-enumref: '#/definitions/Job/operation' + required: + - operation + type: object + CreateJobOperationDetails: + description: | + Job details that are specific to the operation type. + discriminator: + propertyName: operation + properties: + isProviderUpgradeRequired: + default: false + description: | + Specifies whether or not to upgrade provider versions. + Within the version constraints of your Terraform configuration, use the latest versions available from the source of Terraform providers. + For more information about this option, see [Dependency Lock File (terraform.io)](https://www.terraform.io/language/files/dependency-lock). + type: boolean + operation: + description: Terraform-specific operation to execute. + type: string + x-obmcs-enumref: '#/definitions/Job/operation' + required: + - operation + type: object + CancellationDetails: + description: | + Cancellation details for a job. + properties: + isForced: + description: | + Indicates whether a forced cancellation was requested for the job while it was running. + A forced cancellation can result in an incorrect state file. + For example, the state file might not reflect the exact state of the provisioned resources. + type: boolean + type: object + ConfigSourceRecord: + description: | + Information about the Terraform configuration. + discriminator: + propertyName: configSourceRecordType + properties: + configSourceRecordType: + description: | + The type of configuration source to use for the Terraform configuration. + enum: + - BITBUCKET_CLOUD_CONFIG_SOURCE + - BITBUCKET_SERVER_CONFIG_SOURCE + - COMPARTMENT_CONFIG_SOURCE + - DEVOPS_CONFIG_SOURCE + - GIT_CONFIG_SOURCE + - OBJECT_STORAGE_CONFIG_SOURCE + - ZIP_UPLOAD + type: string + required: + - configSourceRecordType + type: object + x-example: | + Sample 1: Local Terraform configuration (zip file) + + { + "configSourceRecordType": "ZIP_UPLOAD" + } + + Sample 2: Remote Terraform configuration (Git) + + { + "configSourceType": "GIT_CONFIG_SOURCE", + "workingDirectory": "<file_path_to_directory>", + "configurationSourceProviderId": "ocid1.ormconfigsourceprovider.oc1..<unique_ID>", + "repositoryUrl": "https://github.com/user/repo.git", + "branchName": "MyBranch", + "commitId": "2dc979a95e86abb211eda8515e1655dfa4275a00" + } + FailureDetails: + properties: + code: + description: Job failure reason. + enum: + - INTERNAL_SERVICE_ERROR + - TERRAFORM_EXECUTION_ERROR + - TERRAFORM_CONFIG_UNZIP_FAILED + - INVALID_WORKING_DIRECTORY + - JOB_TIMEOUT + - TERRAFORM_CONFIG_VIRUS_FOUND + - TERRAFORM_GIT_CLONE_FAILURE + - TERRAFORM_GIT_CHECKOUT_FAILURE + - TERRAFORM_OBJECT_STORAGE_CONFIG_SOURCE_EMPTY_BUCKET + - TERRAFORM_OBJECT_STORAGE_CONFIG_SOURCE_NO_TF_FILE_PRESENT + - TERRAFORM_OBJECT_STORAGE_CONFIG_SOURCE_UNSUPPORTED_OBJECT_SIZE + - CUSTOM_TERRAFORM_PROVIDER_BUCKET_NOT_FOUND + - CUSTOM_TERRAFORM_PROVIDER_UNSUPPORTED_OBJECT_SIZE + type: string + message: + description: A human-readable error string. + type: string + required: + - code + - message + type: object + JobOperationDetails: + description: | + Job details that are specific to the operation type. + discriminator: + propertyName: operation + properties: + operation: + description: Terraform-specific operation to execute. + type: string + x-obmcs-enumref: '#/definitions/Job/operation' + required: + - operation + type: object + AssociatedResourceSummary: + description: | + Summary information for a resource associated with a stack or job. + properties: + attributes: + additionalProperties: + type: string + description: | + Resource attribute values. Each value is represented as a key-value pair. + Example: `{"state": "AVAILABLE"}` + type: object + region: + description: | + Resource region. + For information about regions, see [Regions and Availability Domains](/iaas/Content/General/Concepts/regions.htm). + Example: `us-phoenix-1` + type: string + resourceAddress: + description: Terraform resource address. + type: string + resourceId: + description: Unique identifier for the resource. + type: string + resourceName: + description: Name of the resource. + type: string + resourceType: + description: Resource type. For more information about resource types supported for the Oracle Cloud Infrastructure (OCI) provider, see [Oracle Cloud Infrastructure Provider](https://registry.terraform.io/providers/oracle/oci/latest/docs). + type: string + timeCreated: + description: | + The date and time when the stack was created. + Format is defined by RFC3339. + Example: `2022-07-25T21:10:29.600Z` + format: date-time + type: string + x-example: | + { + id: "ocid1.instance.oc1.phx.anyhqljrfvoefqyc5pous5opmo57ql2gudgg5goqvzhmebs6ul6pthzdesyq", + name: "TFInstance0", + type: "oci_core_instance", + timeCreated: 2020-05-13T21:57:07.363" + region: "us-phoenix-1" + attributes: { + "id": "ocid1.instance.oc1.phx.anyhqljrfvoefqyc5pous5opmo57ql2gudgg5goqvzhmebs6ul6pthzdesyq", + "image": "ocid1.image.oc1.phx.aaaaaaaaupbfz5f5hdvejulmalhyb6goieolullgkpumorbvxlwkaowglslq", + } + } + type: object + JobOutputSummary: + description: | + Terraform output associated with a job. + properties: + description: + description: Description of the output. + type: string + isSensitive: + description: When `true`, output is sensitive. + type: boolean + outputName: + description: Name of the output. + type: string + outputType: + description: Output resource type. + type: string + outputValue: + description: Value of the Terraform output. + type: string + x-example: | + { + name: "BootVolumeIDs", + type: "list" + value: "[\"ocid1.bootvolume.oc1.phx.abyhqljrglzsejlhn5j6ycmfvufo7zmxtsc27lp2lcjeuv7jonod7tr7f6ea\"]" + sensitive: false + } + type: object + PrivateEndpointSummary: + description: | + The summary metadata associated with the private endpoint. + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this private endpoint. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the string data type is supported. + (opaque JSON object) + type: string + 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 + description: + description: Description of the private endpoint. Avoid entering confidential information. + maxLength: 500 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + maxLength: 255 + type: string + dnsZones: + description: | + DNS zones to use for accessing private Git servers. + For private Git server instructions, see + [Private Git Server](/iaas/Content/ResourceManager/Tasks/private-endpoints.htm#private-git). + DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver. + items: + type: string + maxItems: 5 + type: array + freeformTags: + additionalProperties: + type: string + description: | + Free-form tags associated with the resource. Each tag is a 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 + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. + type: string + isUsedWithConfigurationSourceProvider: + description: When `true`, allows the private endpoint to be used with a configuration source provider. + type: boolean + lifecycleState: + description: | + The current lifecycle state of the private endpoint. + type: string + x-obmcs-enumref: '#/definitions/PrivateEndpoint/lifecycleState' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. + For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). + Example: `{orcl-cloud: {free-tier-retain: true}}` + type: object + timeCreated: + description: | + The date and time when the private endpoint was created. + Format is defined by RFC3339. + Example: `2020-01-25T21:10:29.600Z` + format: date-time + type: string + vcnId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN for the private endpoint. + type: string + required: + - id + - compartmentId + - vcnId + - displayName + type: object + x-example: | + { + "id": "ocid1.ormprivateendpoint.oc1..<unique_ID>", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "My Private Endpoint", + "description": "Example Private Endpoint", + "vcnId": "ocid1.vcn.oc1..<unique_ID>", + "timeCreated": "2019-10-02T19:18:44.437Z", + "lifecycleState": "ACTIVE", + "freeformTags": { + "Department": "Finance", + "Group": "D" + }, + "definedTags": { + "ProjectTags": { + "Owner": "Operations" + } + }, + "securityAttributes": { + "oracle-zpr": { + "MaxEgressCount": { + "mode": "enforce", + "value": "45" + } + } + } + } + ResourceDiscoveryServiceSummary: + description: | + A service supported for use with [Resource Discovery](https://www.terraform.io/docs/providers/oci/guides/resource_discovery.html#services). + properties: + discoveryScope: + description: | + The scope of the service as used with Resource Discovery. + This property determines the type of compartment OCID required: root compartment (`TENANCY`) or not (`COMPARTMENT`). + For example, `identity` is at the root compartment scope while `database` is at the compartment scope. + enum: + - TENANCY + - COMPARTMENT + type: string + name: + description: | + A supported service. Example: `core` + For reference on service names, see the [Terraform provider documentation](https://www.terraform.io/docs/providers/oci/guides/resource_discovery.html#services). + maxLength: 255 + type: string + type: object + CreateConfigSourceDetails: + description: | + Creation details for a configuration source used with the stack. + discriminator: + propertyName: configSourceType + properties: + configSourceType: + description: | + Specifies the `configSourceType` for uploading the Terraform configuration. + type: string + x-obmcs-enumref: '#/definitions/ConfigSource/configSourceType' + workingDirectory: + description: | + File path to the directory to use for running Terraform. + If not specified, the root directory is used. + Required when using a zip Terraform configuration (`configSourceType` value of `ZIP_UPLOAD`) that contains folders. + Ignored for the `configSourceType` value of `COMPARTMENT_CONFIG_SOURCE`. + For more information about required and recommended file structure, see + [File Structure (Terraform Configurations for Resource Manager)](/iaas/Content/ResourceManager/Concepts/terraformconfigresourcemanager.htm#filestructure). + type: string + required: + - configSourceType + type: object + CustomTerraformProvider: + description: | + Location information about custom Terraform providers for a stack. + For more information, see [Using Custom Providers with a Stack](/iaas/Content/ResourceManager/Tasks/update-stack-custom-providers.htm). + Note: Older stacks must be explicitly updated to use Terraform Registry (`isThirdPartyProviderExperienceEnabled=true`). + See [UpdateStack](#/en/resourcemanager/latest/Stack/UpdateStack). For more information, see + [Using Terraform Registry with an Older Stack](/iaas/Content/ResourceManager/Tasks/update-stack-tf-reg.htm). + properties: + bucketName: + description: | + The name of the bucket that contains the binary files for the custom Terraform providers. + For information about buckets, see [Managing Buckets](/iaas/Content/Object/Tasks/managingbuckets.htm). + type: string + namespace: + description: | + The Object Storage namespace that contains the bucket you want. + For information about Object Storage namespaces, see [Understanding Object Storage Namespaces](/iaas/Content/Object/Tasks/understandingnamespaces.htm). + type: string + region: + description: | + The name of the region that contains the bucket you want. + For information about regions, see [Regions and Availability Domains](/iaas/Content/General/Concepts/regions.htm). + Example: `us-phoenix-1` + type: string + required: + - region + - namespace + - bucketName + type: object + x-example: | + { + "region": "us-phoenix-1", + "namespace": "<bucket_namespace>", + "bucketName": "<bucket_name>" + } + ConfigSource: + description: | + Information about the Terraform configuration. + discriminator: + propertyName: configSourceType + properties: + configSourceType: + description: | + The type of configuration source to use for the Terraform configuration. + enum: + - BITBUCKET_CLOUD_CONFIG_SOURCE + - BITBUCKET_SERVER_CONFIG_SOURCE + - COMPARTMENT_CONFIG_SOURCE + - DEVOPS_CONFIG_SOURCE + - GIT_CONFIG_SOURCE + - OBJECT_STORAGE_CONFIG_SOURCE + - ZIP_UPLOAD + type: string + workingDirectory: + description: | + File path to the directory to use for running Terraform. + If not specified, the root directory is used. + Required when using a zip Terraform configuration (`configSourceType` value of `ZIP_UPLOAD`) that contains folders. + Ignored for the `configSourceType` value of `COMPARTMENT_CONFIG_SOURCE`. + For more information about required and recommended file structure, see + [File Structure (Terraform Configurations for Resource Manager)](/iaas/Content/ResourceManager/Concepts/terraformconfigresourcemanager.htm#filestructure). + type: string + required: + - configSourceType + type: object + x-example: | + Sample 1: Zip file + + { + "configSourceType": "ZIP_UPLOAD", + "zipFileBase64Encoded": "<zip_file_content_encoded_in_base64_format>", + "workingDirectory": "<file_path_to_directory>" + } + + Sample 2: GitHub + + { + "configSourceType": "GIT_CONFIG_SOURCE", + "configurationSourceProviderId": "ocid1.ormconfigsourceprovider.oc1..<unique_ID>", + "repositoryUrl": "https://github.com/user/repo.git", + "branchName": "MyBranch", + "workingDirectory": "<file_path_to_directory>", + } + + Sample 3: Bucket + + { + "configSourceType": "OBJECT_STORAGE_CONFIG_SOURCE", + "region": "us-phoenix-1", + "namespace": "<bucket_namespace>", + "bucketName": "<bucket_name>" + } + + Sample 4: Existing compartment (resource discovery) + + { + "configSourceType": "COMPARTMENT_CONFIG_SOURCE", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "region": "us-phoenix-1" + } + + Sample 5: DevOps repository + + { + "configSourceType": "DEVOPS_CONFIG_SOURCE", + "projectId": "ocid1.devopsproject.oc1..<unique_ID>", + "repositoryId": "ocid1.devopsrepository.oc1..<unique_ID>", + "branchName": "MyBranch", + "workingDirectory": "<file_path_to_directory>", + } + UpdateConfigSourceDetails: + description: | + Update details for a configuration source. + discriminator: + propertyName: configSourceType + properties: + configSourceType: + description: | + Specifies the `configSourceType` for uploading the Terraform configuration. + type: string + x-obmcs-enumref: '#/definitions/ConfigSource/configSourceType' + workingDirectory: + description: | + File path to the directory to use for running Terraform. + If not specified, the root directory is used. + Required when using a zip Terraform configuration (`configSourceType` value of `ZIP_UPLOAD`) that contains folders. + Ignored for the `configSourceType` value of `COMPARTMENT_CONFIG_SOURCE`. + For more information about required and recommended file structure, see + [File Structure (Terraform Configurations for Resource Manager)](/iaas/Content/ResourceManager/Concepts/terraformconfigresourcemanager.htm#filestructure). + type: string + required: + - configSourceType + x-example: | + Sample 1: Local Terraform configuration (zip file) + + { + "configSourceType": "ZIP_UPLOAD", + "workingDirectory": "<file_path_to_directory>", + "configurationSourceProviderId": "ocid1.ormconfigsourceprovider.oc1..<unique_ID>", + "branchName": "MyBranch" + } + + Sample 2: Remote Terraform configuration (Git) + + { + "configSourceType": "GIT_CONFIG_SOURCE", + "workingDirectory": "<file_path_to_directory>" + } + type: object + StackResourceDriftSummary: + description: | + Drift status details for the indicated resource and stack. Includes actual and expected (defined) properties. + properties: + actualProperties: + additionalProperties: + type: string + description: | + Actual values of properties that the stack defines for the indicated resource. + Each property and value is provided as a key-value pair. + The following example shows actual values for the resource's display name and server type: + `{"display_name": "tf-default-dhcp-options-new", "options.0.server_type": "VcnLocalPlusInternet"}` + type: object + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where the stack is located. + type: string + expectedProperties: + additionalProperties: + type: string + description: | + Expected values of properties that the stack defines for the indicated resource. + Each property and value is provided as a key-value pair. + The following example shows expected (defined) values for the resource's display name and server type: + `{"display_name": "tf-default-dhcp-options", "options.0.server_type": "VcnLocalPlusInternet"}` + type: object + resourceDriftStatus: + description: | + The drift status of the resource. + A drift status value indicates whether or not the actual state of the resource differs from the expected (defined) state for that resource. + enum: + - NOT_CHECKED + - IN_SYNC + - MODIFIED + - DELETED + type: string + resourceId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource provisioned by Terraform. + maxLength: 255 + type: string + resourceName: + description: The name of the resource as defined in the stack. + maxLength: 255 + type: string + resourceType: + description: | + The provider resource type. + Must be supported by the [Oracle Cloud Infrastructure provider](https://www.terraform.io/docs/providers/oci/index.html). + Example: `oci_core_instance` + maxLength: 255 + type: string + stackId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the stack. + type: string + timeDriftChecked: + description: | + The date and time when the drift detection was executed. + Format is defined by RFC3339. + Example: `2020-01-25T21:10:29.600Z` + format: date-time + type: string + type: object + x-example: | + { + "stackId": "ocid1.ormstackoc1..<unique_ID>", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "resourceName": "oci_core_default_dhcp_options.tf-default-dhcp-options", + "resourceId": "ocid1.dhcpoptions.oc1..<unique_ID>", + "resourceType": "oci_core_dhcp_options", + "resourceDriftStatus": "MODIFIED", + "actualProperties": + "{ + "display_name": "tf-default-dhcp-options-new", + "id": "ocid1.dhcpoptions.oc1..<unique_ID>", + "options.0.server_type": "VcnLocalPlusInternet", + "state": "AVAILABLE", + "time_created": "2019-01-08 23:10:28.441 +0000 UTC" + }", + "expectedProperties": + "{ + "display_name": "tf-default-dhcp-options", + "id": "ocid1.dhcpoptions.oc1.phx..<unique_ID>", + "options.0.server_type": "VcnLocalPlusInternet", + "state": "AVAILABLE", + "time_created": "2019-01-08 23:10:28.441 +0000 UTC" + }", + "timeDriftChecked": "2019-10-02T19:18:44.437Z", + } + TemplateCategorySummary: + description: | + Summary information for the template category. + properties: + displayName: + description: The name of the template category. Not changeable. + type: string + id: + description: | + Unique identifier for the template category. + Possible values are `0` (Quickstarts), `1` (Service), `2` (Architecture), and `3` (Private). + Template category labels are displayed in the Console page listing templates. + Quickstarts, Service, and Architecture templates (categories 0, 1, and 2) are available in all compartments. + Each private template (category 3) is available in the compartment where it was created. + type: string + x-example: | + { + "id": "3" + "displayName": "Private Template", + "lifecycleState": "ACTIVE" + } + type: object + TemplateSummary: + description: | + Summary information for a template. + properties: + compartmentId: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this template. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the string data type is supported. + (opaque JSON object) + type: string + 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 + description: + description: Brief description of the template. + maxLength: 500 + type: string + displayName: + description: | + A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. + maxLength: 255 + type: string + freeformTags: + additionalProperties: + type: string + description: | + Free-form tags associated with the resource. Each tag is a 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 + id: + description: Unique identifier of the specified template. + type: string + isFreeTier: + description: whether the template will work for free tier tenancy. + type: boolean + lifecycleState: + description: | + The current lifecycle state of the template. + type: string + x-obmcs-enumref: '#/definitions/Template/lifecycleState' + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + type: object + description: | + The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. + For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). + Example: `{orcl-cloud: {free-tier-retain: true}}` + type: object + timeCreated: + description: | + The date and time at which the template was created. + Format is defined by RFC3339. + Example: `2020-11-25T21:10:29.600Z` + format: date-time + type: string + x-example: | + { + "id": "ocid1.template.oc1..<unique_ID>", + "compartmentId": "ocid1.compartment.oc1..<unique_ID>", + "displayName": "Template Display Name", + "description": "Brief description of the template", + "timeCreated": "2020-10-02T19:18:44.437Z" + } + type: object + CreateTemplateConfigSourceDetails: + description: | + Creation details for a configuration source used for a template. + discriminator: + propertyName: templateConfigSourceType + properties: + templateConfigSourceType: + description: | + Specifies the `configSourceType` for uploading the Terraform configuration. + type: string + x-obmcs-enumref: '#/definitions/TemplateConfigSource/templateConfigSourceType' + required: + - templateConfigSourceType + type: object + TemplateConfigSource: + description: | + Information about the Template. + discriminator: + propertyName: templateConfigSourceType + properties: + templateConfigSourceType: + description: | + The type of configuration source to use for the template configuration. + enum: + - ZIP_UPLOAD + type: string + required: + - templateConfigSourceType + type: object + x-example: | + Sample 1: Directly uploaded Template zip file + { + "templateConfigSourceType": "ZIP_UPLOAD", + } + UpdateTemplateConfigSourceDetails: + description: | + Update details for a configuration source for a template. + discriminator: + propertyName: templateConfigSourceType + properties: + templateConfigSourceType: + description: | + Specifies the `configSourceType` for uploading the Terraform configuration. + type: string + x-obmcs-enumref: '#/definitions/TemplateConfigSource/templateConfigSourceType' + required: + - templateConfigSourceType + type: object + TerraformVersionSummary: + description: | + A Terraform version supported for use with stacks. + properties: + isDefault: + description: Indicates whether this Terraform version is used by default in [CreateStack](#/en/resourcemanager/latest/Stack/CreateStack). + type: boolean + name: + description: | + A supported Terraform version. Example: `1.5.x` + maxLength: 255 + type: string + type: object + WorkRequestResource: + description: A resource created or operated on by a work request. + properties: + actionType: + description: | + The way in which this resource is affected by the work tracked in the work request. + A resource being created, updated, or deleted will remain in the IN_PROGRESS state until + work is complete for that resource at which point it will transition to CREATED, UPDATED, + or DELETED, respectively. + enum: + - CREATED + - UPDATED + - DELETED + - IN_PROGRESS + type: string + entityType: + description: The resource type the work request affects. + type: string + entityUri: + description: The URI path that you can use for a GET request to access the resource metadata. + type: string + identifier: + description: An [OCID](/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource. + type: string + required: + - actionType + - entityType + - identifier + x-example: | + { + "actionType": "IN_PROGRESS", + "entityType": "ormstack", + "identifier": "ocid1.ormstack.oci..<unique_ID>", + "entityUri": /latest/stacks/ocid1.ormstack.oc1..<unique_ID>" + } + type: object + ListJobsResponse: + type: object + properties: + jobs: + type: array + items: + $ref: '#/components/schemas/JobSummary' + GetJobLogsResponse: + type: object + properties: + job_logs: + type: array + items: + $ref: '#/components/schemas/LogEntry' + ListStacksResponse: + type: object + properties: + stacks: + type: array + items: + $ref: '#/components/schemas/StackSummary' + ListWorkRequestsResponse: + type: object + properties: + work_requests: + type: array + items: + $ref: '#/components/schemas/WorkRequestSummary' + ListWorkRequestErrorsResponse: + type: object + properties: + work_request_errors: + type: array + items: + $ref: '#/components/schemas/WorkRequestError' + ListWorkRequestLogsResponse: + type: object + properties: + work_request_logs: + type: array + items: + $ref: '#/components/schemas/WorkRequestLogEntry' + responses: + '400': + description: Bad Request + 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: + '*/*': + schema: + $ref: '#/components/schemas/Error' + '401': + description: Unauthorized + 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: + '*/*': + schema: + $ref: '#/components/schemas/Error' + '404': + description: Not Found + 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: + '*/*': + schema: + $ref: '#/components/schemas/Error' + '409': + description: IncorrectState + 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: + '*/*': + schema: + $ref: '#/components/schemas/Error' + '412': + description: Precondition Failed + 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: + '*/*': + schema: + $ref: '#/components/schemas/Error' + '429': + description: Too many requests. Rate limit exceeded + 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: + '*/*': + schema: + $ref: '#/components/schemas/Error' + '500': + description: Internal Server 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: + '*/*': + schema: + $ref: '#/components/schemas/Error' + DefaultError: + description: An error has occurred. + 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: + '*/*': + schema: + $ref: '#/components/schemas/Error' + parameters: + OpcRequestIdHeaderParam: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + CompartmentIdQueryParam: + description: | + A filter to return only resources that exist in the compartment, identified by [OCID](/iaas/Content/General/Concepts/identifiers.htm). + in: query + name: compartmentId + required: false + schema: + type: string + IdForConfigurationSourceProviderQueryParam: + description: | + A filter to return only configuration source providers that match the provided [OCID](/iaas/Content/General/Concepts/identifiers.htm). + in: query + name: configurationSourceProviderId + required: false + schema: + type: string + FilterByDisplayNameQueryParam: + description: | + A filter to return only resources that match the given display name exactly. + Use this filter to list a resource by name. + Requires `sortBy` set to `DISPLAYNAME`. + Alternatively, when you know the resource OCID, use the related Get operation. + in: query + name: displayName + required: false + schema: + type: string + maxLength: 255 + SortByQueryParam: + description: | + The field to use when sorting returned resources. + By default, `TIMECREATED` is ordered descending. + By default, `DISPLAYNAME` is ordered ascending. Note that you can sort only on one field. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - DISPLAYNAME + SortOrderQueryParam: + description: | + The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`). + in: query + name: sortOrder + required: false + schema: + type: string + enum: + - ASC + - DESC + PaginationLimitQueryParam: + description: | + The number of items returned in a paginated `List` call. For information about pagination, see + [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + in: query + name: limit + schema: + type: integer + minimum: 1 + maximum: 1000 + PaginationTokenQueryParam: + description: | + The value of the `opc-next-page` response header from the preceding `List` call. + For information about pagination, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + in: query + name: page + schema: + type: string + minLength: 1 + maxLength: 512 + FilterByConfigSourceProviderTypeQueryParam: + description: | + A filter to return only configuration source providers of the specified type (GitHub or GitLab). + in: query + name: configSourceProviderType + required: false + schema: + type: string + OpcRetryTokenHeaderParam: + description: | + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error without risk of retrying the same action. Retry tokens expire after + 24 hours, but can be invalidated before then due to conflicting operations. For example, + if a resource has been deleted and purged from the system, then a retry of the original + creation request may be rejected. + in: header + name: opc-retry-token + required: false + schema: + type: string + IfMatchHeaderParam: + 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 + schema: + type: string + ConfigurationSourceProviderIdPathParam: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the configuration source provider. + in: path + name: configurationSourceProviderId + required: true + schema: + type: string + StackIdQueryParam: + description: | + The stack [OCID](/iaas/Content/General/Concepts/identifiers.htm) on which to filter. + in: query + name: stackId + required: false + schema: + type: string + IdForJobQueryParam: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) on which to query for jobs. + in: query + name: id + required: false + schema: + type: string + JobIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job. + in: path + name: jobId + required: true + schema: + type: string + IsForcedQueryParam: + description: | + Indicates whether a forced cancellation is requested for the job while it was running. + A forced cancellation can result in an incorrect state file. + For example, the state file might not reflect the exact state of the provisioned resources. + in: query + name: isForced + required: false + schema: + type: boolean + default: false + TerraformResourceTypeQueryParam: + description: | + A filter to return only specified resource types. + For more information about resource types supported for the Oracle Cloud Infrastructure [OCI] provider, see [Oracle Cloud Infrastructure Provider](https://registry.terraform.io/providers/oracle/oci/latest/docs). + in: query + name: terraformResourceType + required: false + schema: + type: string + LogTimestampGreaterThanOrEqualToQueryParam: + description: | + Time stamp specifying the lower time limit for which logs are returned in a query. + Format is defined by RFC3339. + Example: `2020-01-01T12:00:00.000Z` + in: query + name: timestampGreaterThanOrEqualTo + required: false + schema: + type: string + format: date-time + LogTimestampLessThanOrEqualToQueryParam: + description: | + Time stamp specifying the upper time limit for which logs are returned in a query. + Format is defined by RFC3339. + Example: `2020-02-01T12:00:00.000Z` + in: query + name: timestampLessThanOrEqualTo + required: false + schema: + type: string + format: date-time + TfPlanFormatQueryParam: + description: | + The output format of the Terraform plan. + in: query + name: tfPlanFormat + required: false + schema: + type: string + enum: + - BINARY + - JSON + default: BINARY + PrivateEndpointIdQueryParam: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. + in: query + name: privateEndpointId + required: false + schema: + type: string + FilterByVcnIdQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN. + in: query + name: vcnId + required: false + schema: + type: string + PrivateEndpointIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. + in: path + name: privateEndpointId + required: true + schema: + type: string + PrivateIpQueryParam: + description: | + The IP address of the resource in the private subnet. + in: query + name: privateIp + required: true + schema: + type: string + IdForStackQueryParam: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) on which to query for a stack. + in: query + name: id + required: false + schema: + type: string + StackIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the stack. + in: path + name: stackId + required: true + schema: + type: string + WorkRequestIdQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + in: query + name: workRequestId + required: false + schema: + type: string + TemplateCategoryIdQueryParam: + description: | + Unique identifier for the template category. + Possible values are `0` (Quickstarts), `1` (Service), `2` (Architecture), and `3` (Private). + Template category labels are displayed in the Console page listing templates. + Quickstarts, Service, and Architecture templates (categories 0, 1, and 2) are available in all compartments. + Each private template (category 3) is available in the compartment where it was created. + in: query + name: templateCategoryId + required: false + schema: + type: string + TemplateIdQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the template. + in: query + name: templateId + required: false + schema: + type: string + TemplateIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the template. + in: path + name: templateId + required: true + schema: + type: string + RequiredCompartmentIdQueryParam: + description: | + A filter to return only resources that exist in the compartment, identified by [OCID](/iaas/Content/General/Concepts/identifiers.htm). + in: query + name: compartmentId + required: true + schema: + type: string + ResourceIdQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. + in: query + name: resourceId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + WorkRequestIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + in: path + name: workRequestId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + x-stackQL-resources: + configuration_source_providers: + id: oci.resource_manager.configuration_source_providers + name: configuration_source_providers + title: Configuration Source Providers + methods: + list: + operation: + $ref: '#/paths/~1configurationSourceProviders/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1configurationSourceProviders/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1configurationSourceProviders~1{configurationSourceProviderId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1configurationSourceProviders~1{configurationSourceProviderId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1configurationSourceProviders~1{configurationSourceProviderId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1configurationSourceProviders~1{configurationSourceProviderId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/configuration_source_providers/methods/get' + - $ref: '#/components/x-stackQL-resources/configuration_source_providers/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/configuration_source_providers/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/configuration_source_providers/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/configuration_source_providers/methods/delete' + replace: [] + jobs: + id: oci.resource_manager.jobs + name: jobs + title: Jobs + methods: + list: + operation: + $ref: '#/paths/~1jobs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.jobs + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListJobsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"jobs\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1jobs/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + cancel_job: + operation: + $ref: '#/paths/~1jobs~1{jobId}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1jobs~1{jobId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1jobs~1{jobId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/jobs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/jobs/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/jobs/methods/update' + delete: [] + replace: [] + job_associated_resources: + id: oci.resource_manager.job_associated_resources + name: job_associated_resources + title: Job Associated Resources + methods: + list: + operation: + $ref: '#/paths/~1jobs~1{jobId}~1associatedResources/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/job_associated_resources/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + job_detailed_log_contents: + id: oci.resource_manager.job_detailed_log_contents + name: job_detailed_log_contents + title: Job Detailed Log Contents + methods: + get: + operation: + $ref: '#/paths/~1jobs~1{jobId}~1detailedLogContent/get' + response: + mediaType: text/plain; charset=utf-8 + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/job_detailed_log_contents/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + job_logs: + id: oci.resource_manager.job_logs + name: job_logs + title: Job Logs + methods: + get: + operation: + $ref: '#/paths/~1jobs~1{jobId}~1logs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.job_logs + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/GetJobLogsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"job_logs\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/job_logs/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + job_logs_contents: + id: oci.resource_manager.job_logs_contents + name: job_logs_contents + title: Job Logs Contents + methods: + get: + operation: + $ref: '#/paths/~1jobs~1{jobId}~1logs~1content/get' + response: + mediaType: text/plain; charset=utf-8 + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/job_logs_contents/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + job_outputs: + id: oci.resource_manager.job_outputs + name: job_outputs + title: Job Outputs + methods: + list: + operation: + $ref: '#/paths/~1jobs~1{jobId}~1outputs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/job_outputs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + job_tf_configs: + id: oci.resource_manager.job_tf_configs + name: job_tf_configs + title: Job Tf Configs + methods: + get: + operation: + $ref: '#/paths/~1jobs~1{jobId}~1tfConfig/get' + response: + mediaType: application/zip + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/job_tf_configs/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + job_tf_plans: + id: oci.resource_manager.job_tf_plans + name: job_tf_plans + title: Job Tf Plans + methods: + get: + operation: + $ref: '#/paths/~1jobs~1{jobId}~1tfPlan/get' + response: + mediaType: application/octet-stream + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/job_tf_plans/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + job_tf_states: + id: oci.resource_manager.job_tf_states + name: job_tf_states + title: Job Tf States + methods: + get: + operation: + $ref: '#/paths/~1jobs~1{jobId}~1tfState/get' + response: + mediaType: application/octet-stream + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/job_tf_states/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + private_endpoints: + id: oci.resource_manager.private_endpoints + name: private_endpoints + title: Private Endpoints + methods: + list: + operation: + $ref: '#/paths/~1privateEndpoints/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1privateEndpoints/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1privateEndpoints~1{privateEndpointId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1privateEndpoints~1{privateEndpointId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1privateEndpoints~1{privateEndpointId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1privateEndpoints~1{privateEndpointId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/private_endpoints/methods/get' + - $ref: '#/components/x-stackQL-resources/private_endpoints/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/private_endpoints/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/private_endpoints/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/private_endpoints/methods/delete' + replace: [] + reachable_ips: + id: oci.resource_manager.reachable_ips + name: reachable_ips + title: Reachable Ips + methods: + get: + operation: + $ref: '#/paths/~1privateEndpoints~1{privateEndpointId}~1reachableIp/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/reachable_ips/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + resource_discovery_services: + id: oci.resource_manager.resource_discovery_services + name: resource_discovery_services + title: Resource Discovery Services + methods: + list: + operation: + $ref: '#/paths/~1resourceDiscoveryServices/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/resource_discovery_services/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + stacks: + id: oci.resource_manager.stacks + name: stacks + title: Stacks + methods: + list: + operation: + $ref: '#/paths/~1stacks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.stacks + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListStacksResponse' + transform: + body: |- + {{- $wrapped := printf "{\"stacks\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1stacks/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1stacks~1{stackId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1stacks~1{stackId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1stacks~1{stackId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1stacks~1{stackId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + detect_stack_drift: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1stacks~1{stackId}~1actions~1detectDrift/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + list_stack_resource_drift_details: + operation: + $ref: '#/paths/~1stacks~1{stackId}~1actions~1listResourceDriftDetails/post' + response: + mediaType: application/json + openAPIDocKey: '200' + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/stacks/methods/get' + - $ref: '#/components/x-stackQL-resources/stacks/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/stacks/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/stacks/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/stacks/methods/delete' + replace: [] + stack_associated_resources: + id: oci.resource_manager.stack_associated_resources + name: stack_associated_resources + title: Stack Associated Resources + methods: + list: + operation: + $ref: '#/paths/~1stacks~1{stackId}~1associatedResources/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/stack_associated_resources/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + stack_tf_configs: + id: oci.resource_manager.stack_tf_configs + name: stack_tf_configs + title: Stack Tf Configs + methods: + get: + operation: + $ref: '#/paths/~1stacks~1{stackId}~1tfConfig/get' + response: + mediaType: application/zip + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/stack_tf_configs/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + stack_tf_states: + id: oci.resource_manager.stack_tf_states + name: stack_tf_states + title: Stack Tf States + methods: + get: + operation: + $ref: '#/paths/~1stacks~1{stackId}~1tfState/get' + response: + mediaType: application/octet-stream + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/stack_tf_states/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + template_categories: + id: oci.resource_manager.template_categories + name: template_categories + title: Template Categories + methods: + list: + operation: + $ref: '#/paths/~1templateCategories/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/template_categories/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + templates: + id: oci.resource_manager.templates + name: templates + title: Templates + methods: + list: + operation: + $ref: '#/paths/~1templates/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1templates/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1templates~1{templateId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1templates~1{templateId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1templates~1{templateId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1templates~1{templateId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/templates/methods/get' + - $ref: '#/components/x-stackQL-resources/templates/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/templates/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/templates/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/templates/methods/delete' + replace: [] + template_logos: + id: oci.resource_manager.template_logos + name: template_logos + title: Template Logos + methods: + get: + operation: + $ref: '#/paths/~1templates~1{templateId}~1logo/get' + response: + mediaType: image/png + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/template_logos/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + template_tf_configs: + id: oci.resource_manager.template_tf_configs + name: template_tf_configs + title: Template Tf Configs + methods: + get: + operation: + $ref: '#/paths/~1templates~1{templateId}~1tfConfig/get' + response: + mediaType: application/zip + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/template_tf_configs/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + terraform_versions: + id: oci.resource_manager.terraform_versions + name: terraform_versions + title: Terraform Versions + methods: + list: + operation: + $ref: '#/paths/~1terraformVersions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/terraform_versions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + work_requests: + id: oci.resource_manager.work_requests + name: work_requests + title: Work Requests + methods: + list: + operation: + $ref: '#/paths/~1workRequests/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.work_requests + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListWorkRequestsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"work_requests\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1workRequests~1{workRequestId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/work_requests/methods/get' + - $ref: '#/components/x-stackQL-resources/work_requests/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + work_request_errors: + id: oci.resource_manager.work_request_errors + name: work_request_errors + title: Work Request Errors + methods: + list: + operation: + $ref: '#/paths/~1workRequests~1{workRequestId}~1errors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.work_request_errors + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListWorkRequestErrorsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"work_request_errors\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/work_request_errors/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + work_request_logs: + id: oci.resource_manager.work_request_logs + name: work_request_logs + title: Work Request Logs + methods: + list: + operation: + $ref: '#/paths/~1workRequests~1{workRequestId}~1logs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.work_request_logs + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListWorkRequestLogsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"work_request_logs\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/work_request_logs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://resourcemanager.{region}.oraclecloud.com/20180917 + variables: + region: + default: us-ashburn-1 + description: OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. + x-stackQL-envVar: OCI_REGION +x-stackQL-config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: opc-next-page + location: header diff --git a/providers/src/oci/v00.00.00000/services/secrets.yaml b/providers/src/oci/v00.00.00000/services/secrets.yaml new file mode 100644 index 00000000..62478373 --- /dev/null +++ b/providers/src/oci/v00.00.00000/services/secrets.yaml @@ -0,0 +1,547 @@ +openapi: 3.0.0 +info: + title: secrets API + description: Use this API to retrieve secrets and secret versions from vaults. + version: '20190301' +paths: + /secretbundles/actions/getByName: + post: + description: | + Gets a secret bundle by secret name and vault ID, and secret version that matches either the specified `stage`, `secretVersionName`, or `versionNumber` parameter. + If none of these parameters are provided, the bundle for the secret version marked as `CURRENT` is returned. + operationId: GetSecretBundleByName + parameters: + - $ref: '#/components/parameters/SecretNameQueryParam' + - $ref: '#/components/parameters/VaultIdQueryParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/SecretVersionNumberQueryParam' + - $ref: '#/components/parameters/SecretVersionNameQueryParam' + - $ref: '#/components/parameters/StageQueryParam' + responses: + '200': + description: A secret bundle. + 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/SecretBundle' + '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/DefaultError' + summary: Gets a secret bundle by secret name and vault ID. + tags: + - secrets + x-example: | + POST /20190301/secretbundles/actions/getByName?secretName=<secret_name>&vaultId=<vault_Ocid> + Host: <secretsEndpoint> + <authorization and other headers> + x-related-resource: '#/definitions/SecretBundle' + /secretbundles/{secretId}: + get: + description: | + Gets a secret bundle that matches either the specified `stage`, `secretVersionName`, or `versionNumber` parameter. + If none of these parameters are provided, the bundle for the secret version marked as `CURRENT` will be returned. + operationId: GetSecretBundle + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/SecretIdRequiredPathParam' + - $ref: '#/components/parameters/SecretVersionNumberQueryParam' + - $ref: '#/components/parameters/SecretVersionNameQueryParam' + - $ref: '#/components/parameters/StageQueryParam' + responses: + '200': + description: A secret bundle. + 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/SecretBundle' + '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/DefaultError' + summary: Gets a secret bundle. + tags: + - secrets + x-example: | + GET /20190301/secretbundles/<secret_OCID> + Host: <secretsEndpoint> + <authorization and other headers> + /secretbundles/{secretId}/versions: + get: + description: Lists all secret bundle versions for the specified secret. + operationId: ListSecretBundleVersions + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/SecretIdRequiredPathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: A list of secret bundle version objects. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/Content/API/Concepts/usingapi.htm#List_Pagination). + 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/ListSecretBundleVersionsResponse' + '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/DefaultError' + summary: Lists all secret bundle versions. + tags: + - secrets + x-example: | + GET /20190301/secretbundles/<secret_OCID>/versions + Host: <secretsEndpoint> + <authorization and other headers> + x-related-resource: '#/definitions/SecretBundleVersionSummary' +components: + schemas: + SecretBundle: + description: | + The contents of the secret, properties of the secret (and secret version), and user-provided contextual metadata for the secret. + properties: + metadata: + additionalProperties: + type: string + description: (opaque JSON object) + description: | + Customer-provided contextual metadata for the secret. + type: object + secretBundleContent: + $ref: '#/components/schemas/SecretBundleContentDetails' + secretId: + description: The OCID of the secret. + type: string + stages: + description: A list of possible rotation states for the secret version. + items: + enum: + - CURRENT + - PENDING + - LATEST + - PREVIOUS + - DEPRECATED + type: string + x-obmcs-inline-enum: true + type: array + timeCreated: + description: The time when the secret bundle was created. + format: date-time + type: string + timeOfDeletion: + description: | + An optional property indicating when to delete the secret version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + timeOfExpiry: + description: | + An optional property indicating when the secret version will expire, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + versionName: + description: | + The name of the secret version. Labels are unique across the different versions of a particular secret. + type: string + versionNumber: + description: The version number of the secret. + format: int64 + type: integer + required: + - secretId + - versionNumber + type: object + x-example: | + { + "secretId" : "ocid1.vaultsecret.oc1.iad.exampleaz5qacpqadubrc4wwugrqmw5dnyzvcxwzds6er5enn2oamexample", + "timeCreated" : "2020-03-18T16:51:38.851Z", + "versionNumber" : 1, + "versionName" : null, + "secretBundleContent" : { + "contentType" : "BASE64", + "content" : "aGVsbG8h" + }, + "timeOfDeletion" : null, + "timeOfExpiry" : null, + "stages" : [ "CURRENT", "LATEST" ], + "metadata" : null + } + SecretBundleVersionSummary: + description: | + The properties of the secret bundle. (Secret bundle version summary objects do not include the actual contents of the secret.) + properties: + secretId: + description: The OCID of the secret. + type: string + stages: + description: A list of possible rotation states for the secret bundle. + items: + enum: + - CURRENT + - PENDING + - LATEST + - PREVIOUS + - DEPRECATED + type: string + x-obmcs-inline-enum: true + type: array + timeCreated: + description: The time when the secret bundle was created. + format: date-time + type: string + timeOfDeletion: + description: | + An optional property indicating when to delete the secret version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + timeOfExpiry: + description: | + An optional property indicating when the secret version will expire, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + versionName: + description: | + The version name of the secret bundle, as provided when the secret was created or last rotated. + type: string + versionNumber: + description: The version number of the secret. + format: int64 + type: integer + required: + - secretId + - versionNumber + type: object + x-example: | + [ + { + "secretId": "ocid1.vaultsecret.oc1.iad.exampleaz5qacpqadubrc4wwugrqmw5dnyzvcxwzds6er5enn2oamexample", + "timeCreated": "2020-03-18T16:51:38.851Z", + "versionNumber": 1, + “versionName” : null, + “timeOfDeletion” : null, + “timeOfExpiry” : null, + “stages” : [ “CURRENT”, “LATEST” ] + } + ] + SecretBundleContentDetails: + description: The contents of the secret. + discriminator: + propertyName: contentType + properties: + contentType: + description: The formatting type of the secret contents. + enum: + - BASE64 + type: string + x-obmcs-inline-enum: true + required: + - contentType + type: object + x-example: | + { + "contentType": "BASE64" + } + Error: + description: An error. + properties: + code: + description: | + A short error code that defines the error, meant for programmatic parsing. See + [API Errors](/Content/API/References/apierrors.htm). + type: string + message: + description: A human-readable error string. + type: string + required: + - code + - message + type: object + ListSecretBundleVersionsResponse: + type: object + properties: + secret_bundle_versions: + type: array + items: + $ref: '#/components/schemas/SecretBundleVersionSummary' + responses: + '400': + $ref: '#/components/responses/Error' + '401': + $ref: '#/components/responses/Error' + '404': + $ref: '#/components/responses/Error' + '429': + $ref: '#/components/responses/Error' + '500': + $ref: '#/components/responses/Error' + DefaultError: + $ref: '#/components/responses/Error' + Error: + description: An error response. + headers: + opc-request-id: + description: Unique identifier for the request. + schema: + type: string + content: + '*/*': + schema: + $ref: '#/components/schemas/Error' + parameters: + SecretNameQueryParam: + description: A user-friendly name for the secret. Secret names are unique within a vault. Secret names are case-sensitive. + in: query + name: secretName + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + VaultIdQueryParam: + description: The OCID of the vault that contains the secret. + in: query + name: vaultId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + OpcRequestIdHeaderParam: + description: Unique identifier for the request. + in: header + name: opc-request-id + required: false + schema: + type: string + SecretVersionNumberQueryParam: + description: The version number of the secret. + in: query + name: versionNumber + required: false + x-default-description: The default value is `0`, which indicates a non-existent version. + schema: + type: integer + format: int64 + default: 0 + SecretVersionNameQueryParam: + description: The name of the secret. (This might be referred to as the name of the secret version. Names are unique across the different versions of a secret.) + in: query + name: secretVersionName + required: false + x-default-description: The default value is null. + schema: + type: string + StageQueryParam: + description: The rotation state of the secret version. + in: query + name: stage + required: false + x-default-description: The default value is null. + x-obmcs-inline-enum: true + schema: + type: string + enum: + - CURRENT + - PENDING + - LATEST + - PREVIOUS + - DEPRECATED + SecretIdRequiredPathParam: + description: The OCID of the secret. + in: path + name: secretId + required: true + schema: + type: string + PaginationLimitQueryParam: + description: | + The maximum number of items to return in a paginated "List" call. For information about pagination, see + [List Pagination](../../../#API/Concepts/usingapi.htm#List_Pagination). + in: query + name: limit + schema: + type: integer + minimum: 1 + maximum: 1000 + default: 10 + PaginationTokenQueryParam: + description: | + The value of the `opc-next-page` response header from the previous "List" call. For information about + pagination, see [List Pagination](../../../#API/Concepts/usingapi.htm#List_Pagination). + in: query + name: page + x-default-description: The default value is null. + schema: + type: string + minLength: 1 + maxLength: 512 + SortByQueryParam: + description: | + The field to sort by. You can specify only one sort order. The default + order for `VERSION_NUMBER` is descending. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - VERSION_NUMBER + default: VERSION_NUMBER + SortOrderQueryParam: + description: | + The sort order to use, either ascending (`ASC`) or descending (`DESC`). + in: query + name: sortOrder + required: false + x-obmcs-inline-enum: true + schema: + type: string + enum: + - ASC + - DESC + default: DESC + x-stackQL-resources: + secretbundles: + id: oci.secrets.secretbundles + name: secretbundles + title: Secretbundles + methods: + get_secret_bundle_by_name: + operation: + $ref: '#/paths/~1secretbundles~1actions~1getByName/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + secret_bundles: + id: oci.secrets.secret_bundles + name: secret_bundles + title: Secret Bundles + methods: + get: + operation: + $ref: '#/paths/~1secretbundles~1{secretId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/secret_bundles/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + secret_bundle_versions: + id: oci.secrets.secret_bundle_versions + name: secret_bundle_versions + title: Secret Bundle Versions + methods: + list: + operation: + $ref: '#/paths/~1secretbundles~1{secretId}~1versions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.secret_bundle_versions + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListSecretBundleVersionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"secret_bundle_versions\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/secret_bundle_versions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://secrets.vaults.{region}.oci.oraclecloud.com/20190301 + variables: + region: + default: us-ashburn-1 + description: OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. + x-stackQL-envVar: OCI_REGION +x-stackQL-config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: opc-next-page + location: header diff --git a/providers/src/oci/v00.00.00000/services/streaming.yaml b/providers/src/oci/v00.00.00000/services/streaming.yaml new file mode 100644 index 00000000..8906a88b --- /dev/null +++ b/providers/src/oci/v00.00.00000/services/streaming.yaml @@ -0,0 +1,4050 @@ +openapi: 3.0.0 +info: + title: streaming API + description: oci streaming API + version: '20180418' +paths: + /connectharnesses: + get: + description: Lists the connectharness. + operationId: ListConnectHarnesses + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/FilterByIdQueryParam' + - $ref: '#/components/parameters/FilterByNameQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/ConnectHarnessSummary/lifecycleState' + schema: + type: string + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: The list of connect harnesses. + 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-prev-page: + description: For list pagination. When this header appears in the response, previous pages of results exist. 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/ListConnectHarnessesResponse' + '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/DefaultError' + summary: Lists the connectharnesses. + tags: + - streamAdmin + x-example: | + GET /20180418/connectharnesses?compartmentId=<compartmentId>&limit=10&page=1 + Host: streaming.us-phoenix-1.oraclecloud.com + <authorization and other headers> + post: + description: | + Starts the provisioning of a new connect harness. + To track the progress of the provisioning, you can periodically call [GetConnectHarness]. + In the response, the `lifecycleState` parameter of the [ConnectHarness](#/en/streaming/20180418/ConnectHarness/) object tells you its current state. + operationId: CreateConnectHarness + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateConnectHarnessDetails' + description: The connect harness to create. + required: true + responses: + '200': + description: Created + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. You can use this to query + status of the asynchronous operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ConnectHarness' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '409': + $ref: '#/components/responses/409' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Create a connect harness + tags: + - streamAdmin + x-example: | + POST /20180418/connectharnesses + Host: streaming.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta", + "name": "mynewconnectharness" + } + /connectharnesses/{connectHarnessId}: + delete: + description: | + Deletes a connect harness and its content. Connect harness contents are deleted immediately. The service retains records of the connect harness itself for 90 days after deletion. + The `lifecycleState` parameter of the `ConnectHarness` object changes to `DELETING` and the connect harness becomes inaccessible for read or write operations. + To verify that a connect harness has been deleted, make a [GetConnectHarness](#/en/streaming/20180418/ConnectHarness/GetConnectHarness) request. If the call returns the connect harness's + lifecycle state as `DELETED`, then the connect harness has been deleted. If the call returns a "404 Not Found" error, that means all records of the + connect harness have been deleted. + operationId: DeleteConnectHarness + parameters: + - $ref: '#/components/parameters/ConnectHarnessIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/OpcIfMatchHeaderParam' + responses: + '204': + description: The connect harness is being 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: | + Unique Oracle-assigned identifier for the asynchronous request. You can use this to query + status of the asynchronous operation. + schema: + type: string + '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/DefaultError' + summary: Deletes a connect harness. + tags: + - streamAdmin + x-example: | + DELETE /20180418/connectharnesses/<connectHarnessId> + Host: streaming.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/ConnectHarness' + get: + description: Gets detailed information about a connect harness. + operationId: GetConnectHarness + parameters: + - $ref: '#/components/parameters/ConnectHarnessIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: Success + 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/ConnectHarness' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Gets a connectharness + tags: + - streamAdmin + x-example: | + GET /20180418/connectharnesses/<connectHarnessId> + Host: streaming.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the tags applied to the connect harness. + operationId: UpdateConnectHarness + parameters: + - $ref: '#/components/parameters/ConnectHarnessIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/OpcIfMatchHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateConnectHarnessDetails' + description: The connect harness is updated with the tags provided. + required: true + responses: + '200': + description: Updated + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. You can use this to query + status of the asynchronous operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ConnectHarness' + '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/DefaultError' + summary: Updates a connect harness. + tags: + - streamAdmin + x-example: | + PUT /20180418/connectharnesses/<connectHarnessId> + Host: streaming.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "definedTags": { + "Operations": { + "CostCenter": "42" + } + }, + "freeformTags": { + "Department": "Finance" + } + } + /connectharnesses/{connectHarnessId}/actions/changeCompartment: + post: + description: Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource. + operationId: ChangeConnectHarnessCompartment + parameters: + - $ref: '#/components/parameters/ConnectHarnessIdPathParam' + - $ref: '#/components/parameters/OpcIfMatchHeaderParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeConnectHarnessCompartmentDetails' + description: The connect harness will be moved into the compartment specified within this entity. + required: true + responses: + '204': + description: ConnectHarness's compartment has been changed. + 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: | + Unique Oracle-assigned identifier for the asynchronous request. You can use this to query + status of the asynchronous operation. + schema: + type: string + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Moves a resource into a different compartment. + tags: + - streamAdmin + x-related-resource: '#/definitions/ConnectHarness' + /streampools: + get: + description: List the stream pools for a given compartment ID. + operationId: ListStreamPools + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/FilterByIdQueryParam' + - $ref: '#/components/parameters/FilterByNameQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/StreamPoolSummary/lifecycleState' + schema: + type: string + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: A list containing the stream pools for the compartment. + 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-prev-page: + description: For list pagination. When this header appears in the response, previous pages of results exist. 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/ListStreamPoolsResponse' + '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/DefaultError' + summary: List the stream pools for a given compartment ID. + tags: + - streamAdmin + x-example: | + GET /20180418/streampools?compartmentId=<compartmentId> + Host: streaming.us-phoenix-1.oraclecloud.com + <authorization and other headers> + post: + description: | + Starts the provisioning of a new stream pool. + To track the progress of the provisioning, you can periodically call GetStreamPool. + In the response, the `lifecycleState` parameter of the object tells you its current state. + operationId: CreateStreamPool + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateStreamPoolDetails' + description: The stream pool to create. + required: true + responses: + '200': + description: Created + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. You can use this to query + status of the asynchronous operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/StreamPool' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '409': + $ref: '#/components/responses/409' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Creates a stream pool. + tags: + - streamAdmin + x-example: | + POST /20180418/streampools + Host: streaming.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta", + "name": "MyStreamPool" + } + /streampools/{streamPoolId}: + delete: + description: | + Deletes a stream pool. All containing streams will also be deleted. + The default stream pool of a compartment cannot be deleted. + operationId: DeleteStreamPool + parameters: + - $ref: '#/components/parameters/StreamPoolIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/OpcIfMatchHeaderParam' + responses: + '204': + description: The stream pool is being 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: | + Unique Oracle-assigned identifier for the asynchronous request. You can use this to query + status of the asynchronous operation. + schema: + type: string + '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/DefaultError' + summary: Deletes a stream pool. + tags: + - streamAdmin + x-example: | + DELETE /20180418/streampools/<streamPoolId> + Host: streaming.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/StreamPool' + get: + description: Gets detailed information about the stream pool, such as Kafka settings. + operationId: GetStreamPool + parameters: + - $ref: '#/components/parameters/StreamPoolIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: Success + 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/StreamPool' + '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/DefaultError' + summary: Gets the stream pool + tags: + - streamAdmin + x-example: | + GET /20180418/streampools/<streamPoolId> + Host: streaming.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the specified stream pool. + operationId: UpdateStreamPool + parameters: + - $ref: '#/components/parameters/StreamPoolIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/OpcIfMatchHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateStreamPoolDetails' + description: The pool is updated with the provided fields. + required: true + responses: + '200': + description: Updated + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. You can use this to query + status of the asynchronous operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/StreamPool' + '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/DefaultError' + summary: Updates the stream pool. + tags: + - streamAdmin + x-example: | + PUT /20180418/streampools/<streamPoolId> + Host: streaming.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "kafkaSettings": { + "autoCreateTopicsEnable": true, + "logRetentionHours": 24, + "numPartitions": 1 + } + } + /streampools/{streamPoolId}/actions/changeCompartment: + post: + description: Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource. + operationId: ChangeStreamPoolCompartment + parameters: + - $ref: '#/components/parameters/StreamPoolIdPathParam' + - $ref: '#/components/parameters/OpcIfMatchHeaderParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeStreamPoolCompartmentDetails' + description: The stream pool will be moved into the compartment specified within this entity. + required: true + responses: + '204': + description: The compartment has been changed. + 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: | + Unique Oracle-assigned identifier for the asynchronous request. You can use this to query + status of the asynchronous operation. + 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' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Moves a resource into a different compartment. + tags: + - streamAdmin + x-related-resource: '#/definitions/StreamPool' + /streams: + get: + description: | + Lists the streams in the given compartment id. + If the compartment id is specified, it will list streams in the compartment, regardless of their stream pool. + If the stream pool id is specified, the action will be scoped to that stream pool. + The compartment id and stream pool id cannot be specified at the same time. + operationId: ListStreams + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryOptionalParam' + - $ref: '#/components/parameters/StreamPoolIdQueryParam' + - $ref: '#/components/parameters/FilterByIdQueryParam' + - $ref: '#/components/parameters/FilterByNameQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - description: | + A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/Stream/lifecycleState' + schema: + type: string + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: The list of streams. + 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-prev-page: + description: For list pagination. When this header appears in the response, previous pages of results exist. 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/ListStreamsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Lists the streams in the given compartment id. + tags: + - streamAdmin + x-example: | + GET /20180418/streams?compartmentId=<compartmentId>&limit=10&page=1 + Host: streaming.us-phoenix-1.oraclecloud.com + <authorization and other headers> + post: + description: | + Starts the provisioning of a new stream. + The stream will be created in the given compartment id or stream pool id, depending on which parameter is specified. + Compartment id and stream pool id cannot be specified at the same time. + To track the progress of the provisioning, you can periodically call [GetStream](#/en/streaming/20180418/Stream/GetStream). + In the response, the `lifecycleState` parameter of the [Stream](#/en/streaming/20180418/Stream/) object tells you its current state. + operationId: CreateStream + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateStreamDetails' + description: The stream to create. + required: true + responses: + '200': + description: Created + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. You can use this to query + status of the asynchronous operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Stream' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '409': + description: A stream with an identical name already exists. + 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' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Creates a stream. + tags: + - streamAdmin + x-example: | + POST /20180418/streams + Host: streaming.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "compartmentId": "ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta", + "name": "mynewstream", + "partitions": "4" + } + /streams/{streamId}: + delete: + description: | + Deletes a stream and its content. Stream contents are deleted immediately. The service retains records of the stream itself for 90 days after deletion. + The `lifecycleState` parameter of the `Stream` object changes to `DELETING` and the stream becomes inaccessible for read or write operations. + To verify that a stream has been deleted, make a [GetStream](#/en/streaming/20180418/Stream/GetStream) request. If the call returns the stream's + lifecycle state as `DELETED`, then the stream has been deleted. If the call returns a "404 Not Found" error, that means all records of the + stream have been deleted. + operationId: DeleteStream + parameters: + - $ref: '#/components/parameters/StreamIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/OpcIfMatchHeaderParam' + responses: + '204': + description: The stream is being 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: | + Unique Oracle-assigned identifier for the asynchronous request. You can use this to query + status of the asynchronous operation. + schema: + type: string + '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/DefaultError' + summary: Deletes a stream. + tags: + - streamAdmin + x-example: | + DELETE /20180418/streams/<streamId> + Host: streaming.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/Stream' + get: + description: Gets detailed information about a stream, including the number of partitions. + operationId: GetStream + parameters: + - $ref: '#/components/parameters/StreamIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: Success + 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/Stream' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Gets a stream + tags: + - streamAdmin + x-example: | + GET /20180418/streams/<streamId> + Host: streaming.us-phoenix-1.oraclecloud.com + <authorization and other headers> + put: + description: | + Updates the stream. Only specified values will be updated. + operationId: UpdateStream + parameters: + - $ref: '#/components/parameters/StreamIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/OpcIfMatchHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateStreamDetails' + description: The stream is updated with the values provided. + required: true + responses: + '200': + description: Updated + 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 + opc-work-request-id: + description: | + Unique Oracle-assigned identifier for the asynchronous request. You can use this to query + status of the asynchronous operation. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Stream' + '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/DefaultError' + summary: Updates a stream. + tags: + - streamAdmin + x-example: | + PUT /20180418/streams/<streamId> + Host: streaming.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "definedTags": { + "Operations": { + "CostCenter": "42" + } + }, + "freeformTags": { + "Department": "Finance" + }, + "streamPoolId": "ocid1.streampool.realm.region.zxcvbn432765" + } + /streams/{streamId}/actions/changeCompartment: + post: + description: | + Moves a resource into a different compartment. + When provided, If-Match is checked against ETag values of the resource. + The stream will also be moved into the default stream pool in the destination compartment. + operationId: ChangeStreamCompartment + parameters: + - $ref: '#/components/parameters/StreamIdPathParam' + - $ref: '#/components/parameters/OpcIfMatchHeaderParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeStreamCompartmentDetails' + description: The stream will be moved into the compartment specified within this entity. + required: true + responses: + '204': + description: Stream's compartment has been changed. + 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: | + Unique Oracle-assigned identifier for the asynchronous request. You can use this to query + status of the asynchronous operation. + schema: + type: string + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '409': + $ref: '#/components/responses/409' + '412': + $ref: '#/components/responses/412' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Moves a resource into a different compartment. + tags: + - streamAdmin + x-related-resource: '#/definitions/Stream' + /streams/{streamId}/commit: + post: + description: | + Provides a mechanism to manually commit offsets, if not using commit-on-get consumer semantics. + This commits offsets assicated with the provided cursor, extends the timeout on each of the affected partitions, and returns an updated cursor. + operationId: ConsumerCommit + parameters: + - $ref: '#/components/parameters/StreamIdPathParam' + - $ref: '#/components/parameters/GroupCursorQueryParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: Offsets were committeed successfully. + 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/Cursor' + '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/DefaultError' + summary: Commits processed offsets to consumer group state. + tags: + - stream + x-related-resource: '#/definitions/Group' + /streams/{streamId}/cursors: + post: + description: | + Creates a cursor. Cursors are used to consume a stream, starting from a specific point in the partition and going forward from there. + You can create a cursor based on an offset, a time, the trim horizon, or the most recent message in the stream. As the oldest message + inside the retention period boundary, using the trim horizon effectively lets you consume all messages in the stream. A cursor based + on the most recent message allows consumption of only messages that are added to the stream after you create the cursor. Cursors expire + five minutes after you receive them from the service. + operationId: CreateCursor + parameters: + - $ref: '#/components/parameters/StreamIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCursorDetails' + description: The information used to create the cursor. + required: true + responses: + '200': + description: Created + 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/Cursor' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Creates a cursor for the specified stream. A cursor is used to consume a stream. + tags: + - stream + x-example: | + POST /20180418/streams/<streamId>/cursors + Host: streaming-api.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "partition": "0", + "type": "TRIM_HORIZON" # Cursor will point to the oldest message in the partition that is within the retention period window. + } + OR + { + "partition": "0", + "type": "LATEST", # Cursor will point to the most recent message in the partition that was added after the cursor was created + } + OR + { + "partition": "0", + "type": "AT_OFFSET", # Cursor will point to the offset specified in the offset parameter + "offset": 342334L + } + OR + { + "partition": "0", + "type": "AFTER_OFFSET", # Cursor will point to the position immediately following the offset specified in the offset parameter + "offset": 34233434L + } + OR + { + "partition": "0", + "type": "AT_TIME", # Cursor will point to the specific point in time + "time": "Fri Feb 21 15:36:49 UTC 2042" + } + /streams/{streamId}/groupCursors: + post: + description: | + Creates a group-cursor. + operationId: CreateGroupCursor + parameters: + - $ref: '#/components/parameters/StreamIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateGroupCursorDetails' + description: The information used to create the cursor. + required: true + responses: + '200': + description: Created + 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/Cursor' + '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/DefaultError' + summary: Creates a group-cursor for the specified stream. A cursor is used to consume a stream. + tags: + - stream + x-related-resource: '#/definitions/Cursor' + /streams/{streamId}/groups/{groupName}: + get: + description: | + Returns the current state of a consumer group. + operationId: GetGroup + parameters: + - $ref: '#/components/parameters/StreamIdPathParam' + - description: The name of the consumer group. + in: path + name: groupName + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: Group State + 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/Group' + '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/DefaultError' + summary: Returns the current state of a consumer group. + tags: + - stream + x-example: | + GET /20180418/<streamId>/groups/<groupName> + Host: streaming.us-phoenix-1.oraclecloud.com + <authorization and other headers> + + HTTP/1.1 200 OK + Content-Length: 276 + Content-Type: application/json + Date: Mon, 09 Jul 2018 21:19:03 GMT + opc-request-id: /A8E351184AEE4F026738B89AD2058120/B484F7819E9FE5A487EA3091D2E4G5A9 + { + "group": { + "groupName": "group1", + "reservations": [ + { + "committedOffset": 20, + "partition": "0", + "reservedInstance": "51464135-9edd-4857-909c-fbfbf1c2ca8e", + "timeReservedUntil": "2018-07-09T21:17:44.554Z" + }, { + "committedOffset": 32, + "partition": "1", + "reservedInstance": "51464135-9edd-4857-909c-fbfbfabcdefg", + "timeReservedUntil": "2018-07-09T21:17:44.554Z" + }, { + "committedOffset": 103, + "partition": "2", + "reservedInstance": "51464135-9edd-4857-909c-fbfbf1c2ca8e", + "timeReservedUntil": "2018-07-09T21:17:44.554Z" + } + ], + "streamId": "ocid1.stream.desktop..aaaaaaaaiegcfiu3pprvc3p4uase4pvaazbspmxfq6ztzu72skwlabcdefga" + } + } + put: + description: | + Forcefully changes the current location of a group as a whole; reseting processing location of all consumers to a particular location in the stream. + operationId: UpdateGroup + parameters: + - $ref: '#/components/parameters/StreamIdPathParam' + - description: The name of the consumer group. + in: path + name: groupName + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateGroupDetails' + description: The information used to modify the group. + required: true + responses: + '200': + description: Group details 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 + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Forcefully changes the committed location of a group on a stream. + tags: + - stream + x-related-resource: '#/definitions/Group' + /streams/{streamId}/heartbeat: + post: + description: | + Allows long-running processes to extend the timeout on partitions reserved by a consumer instance. + operationId: ConsumerHeartbeat + parameters: + - $ref: '#/components/parameters/StreamIdPathParam' + - $ref: '#/components/parameters/GroupCursorQueryParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: Success + 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/Cursor' + '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/DefaultError' + summary: Extends the reservation timeout on partitions reserved by the provided cursor. + tags: + - stream + x-related-resource: '#/definitions/Group' + /streams/{streamId}/messages: + get: + description: | + Returns messages from the specified stream using the specified cursor as the starting point for consumption. By default, the number of messages returned is undefined, but the service returns as many as possible. + To get messages, you must first obtain a cursor using the [CreateCursor](#/en/streaming/20180418/Cursor/CreateCursor) operation. + In the response, retrieve the value of the 'opc-next-cursor' header to pass as a parameter to get the next batch of messages in the stream. + operationId: GetMessages + parameters: + - $ref: '#/components/parameters/StreamIdPathParam' + - description: | + The cursor used to consume the stream. + in: query + name: cursor + required: true + schema: + type: string + - description: | + The maximum number of messages to return. You can specify any value up to 10000. By default, the service returns as many messages as possible. + Consider your average message size to help avoid exceeding throughput on the stream. + in: query + name: limit + required: false + x-default-description: By default, the service will return as much as possible within the preset limit for total bytes transferred per call. + schema: + type: integer + minimum: 1 + maximum: 10000 + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: Success + headers: + opc-next-cursor: + description: The cursor to use to get the next batch of messages. + 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/GetMessagesResponse' + '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/DefaultError' + summary: Gets messages from a stream. + tags: + - stream + x-example: | + GET /20180418/streams/<streamId>/messages?cursor=<cursor>&limit=100 + Host: streaming.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-stackql-bare-array-wrap: + wrapperKey: messages + wrapperName: GetMessagesResponse + mediaType: application/json + scalar: false + post: + description: | + Emits messages to a stream. There's no limit to the number of messages in a request, but the total size of a message or request must be 1 MiB or less. + The service calculates the partition ID from the message key and stores messages that share a key on the same partition. + If a message does not contain a key or if the key is null, the service generates a message key for you. + The partition ID cannot be passed as a parameter. + operationId: PutMessages + parameters: + - $ref: '#/components/parameters/StreamIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PutMessagesDetails' + description: Array of messages to put into the stream. + required: true + responses: + '200': + description: Success + 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/PutMessagesResult' + '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/DefaultError' + summary: Puts messages in a stream. + tags: + - stream + x-example: | + POST /20180418/streams/<streamId>/messages + Host: streaming-api.us-phoenix-1.oraclecloud.com + <authorization and other headers> + { + "messages": + { + { + "key": null, + "value": "VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wZWQgb3ZlciB0aGUgbGF6eSBkb2cu" + }, + { + "key": null, + "value": "UGFjayBteSBib3ggd2l0aCBmaXZlIGRvemVuIGxpcXVvciBqdWdzLg==" + } + } + } + x-obmcs-signing-strategy: exclude_body + x-related-resource: '#/definitions/Message' + /workRequests: + get: + description: | + Lists the work requests in a compartment. + operationId: ListWorkRequests + parameters: + - $ref: '#/components/parameters/WorkRequestIdQueryOptionalParam' + - $ref: '#/components/parameters/CompartmentIdQueryOptionalParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/WorkRequestSortByQueryParam' + - $ref: '#/components/parameters/ResourceIdentifierQueryParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: The list of work requests was retrieved. + 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-prev-page: + description: For list pagination. When this header appears in the response, previous pages of results exist. 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/WorkRequestSummaryCollection' + '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/DefaultError' + summary: List Work Requests + tags: + - streamAdmin + x-obmcs-client-retries-enabled: true + /workRequests/{workRequestId}: + get: + description: Gets the details of a work request. + operationId: GetWorkRequest + parameters: + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: The work request was retrieved. + 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/WorkRequest' + '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/DefaultError' + summary: GET Work Request Status + tags: + - streamAdmin + x-obmcs-client-retries-enabled: true + /workRequests/{workRequestId}/errors: + get: + description: | + Lists the errors for a work request. + operationId: ListWorkRequestErrors + parameters: + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/WorkRequestSortByQueryParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: The list of work request errors was retrieved. + 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-prev-page: + description: For list pagination. When this header appears in the response, previous pages of results exist. 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/WorkRequestErrorCollection' + '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/DefaultError' + summary: Lists work request errors + tags: + - streamAdmin + x-obmcs-client-retries-enabled: true + /workRequests/{workRequestId}/logs: + get: + description: | + Lists the logs for a work request. + operationId: ListWorkRequestLogs + parameters: + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/WorkRequestSortByQueryParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: The list of work request logs. + 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-prev-page: + description: For list pagination. When this header appears in the response, previous pages of results exist. 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/WorkRequestLogEntryCollection' + '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/DefaultError' + summary: Lists work request logs + tags: + - streamAdmin + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/WorkRequestLogEntry' +components: + schemas: + ConnectHarnessSummary: + description: Summary representation of a ConnectHarness. + properties: + compartmentId: + description: The OCID of the compartment that contains the connect harness. + example: ocid1.compartment.realm.region.zxcvbn432765 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/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 that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the connect harness. + example: ocid1.connectharness.realm.region.mnopqr789 + type: string + lifecycleState: + description: The current state of the connect harness. + enum: + - CREATING + - ACTIVE + - DELETING + - DELETED + - FAILED + - UPDATING + type: string + name: + description: | + The name of the connect harness. + + Example: `TelemetryEvents` + example: TelemetryEvents + type: string + timeCreated: + description: | + The date and time the connect harness was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + format: date-time + type: string + required: + - name + - id + - compartmentId + - lifecycleState + - timeCreated + type: object + x-example: | + [ + { + "name": "config-topic", + "id": "ocid1.connectharness.oc1..exampleakzxrjqcvbj2rpflj6xqnej3gus4xse3fxmnfauxbdtovpuhywnua", + "compartmentId": "ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta", + "lifecycleState": "ACTIVE", + "timeCreated": "2018-04-25T23:28:30.629Z", + "messagesEndpoint": "https://streaming-api-1.us-phoenix-1.oraclecloud.com", + "freeformTags": { + "Department": "Finance" + }, + "definedTags": + { + "MyNamespace": + { + "CostCenter": "42" + } + } + }, + { + "name": "status-topic", + "id": "ocid1.connectharness.oc1..exampleak737ys3cvb5xs42lbuy3qr3wiqmfaux5ugnn7wmpvb4d2sgk7dmq", + "compartmentId": "ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta", + "lifecycleState": "ACTIVE", + "timeCreated": "2018-04-25T15:35:07.306Z", + "messagesEndpoint": "https://streaming-api-1.us-phoenix-1.oraclecloud.com", + "freeformTags": { }, + "definedTags": { } + } + ] + CreateConnectHarnessDetails: + description: Object used to create a connect harness. + properties: + compartmentId: + description: The OCID of the compartment that contains the connect harness. + example: ocid1.compartment.realm.region.zxcvbn432765 + maxLength: 1024 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/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 that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + name: + description: | + The name of the connect harness. Avoid entering confidential information. + + Example: `JDBCConnector` + example: JDBCConnector + maxLength: 1024 + minLength: 1 + type: string + required: + - name + - compartmentId + type: object + x-example: | + { + "compartmentId": "ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta", + "name": "jdbcconnector" + } + ConnectHarness: + description: Detailed representation of a connect harness. + properties: + compartmentId: + description: The OCID of the compartment that contains the connect harness. + example: ocid1.compartment.realm.region.zxcvbn432765 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/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. Exists for cross-compatibility only. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the connect harness. + example: ocid1.connectharness.realm.region.mnopqr789 + type: string + lifecycleState: + description: The current state of the connect harness. + enum: + - CREATING + - ACTIVE + - DELETING + - DELETED + - FAILED + - UPDATING + type: string + lifecycleStateDetails: + description: Any additional details about the current state of the connect harness. + type: string + name: + description: | + The name of the connect harness. Avoid entering confidential information. + + Example: `JDBCConnector` + example: TelemetryEvents + type: string + timeCreated: + description: | + The date and time the connect harness was created, expressed in in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + format: date-time + type: string + required: + - name + - id + - compartmentId + - lifecycleState + - timeCreated + type: object + x-example: | + { + "name": "mynewstream", + "id": "ocid1.stream.oc1..exampleakzxrjqcvbj2rpflj6xqnej3gus4xse3fxmnfauxbdtovpuhywnua", + "compartmentId": "ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta", + "lifecycleState": "CREATING", + "timeCreated": "2018-04-25T23:28:30.629Z", + "messagesEndpoint": "https://streaming-api-1.us-phoenix-1.oraclecloud.com", + "freeformTags": { }, + "definedTags": { } + } + UpdateConnectHarnessDetails: + description: Object used to update a connect harness. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/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 that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + type: object + ChangeConnectHarnessCompartmentDetails: + description: Detailed representation of a change connect harness compartment operation. + properties: + compartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment + into which the resource should be moved. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + StreamPoolSummary: + description: The summary representation of a stream pool. + properties: + compartmentId: + description: Compartment OCID that the pool belongs to. + example: ocid1.compartment.oc1..aaaaaaaa2byuam5ewxzrcs2iqzh7okx84jae6j4uhkih5wdbrkkwuxv3qgpa + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/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 that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the stream pool. + example: ocid1.streampool.realm.region.mnopqr789 + type: string + isPrivate: + description: | + True if the stream pool is private, false otherwise. + The associated endpoint and subnetId of a private stream pool can be retrieved through the [GetStreamPool](#/en/streaming/20180418/StreamPool/GetStreamPool) API. + type: boolean + lifecycleState: + description: The current state of the stream pool. + enum: + - CREATING + - ACTIVE + - DELETING + - DELETED + - FAILED + - UPDATING + type: string + name: + description: The name of the stream pool. + example: MyStreamPool + type: string + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". + (opaque JSON object) + type: string + description: | + Key-value pair representing a security attribute key and value, scoped to a namespace. + + Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` + type: object + description: | + Security attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` + type: object + timeCreated: + description: | + The date and time the stream pool was created, expressed in in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + format: date-time + type: string + required: + - id + - compartmentId + - name + - lifecycleState + - timeCreated + type: object + x-example: | + { + "id": "ocid1.streampool.realm.region.mnopqr789", + "compartmentId": "ocid1.compartment.oc1..aaaaaaaa2byuam5ewxzrcs2iqzh7okx84jae6j4uhkih5wdbrkkwuxv3qgpa", + "name": "MyStreamPool" + } + CreateStreamPoolDetails: + description: Object used to create a stream pool. + properties: + compartmentId: + description: The OCID of the compartment that contains the stream. + example: ocid1.compinstance.realm.region.zxcvbn432765 + maxLength: 1024 + minLength: 1 + type: string + customEncryptionKeyDetails: + $ref: '#/components/schemas/CustomEncryptionKeyDetails' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/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 that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + kafkaSettings: + $ref: '#/components/schemas/KafkaSettings' + name: + description: | + The name of the stream pool. Avoid entering confidential information. + + Example: `MyStreamPool` + example: MyStreamPool + maxLength: 1024 + minLength: 1 + type: string + privateEndpointDetails: + $ref: '#/components/schemas/PrivateEndpointDetails' + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". + (opaque JSON object) + type: string + description: | + Key-value pair representing a security attribute key and value, scoped to a namespace. + + Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` + type: object + description: | + Security attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` + type: object + required: + - name + - compartmentId + type: object + x-example: | + { + "compartmentId": "ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta", + "name": "MyStreamPool", + "kafkaSettings": { + "autoCreateTopicsEnable": false + } + StreamPool: + description: The details of a stream pool. + properties: + compartmentId: + description: Compartment OCID that the pool belongs to. + example: ocid1.compartment.oc1..aaaaaaaa2byuam5ewxzrcs2iqzh7okx84jae6j4uhkih5wdbrkkwuxv3qgpa + type: string + customEncryptionKey: + $ref: '#/components/schemas/CustomEncryptionKey' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Operations": {"CostCenter": "42"}}' + type: object + endpointFqdn: + description: | + The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a [Stream](#/en/streaming/20180418/Stream) object). + If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. + Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port. + 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. Exists for cross-compatibility only. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the stream pool. + example: ocid1.streampool.realm.region.mnopqr789 + type: string + isPrivate: + description: | + True if the stream pool is private, false otherwise. + If the stream pool is private, the streams inside the stream pool can only be accessed from inside the associated subnetId. + type: boolean + kafkaSettings: + $ref: '#/components/schemas/KafkaSettings' + lifecycleState: + description: The current state of the stream pool. + enum: + - CREATING + - ACTIVE + - DELETING + - DELETED + - FAILED + - UPDATING + type: string + lifecycleStateDetails: + description: Any additional details about the current state of the stream. + type: string + name: + description: The name of the stream pool. + example: MyStreamPool + type: string + privateEndpointSettings: + $ref: '#/components/schemas/PrivateEndpointSettings' + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". + (opaque JSON object) + type: string + description: | + Key-value pair representing a security attribute key and value, scoped to a namespace. + + Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` + type: object + description: | + Security attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` + type: object + timeCreated: + description: | + The date and time the stream pool was created, expressed in in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + format: date-time + type: string + required: + - id + - compartmentId + - name + - kafkaSettings + - customEncryptionKey + - lifecycleState + - timeCreated + type: object + x-example: | + { + "id": "ocid1.streampool.realm.region.mnopqr789", + "compartmentId": "ocid1.compartment.oc1..aaaaaaaa2byuam5ewxzrcs2iqzh7okx84jae6j4uhkih5wdbrkkwuxv3qgpa", + "name": "MyStreamPool", + "kafkaSettings": { + "autoCreateTopicsEnable": true, + "logRetentionHours": 24, + "numPartitions": 1, + }, + "freeformTags": {}, + "definedTags": {} + } + UpdateStreamPoolDetails: + description: Object used to update the stream pool's details. + properties: + customEncryptionKeyDetails: + $ref: '#/components/schemas/CustomEncryptionKeyDetails' + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/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 that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + kafkaSettings: + $ref: '#/components/schemas/KafkaSettings' + name: + description: | + The name of the stream pool. Avoid entering confidential information. + + Example: `MyStreamPool` + maxLength: 1024 + minLength: 1 + type: string + securityAttributes: + additionalProperties: + additionalProperties: + description: |- + Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". + (opaque JSON object) + type: string + description: | + Key-value pair representing a security attribute key and value, scoped to a namespace. + + Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` + type: object + description: | + Security attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` + type: object + type: object + ChangeStreamPoolCompartmentDetails: + description: Detailed representation of a change stream pool compartment operation. + properties: + compartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment + into which the resource should be moved. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + StreamSummary: + description: Summary representation of a stream. + properties: + compartmentId: + description: The OCID of the compartment that contains the stream. + example: ocid1.compinstance.realm.region.zxcvbn432765 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/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 that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the stream. + example: ocid1.stream.realm.region.mnopqr789 + type: string + lifecycleState: + description: The current state of the stream. + enum: + - CREATING + - ACTIVE + - DELETING + - DELETED + - FAILED + - UPDATING + type: string + messagesEndpoint: + description: | + The endpoint to use when creating the StreamClient to consume or publish messages in the stream. + If the associated stream pool is private, the endpoint is also private and can only be accessed from inside the stream pool's associated subnet. + type: string + name: + description: | + The name of the stream. + + Example: `TelemetryEvents` + example: TelemetryEvents + type: string + partitions: + description: The number of partitions in the stream. + example: 10 + type: integer + streamPoolId: + description: The OCID of the stream pool that contains the stream. + example: ocid1.streampool.realm.region.zxcvbn432765 + type: string + timeCreated: + description: | + The date and time the stream was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + format: date-time + type: string + required: + - name + - id + - partitions + - compartmentId + - lifecycleState + - timeCreated + - messagesEndpoint + - streamPoolId + type: object + x-example: | + [ + { + "name": "mynewstream", + "id": "ocid1.stream.oc1..exampleakzxrjqcvbj2rpflj6xqnej3gus4xse3fxmnfauxbdtovpuhywnua", + "partitions": 4, + "compartmentId": "ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta", + "lifecycleState": "ACTIVE", + "timeCreated": "2018-04-25T23:28:30.629Z", + "messagesEndpoint": "https://streaming-api-1.us-phoenix-1.oraclecloud.com", + "freeformTags": { + "Department": "Finance" + }, + "definedTags": + { + "MyNamespace": + { + "CostCenter": "42" + } + } + }, + { + "name": "Stream1", + "id": "ocid1.stream.oc1..exampleak737ys3cvb5xs42lbuy3qr3wiqmfaux5ugnn7wmpvb4d2sgk7dmq", + "partitions": 1, + "compartmentId": "ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta", + "lifecycleState": "ACTIVE", + "timeCreated": "2018-04-25T15:35:07.306Z", + "messagesEndpoint": "https://streaming-api-1.us-phoenix-1.oraclecloud.com", + "freeformTags": { }, + "definedTags": { } + } + ] + CreateStreamDetails: + description: Object used to create a stream. + properties: + compartmentId: + description: The OCID of the compartment that contains the stream. + example: ocid1.compinstance.realm.region.zxcvbn432765 + maxLength: 1024 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/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 that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + name: + description: | + The name of the stream. Avoid entering confidential information. + + Example: `TelemetryEvents` + example: TelemetryEvents + maxLength: 1024 + minLength: 1 + type: string + partitions: + description: The number of partitions in the stream. + example: 1 + minimum: 1 + type: integer + retentionInHours: + description: | + The retention period of the stream, in hours. Accepted values are between 24 and 168 (7 days). + If not specified, the stream will have a retention period of 24 hours. + example: 24 + type: integer + streamPoolId: + description: The OCID of the stream pool that contains the stream. + example: ocid1.streampool.realm.region.zxcvbn432765 + maxLength: 1024 + minLength: 1 + type: string + required: + - name + - partitions + type: object + x-example: | + { + "compartmentId": "ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta", + "name": "mynewstream", + "partitions": "4" + } + Stream: + description: Detailed representation of a stream, including all its partitions. + properties: + compartmentId: + description: The OCID of the stream. + example: ocid1.compinstance.realm.region.zxcvbn432765 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/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. Exists for cross-compatibility only. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the stream. + example: ocid1.stream.realm.region.mnopqr789 + type: string + lifecycleState: + description: The current state of the stream. + enum: + - CREATING + - ACTIVE + - DELETING + - DELETED + - FAILED + - UPDATING + type: string + lifecycleStateDetails: + description: Any additional details about the current state of the stream. + type: string + messagesEndpoint: + description: | + The endpoint to use when creating the StreamClient to consume or publish messages in the stream. + If the associated stream pool is private, the endpoint is also private and can only be accessed from inside the stream pool's associated subnet. + type: string + name: + description: | + The name of the stream. Avoid entering confidential information. + + Example: `TelemetryEvents` + example: TelemetryEvents + type: string + partitions: + description: The number of partitions in the stream. + example: 10 + type: integer + retentionInHours: + description: The retention period of the stream, in hours. This property is read-only. + example: 24 + type: integer + streamPoolId: + description: The OCID of the stream pool that contains the stream. + example: ocid1.streampool.realm.region.zxcvbn432765 + type: string + timeCreated: + description: | + The date and time the stream was created, expressed in in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. + + Example: `2018-04-20T00:00:07.405Z` + format: date-time + type: string + required: + - name + - id + - partitions + - compartmentId + - streamPoolId + - lifecycleState + - timeCreated + - retentionInHours + - messagesEndpoint + type: object + x-example: | + { + "name": "mynewstream", + "id": "ocid1.stream.oc1..exampleakzxrjqcvbj2rpflj6xqnej3gus4xse3fxmnfauxbdtovpuhywnua", + "partitions": 4, + "retentionInHours": 24, + "compartmentId": "ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta", + "lifecycleState": "CREATING", + "timeCreated": "2018-04-25T23:28:30.629Z", + "messagesEndpoint": "https://streaming-api-1.us-phoenix-1.oraclecloud.com", + "freeformTags": { }, + "definedTags": { } + } + Error: + description: The representation of an error. + properties: + code: + description: | + A short error code that defines the error, meant for programmatic parsing. See [API Errors](/Content/API/References/apierrors.htm). + type: string + message: + description: A human-readable error string. + type: string + required: + - code + - message + type: object + UpdateStreamDetails: + description: Object used to update a stream. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + 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](/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 that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. + For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). + + Example: `{"Department": "Finance"}` + type: object + streamPoolId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the stream pool where the stream should be moved. + maxLength: 255 + minLength: 1 + type: string + type: object + ChangeStreamCompartmentDetails: + description: Detailed representation of a change stream compartment operation. + properties: + compartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment + into which the resource should be moved. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + Cursor: + description: | + A cursor that indicates the position in the stream from which you want to begin consuming messages and which is required by the [GetMessages](#/en/streaming/20180418/Message/GetMessages) operation. + properties: + value: + description: The cursor to pass to the `GetMessages` operation. + type: string + required: + - value + type: object + x-example: | + { + "value": "examplelIjoiVHJpbUhcvbl6b24iLCJvZmZzZXQiOm51bGwsInRpbWUiOm51bGwsInBhcnRpdGlvbiI6IjAiLCJzdHJlYW1JZCI6Im9jaWQxLnN0cmVhbS5kZXNrdG9wLi5hYWFhYWFhYWN1ZG5udHFjeXN4dHF6NTZuNWVoYWZ3c3JudHp5dHhjNmF3cDM0N3dxa2R0Ymt2d3VpaXEiLCJleHBfaux0aW9uIjoxNTI0Njg0MDE3NzUwfQ==" + } + CreateCursorDetails: + description: Object used to create a cursor to consume messages in a stream. + properties: + offset: + description: The offset to consume from if the cursor type is `AT_OFFSET` or `AFTER_OFFSET`. + example: 42 + format: int64 + type: integer + partition: + description: The partition to get messages from. + minimum: 0 + type: string + time: + description: | + The time to consume from if the cursor type is `AT_TIME`, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. + format: date-time + type: string + type: + description: | + The type of cursor, which determines the starting point from which the stream will be consumed: + + - `AFTER_OFFSET:` The partition position immediately following the offset you specify. (Offsets are assigned when you successfully append a message to a partition in a stream.) + - `AT_OFFSET:` The exact partition position indicated by the offset you specify. + - `AT_TIME:` A specific point in time. + - `LATEST:` The most recent message in the partition that was added after the cursor was created. + - `TRIM_HORIZON:` The oldest message in the partition that is within the retention period window. + enum: + - AFTER_OFFSET + - AT_OFFSET + - AT_TIME + - LATEST + - TRIM_HORIZON + type: string + required: + - type + - partition + type: object + x-example: | + { + "partition": "0", + "type": "TRIM_HORIZON" + } + CreateGroupCursorDetails: + description: Object used to create a group cursor. + properties: + commitOnGet: + default: true + description: | + When using consumer-groups, the default commit-on-get behaviour can be overriden by setting this value to false. + If disabled, a consumer must manually commit their cursors. + type: boolean + groupName: + description: Name of the consumer group. + type: string + instanceName: + description: A unique identifier for the instance joining the consumer group. If an instanceName is not provided, a UUID will be generated and used. + type: string + time: + description: The time to consume from if type is AT_TIME. + format: date-time + type: string + timeoutInMs: + default: 30000 + description: The amount of a consumer instance inactivity time, before partition reservations are released. + format: int32 + minimum: 5000 + type: integer + type: + description: The type of the cursor. This value is only used when the group is created. + enum: + - AT_TIME + - LATEST + - TRIM_HORIZON + type: string + required: + - groupName + - type + type: object + Group: + description: | + Represents the current state of a consumer group, including partition reservations and committed offsets. + properties: + groupName: + description: The name of the consumer group. + type: string + reservations: + description: An array of the partition reservations of a group. + items: + $ref: '#/components/schemas/PartitionReservation' + type: array + streamId: + description: The streamId for which the group exists. + type: string + required: + - streamId + - groupName + type: object + UpdateGroupDetails: + description: | + Request body for operationally managing a group. + properties: + time: + description: The time to consume from if type is AT_TIME. + format: date-time + type: string + type: + description: The type of the cursor. + enum: + - AT_TIME + - LATEST + - TRIM_HORIZON + type: string + type: object + Message: + description: A message in a stream. + properties: + key: + description: The key associated with the message, expressed as a byte array. + format: byte + type: string + offset: + description: The offset of the message, which uniquely identifies it within the partition. + example: 42 + format: int64 + type: integer + partition: + description: The ID of the partition where the message is stored. + example: '1' + type: string + stream: + description: The name of the stream that the message belongs to. + example: ocid1.stream.realm.region.mnopqr789 + type: string + timestamp: + description: The timestamp indicating when the server appended the message to the stream. + format: date-time + type: string + value: + description: The value associated with the message, expressed as a byte array. + format: byte + type: string + required: + - stream + - partition + - key + - value + - offset + - timestamp + type: object + x-example: | + { + "stream": "mynewstream", + "partition": "0", + "key": null, + "value": "VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wZWQgb3ZlciB0aGUgbGF6eSBkb2cu", + "offset": 0, + "timestamp": "2018-04-26T01:03:06.051Z" + } + PutMessagesDetails: + description: Object that represents an array of messages to emit to a stream. + properties: + messages: + description: The array of messages to put into a stream. + items: + $ref: '#/components/schemas/PutMessagesDetailsEntry' + minItems: 1 + type: array + required: + - messages + type: object + x-example: | + { + "messages": + [ + { + "key": null, + "value": "VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wZWQgb3ZlciB0aGUgbGF6eSBkb2cu" + } + ] + } + PutMessagesResult: + description: | + The response to a [PutMessages](#/en/streaming/20180418/methods/PutMessages) request. It indicates the number + of failed messages as well as an array of results for successful and failed messages. + properties: + entries: + description: | + An array of items representing the result of each message. + The order is guaranteed to be the same as in the `PutMessagesDetails` object. + If a message was successfully appended to the stream, the entry includes the `offset`, `partition`, and `timestamp`. + If a message failed to be appended to the stream, the entry includes the `error` and `errorMessage`. + items: + $ref: '#/components/schemas/PutMessagesResultEntry' + minItems: 1 + type: array + failures: + description: The number of messages that failed to be added to the stream. + type: integer + required: + - failures + - entries + type: object + x-example: | + { + "failures": 0, + "entries": { + "partition": "3", + "offset": 0, + "timestamp": "2018-04-20T23:21:12.428Z" + } + } + WorkRequestSummaryCollection: + description: A list of work requests. Can contain both work requests and other information, such as metadata. + properties: + items: + description: A list of work requests. + items: + $ref: '#/components/schemas/WorkRequestSummary' + type: array + required: + - items + type: object + WorkRequest: + description: | + An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, + the service creates a work request. A work request is an activity log that lets you track each step in the operation's + progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. + type: string + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + type: string + operationType: + description: The asynchronous operation tracked by this work request. + enum: + - CREATE_STREAM + - UPDATE_STREAM + - DELETE_STREAM + - CREATE_STREAM_POOL + - UPDATE_STREAM_POOL + - DELETE_STREAM_POOL + - CREATE_CONNECT_HARNESS + - UPDATE_CONNECT_HARNESS + - DELETE_CONNECT_HARNESS + type: string + x-obmcs-top-level-enum: '#/definitions/OperationType' + percentComplete: + description: | + Shows the progress of the operation tracked by the work request, as a percentage of the total work + that must be performed. + format: float + type: number + resources: + description: The resources that are affected by the work request. + items: + $ref: '#/components/schemas/WorkRequestResource' + type: array + status: + description: The status of the work request. + enum: + - ACCEPTED + - IN_PROGRESS + - WAITING + - NEEDS_ATTENTION + - FAILED + - SUCCEEDED + - CANCELING + - CANCELED + type: string + x-obmcs-top-level-enum: '#/definitions/OperationStatus' + timeAccepted: + description: | + The date and time the request was created, as described in + [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. + format: date-time + type: string + timeFinished: + description: | + The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). + format: date-time + type: string + timeStarted: + description: | + The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), + section 14.29. + format: date-time + type: string + required: + - operationType + - status + - id + - compartmentId + - resources + - percentComplete + - timeAccepted + type: object + WorkRequestErrorCollection: + description: A list of work request errors. Can contain both errors and other information, such as metadata. + properties: + items: + description: A list of work request errors. + items: + $ref: '#/components/schemas/WorkRequestError' + type: array + required: + - items + type: object + WorkRequestLogEntryCollection: + description: A list of work request logs. Can contain both logs and other information, such as metadata. + properties: + items: + description: A list of work request log entries. + items: + $ref: '#/components/schemas/WorkRequestLogEntry' + type: array + required: + - items + type: object + CustomEncryptionKeyDetails: + description: The OCID of the custom encryption key to be used or deleted if currently being used. + properties: + kmsKeyId: + description: Custom Encryption Key (Master Key) ocid. + maxLength: 1024 + minLength: 1 + type: string + required: + - kmsKeyId + type: object + KafkaSettings: + description: Settings for the Kafka compatibility layer. + properties: + autoCreateTopicsEnable: + description: Enable auto creation of topic on the server. + type: boolean + bootstrapServers: + description: Bootstrap servers. + type: string + logRetentionHours: + description: The number of hours to keep a log file before deleting it (in hours). + maximum: 672 + minimum: 1 + type: integer + numPartitions: + description: The default number of log partitions per topic. + minimum: 1 + type: integer + type: object + PrivateEndpointDetails: + description: Optional parameters if a private stream pool is requested. + properties: + nsgIds: + description: | + The optional list of network security groups to be used with the private endpoint of the stream pool. + That value cannot be changed. + items: + type: string + maxLength: 1024 + minLength: 1 + type: array + uniqueItems: true + privateEndpointIp: + description: | + The optional private IP you want to be associated with your private stream pool. + That parameter can only be specified when the subnetId parameter is set. It cannot be changed. + The private IP needs to be part of the CIDR range of the specified subnetId or the creation will fail. + If not specified a random IP inside the subnet will be chosen. + After the stream pool is created, a custom FQDN, pointing to this private IP, is created. + The FQDN is then used to access the service instead of the private IP. + example: 10.0.0.5 + type: string + subnetId: + description: | + If specified, the stream pool will be private and only accessible from inside that subnet. + Producing-to and consuming-from a stream inside a private stream pool can also only be done from inside the subnet. + That value cannot be changed. + example: ocid1.subnet.realm.region.zxcvbn432765 + maxLength: 1024 + minLength: 1 + type: string + type: object + CustomEncryptionKey: + description: Custom Encryption Key which will be used for encryption by all the streams in the pool. + properties: + keyState: + description: Life cycle State of the custom key + enum: + - ACTIVE + - CREATING + - DELETING + - NONE + - FAILED + - UPDATING + type: string + kmsKeyId: + description: Custom Encryption Key (Master Key) ocid. + maxLength: 1024 + minLength: 1 + type: string + type: object + PrivateEndpointSettings: + description: Optional settings if the stream pool is private. + properties: + nsgIds: + description: The optional list of network security groups that are associated with the private endpoint of the stream pool. + items: + type: string + maxLength: 1024 + minLength: 1 + type: array + uniqueItems: true + privateEndpointIp: + description: | + The private IP associated with the stream pool in the associated subnetId. + The stream pool's FQDN resolves to that IP and should be used - instead of the private IP - in order to not trigger any TLS issues. + example: 10.0.0.5 + type: string + subnetId: + description: | + The subnet id from which the private stream pool can be accessed. + Trying to access the streams from another network location will result in an error. + example: ocid1.subnet.realm.region.zxcvbn432765 + type: string + type: object + PartitionReservation: + description: | + Represents the state of a single partition reservation. + properties: + committedOffset: + description: The latest offset which has been committed for this partition. + format: int64 + type: integer + partition: + description: The partition for which the reservation applies. + type: string + reservedInstance: + description: The consumer instance which currently has the partition reserved. + type: string + timeReservedUntil: + description: A timestamp when the current reservation expires. + format: date-time + type: string + type: object + PutMessagesDetailsEntry: + description: Object that represents a message to emit to a stream. + properties: + key: + description: | + The key of the message, expressed as a byte array up to 256 bytes in size. Messages with the same key are stored in the same partition. + format: byte + maxItems: 256 + type: string + value: + description: The message, expressed as a byte array up to 1 MiB in size. + format: byte + maxItems: 1048576 + minItems: 1 + type: string + required: + - value + type: object + PutMessagesResultEntry: + description: | + Represents the result of a [PutMessages](#/en/streaming/20180418/methods/PutMessages) request, whether it was successful or not. + If a message was successfully appended to the stream, the entry includes the `offset`, `partition`, and `timestamp`. + If the message failed to be appended to the stream, the entry includes the `error` and `errorMessage`. + properties: + error: + description: The error code, in case the message was not successfully appended to the stream. + type: string + errorMessage: + description: A human-readable error message associated with the error code. + type: string + offset: + description: The offset of the message in the partition. + example: 42 + format: int64 + type: integer + partition: + description: The ID of the partition where the message was stored. + example: '1' + type: string + timestamp: + description: The timestamp indicating when the server appended the message to the stream. + format: date-time + type: string + type: object + WorkRequestSummary: + description: | + An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, + the service creates a work request. A work request is an activity log that lets you track each step in the operation's + progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. + type: string + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + type: string + operationType: + description: The asynchronous operation tracked by this work request. + enum: + - CREATE_STREAM + - UPDATE_STREAM + - DELETE_STREAM + - CREATE_STREAM_POOL + - UPDATE_STREAM_POOL + - DELETE_STREAM_POOL + - CREATE_CONNECT_HARNESS + - UPDATE_CONNECT_HARNESS + - DELETE_CONNECT_HARNESS + type: string + x-obmcs-top-level-enum: '#/definitions/OperationType' + percentComplete: + description: | + Shows the progress of the operation tracked by the work request, as a percentage of the total work + that must be performed. + format: float + type: number + resources: + description: The resources that are affected by the work request. + items: + $ref: '#/components/schemas/WorkRequestResource' + type: array + status: + description: The status of the work request. + enum: + - ACCEPTED + - IN_PROGRESS + - WAITING + - NEEDS_ATTENTION + - FAILED + - SUCCEEDED + - CANCELING + - CANCELED + type: string + x-obmcs-top-level-enum: '#/definitions/OperationStatus' + timeAccepted: + description: | + The date and time the request was created, as described in + [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. + format: date-time + type: string + timeFinished: + description: | + The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). + format: date-time + type: string + timeStarted: + description: | + The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), + section 14.29. + format: date-time + type: string + required: + - operationType + - status + - id + - compartmentId + - resources + - percentComplete + - timeAccepted + type: object + WorkRequestResource: + description: A resource created or operated on by a work request. + properties: + actionType: + description: | + The way in which this resource is affected by the operation tracked in the work request. + A resource being created, updated, or deleted remains in the IN_PROGRESS state until + work is complete for that resource, at which point it transitions to CREATED, UPDATED, + or DELETED, respectively. + enum: + - CREATED + - UPDATED + - DELETED + - IN_PROGRESS + - RELATED + - FAILED + type: string + x-obmcs-top-level-enum: '#/definitions/ActionType' + entityType: + description: The resource type that the work request affects. + type: string + entityUri: + description: The URI path that you can use for a GET request to access the resource metadata + type: string + identifier: + description: An [OCID](/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource. + type: string + required: + - actionType + - entityType + - identifier + type: object + WorkRequestError: + description: An error encountered while performing an operation that is tracked by a work request. + properties: + code: + description: | + A machine-usable code for the error that occurred. For a list of error codes, see + [API Errors](/iaas/Content/API/References/apierrors.htm). + type: string + message: + description: A human-readable error message. + type: string + timestamp: + description: The date and time the error occurred, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + required: + - code + - message + - timestamp + type: object + WorkRequestLogEntry: + description: A log message from performing an operation that is tracked by a work request. + properties: + message: + description: A human-readable log message. + type: string + timestamp: + description: The date and time the log message was written, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). + format: date-time + type: string + required: + - message + - timestamp + type: object + ListConnectHarnessesResponse: + type: object + properties: + connect_harnesses: + type: array + items: + $ref: '#/components/schemas/ConnectHarnessSummary' + ListStreamPoolsResponse: + type: object + properties: + stream_pools: + type: array + items: + $ref: '#/components/schemas/StreamPoolSummary' + ListStreamsResponse: + type: object + properties: + streams: + type: array + items: + $ref: '#/components/schemas/StreamSummary' + GetMessagesResponse: + type: object + properties: + messages: + type: array + items: + $ref: '#/components/schemas/Message' + responses: + '400': + description: Bad Request + 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' + '401': + description: Unauthorized + 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' + '404': + description: Not Found + 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' + '409': + description: Conflict + 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' + '412': + description: NoEtagMatch + 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' + '429': + description: Too Many Requests + 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 + retry-after: + description: | + A retry-after header might be included to this response indicating how long to wait before making a new request. A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '500': + description: Internal Server 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' + DefaultError: + description: An error has occurred + 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' + parameters: + CompartmentIdQueryParam: + description: The OCID of the compartment. + in: query + name: compartmentId + required: true + schema: + type: string + minLength: 1 + maxLength: 1024 + FilterByIdQueryParam: + description: | + A filter to return only resources that match the given ID exactly. + in: query + name: id + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 1024 + FilterByNameQueryParam: + description: | + A filter to return only resources that match the given name exactly. + in: query + name: name + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 1024 + PaginationLimitQueryParam: + description: The maximum number of items to return. The value must be between 1 and 50. The default is 10. + in: query + name: limit + required: false + schema: + type: integer + minimum: 1 + maximum: 50 + default: 10 + PaginationTokenQueryParam: + description: The page at which to start retrieving results. + in: query + name: page + required: false + x-default-description: 'null' + schema: + type: string + minLength: 1 + maxLength: 1024 + SortByQueryParam: + description: | + The field to sort by. You can provide no more than one sort order. By default, `TIMECREATED` sorts results in descending order and `NAME` sorts results in ascending order. + in: query + name: sortBy + required: false + x-default-description: By default, TIMECREATED is used to sort by. + schema: + type: string + enum: + - NAME + - TIMECREATED + SortOrderQueryParam: + description: | + The sort order to use, either 'asc' or 'desc'. + in: query + name: sortOrder + required: false + x-default-description: For time-based fields, the default sort order is `DESC` (descending). For all others, it is `ASC` (ascending). + schema: + type: string + enum: + - ASC + - DESC + OpcRequestIdHeaderParam: + description: | + The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + OpcRetryTokenHeaderParam: + description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). + in: header + name: opc-retry-token + required: false + schema: + type: string + maxLength: 255 + ConnectHarnessIdPathParam: + description: | + The OCID of the connect harness. + in: path + name: connectHarnessId + required: true + schema: + type: string + minLength: 1 + maxLength: 256 + OpcIfMatchHeaderParam: + 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 + maxLength: 255 + StreamPoolIdPathParam: + description: | + The OCID of the stream pool. + in: path + name: streamPoolId + required: true + schema: + type: string + minLength: 1 + maxLength: 256 + CompartmentIdQueryOptionalParam: + description: The OCID of the compartment. Is exclusive with the `streamPoolId` parameter. One of them is required. + in: query + name: compartmentId + schema: + type: string + minLength: 1 + maxLength: 1024 + StreamPoolIdQueryParam: + description: The OCID of the stream pool. Is exclusive with the `compartmentId` parameter. One of them is required. + in: query + name: streamPoolId + schema: + type: string + minLength: 1 + maxLength: 1024 + StreamIdPathParam: + description: | + The OCID of the stream. + in: path + name: streamId + required: true + schema: + type: string + minLength: 1 + maxLength: 256 + GroupCursorQueryParam: + description: | + The group-cursor representing the offsets of the group. This cursor is retrieved from the CreateGroupCursor API call. + in: query + name: cursor + required: true + schema: + type: string + minLength: 1 + maxLength: 1024 + WorkRequestIdQueryOptionalParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. + in: query + name: workRequestId + required: false + schema: + type: string + WorkRequestSortByQueryParam: + description: | + The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending. + in: query + name: sortBy + schema: + type: string + enum: + - TIMEACCEPTED + default: TIMEACCEPTED + ResourceIdentifierQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request. + in: query + name: resourceId + x-default-description: 'null' + schema: + type: string + WorkRequestIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. + in: path + name: workRequestId + required: true + schema: + type: string + x-stackQL-resources: + connect_harnesses: + id: oci.streaming.connect_harnesses + name: connect_harnesses + title: Connect Harnesses + methods: + list: + operation: + $ref: '#/paths/~1connectharnesses/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.connect_harnesses + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListConnectHarnessesResponse' + transform: + body: |- + {{- $wrapped := printf "{\"connect_harnesses\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 50 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/connect_harnesses/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + connect_harness: + id: oci.streaming.connect_harness + name: connect_harness + title: Connect Harness + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1connectharnesses/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1connectharnesses~1{connectHarnessId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1connectharnesses~1{connectHarnessId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1connectharnesses~1{connectHarnessId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1connectharnesses~1{connectHarnessId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/connect_harness/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/connect_harness/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/connect_harness/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/connect_harness/methods/delete' + replace: [] + stream_pools: + id: oci.streaming.stream_pools + name: stream_pools + title: Stream Pools + methods: + list: + operation: + $ref: '#/paths/~1streampools/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.stream_pools + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListStreamPoolsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"stream_pools\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 50 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1streampools/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1streampools~1{streamPoolId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1streampools~1{streamPoolId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1streampools~1{streamPoolId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1streampools~1{streamPoolId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/stream_pools/methods/get' + - $ref: '#/components/x-stackQL-resources/stream_pools/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/stream_pools/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/stream_pools/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/stream_pools/methods/delete' + replace: [] + streams: + id: oci.streaming.streams + name: streams + title: Streams + methods: + list: + operation: + $ref: '#/paths/~1streams/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.streams + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListStreamsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"streams\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 50 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1streams/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1streams~1{streamId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1streams~1{streamId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1streams~1{streamId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1streams~1{streamId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/streams/methods/get' + - $ref: '#/components/x-stackQL-resources/streams/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/streams/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/streams/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/streams/methods/delete' + replace: [] + groups: + id: oci.streaming.groups + name: groups + title: Groups + methods: + get: + operation: + $ref: '#/paths/~1streams~1{streamId}~1groups~1{groupName}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1streams~1{streamId}~1groups~1{groupName}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/groups/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/groups/methods/update' + delete: [] + replace: [] + work_requests: + id: oci.streaming.work_requests + name: work_requests + title: Work Requests + methods: + list: + operation: + $ref: '#/paths/~1workRequests/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 50 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1workRequests~1{workRequestId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/work_requests/methods/get' + - $ref: '#/components/x-stackQL-resources/work_requests/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + work_request_errors: + id: oci.streaming.work_request_errors + name: work_request_errors + title: Work Request Errors + methods: + list: + operation: + $ref: '#/paths/~1workRequests~1{workRequestId}~1errors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 50 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/work_request_errors/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + work_request_logs: + id: oci.streaming.work_request_logs + name: work_request_logs + title: Work Request Logs + methods: + list: + operation: + $ref: '#/paths/~1workRequests~1{workRequestId}~1logs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 50 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/work_request_logs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://streaming.{region}.oci.oraclecloud.com/20180418 + variables: + region: + default: us-ashburn-1 + description: OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. + x-stackQL-envVar: OCI_REGION +x-stackQL-config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: opc-next-page + location: header diff --git a/providers/src/oci/v00.00.00000/services/usage.yaml b/providers/src/oci/v00.00.00000/services/usage.yaml new file mode 100644 index 00000000..e0bef34d --- /dev/null +++ b/providers/src/oci/v00.00.00000/services/usage.yaml @@ -0,0 +1,4069 @@ +openapi: 3.0.0 +info: + title: usage API + description: oci usage API + version: '20200107' +paths: + /averageCarbonEmissions/{skuPartNumber}: + get: + description: | + Returns the average carbon emissions summary by SKU. + operationId: RequestAverageCarbonEmission + parameters: + - $ref: '#/components/parameters/SkuPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: The average carbon emissions summary. + 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/AverageCarbonEmission' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Requests average carbon emissions by SKU. + tags: + - usageapi + x-related-resource: '#/definitions/AverageCarbonEmission' + /cleanEnergyUsages/{region}: + get: + description: | + Returns the clean energy usage summary by region. + operationId: RequestCleanEnergyUsage + parameters: + - $ref: '#/components/parameters/RegionPathParam' + - $ref: '#/components/parameters/AdQueryParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: The clean energy usage summary. + 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/CleanEnergyUsage' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Requests renewable/clean energy % used by region. + tags: + - usageapi + x-related-resource: '#/definitions/CleanEnergyUsage' + /configuration: + get: + description: | + Returns the configurations list for the UI drop-down list. + operationId: RequestSummarizedConfigurations + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - description: tenant id + in: query + name: tenantId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + responses: + '200': + description: The configuration used for the drop-down list. The value is a list of available items. + 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/ConfigurationAggregation' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Returns configurations. + tags: + - usageapi + x-related-resource: '#/definitions/Configuration' + /customTables: + get: + description: | + Returns the saved custom table list. + operationId: ListCustomTables + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/SavedReportIdQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The saved custom table list. + headers: + opc-next-page: + description: | + For pagination of a list of custom tables. If this header appears in the response, then this + is a partial list of custom tables. Include this value as the `page` parameter in a subsequent + GET request, to get the next batch of custom tables. + 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/CustomTableCollection' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Returns saved custom tables. + tags: + - usageapi + x-example: | + GET /20200107/customTables?compartmentId=<compartmentId>&savedReportId=<savedReportId> + Host: usageapi.us-ashburn-1.oci.oraclecloud.com + authorization: <authorization and other headers> + x-related-resource: '#/definitions/CustomTable' + post: + description: | + Returns the created custom table. + operationId: CreateCustomTable + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCustomTableDetails' + description: New custom table details. + required: true + responses: + '200': + description: Returns the created custom table ID/name. + 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/CustomTable' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/409Conflict' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Create a custom table. + tags: + - usageapi + x-example: | + POST /20200107/customTables + Host: usageapi.us-ashburn-1.oci.oraclecloud.com + authorization: <authorization and other headers> + { + "compartmentId": "ocid1.tenancy.oc1..testid", + "savedReportId": "testReportId", + "savedCustomTable": { + "displayName": "customTable1", + "rowGroupBy": [ + "string" + ], + "columnGroupBy": [ + "string" + ], + "groupByTag": null, + "compartmentDepth": 1, + "version": 1 + } + } + /customTables/{customTableId}: + delete: + description: | + Delete a saved custom table by the OCID. + operationId: DeleteCustomTable + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/CustomTableIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The custom table was successfully 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 + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/409Conflict' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Delete a custom table. + tags: + - usageapi + x-example: | + DELETE /20200107/customTables/<customTableId> + Host: usageapi.us-ashburn-1.oci.oraclecloud.com + authorization: <authorization and other headers> + x-related-resource: '#/definitions/CustomTable' + get: + description: | + Returns the saved custom table. + operationId: GetCustomTable + parameters: + - $ref: '#/components/parameters/CustomTableIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: The saved custom table. + 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/CustomTable' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Returns saved custom table. + tags: + - usageapi + x-example: | + GET /20200107/customTables/<customTableId> + Host: usageapi.us-ashburn-1.oci.oraclecloud.com + authorization: <authorization and other headers> + x-related-resource: '#/definitions/CustomTable' + put: + description: | + Update a saved custom table by table ID. + operationId: UpdateCustomTable + parameters: + - $ref: '#/components/parameters/CustomTableIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCustomTableDetails' + description: The information to be updated. + required: true + responses: + '200': + description: Returns the updated custom table. + 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/CustomTable' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/409Conflict' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Update a custom table. + tags: + - usageapi + x-example: | + PUT /20200107/customTables/<customTableId> + Host: usageapi.us-ashburn-1.oci.oraclecloud.com + authorization: <authorization and other headers> + { + "savedCustomTable": { + "displayName": "name1", + "rowGroupBy": [ + "string" + ], + "columnGroupBy": [ + "string" + ], + "groupByTag": null, + "compartmentDepth": 1, + "version": 1 + } + } + /queries: + get: + description: | + Returns the saved query list. + operationId: ListQueries + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The saved queries list. + headers: + opc-next-page: + description: | + For pagination of a list of Queries. If this header appears in the response, then this + is a partial list of Queries. Include this value as the `page` parameter in a subsequent + GET request, to get the next batch of Queries. + 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/QueryCollection' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Returns saved queries and UI properties. + tags: + - usageapi + x-related-resource: '#/definitions/Query' + post: + description: | + Returns the created query. + operationId: CreateQuery + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateQueryDetails' + description: New query details. Up to ten saved queries. + required: true + responses: + '200': + description: Returns the query ID/name. + 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/Query' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Create a query. + tags: + - usageapi + /queries/{queryId}: + delete: + description: | + Delete a saved query by the OCID. + operationId: DeleteQuery + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/QueryIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The Query was successfully 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 + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Delete a query. + tags: + - usageapi + x-related-resource: '#/definitions/Query' + get: + description: | + Returns the saved query. + operationId: GetQuery + parameters: + - $ref: '#/components/parameters/QueryIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: The saved query. + 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/Query' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Returns saved query. + tags: + - usageapi + x-related-resource: '#/definitions/Query' + put: + description: | + Update a saved query by the OCID. + operationId: UpdateQuery + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/QueryIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateQueryDetails' + description: The information to be updated. + required: true + responses: + '200': + description: Returns the updated query. + 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/Query' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Update a query. + tags: + - usageapi + /scheduledRuns: + get: + description: | + Returns the schedule history list. + operationId: ListScheduledRuns + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/ScheduleIdQueryParam' + - $ref: '#/components/parameters/ScheduledRunSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: Returns the schedule past runs list. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ScheduledRunCollection' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Returns schedule history list. + tags: + - usageapi + x-related-resource: '#/definitions/ScheduledRun' + /scheduledRuns/{scheduledRunId}: + get: + description: | + Returns the saved schedule run. + operationId: GetScheduledRun + parameters: + - $ref: '#/components/parameters/ScheduledRunIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: The saved scheduled run. + 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/ScheduledRun' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Returns saved schedule run. + tags: + - usageapi + x-related-resource: '#/definitions/ScheduledRun' + /schedules: + get: + description: | + Returns the saved schedule list. + operationId: ListSchedules + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/ScheduleSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/NameQueryParam' + responses: + '200': + description: The saved schedule list. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/ScheduleCollection' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Returns the saved schedule list. + tags: + - usageapi + x-related-resource: '#/definitions/Schedule' + post: + description: | + Returns the created schedule. + operationId: CreateSchedule + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateScheduleDetails' + description: New schedule details. + required: true + responses: + '200': + description: Returns the created scheduled report. + 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/Schedule' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/409Conflict' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Create a schedule. + tags: + - usageapi + /schedules/{scheduleId}: + delete: + description: | + Delete a saved scheduled report by the OCID. + operationId: DeleteSchedule + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/ScheduleIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The schedule was successfully 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 + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/409Conflict' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Delete a schedule. + tags: + - usageapi + x-related-resource: '#/definitions/Schedule' + get: + description: | + Returns the saved schedule. + operationId: GetSchedule + parameters: + - $ref: '#/components/parameters/ScheduleIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: The saved schedule. + 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/Schedule' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Returns saved schedule. + tags: + - usageapi + x-related-resource: '#/definitions/Schedule' + put: + description: | + Update a saved schedule. + operationId: UpdateSchedule + parameters: + - $ref: '#/components/parameters/ScheduleIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateScheduleDetails' + description: The information to be updated. Currently supports only tags. + required: true + responses: + '200': + description: Returns the updated schedule. + 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/Schedule' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/409Conflict' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Update schedule. + tags: + - usageapi + /usage: + post: + description: | + Returns usage for the given account. + operationId: RequestSummarizedUsages + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RequestSummarizedUsagesDetails' + description: | + getUsageRequest contains query inforamtion. + required: true + responses: + '200': + description: A usage list with the given groupBy information. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/UsageAggregation' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Returns usage for the given account. + tags: + - usageapi + x-related-resource: '#/definitions/UsageSummary' + /usageCarbonEmissions: + post: + description: | + Returns carbon emission usage for the given account. + operationId: RequestUsageCarbonEmissions + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RequestUsageCarbonEmissionsDetails' + description: | + getUsageCarbonEmissionRequest contains query inforamtion. + required: true + responses: + '200': + description: A carbon emission usage list with the given groupBy information. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/UsageCarbonEmissionAggregation' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Returns usage carbon emission for the given account. + tags: + - usageapi + x-related-resource: '#/definitions/UsageCarbonEmissionSummary' + /usageCarbonEmissionsConfig: + get: + description: | + Returns the configuration list for the Console's carbon emission user interface drop-down list. + operationId: RequestUsageCarbonEmissionConfig + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - description: tenant id + in: query + name: tenantId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + responses: + '200': + description: The configuration used for the Console's carbon emission drop-down list. The value is a list of available items. + 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/ConfigurationAggregation' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Returns usage carbon emission configurations. + tags: + - usageapi + x-related-resource: '#/definitions/Configuration' + /usageCarbonEmissionsQueries: + get: + description: | + Returns the carbon emissions usage saved query list. + operationId: ListUsageCarbonEmissionsQueries + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The carbon emissions usage saved queries list. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/UsageCarbonEmissionsQueryCollection' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Returns usage carbon emissions saved queries and UI properties. + tags: + - usageapi + x-related-resource: '#/definitions/UsageCarbonEmissionsQuery' + post: + description: | + Returns the created carbon emissions usage query. + operationId: CreateUsageCarbonEmissionsQuery + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateUsageCarbonEmissionsQueryDetails' + description: New query details. Up to ten saved queries. + required: true + responses: + '200': + description: Returns the query ID or name. + 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/UsageCarbonEmissionsQuery' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/409Conflict' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Create usage carbon emissions query. + tags: + - usageapi + /usageCarbonEmissionsQueries/{usageCarbonEmissionsQueryId}: + delete: + description: | + Delete a carbon emissions usage saved query by the OCID. + operationId: DeleteUsageCarbonEmissionsQuery + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/UsageCarbonEmissionsQueryIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + responses: + '204': + description: The query was successfully 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 + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Delete a usage carbon emissions saved query. + tags: + - usageapi + x-related-resource: '#/definitions/UsageCarbonEmissionsQuery' + get: + description: | + Returns the carbon emissions usage saved query. + operationId: GetUsageCarbonEmissionsQuery + parameters: + - $ref: '#/components/parameters/UsageCarbonEmissionsQueryIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: The carbon emissions usage saved query. + 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/UsageCarbonEmissionsQuery' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Returns usage carbon emissions saved query. + tags: + - usageapi + x-related-resource: '#/definitions/UsageCarbonEmissionsQuery' + put: + description: | + Update a carbon emissions usage saved query by the OCID. + operationId: UpdateUsageCarbonEmissionsQuery + parameters: + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/UsageCarbonEmissionsQueryIdPathParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateUsageCarbonEmissionsQueryDetails' + description: The information to be updated. + required: true + responses: + '200': + description: Returns the updated carbon emissions usage saved query. + 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/UsageCarbonEmissionsQuery' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Update usage carbon emissions saved query. + tags: + - usageapi + /usageStatements/{subscriptionId}/emailRecipientsGroups: + get: + description: | + Returns the saved usage statement email recipients group. + operationId: ListEmailRecipientsGroups + parameters: + - $ref: '#/components/parameters/SubscriptionIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/SortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: The usage statement email recipients group list. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then a partial list might have been returned. Include this value as the `page` parameter for the + subsequent GET request to get the next batch of items. + 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/EmailRecipientsGroupCollection' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/409Conflict' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Return the usage statement email recipients groups for this tenancy. + tags: + - usageapi + x-related-resource: '#/definitions/EmailRecipientsGroup' + post: + description: | + Creates a list of email recipients that can receive usage statements for the subscription. + operationId: CreateEmailRecipientsGroup + parameters: + - $ref: '#/components/parameters/SubscriptionIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateEmailRecipientsGroupDetails' + description: New email recipients group details. + required: true + x-default-description: '' + responses: + '200': + description: | + Returns the created email recipients group. + 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/EmailRecipientsGroup' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/409Conflict' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Create an email recipient group to receive usage statements for the subscription. + tags: + - usageapi + x-related-resource: '#/definitions/EmailRecipientsGroup' + /usageStatements/{subscriptionId}/emailRecipientsGroups/{emailRecipientsGroupId}: + delete: + description: | + Deletes the email recipients group for the usage statement subscription. + operationId: DeleteEmailRecipientsGroup + parameters: + - $ref: '#/components/parameters/EmailRecipientsGroupIdPathParam' + - $ref: '#/components/parameters/SubscriptionIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + responses: + '204': + description: | + The email recipients group was successfully 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 + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/409Conflict' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: delete the email recipients group for the usage statement subscription. + tags: + - usageapi + x-related-resource: '#/definitions/EmailRecipientsGroup' + get: + description: | + Returns the saved usage statement email recipients group. + operationId: GetEmailRecipientsGroup + parameters: + - $ref: '#/components/parameters/EmailRecipientsGroupIdPathParam' + - $ref: '#/components/parameters/SubscriptionIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + responses: + '200': + description: The saved email recipients group. + 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/EmailRecipientsGroup' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Return the saved usage statement email recipients group details. + tags: + - usageapi + x-related-resource: '#/definitions/EmailRecipientsGroup' + put: + description: | + Updates a saved email recipients group. + operationId: UpdateEmailRecipientsGroup + parameters: + - $ref: '#/components/parameters/EmailRecipientsGroupIdPathParam' + - $ref: '#/components/parameters/SubscriptionIdPathParam' + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + - $ref: '#/components/parameters/IfMatchHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateEmailRecipientsGroupDetails' + description: The information to be updated. + required: true + responses: + '200': + description: Returns the updated email recipients group. + 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/EmailRecipientsGroup' + '400': + $ref: '#/components/responses/400BadRequest' + '401': + $ref: '#/components/responses/401Unauthorized' + '404': + $ref: '#/components/responses/404NotAuthorizedOrNotFound' + '409': + $ref: '#/components/responses/409Conflict' + '412': + $ref: '#/components/responses/412PreconditionFailed' + '429': + $ref: '#/components/responses/429TooManyRequests' + '500': + $ref: '#/components/responses/500InternalServerError' + default: + $ref: '#/components/responses/DefaultError' + summary: Update email recipients group. + tags: + - usageapi + x-related-resource: '#/definitions/EmailRecipientsGroup' +components: + schemas: + AverageCarbonEmission: + description: Average carbon emissions. + properties: + averageCarbonEmission: + description: The average carbon emissions by SKU. + format: double + type: number + skuPartNumber: + description: The SKU part number. + type: string + required: + - skuPartNumber + - averageCarbonEmission + type: object + CleanEnergyUsage: + description: Clean energy usage. + properties: + ad: + description: The availability domain. + type: string + region: + description: The region. + type: string + usage: + description: The percentage of clean enery used. + format: double + type: number + required: + - region + - usage + type: object + ConfigurationAggregation: + description: The available configurations. + properties: + items: + description: The list of available configurations. + items: + $ref: '#/components/schemas/Configuration' + type: array + required: + - items + type: object + CustomTableCollection: + description: A custom table list. + properties: + items: + description: Custom tables list. + items: + $ref: '#/components/schemas/CustomTableSummary' + type: array + required: + - items + type: object + CreateCustomTableDetails: + description: New custom table detail. + properties: + compartmentId: + description: The compartment OCID. + maxLength: 250 + minLength: 1 + type: string + savedCustomTable: + $ref: '#/components/schemas/SavedCustomTable' + savedReportId: + description: The associated saved report OCID. + maxLength: 250 + minLength: 1 + type: string + required: + - compartmentId + - savedReportId + - savedCustomTable + type: object + CustomTable: + description: The saved custom table. + properties: + compartmentId: + description: The custom table compartment OCID. + maxLength: 250 + minLength: 1 + type: string + id: + description: The custom table OCID. + maxLength: 250 + minLength: 1 + type: string + savedCustomTable: + $ref: '#/components/schemas/SavedCustomTable' + savedReportId: + description: The custom table associated saved report OCID. + maxLength: 250 + minLength: 1 + type: string + required: + - id + type: object + UpdateCustomTableDetails: + description: Details for updating the custom table. + properties: + savedCustomTable: + $ref: '#/components/schemas/SavedCustomTable' + required: + - savedCustomTable + type: object + QueryCollection: + description: A query list. + properties: + items: + description: Query list. + items: + $ref: '#/components/schemas/QuerySummary' + type: array + required: + - items + type: object + CreateQueryDetails: + description: New query detail with savedRequestSummarizedUsagesDetails, savedCostAnalysisUI, and displayName. + properties: + compartmentId: + description: The compartment OCID. + type: string + queryDefinition: + $ref: '#/components/schemas/QueryDefinition' + required: + - compartmentId + - queryDefinition + type: object + Query: + description: The query to filter and aggregate. + properties: + compartmentId: + description: The compartment OCID. + type: string + id: + description: The query OCID. + type: string + queryDefinition: + $ref: '#/components/schemas/QueryDefinition' + required: + - id + - compartmentId + - queryDefinition + type: object + UpdateQueryDetails: + description: Details for the query to update reportQuery, costAnalysisUI, and displayName. + properties: + queryDefinition: + $ref: '#/components/schemas/QueryDefinition' + required: + - queryDefinition + type: object + ScheduledRunCollection: + description: The schedule past run list. + properties: + items: + description: The schedule past run list. + items: + $ref: '#/components/schemas/ScheduledRunSummary' + type: array + required: + - items + type: object + ScheduledRun: + description: The saved schedule run. + properties: + id: + description: The OCID representing a unique shedule run. + type: string + lifecycleDetails: + description: Additional details about the scheduled run. + type: string + lifecycleState: + description: Specifies whether or not the schedule job was successfully run. + enum: + - FAILED + - SUCCEEDED + type: string + scheduleId: + description: The OCID representing a unique shedule. + type: string + timeCreated: + description: The time the schedule started executing. + format: date-time + type: string + timeFinished: + description: The time the schedule finished executing. + format: date-time + type: string + required: + - id + - scheduleId + - timeCreated + - timeFinished + - lifecycleState + - lifecycleDetails + type: object + ScheduleCollection: + description: A schedule collection. + properties: + items: + description: Schedule summary list. + items: + $ref: '#/components/schemas/ScheduleSummary' + type: array + required: + - items + type: object + CreateScheduleDetails: + description: The saved schedule. + properties: + compartmentId: + description: The customer tenancy. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing predefined tags' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` + type: object + description: | + Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}` + type: object + description: + description: The description of the schedule. + type: string + freeformTags: + additionalProperties: + type: string + description: | + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` + type: object + name: + description: The unique name of the user-created schedule. + format: x-obmcs-ascii-identifier + maxLength: 255 + minLength: 1 + type: string + outputFileFormat: + default: CSV + description: Specifies the supported output file format. + enum: + - CSV + - PDF + type: string + queryProperties: + $ref: '#/components/schemas/QueryProperties' + resultLocation: + $ref: '#/components/schemas/ResultLocation' + savedReportId: + description: The saved report ID which can also be used to generate a query. + type: string + scheduleRecurrences: + description: | + Specifies the frequency according to when the schedule will be run, + in the x-obmcs-recurring-time format described in [RFC 5545 section 3.3.10](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10). + Supported values are : ONETIME, DAILY, WEEKLY and MONTHLY. + format: x-obmcs-recurring-time + type: string + timeScheduled: + description: The date and time of the first time job execution. + format: date-time + type: string + required: + - name + - compartmentId + - resultLocation + - scheduleRecurrences + - timeScheduled + type: object + Schedule: + description: The schedule. + properties: + compartmentId: + description: The customer tenancy. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing predefined tags' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` + type: object + description: | + Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}` + type: object + description: + description: The description of the schedule. + type: string + freeformTags: + additionalProperties: + type: string + description: | + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` + type: object + id: + description: The OCID representing a unique shedule. + type: string + lifecycleState: + description: The schedule lifecycle state. + enum: + - ACTIVE + - INACTIVE + type: string + name: + description: The unique name of the schedule created by the user. + format: x-obmcs-ascii-identifier + maxLength: 255 + minLength: 1 + type: string + outputFileFormat: + default: CSV + description: Specifies the supported output file format. + enum: + - CSV + - PDF + type: string + queryProperties: + $ref: '#/components/schemas/QueryProperties' + resultLocation: + $ref: '#/components/schemas/ResultLocation' + savedReportId: + description: The saved report ID which can also be used to generate a query. + type: string + scheduleRecurrences: + description: | + Specifies the frequency according to when the schedule will be run, + in the x-obmcs-recurring-time format described in [RFC 5545 section 3.3.10](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10). + Supported values are : ONETIME, DAILY, WEEKLY and MONTHLY. + format: x-obmcs-recurring-time + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + timeCreated: + description: The date and time the schedule was created. + format: date-time + type: string + timeNextRun: + description: The date and time of the next job execution. + format: date-time + type: string + timeScheduled: + description: The date and time of the first time job execution. + format: date-time + type: string + required: + - id + - name + - compartmentId + - resultLocation + - scheduleRecurrences + - timeScheduled + - timeCreated + - lifecycleState + type: object + UpdateScheduleDetails: + description: | + Details for updating the custom table. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing predefined tags' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` + type: object + description: | + Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}` + type: object + description: + description: The description of the schedule. + type: string + freeformTags: + additionalProperties: + type: string + description: | + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` + type: object + outputFileFormat: + default: CSV + description: Specifies the supported output file format. + enum: + - CSV + - PDF + type: string + resultLocation: + $ref: '#/components/schemas/ResultLocation' + type: object + RequestSummarizedUsagesDetails: + description: Details for the '/usage' query. + properties: + compartmentDepth: + description: The compartment depth level. + maximum: 7 + minimum: 1 + type: number + filter: + $ref: '#/components/schemas/Filter' + forecast: + $ref: '#/components/schemas/Forecast' + granularity: + description: | + The usage granularity. + HOURLY - Hourly data aggregation. + DAILY - Daily data aggregation. + MONTHLY - Monthly data aggregation. + TOTAL - Not yet supported. + enum: + - HOURLY + - DAILY + - MONTHLY + - TOTAL + type: string + groupBy: + description: | + Aggregate the result by. + For example: + `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", + "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", + "resourceId", "tenantId", "tenantName"]` + items: + type: string + maxItems: 4 + type: array + groupByTag: + description: | + GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. + For example: + `[{"namespace":"oracle", "key":"createdBy"]` + items: + $ref: '#/components/schemas/Tag' + type: array + isAggregateByTime: + default: false + description: Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up. + type: boolean + queryType: + description: | + The query usage type. COST by default if it is missing. + Usage - Query the usage data. + Cost - Query the cost/billing data. + Credit - Query the credit adjustments data. + ExpiredCredit - Query the expired credits data. + AllCredit - Query the credit adjustments and expired credit. + Overage - Query the overage cost of a non-metered subscription. + Usage_Only - Query the only usage data without cost or currency. + enum: + - USAGE + - COST + - CREDIT + - EXPIREDCREDIT + - ALLCREDIT + - OVERAGE + - USAGE_ONLY + type: string + tenantId: + description: Tenant ID. + maxLength: 255 + minLength: 1 + type: string + timeUsageEnded: + description: The usage end time. + format: date-time + type: string + timeUsageStarted: + description: The usage start time. + format: date-time + type: string + required: + - tenantId + - timeUsageStarted + - timeUsageEnded + - granularity + type: object + UsageAggregation: + description: The account (tenant) usage. + properties: + groupBy: + description: Aggregate the result by. + items: + type: string + type: array + items: + description: A list of usage items. + items: + $ref: '#/components/schemas/UsageSummary' + type: array + required: + - items + type: object + RequestUsageCarbonEmissionsDetails: + description: Details for the '/usageCarbonEmissions' query. + properties: + compartmentDepth: + description: The compartment depth level. + maximum: 7 + minimum: 1 + type: integer + emissionCalculationMethod: + default: SPEND_BASED + description: Specifies the emission calculation method, whether POWER_BASED or SPEND_BASED. + enum: + - SPEND_BASED + - POWER_BASED + type: string + emissionType: + default: MARKET_BASED + description: Specifies the emission type, whether MARKET_BASED or LOCATION_BASED. + enum: + - MARKET_BASED + - LOCATION_BASED + type: string + filter: + $ref: '#/components/schemas/Filter' + granularity: + default: MONTHLY + description: The carbon emission granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. + enum: + - DAILY + - MONTHLY + type: string + groupBy: + description: | + Aggregate the result by. + For example: + `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", + "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", + "resourceId", "resourceName", "tenantId", "tenantName", "subscriptionId"]` + items: + type: string + maxItems: 4 + type: array + groupByTag: + description: | + GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. + For example: + `[{"namespace":"oracle", "key":"createdBy"]` + items: + $ref: '#/components/schemas/Tag' + type: array + isAggregateByTime: + default: false + description: Specifies whether aggregated by time. If isAggregateByTime is true, all carbon emissions usage over the query time period are summed. + type: boolean + tenantId: + description: Tenant ID. + maxLength: 255 + minLength: 1 + type: string + timeUsageEnded: + description: The usage end time. + format: date-time + type: string + timeUsageStarted: + description: The usage start time. + format: date-time + type: string + required: + - tenantId + - timeUsageStarted + - timeUsageEnded + type: object + UsageCarbonEmissionAggregation: + description: The account (tenant) carbon emissions usage. + properties: + groupBy: + description: Specifies what to aggregate the result by. + items: + type: string + maxItems: 4 + type: array + items: + description: A list of carbon emission usage items. + items: + $ref: '#/components/schemas/UsageCarbonEmissionSummary' + maxItems: 500 + type: array + required: + - items + type: object + UsageCarbonEmissionsQueryCollection: + description: A carbon emissions usage query list. + properties: + items: + description: Usage carbon emissions query list. + items: + $ref: '#/components/schemas/UsageCarbonEmissionsQuerySummary' + type: array + required: + - items + type: object + CreateUsageCarbonEmissionsQueryDetails: + description: New query detail with savedRequestUsageCarbonEmissionsDetails, savedCostAnalysisUI, and displayName. + properties: + compartmentId: + description: The compartment OCID. + type: string + queryDefinition: + $ref: '#/components/schemas/UsageCarbonEmissionsQueryDefinition' + required: + - compartmentId + - queryDefinition + type: object + UsageCarbonEmissionsQuery: + description: The carbon emissions usage saved query to filter and aggregate. + properties: + compartmentId: + description: The compartment OCID. + type: string + id: + description: The query OCID. + type: string + queryDefinition: + $ref: '#/components/schemas/UsageCarbonEmissionsQueryDefinition' + required: + - id + - compartmentId + - queryDefinition + type: object + UpdateUsageCarbonEmissionsQueryDetails: + description: Details for the query to update usageCarbonEmissionsQuery, costAnalysisUI, and displayName. + properties: + queryDefinition: + $ref: '#/components/schemas/UsageCarbonEmissionsQueryDefinition' + required: + - queryDefinition + type: object + EmailRecipientsGroupCollection: + description: The email recipients group collection. + properties: + items: + description: The email recipients group list. + items: + $ref: '#/components/schemas/EmailRecipientsGroupSummary' + type: array + required: + - items + type: object + CreateEmailRecipientsGroupDetails: + description: The saved email recipient group to receive usage statement emails. + properties: + compartmentId: + description: The customer tenancy. + maxLength: 255 + minLength: 1 + type: string + recipientsList: + description: The list of recipients that will receive usage statement emails. + items: + $ref: '#/components/schemas/EmailRecipient' + maxItems: 10 + type: array + uniqueItems: true + required: + - compartmentId + - recipientsList + type: object + EmailRecipientsGroup: + description: The recipients group to receive usage statement emails. + properties: + compartmentId: + description: The customer tenancy OCID. + maxLength: 255 + minLength: 1 + type: string + id: + description: The usage statement email recipients group OCID. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The email recipients group lifecycle state. + enum: + - ACTIVE + - INACTIVE + type: string + recipientsList: + description: The list of recipients that will receive usage statement emails. + items: + $ref: '#/components/schemas/EmailRecipient' + maxItems: 10 + type: array + required: + - id + - compartmentId + - recipientsList + - lifecycleState + type: object + UpdateEmailRecipientsGroupDetails: + description: | + The saved email recipient group to receive usage statement emails. + properties: + recipientsList: + description: The list of recipients will receive usage statement emails. + items: + $ref: '#/components/schemas/EmailRecipient' + maxItems: 10 + type: array + uniqueItems: true + required: + - recipientsList + type: object + Error: + description: Erorr details. + properties: + code: + description: | + A short error code that defines the error, meant for programmatic parsing. See + [API Errors](/Content/API/References/apierrors.htm). + type: string + message: + description: A human-readable error string. + type: string + required: + - code + - message + type: object + Configuration: + description: A configuration. + properties: + key: + description: The configuration key. + type: string + values: + description: The configuration value. + items: + type: string + type: array + required: + - key + type: object + CustomTableSummary: + description: Custom table in the list request. + properties: + id: + description: The custom table OCID. + maxLength: 250 + minLength: 1 + type: string + savedCustomTable: + $ref: '#/components/schemas/SavedCustomTable' + required: + - id + - savedCustomTable + type: object + SavedCustomTable: + description: The custom table for Cost Analysis UI rendering. + properties: + columnGroupBy: + description: | + The column groupBy key list. + For example: + `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", + "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", + "resourceId", "tenantId", "tenantName"]` + items: + type: string + maxItems: 4 + type: array + compartmentDepth: + default: 1 + description: The compartment depth level. + maximum: 7 + minimum: 1 + type: number + displayName: + description: The name of the custom table. + maxLength: 40 + minLength: 1 + type: string + groupByTag: + description: | + GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only one tag in the list is supported. + For example: + `[{"namespace":"oracle", "key":"createdBy"]` + items: + $ref: '#/components/schemas/Tag' + type: array + rowGroupBy: + description: | + The row groupBy key list. + For example: + `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", + "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", + "resourceId", "tenantId", "tenantName"]` + items: + type: string + maxItems: 4 + type: array + version: + default: 1 + description: The version of the custom table. + maximum: 10000 + minimum: 1 + type: number + required: + - displayName + type: object + QuerySummary: + description: Query summery in the list request. + properties: + id: + description: The query OCID. + type: string + queryDefinition: + $ref: '#/components/schemas/QueryDefinition' + required: + - id + - queryDefinition + type: object + QueryDefinition: + description: The common fields for queries. + properties: + costAnalysisUI: + $ref: '#/components/schemas/CostAnalysisUI' + displayName: + description: The query display name. Avoid entering confidential information. + maxLength: 40 + minLength: 1 + type: string + reportQuery: + $ref: '#/components/schemas/ReportQuery' + version: + description: The saved query version. + maximum: 10000 + minimum: 1 + type: number + required: + - displayName + - reportQuery + - costAnalysisUI + - version + type: object + ScheduledRunSummary: + description: The saved history past run. + properties: + id: + description: The OCID representing a unique shedule run. + type: string + lifecycleDetails: + description: Additional details about the scheduled run. + type: string + lifecycleState: + description: Specifies whether or not the schedule job was successfully run. + type: string + x-obmcs-enumref: '#/definitions/ScheduledRun/lifecycleState' + scheduleId: + description: The OCID representing a unique shedule. + type: string + timeCreated: + description: The time the schedule started executing. + format: date-time + type: string + timeFinished: + description: The time the schedule finished executing. + format: date-time + type: string + required: + - id + - scheduleId + - timeCreated + - timeFinished + - lifecycleState + - lifecycleDetails + type: object + ScheduleSummary: + description: Schedule summary for the list schedule. + properties: + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing predefined tags' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` + type: object + description: | + Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}` + type: object + description: + description: The description of the schedule. + type: string + freeformTags: + additionalProperties: + type: string + description: | + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` + type: object + id: + description: The schedule OCID. + type: string + lifecycleState: + description: The schedule summary lifecycle state. + type: string + x-obmcs-enumref: '#/definitions/Schedule/lifecycleState' + name: + description: The unique name of the user-created schedule. + type: string + scheduleRecurrences: + description: | + Specifies the frequency according to when the schedule will be run, + in the x-obmcs-recurring-time format described in [RFC 5545 section 3.3.10](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10). + Supported values are : ONETIME, DAILY, WEEKLY and MONTHLY. + format: x-obmcs-recurring-time + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + timeNextRun: + description: The date and time of the next job execution. + format: date-time + type: string + timeScheduled: + description: The date and time of the first time job execution. + format: date-time + type: string + required: + - id + - name + - scheduleRecurrences + - timeScheduled + - lifecycleState + type: object + QueryProperties: + description: The query properties. + properties: + compartmentDepth: + description: The depth level of the compartment. + maximum: 7 + minimum: 1 + type: number + dateRange: + $ref: '#/components/schemas/DateRange' + filter: + $ref: '#/components/schemas/Filter' + granularity: + description: | + The usage granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. + Allowed values are: + DAILY + MONTHLY + enum: + - DAILY + - MONTHLY + type: string + groupBy: + description: | + Aggregate the result by. For example: [ "tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName" ] + items: + type: string + maxItems: 4 + type: array + groupByTag: + description: | + GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: [ { "namespace": "oracle", "key": "createdBy" ] + items: + $ref: '#/components/schemas/Tag' + type: array + isAggregateByTime: + default: false + description: Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up. + type: boolean + queryType: + default: COST + description: | + The query usage type. COST by default if it is missing. Usage - Query the usage data. Cost - Query the cost/billing data. + Allowed values are: + USAGE + COST + USAGE_AND_COST + enum: + - USAGE + - COST + - USAGE_AND_COST + type: string + required: + - granularity + - dateRange + type: object + ResultLocation: + description: | + The location where usage or cost CSVs will be uploaded defined by `locationType`, + which corresponds with type-specific characteristics. + discriminator: + propertyName: locationType + properties: + locationType: + description: | + Defines the type of location where the usage or cost CSVs will be stored. + enum: + - OBJECT_STORAGE + type: string + required: + - locationType + type: object + Filter: + description: The filter object for query usage. + properties: + dimensions: + description: The dimensions to filter on. + items: + $ref: '#/components/schemas/Dimension' + type: array + filters: + description: The nested filter object. + items: + $ref: '#/components/schemas/Filter' + type: array + operator: + description: 'The filter operator. Example: ''AND'', ''OR'', ''NOT''.' + enum: + - AND + - NOT + - OR + type: string + tags: + description: The tags to filter on. + items: + $ref: '#/components/schemas/Tag' + type: array + type: object + Forecast: + description: Forecast configuration of usage or cost. + properties: + forecastType: + default: BASIC + description: | + BASIC uses the exponential smoothing (ETS) model to project future usage or costs based on history data. + The basis for projections is a periodic set of equivalent historical days for which the projection is being made. + enum: + - BASIC + type: string + timeForecastEnded: + description: The forecast end time. + format: date-time + type: string + timeForecastStarted: + description: | + The forecast start time. Defaults to UTC-1 if not specified. + format: date-time + type: string + required: + - timeForecastEnded + type: object + Tag: + description: The tag used for filtering. + properties: + key: + description: The tag key. + type: string + namespace: + description: The tag namespace. + type: string + value: + description: The tag value. + type: string + type: object + UsageSummary: + description: The usage store result. + properties: + ad: + description: The availability domain of the usage. + type: string + attributedCost: + description: The attributed cost with a maximum value of 9999999999.999999999999 and a minimum value of 0. + pattern: ^\d{1,10}\.\d{0,12}$ + type: string + attributedUsage: + description: The attributed usage with a maximum value of 9999999999.999999999999 and a minimum value of 0. + pattern: ^\d{1,10}\.\d{0,12}$ + type: string + compartmentId: + description: The compartment OCID. + type: string + compartmentName: + description: The compartment name. + type: string + compartmentPath: + description: The compartment path, starting from root. + type: string + computedAmount: + description: The computed cost. + type: number + computedQuantity: + description: The usage number. + type: number + currency: + description: The price currency. + type: string + discount: + description: The discretionary discount applied to the SKU. + type: number + isForecast: + description: The forecasted data. + type: boolean + listRate: + description: The SKU list rate (not discount). + type: number + overage: + description: The overage usage. + type: string + overagesFlag: + description: The SPM OverageFlag. + type: string + platform: + description: Platform for the cost. + type: string + region: + description: The region of the usage. + type: string + resourceId: + description: The resource OCID that is incurring the cost. + type: string + resourceName: + description: The resource name that is incurring the cost. + type: string + service: + description: The service name that is incurring the cost. + type: string + shape: + description: The resource shape. + type: string + skuName: + description: The SKU friendly name. + type: string + skuPartNumber: + description: The SKU part number. + type: string + subscriptionId: + description: The subscription ID. + type: string + tags: + description: For grouping, a tag definition. For filtering, a definition and key. + items: + $ref: '#/components/schemas/Tag' + type: array + tenantId: + description: The tenancy OCID. + type: string + tenantName: + description: The tenancy name. + type: string + timeUsageEnded: + description: The usage end time. + format: date-time + type: string + timeUsageStarted: + description: The usage start time. + format: date-time + type: string + unit: + description: The usage unit. + type: string + unitPrice: + description: The price per unit. + type: number + weight: + description: The resource size being metered. + type: number + required: + - timeUsageStarted + - timeUsageEnded + type: object + UsageCarbonEmissionSummary: + description: The carbon emission usage store result. + properties: + ad: + description: The availability domain of the usage. + type: string + compartmentId: + description: The compartment OCID. + type: string + compartmentName: + description: The compartment name. + type: string + compartmentPath: + description: The compartment path, starting from root. + type: string + computedCarbonEmission: + description: The carbon emission usage in MTCO2 units. + format: double + type: number + emissionCalculationMethod: + description: Specifies the carbon emissions calculation method. Both SPEND_BASED (based on expenditure data) and POWER_BASED (based on power consumption) are supported. + type: string + emissionType: + default: MARKET_BASED + description: The emission type, whether MARKET_BASED or LOCATION_BASED. + type: string + x-obmcs-enumref: '#/definitions/RequestUsageCarbonEmissionsDetails/emissionType' + platform: + description: Platform for the cost. + type: string + region: + description: The region of the usage. + type: string + resourceId: + description: The resource OCID that is incurring the cost. + type: string + resourceName: + description: The resource name that is incurring the cost. + type: string + service: + description: The service name that is incurring the cost. + type: string + skuName: + description: The SKU friendly name. + type: string + skuPartNumber: + description: The SKU part number. + type: string + subscriptionId: + description: The subscription ID. + type: string + tags: + description: For grouping, a tag definition. For filtering, a definition and key. + items: + $ref: '#/components/schemas/Tag' + maxItems: 1000 + type: array + tenantId: + description: The tenancy OCID. + type: string + tenantName: + description: The tenancy name. + type: string + timeUsageEnded: + description: The usage end time. + format: date-time + type: string + timeUsageStarted: + description: The usage start time. + format: date-time + type: string + required: + - timeUsageStarted + - timeUsageEnded + - computedCarbonEmission + - emissionCalculationMethod + type: object + UsageCarbonEmissionsQuerySummary: + description: The carbon emissions usage query summary in the list request. + properties: + id: + description: The query OCID. + type: string + queryDefinition: + $ref: '#/components/schemas/UsageCarbonEmissionsQueryDefinition' + required: + - id + - queryDefinition + type: object + UsageCarbonEmissionsQueryDefinition: + description: The common fields for queries. + properties: + costAnalysisUI: + $ref: '#/components/schemas/CostAnalysisUI' + displayName: + description: The query display name. Avoid entering confidential information. + maxLength: 40 + minLength: 1 + type: string + reportQuery: + $ref: '#/components/schemas/UsageCarbonEmissionsReportQuery' + version: + description: The saved query version. + maximum: 10000 + minimum: 1 + type: integer + required: + - displayName + - reportQuery + - costAnalysisUI + - version + type: object + EmailRecipientsGroupSummary: + description: The email recipients group summary for the recipients group list. + properties: + compartmentId: + description: The customer tenancy. + maxLength: 255 + minLength: 1 + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing predefined tags' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` + type: object + description: | + Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}` + type: object + freeformTags: + additionalProperties: + type: string + description: | + Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. + See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` + type: object + id: + description: The usage statement email recipients group OCID. + maxLength: 255 + minLength: 1 + type: string + lifecycleState: + description: The email recipients group lifecycle state. + type: string + x-obmcs-enumref: '#/definitions/EmailRecipientsGroup/lifecycleState' + recipientsList: + description: The list of recipients that will receive usage statement emails. + items: + $ref: '#/components/schemas/EmailRecipient' + maxItems: 10 + type: array + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only string, integer, and boolean types are supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tags' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` + type: object + description: | + Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` + type: object + required: + - id + - compartmentId + - recipientsList + - lifecycleState + type: object + EmailRecipient: + description: The email recipient to receive usage statements for the subscription. + properties: + emailId: + description: The recipient email address. + type: string + firstName: + description: The recipient first name. + type: string + lastName: + description: The recipient last name. + type: string + lifecycleState: + description: The email recipient lifecycle state. + enum: + - ACTIVE + - INACTIVE + type: string + required: + - emailId + - lifecycleState + type: object + CostAnalysisUI: + description: The common fields for Cost Analysis UI rendering. + properties: + graph: + description: The graph type. + enum: + - BARS + - LINES + - STACKED_LINES + type: string + isCumulativeGraph: + description: A cumulative graph. + type: boolean + type: object + ReportQuery: + description: The request of the generated Cost Analysis report. + properties: + compartmentDepth: + description: The compartment depth level. + maximum: 7 + minimum: 1 + type: number + dateRangeName: + description: The UI date range, for example, LAST_THREE_MONTHS. Conflicts with timeUsageStarted and timeUsageEnded. + enum: + - LAST_SEVEN_DAYS + - LAST_TEN_DAYS + - MTD + - LAST_TWO_MONTHS + - LAST_THREE_MONTHS + - ALL + - LAST_SIX_MONTHS + - LAST_ONE_YEAR + - YTD + - CUSTOM + type: string + filter: + $ref: '#/components/schemas/Filter' + forecast: + $ref: '#/components/schemas/Forecast' + granularity: + description: | + The usage granularity. + HOURLY - Hourly data aggregation. + DAILY - Daily data aggregation. + MONTHLY - Monthly data aggregation. + TOTAL - Not yet supported. + enum: + - HOURLY + - DAILY + - MONTHLY + - TOTAL + type: string + groupBy: + description: | + Specifies what to aggregate the result by. + For example: + `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", + "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", + "resourceId", "tenantId", "tenantName"]` + items: + type: string + maxItems: 4 + type: array + groupByTag: + description: | + GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. + For example: + `[{"namespace":"oracle", "key":"createdBy"]` + items: + $ref: '#/components/schemas/Tag' + type: array + isAggregateByTime: + default: false + description: Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up. + type: boolean + queryType: + description: | + The query usage type. COST by default if it is missing. + * Usage: Query the usage data. + * Cost: Query the cost/billing data. + * Credit: Query the credit adjustments data. + * ExpiredCredit: Query the expired credits data. + * AllCredit: Query the credit adjustments and expired credit. + enum: + - USAGE + - COST + - CREDIT + - EXPIREDCREDIT + - ALLCREDIT + type: string + tenantId: + description: Tenant ID. + maxLength: 255 + minLength: 1 + type: string + timeUsageEnded: + description: The usage end time. + format: date-time + type: string + timeUsageStarted: + description: The usage start time. + format: date-time + type: string + required: + - tenantId + - granularity + type: object + DateRange: + description: | + Static or dynamic date range `dateRangeType`, + which corresponds with type-specific characteristics. + discriminator: + propertyName: dateRangeType + properties: + dateRangeType: + description: Defines whether the schedule date range is STATIC or DYNAMIC. + enum: + - STATIC + - DYNAMIC + type: string + required: + - dateRangeType + type: object + Dimension: + description: | + The dimension used for filtering. Availabe dimensions are: "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", and "tenantName". + For example: + `[{value: "COMPUTE", key: "service"}]` + properties: + key: + description: The dimension key. + type: string + value: + description: The dimension value. + type: string + required: + - key + - value + type: object + UsageCarbonEmissionsReportQuery: + description: The request of the generated carbon emissions usage report. + properties: + compartmentDepth: + description: The compartment depth level. + maximum: 7 + minimum: 1 + type: integer + dateRangeName: + description: The user interface date range, for example, LAST_THREE_MONTHS. Overrides the timeUsageStarted and timeUsageEnded properties. + enum: + - LAST_TWO_MONTHS + - LAST_THREE_MONTHS + - LAST_SIX_MONTHS + - LAST_ONE_YEAR + - CUSTOM + type: string + emissionCalculationMethod: + default: SPEND_BASED + description: Specifies the emission calculation method, whether POWER_BASED or SPEND_BASED. + type: string + x-obmcs-enumref: '#/definitions/RequestUsageCarbonEmissionsDetails/emissionCalculationMethod' + emissionType: + default: MARKET_BASED + description: Specifies the emission type, whether MARKET_BASED or LOCATION_BASED. + type: string + x-obmcs-enumref: '#/definitions/RequestUsageCarbonEmissionsDetails/emissionType' + filter: + $ref: '#/components/schemas/Filter' + granularity: + default: MONTHLY + description: The carbon emission granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. + type: string + x-obmcs-enumref: '#/definitions/RequestUsageCarbonEmissionsDetails/granularity' + groupBy: + description: | + Specifies what to aggregate the result by. + For example: + `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", + "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", + "resourceId", "tenantId", "tenantName"]` + items: + type: string + maxItems: 4 + type: array + groupByTag: + description: | + GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. + For example: + `[{"namespace":"oracle", "key":"createdBy"]` + items: + $ref: '#/components/schemas/Tag' + type: array + isAggregateByTime: + default: false + description: Specifies whether aggregated by time. If isAggregateByTime is true, all usage or costs over the query time period are summed. + type: boolean + tenantId: + description: Tenant ID. + maxLength: 255 + minLength: 1 + type: string + timeUsageEnded: + description: The usage end time. + format: date-time + type: string + timeUsageStarted: + description: The usage start time. + format: date-time + type: string + required: + - tenantId + type: object + responses: + 400BadRequest: + description: A bad request was made. + 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' + 401Unauthorized: + description: Unauthorized. + 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' + 404NotAuthorizedOrNotFound: + description: Not authorized or not found. + 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' + 412PreconditionFailed: + description: Precondition failed. + 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' + 429TooManyRequests: + description: Too many requests. + 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' + 500InternalServerError: + description: Internal server 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' + DefaultError: + description: Unexpected 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' + 409Conflict: + description: Conflict. + 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' + parameters: + SkuPathParam: + description: The SKU part number. + in: path + name: skuPartNumber + required: true + x-default-description: '' + schema: + type: string + OpcRequestIdHeaderParam: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + RegionPathParam: + description: The region. + in: path + name: region + required: true + x-default-description: '' + schema: + type: string + AdQueryParam: + description: The availability domain. + in: query + name: ad + required: false + x-default-description: '' + schema: + type: string + PaginationLimitQueryParam: + description: The maximum number of items to return. + in: query + name: limit + schema: + type: integer + minimum: 1 + maximum: 1000 + default: 25 + 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: '' + schema: + type: string + minLength: 1 + maxLength: 512 + CompartmentIdQueryParam: + description: The compartment ID in which to list resources. + in: query + name: compartmentId + required: true + schema: + type: string + SavedReportIdQueryParam: + description: The saved report ID in which to list resources. + in: query + name: savedReportId + required: true + schema: + type: string + SortByQueryParam: + description: | + The field to sort by. If not specified, the default is displayName. + in: query + name: sortBy + schema: + type: string + enum: + - displayName + default: displayName + SortOrderQueryParam: + description: The sort order to use, whether 'asc' or 'desc'. + in: query + name: sortOrder + schema: + type: string + enum: + - ASC + - DESC + default: ASC + RetryTokenHeader: + description: | + A token that uniquely identifies a request so it can be retried in case of a timeout or + server error, without risk of executing that same action again. Retry tokens expire after 24 + hours, but can be invalidated before then due to conflicting operations. For example, if a resource + has been deleted and purged from the system, then a retry of the original creation request + might be rejected. + in: header + name: opc-retry-token + required: false + schema: + type: string + minLength: 1 + maxLength: 64 + CustomTableIdPathParam: + description: The custom table unique OCID. + in: path + name: customTableId + required: true + x-default-description: '' + schema: + type: string + minLength: 1 + maxLength: 250 + 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 + QueryIdPathParam: + description: The query unique OCID. + in: path + name: queryId + required: true + x-default-description: '' + schema: + type: string + ScheduleIdQueryParam: + description: The schedule unique ID. + in: query + name: scheduleId + required: true + schema: + type: string + ScheduledRunSortByQueryParam: + description: | + The field to sort by. If not specified, the default is timeCreated. + in: query + name: sortBy + schema: + type: string + enum: + - timeCreated + default: timeCreated + ScheduledRunIdPathParam: + description: The scheduled run unique OCID. + in: path + name: scheduledRunId + required: true + x-default-description: '' + schema: + type: string + ScheduleSortByQueryParam: + description: | + The field to sort by. If not specified, the default is timeCreated. + in: query + name: sortBy + schema: + type: string + enum: + - name + - timeCreated + default: timeCreated + NameQueryParam: + description: | + The query parameter for filtering by name. + in: query + name: name + schema: + type: string + ScheduleIdPathParam: + description: The schedule unique OCID. + in: path + name: scheduleId + required: true + x-default-description: '' + schema: + type: string + UsageCarbonEmissionsQueryIdPathParam: + description: The query unique OCID. + in: path + name: usageCarbonEmissionsQueryId + required: true + x-default-description: '' + schema: + type: string + SubscriptionIdPathParam: + description: The usage statement subscription unique OCID. + in: path + name: subscriptionId + required: true + x-default-description: '' + schema: + type: string + EmailRecipientsGroupIdPathParam: + description: The email recipients group OCID. + in: path + name: emailRecipientsGroupId + required: true + x-default-description: '' + schema: + type: string + x-stackQL-resources: + average_carbon_emissions: + id: oci.usage.average_carbon_emissions + name: average_carbon_emissions + title: Average Carbon Emissions + methods: + request_average_carbon_emission: + operation: + $ref: '#/paths/~1averageCarbonEmissions~1{skuPartNumber}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + clean_energy_usages: + id: oci.usage.clean_energy_usages + name: clean_energy_usages + title: Clean Energy Usages + methods: + request_clean_energy_usage: + operation: + $ref: '#/paths/~1cleanEnergyUsages~1{region}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + configurations: + id: oci.usage.configurations + name: configurations + title: Configurations + methods: + request_summarized_configurations: + operation: + $ref: '#/paths/~1configuration/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + custom_tables: + id: oci.usage.custom_tables + name: custom_tables + title: Custom Tables + methods: + list: + operation: + $ref: '#/paths/~1customTables/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1customTables/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1customTables~1{customTableId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1customTables~1{customTableId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1customTables~1{customTableId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/custom_tables/methods/get' + - $ref: '#/components/x-stackQL-resources/custom_tables/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/custom_tables/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/custom_tables/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/custom_tables/methods/delete' + replace: [] + queries: + id: oci.usage.queries + name: queries + title: Queries + methods: + list: + operation: + $ref: '#/paths/~1queries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1queries/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1queries~1{queryId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1queries~1{queryId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1queries~1{queryId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/queries/methods/get' + - $ref: '#/components/x-stackQL-resources/queries/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/queries/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/queries/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/queries/methods/delete' + replace: [] + scheduled_runs: + id: oci.usage.scheduled_runs + name: scheduled_runs + title: Scheduled Runs + methods: + list: + operation: + $ref: '#/paths/~1scheduledRuns/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1scheduledRuns~1{scheduledRunId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/scheduled_runs/methods/get' + - $ref: '#/components/x-stackQL-resources/scheduled_runs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + schedules: + id: oci.usage.schedules + name: schedules + title: Schedules + methods: + list: + operation: + $ref: '#/paths/~1schedules/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1schedules/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1schedules~1{scheduleId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1schedules~1{scheduleId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1schedules~1{scheduleId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/schedules/methods/get' + - $ref: '#/components/x-stackQL-resources/schedules/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/schedules/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/schedules/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/schedules/methods/delete' + replace: [] + usages: + id: oci.usage.usages + name: usages + title: Usages + methods: + request_summarized_usages: + config: + requestBodyTranslate: + algorithm: naive + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + operation: + $ref: '#/paths/~1usage/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + usage_carbon_emissions: + id: oci.usage.usage_carbon_emissions + name: usage_carbon_emissions + title: Usage Carbon Emissions + methods: + request_usage_carbon_emissions: + config: + requestBodyTranslate: + algorithm: naive + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + operation: + $ref: '#/paths/~1usageCarbonEmissions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + usage_carbon_emissions_configs: + id: oci.usage.usage_carbon_emissions_configs + name: usage_carbon_emissions_configs + title: Usage Carbon Emissions Configs + methods: + request_usage_carbon_emission_config: + operation: + $ref: '#/paths/~1usageCarbonEmissionsConfig/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + usage_carbon_emissions_queries: + id: oci.usage.usage_carbon_emissions_queries + name: usage_carbon_emissions_queries + title: Usage Carbon Emissions Queries + methods: + list: + operation: + $ref: '#/paths/~1usageCarbonEmissionsQueries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1usageCarbonEmissionsQueries/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1usageCarbonEmissionsQueries~1{usageCarbonEmissionsQueryId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1usageCarbonEmissionsQueries~1{usageCarbonEmissionsQueryId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1usageCarbonEmissionsQueries~1{usageCarbonEmissionsQueryId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/usage_carbon_emissions_queries/methods/get' + - $ref: '#/components/x-stackQL-resources/usage_carbon_emissions_queries/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/usage_carbon_emissions_queries/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/usage_carbon_emissions_queries/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/usage_carbon_emissions_queries/methods/delete' + replace: [] + email_recipients_groups: + id: oci.usage.email_recipients_groups + name: email_recipients_groups + title: Email Recipients Groups + methods: + list: + operation: + $ref: '#/paths/~1usageStatements~1{subscriptionId}~1emailRecipientsGroups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1usageStatements~1{subscriptionId}~1emailRecipientsGroups/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + delete: + operation: + $ref: '#/paths/~1usageStatements~1{subscriptionId}~1emailRecipientsGroups~1{emailRecipientsGroupId}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1usageStatements~1{subscriptionId}~1emailRecipientsGroups~1{emailRecipientsGroupId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1usageStatements~1{subscriptionId}~1emailRecipientsGroups~1{emailRecipientsGroupId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/email_recipients_groups/methods/get' + - $ref: '#/components/x-stackQL-resources/email_recipients_groups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/email_recipients_groups/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/email_recipients_groups/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/email_recipients_groups/methods/delete' + replace: [] +servers: + - url: https://usageapi.{region}.oci.oraclecloud.com/20200107 + variables: + region: + default: us-ashburn-1 + description: OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. + x-stackQL-envVar: OCI_REGION +x-stackQL-config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: opc-next-page + location: header diff --git a/providers/src/oci/v00.00.00000/services/vault.yaml b/providers/src/oci/v00.00.00000/services/vault.yaml new file mode 100644 index 00000000..207f4f97 --- /dev/null +++ b/providers/src/oci/v00.00.00000/services/vault.yaml @@ -0,0 +1,2092 @@ +openapi: 3.0.0 +info: + title: vault API + description: oci vault API + version: '20180608' +paths: + /secrets: + get: + description: Lists all secrets in the specified vault and compartment. + operationId: ListSecrets + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/FilterByNameQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SecretSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/VaultIdQueryParam' + - description: | + A filter that returns only resources that match the specified lifecycle state. The state value is case-insensitive. + in: query + name: lifecycleState + required: false + x-obmcs-enumref: '#/definitions/SecretSummary/lifecycleState' + schema: + type: string + responses: + '200': + description: A list of secret summary objects. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/Content/API/Concepts/usingapi.htm#List_Pagination). + 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/ListSecretsResponse' + '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/DefaultError' + summary: Lists all secrets. + tags: + - vaults + x-example: | + GET /20180608/secrets?compartmentId= + Host: <managementEndpoint> + <authorization and other headers> + x-obmcs-client-retries-enabled: true + post: + description: | + Creates a new secret according to the details of the request. + + This operation is not supported by the Oracle Cloud Infrastructure Terraform Provider. + operationId: CreateSecret + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateSecretDetails' + description: Request to create a new secret. + required: true + responses: + '200': + description: The secret is being created. + 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/Secret' + '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/DefaultError' + summary: Creates a secret. + tags: + - vaults + x-example: | + POST /20180608/secrets + Host: <managementEndpoint> + <authorization and other headers> + { + "vaultId": "<vault_OCID>", + "secretRules": "[]", + "compartmentId": "", + "secretName": "testSecret", + "description": "my test secret", + "keyId": "<key_OCID>", + "secretContent": + { + "content": "<base64_encoded_secret_contents>", + "contentType": "BASE64" + } + } + x-obmcs-client-retries-enabled: true + /secrets/{secretId}: + get: + description: Gets information about the specified secret. + operationId: GetSecret + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SecretIdRequiredPathParam' + responses: + '200': + description: The specified secret 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/Secret' + '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/DefaultError' + summary: Gets details about a secret. + tags: + - vaults + x-example: | + GET /20180608/secrets/<secret_OCID> + Host: <managementEndpoint> + <authorization and other headers> + x-obmcs-client-retries-enabled: true + put: + description: | + Updates the properties of a secret. Specifically, you can update the version number of the secret to make + that version number the current version. You can also update a secret's description, its free-form or defined tags, rules + and the secret contents. Updating the secret content automatically creates a new secret version. You cannot, however, update the current secret version number, secret contents, and secret rules at the + same time. Furthermore, the secret must in an `ACTIVE` lifecycle state to be updated. + + This operation is not supported by the Oracle Cloud Infrastructure Terraform Provider. + operationId: UpdateSecret + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SecretIdRequiredPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSecretDetails' + description: Request to update a secret. + required: true + responses: + '200': + description: The secret is being updated according to the request. + 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/Secret' + '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/DefaultError' + summary: Updates a secret's properties. + tags: + - vaults + x-example: | + PUT /20180608/secrets/<secret_OCID> + Host: <managementEndpoint> + <authorization and other headers> + { + "description": "updated version of my test secret", + "currentVersionNumber": 4 + } + /secrets/{secretId}/actions/cancelDeletion: + post: + description: | + Cancels the pending deletion of the specified secret. Canceling + a scheduled deletion restores the secret's lifecycle state to what + it was before you scheduled the secret for deletion. + operationId: CancelSecretDeletion + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SecretIdRequiredPathParam' + responses: + '204': + description: The secret's scheduled deletion has been canceled. + 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 + '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/DefaultError' + summary: Cancels a scheduled secret deletion. + tags: + - vaults + x-example: | + POST /20180608/secrets/<secret_OCID>/cancelDeletion + Host: <managementEndpoint> + <authorization and other headers> + x-related-resource: '#/definitions/Secret' + /secrets/{secretId}/actions/cancelRotation: + post: + description: | + Cancels the ongoing secret rotation. The cancellation is contingent on how + far the rotation process has progressed. Upon cancelling a rotation, all + future rotations are also disabled. + operationId: CancelSecretRotation + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SecretIdRequiredPathParam' + responses: + '204': + description: The request to cancel the secret rotation was successful. + 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 + '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/DefaultError' + summary: Cancels an ongoing secret rotation. + tags: + - vaults + x-example: | + POST /20180608/secrets/<secret_OCID>/actions/cancelRotation + Host: <managementEndpoint> + <authorization and other headers> + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/Secret' + /secrets/{secretId}/actions/changeCompartment: + post: + description: | + Moves a secret into a different compartment within the same tenancy. For information about + moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). + + When provided, if-match is checked against the ETag values of the secret. + operationId: ChangeSecretCompartment + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/SecretIdRequiredPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeSecretCompartmentDetails' + description: The updated compartment details. + required: true + responses: + '204': + description: The compartment information for the secret has been updated. + 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 + '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/DefaultError' + summary: Moves a secret into a different compartment. + tags: + - vaults + x-example: | + POST /20180608/secrets/<secret_OCID>/actions/changeCompartment + Host: <managementEndpoint> + <authorization and other headers> + { + "compartmentId": "<compartment_OCID>" + } + x-related-resource: '#/definitions/Secret' + /secrets/{secretId}/actions/rotate: + post: + description: | + API to force rotation of an existing secret in Vault and the specified target system; expects secret to have a valid Target System Details object + operationId: RotateSecret + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/RetryTokenHeader' + - $ref: '#/components/parameters/SecretIdRequiredPathParam' + responses: + '202': + description: The secret rotation request has been accepted + 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 of the work request. Use GetWorkRequest with this OCID 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/DefaultError' + summary: Rotates an existing secret. + tags: + - vaults + x-example: | + POST /20180608/secrets/<secret_OCID>/actions/rotate + Host: <managementEndpoint> + <authorization and other headers> + x-obmcs-client-retries-enabled: true + x-related-resource: '#/definitions/Secret' + /secrets/{secretId}/actions/scheduleDeletion: + post: + description: | + Schedules the deletion of the specified secret. This sets the lifecycle state of the secret + to `PENDING_DELETION` and then deletes it after the specified retention period ends. + operationId: ScheduleSecretDeletion + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SecretIdRequiredPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScheduleSecretDeletionDetails' + description: Request to schedule the deletion of a secret. + required: true + responses: + '204': + description: The secret is scheduled for deletion. + 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 + '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/DefaultError' + summary: Schedules the deletion of a secret. + tags: + - vaults + x-example: | + POST /20180608/secrets/<secret_OCID>/actions/scheduleDeletion + Host: <managementEndpoint> + <authorization and other headers> + { + "timeOfDeletion": "2018-04-03T21:10:29.600Z" + } + x-related-resource: '#/definitions/Secret' + /secrets/{secretId}/version/{secretVersionNumber}: + get: + description: | + Gets information about the specified version of a secret. + operationId: GetSecretVersion + parameters: + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SecretIdRequiredPathParam' + - $ref: '#/components/parameters/SecretVersionNumberRequiredPathParam' + responses: + '200': + description: The specified secret version 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/SecretVersion' + '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/DefaultError' + summary: Gets details about a secret version. + tags: + - vaults + x-example: | + GET /20180608/secrets/<secret_OCID>/version/<secret_version_number> + Host: <managementEndpoint> + <authorization and other headers> + x-obmcs-client-retries-enabled: true + /secrets/{secretId}/version/{secretVersionNumber}/actions/cancelDeletion: + post: + description: Cancels the scheduled deletion of a secret version. + operationId: CancelSecretVersionDeletion + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SecretIdRequiredPathParam' + - $ref: '#/components/parameters/SecretVersionNumberRequiredPathParam' + responses: + '204': + description: The scheduled secret version deletion has been canceled. + 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 + '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/DefaultError' + summary: Cancels a scheduled secret version deletion. + tags: + - vaults + x-example: | + POST /20180608/secrets/<secret_OCID>/version/<secret_version_number>/actions/cancelDeletion + Host: <managementEndpoint> + <authorization and other headers> + x-related-resource: '#/definitions/SecretVersion' + /secrets/{secretId}/version/{secretVersionNumber}/actions/scheduleDeletion: + post: + description: | + Schedules the deletion of the specified secret version. This deletes it after the specified retention period ends. You can only + delete a secret version if the secret version rotation state is marked as `DEPRECATED`. + operationId: ScheduleSecretVersionDeletion + parameters: + - $ref: '#/components/parameters/IfMatchHeader' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SecretIdRequiredPathParam' + - $ref: '#/components/parameters/SecretVersionNumberRequiredPathParam' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScheduleSecretVersionDeletionDetails' + description: | + Request to delete a secret version. + required: true + responses: + '204': + description: The secret version is scheduled for deletion. + 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 + '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/DefaultError' + summary: Schedules a deletion of a secret version. + tags: + - vaults + x-example: | + POST /20180608/secrets/<secret_OCID>/version/<secret_version_number>/actions/scheduleDeletion + Host: <managementEndpoint> + <authorization and other headers> + { + "timeOfDeletion": "2018-04-03T21:10:29.600Z" + } + x-related-resource: '#/definitions/SecretVersion' + /secrets/{secretId}/versions: + get: + description: Lists all secret versions for the specified secret. + operationId: ListSecretVersions + parameters: + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/RequestIdHeader' + - $ref: '#/components/parameters/SecretIdRequiredPathParam' + - $ref: '#/components/parameters/SecretVersionSortByQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + responses: + '200': + description: | + The secret version summary object for the specified secret. + headers: + opc-next-page: + description: | + For pagination of a list of items. When paging through a list, if this header appears in the response, + then there are additional items still to get. Include this value as the `page` parameter for the + subsequent GET request. For information about pagination, see + [List Pagination](/Content/API/Concepts/usingapi.htm#List_Pagination). + 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/ListSecretVersionsResponse' + '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/DefaultError' + summary: Lists all secret versions for a secret. + tags: + - vaults + x-example: | + GET /20180608/secrets/<secret_OCID>/versions + Host: <managementEndpoint> + <authorization and other headers> + x-obmcs-client-retries-enabled: true +components: + schemas: + SecretSummary: + description: The details of the secret, excluding the contents of the secret. + properties: + compartmentId: + description: The OCID of the compartment that contains the secret. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only string, integer, and Boolean types are supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: A brief description of the secret. + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the secret. + type: string + isAutoGenerationEnabled: + description: | + The value of this flag determines whether or not secret content will be generated automatically. + type: boolean + keyId: + description: | + The OCID of the master encryption key that is used to encrypt the secret. You must specify a symmetric key to encrypt the secret during import to the vault. You cannot encrypt secrets with asymmetric keys. Furthermore, the key must exist in the vault that you specify. + maxLength: 255 + type: string + lastRotationTime: + description: | + A property indicating when the secret was last rotated successfully, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + lifecycleDetails: + description: Additional information about the secret's current lifecycle state. + maxLength: 4000 + minLength: 1 + type: string + lifecycleState: + description: The current lifecycle state of the secret. + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + - DELETED + - SCHEDULING_DELETION + - PENDING_DELETION + - CANCELLING_DELETION + - FAILED + type: string + nextRotationTime: + description: | + A property indicating when the secret is scheduled to be rotated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + rotationConfig: + $ref: '#/components/schemas/RotationConfig' + rotationStatus: + description: Additional information about the status of the secret rotation + type: string + x-obmcs-enumref: '#/definitions/Secret/rotationStatus' + secretGenerationContext: + $ref: '#/components/schemas/SecretGenerationContext' + secretName: + description: The name of the secret. + maxLength: 255 + type: string + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tag keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + 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: | + A property indicating when the secret was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + timeOfCurrentVersionExpiry: + description: | + An optional property indicating when the current secret version will expire, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + timeOfDeletion: + description: | + An optional property indicating when to delete the secret, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + vaultId: + description: The OCID of the Vault in which the secret exists + type: string + required: + - id + - vaultId + - secretName + - compartmentId + - lifecycleState + - timeCreated + type: object + x-example: | + [ + { + "compartmentId": "ocid1.tenancy.oc1..exampleah7zkvaffv26pzyauoe2zbncvbqvhvsudmlpe557wakiofexample", + "definedTags": { }, + "description": null, + "freeformTags": {}, + "systemTags": {}, + "keyId": "ocid1.key.oc1.iad.exampleyaaeuk.abuwcvbrswr2nbvrraqomsmhopc74rlqupwyv3byhikd4577rrky7example", + "id": "ocid1.vaultsecret.oc1.iad.exampleaz5qacpqahuecvbjqzql4qmpbrtd7pprafhivcfik6wuitexample", + "lifecycleDetails": null, + "lifecycleState": "ACTIVE", + "secretName": "testsecret", + "timeCreated": "2020-03-17T20:34:07.147Z", + "timeOfCurrentVersionExpiry": null, + "timeOfDeletion": null, + "vaultId": "ocid1.vault.oc1.iad.exampleyaaeuk.examplesuxtdqxczlvygwk4ouq2mhzr223g4o2ojs4o4q4ghmt6rlexample" + }, + { + "compartmentId": "ocid1.tenancy.oc1..exampleah7zkvaffv26pzyauoe2zbnionqvhvsudmlpe557wakiofexample", + "definedTags": { }, + "description": "example secret", + "freeformTags": { }, + "systemTags": {}, + "keyId": "ocid1.key.oc1.iad.exampleyaaeuk.abuwcvbrswr2nbvrraqomsmhopc74rlqupwyv3byhikd4577rrky7example", + "id": "ocid1.vaultsecret.oc1.iad.exampleaz5qacpqadubrc4wcvbrqmw5dnyzvcxwzds6er5enn2oamexample", + "lifecycleDetails": null, + "lifecycleState": "ACTIVE", + "secretName": "examplesecret", + "timeCreated": "2020-03-18T16:51:38.851Z", + "timeOfCurrentVersionExpiry": "2020-04-18T16:51:39.442Z", + "timeOfDeletion": null, + "vaultId": "ocid1.vault.oc1.iad.exampleyaaeuk.examplesuxtdqxczlvygwk4ouq2mhzr223g4o2ojs4o4q4ghmt6rlexample" + } + ,{ + "compartmentId" : "ocid1.tenancy.oc1..exampleah7zkvaffv26pzyauoe2zbncvbqvhvsudmlpe557wakiofexample", + "currentVersionNumber" : 1, + "definedTags" : { }, + "description" : "example secret description", + "freeformTags" : { }, + "systemTags": {}, + "id" : "ocid1.vaultsecret.oc1.iad.exampleaz5qacpqadubrc4wwugrqmw5dnyzvcxwzds6er5enn2oamexample”, + "keyId" : "ocid1.key.oc1.iad.exampleyaaeuk.abuwcvbrswr2nbvrraqomsmhopc74rlqupwyv3byhikd4577rrky7example”, + "lifecycleDetails" : null, + "lifecycleState" : "ACTIVE", + "metadata" : null, + "secretName" : "exampleSecret", + "secretRules" : [ { + "ruleType" : "SECRET_EXPIRY_RULE", + "secretVersionExpiryInterval" : "P30D", + "timeOfAbsoluteExpiry" : "2023-03-18T22:00:00.000Z", + "isSecretContentRetrievalBlockedOnExpiry" : false + } ], + "timeCreated" : "2020-03-18T16:51:38.851Z", + "timeOfCurrentVersionExpiry" : null, + "timeOfDeletion" : null, + "vaultId" : "ocid1.vault.oc1.iad.exampleyaaeuk.examplesuxtdqxczlvygwk4ouq2mhzr223g4o2ojs4o4q4ghmt6rlexample", + "isAutoGenerationEnabled": true, + "secretGenerationContext": { + "generationType": "PASSPHRASE", + "generationTemplate": "SECRETS_DEFAULT_PASSWORD" + } + } + ] + CreateSecretDetails: + description: The details of the secret that you want to create. + properties: + compartmentId: + description: The OCID of the compartment where you want to create the secret. + type: string + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only string, integer, and Boolean types are supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: A brief description of the secret. Avoid entering confidential information. + maxLength: 4000 + type: string + enableAutoGeneration: + description: | + The value of this flag determines whether or not secret content will be generated automatically. If not set, it defaults to false. + type: boolean + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + keyId: + description: | + The OCID of the master encryption key that is used to encrypt the secret. You must specify a symmetric key to encrypt the secret during import to the vault. You cannot encrypt secrets with asymmetric keys. Furthermore, the key must exist in the vault that you specify. + maxLength: 255 + minLength: 1 + type: string + metadata: + additionalProperties: + type: string + description: (opaque JSON object) + description: | + Additional metadata that you can use to provide context about how to use the secret during rotation or + other administrative tasks. For example, for a secret that you use to connect to a database, the additional + metadata might specify the connection endpoint and the connection string. Provide additional metadata as key-value pairs. + type: object + rotationConfig: + $ref: '#/components/schemas/RotationConfig' + secretContent: + $ref: '#/components/schemas/SecretContentDetails' + secretGenerationContext: + $ref: '#/components/schemas/SecretGenerationContext' + secretName: + description: | + A user-friendly name for the secret. Secret names should be unique within a vault. Avoid entering confidential information. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods. + maxLength: 255 + type: string + secretRules: + description: A list of rules to control how the secret is used and managed. + items: + $ref: '#/components/schemas/SecretRule' + type: array + vaultId: + description: The OCID of the vault where you want to create the secret. + maxLength: 255 + minLength: 1 + type: string + required: + - vaultId + - secretName + - compartmentId + - keyId + type: object + x-example: | + { + "vaultId": "ocid1.vault.oc1.iad.exampleyaaeuk.examplesuxtdqxczlvygwk4ouq2mhzr223g4o2ojs4o4q4ghmt6rlexample", + "secretRules": [ { + "ruleType" : "SECRET_EXPIRY_RULE", + "secretVersionExpiryInterval" : "P30D", + "timeOfAbsoluteExpiry" : "2021-03-18T22:00:00.000Z", + "isSecretContentRetrievalBlockedOnExpiry" : false + } ], + "compartmentId": "ocid1.tenancy.oc1..exampleah7zkvaffv26pzyauoe2zbncvbqvhvsudmlpe557wakiofexample", + "secretName": "testSecret", + "description": "my test secret", + "keyId": "ocid1.key.oc1.iad.exampleyaaeuk.abuwcvbrswr2nbvrraqomsmhopc74rlqupwyv3byhikd4577rrky7example", + "secretContent": { + "content": "<base64_encoded_secret_contents>", + "contentType": "BASE64" + } + } + , { + "vaultId": "ocid1.vault.oc1.iad.exampleyaaeuk.examplesuxtdqxczlvygwk4ouq2mhzr223g4o2ojs4o4q4ghmt6rlexample", + "secretRules": [ { + "ruleType" : "SECRET_EXPIRY_RULE", + "secretVersionExpiryInterval" : "P30D", + "timeOfAbsoluteExpiry" : "2023-03-18T22:00:00.000Z", + "isSecretContentRetrievalBlockedOnExpiry" : false + } ], + "compartmentId": "ocid1.tenancy.oc1..exampleah7zkvaffv26pzyauoe2zbncvbqvhvsudmlpe557wakiofexample", + "secretName": "testSecret", + "description": "my test secret", + "keyId": "ocid1.key.oc1.iad.exampleyaaeuk.abuwcvbrswr2nbvrraqomsmhopc74rlqupwyv3byhikd4577rrky7example", + "enableAutoGeneration": true, + "secretGenerationContext": { + "generationType": "PASSPHRASE", + "generationTemplate": "SECRETS_DEFAULT_PASSWORD" + } + } + Secret: + description: The details of the secret. Secret details do not contain the contents of the secret itself. + properties: + compartmentId: + description: The OCID of the compartment where you want to create the secret. + type: string + currentVersionNumber: + description: The version number of the secret version that's currently in use. + format: int64 + type: integer + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only string, integer and boolean types are supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: A brief description of the secret. Avoid entering confidential information. + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + id: + description: The OCID of the secret. + type: string + isAutoGenerationEnabled: + description: | + The value of this flag determines whether or not secret content will be generated automatically. + type: boolean + keyId: + description: | + The OCID of the master encryption key that is used to encrypt the secret. You must specify a symmetric key to encrypt the secret during import to the vault. You cannot encrypt secrets with asymmetric keys. Furthermore, the key must exist in the vault that you specify. + maxLength: 255 + type: string + lastRotationTime: + description: | + A property indicating when the secret was last rotated successfully, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + lifecycleDetails: + description: Additional information about the current lifecycle state of the secret. + maxLength: 4000 + minLength: 1 + type: string + lifecycleState: + description: The current lifecycle state of the secret. + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + - DELETED + - SCHEDULING_DELETION + - PENDING_DELETION + - CANCELLING_DELETION + - FAILED + type: string + metadata: + additionalProperties: + type: string + description: (opaque JSON object) + description: | + Additional metadata that you can use to provide context about how to use the secret or during rotation or + other administrative tasks. For example, for a secret that you use to connect to a database, the additional + metadata might specify the connection endpoint and the connection string. Provide additional metadata as key-value pairs. + type: object + nextRotationTime: + description: | + A property indicating when the secret is scheduled to be rotated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + rotationConfig: + $ref: '#/components/schemas/RotationConfig' + rotationStatus: + description: Additional information about the status of the secret rotation + enum: + - IN_PROGRESS + - SCHEDULED + - NOT_ENABLED + - CANCELLING + type: string + secretGenerationContext: + $ref: '#/components/schemas/SecretGenerationContext' + secretName: + description: The user-friendly name of the secret. Avoid entering confidential information. + maxLength: 255 + type: string + secretRules: + description: A list of rules that control how the secret is used and managed. + items: + $ref: '#/components/schemas/SecretRule' + type: array + timeCreated: + description: | + A property indicating when the secret was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + timeOfCurrentVersionExpiry: + description: | + An optional property indicating when the current secret version will expire, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + timeOfDeletion: + description: | + An optional property indicating when to delete the secret, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + vaultId: + description: The OCID of the vault where the secret exists. + type: string + required: + - id + - vaultId + - secretName + - compartmentId + - lifecycleState + - timeCreated + type: object + x-example: | + { + "compartmentId" : "ocid1.tenancy.oc1..exampleah7zkvaffv26pzyauoe2zbncvbqvhvsudmlpe557wakiofexample", + "currentVersionNumber" : 1, + "definedTags" : { }, + "description" : "example secret description", + "freeformTags" : { }, + "id" : "ocid1.vaultsecret.oc1.iad.exampleaz5qacpqadubrc4wwugrqmw5dnyzvcxwzds6er5enn2oamexample", + "keyId" : "ocid1.key.oc1.iad.exampleyaaeuk.abuwcvbrswr2nbvrraqomsmhopc74rlqupwyv3byhikd4577rrky7example", + "lifecycleDetails" : null, + "lifecycleState" : "ACTIVE", + "metadata" : null, + "secretName" : "exampleSecret", + "secretRules" : [ { + "ruleType" : "SECRET_EXPIRY_RULE", + "secretVersionExpiryInterval" : "P30D", + "timeOfAbsoluteExpiry" : "2021-03-18T22:00:00.000Z", + "isSecretContentRetrievalBlockedOnExpiry" : false + } ], + "timeCreated" : "2020-03-18T16:51:38.851Z", + "timeOfCurrentVersionExpiry" : null, + "timeOfDeletion" : null, + "vaultId" : "ocid1.vault.oc1.iad.exampleyaaeuk.examplesuxtdqxczlvygwk4ouq2mhzr223g4o2ojs4o4q4ghmt6rlexample" + } + ,{ + "compartmentId" : "ocid1.tenancy.oc1..exampleah7zkvaffv26pzyauoe2zbncvbqvhvsudmlpe557wakiofexample", + "currentVersionNumber" : 1, + "definedTags" : { }, + "description" : "example secret description", + "freeformTags" : { }, + "id" : "ocid1.vaultsecret.oc1.iad.exampleaz5qacpqadubrc4wwugrqmw5dnyzvcxwzds6er5enn2oamexample", + "keyId" : "ocid1.key.oc1.iad.exampleyaaeuk.abuwcvbrswr2nbvrraqomsmhopc74rlqupwyv3byhikd4577rrky7example", + "lifecycleDetails" : null, + "lifecycleState" : "ACTIVE", + "metadata" : null, + "secretName" : "exampleSecret", + "secretRules" : [ { + "ruleType" : "SECRET_EXPIRY_RULE", + "secretVersionExpiryInterval" : "P30D", + "timeOfAbsoluteExpiry" : "2023-03-18T22:00:00.000Z", + "isSecretContentRetrievalBlockedOnExpiry" : false + } ], + "timeCreated" : "2020-03-18T16:51:38.851Z", + "timeOfCurrentVersionExpiry" : null, + "timeOfDeletion" : null, + "vaultId" : "ocid1.vault.oc1.iad.exampleyaaeuk.examplesuxtdqxczlvygwk4ouq2mhzr223g4o2ojs4o4q4ghmt6rlexample", + "isAutoGenerationEnabled": true, + "secretGenerationContext": { + "generationType": "PASSPHRASE", + "generationTemplate": "SECRETS_DEFAULT_PASSWORD" + } + } + UpdateSecretDetails: + description: Details for updating a secret. + properties: + currentVersionNumber: + description: | + Details to update the secret version of the specified secret. The secret contents, + version number, and rules can't be specified at the same time. + Updating the secret contents automatically creates a new secret version. + format: int64 + type: integer + definedTags: + additionalProperties: + additionalProperties: + description: |- + An object that represents the value of the tag. Only string, integer, and Boolean types are supported. + (opaque JSON object) + type: string + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Operations": {"CostCenter": "42"}}` + type: object + description: + description: A brief description of the secret. Avoid entering confidential information. + type: string + enableAutoGeneration: + description: | + The value of this flag determines whether or not secret content will be generated automatically. + type: boolean + 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](/Content/General/Concepts/resourcetags.htm). + Example: `{"Department": "Finance"}` + type: object + metadata: + additionalProperties: + type: string + description: (opaque JSON object) + description: | + Additional metadata that you can use to provide context about how to use the secret or during rotation or + other administrative tasks. For example, for a secret that you use to connect to a database, the additional + metadata might specify the connection endpoint and the connection string. Provide additional metadata as key-value pairs. + type: object + rotationConfig: + $ref: '#/components/schemas/RotationConfig' + secretContent: + $ref: '#/components/schemas/SecretContentDetails' + secretGenerationContext: + $ref: '#/components/schemas/SecretGenerationContext' + secretRules: + description: A list of rules to control how the secret is used and managed. + items: + $ref: '#/components/schemas/SecretRule' + type: array + type: object + x-example: | + { + "description": "test secret - v2", + "currentVersionNumber": 4 + } + ChangeSecretCompartmentDetails: + description: Specifies the updated compartment OCID for the secret. + properties: + compartmentId: + description: | + The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment + into which the resource should be moved. + maxLength: 255 + minLength: 1 + type: string + required: + - compartmentId + type: object + x-example: | + { + "compartmentId": "ocid1.tenancy.oc1..exampleayur5bs7qclkqyk7cvbgu44hdxvkjugqrqicjfcem7qri4example" + } + ScheduleSecretDeletionDetails: + description: Details for scheduling the deletion of the specified secret. + properties: + timeOfDeletion: + description: | + An optional property indicating when to delete the secret version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + format: date-time + type: string + type: object + x-example: | + { + "timeOfDeletion": "2020-04-18T05:30:00.000Z" + } + SecretVersion: + description: The details of the secret version, excluding the contents of the secret. + properties: + contentType: + description: The content type of the secret version's secret contents. + enum: + - BASE64 + type: string + isContentAutoGenerated: + description: | + Boolean flag indicating whether secret content for this secret version was auto-generated or not. + type: boolean + name: + description: | + The name of the secret version. A name is unique across versions of a secret. + type: string + secretId: + description: The OCID of the secret. + type: string + stages: + description: | + A list of possible rotation states for the secret version. A secret version marked `CURRENT` is currently in use. A secret version + marked `PENDING` is staged and available for use, but has not been applied on the target system and, therefore, has not been rotated + into current, active use. The secret most recently uploaded to a vault is always marked `LATEST`. (The first version of a secret is + always marked as both `CURRENT` and `LATEST`.) A secret version marked `PREVIOUS` is the secret version that was most recently marked + `CURRENT`, before the last secret version rotation. A secret version marked `DEPRECATED` is neither current, pending, nor the previous + one in use. Only secret versions marked `DEPRECATED` can be scheduled for deletion. + items: + enum: + - CURRENT + - PENDING + - LATEST + - PREVIOUS + - DEPRECATED + type: string + type: array + timeCreated: + description: | + A optional property indicating when the secret version was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + timeOfCurrentVersionExpiry: + description: | + An optional property indicating when the current secret version will expire, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + timeOfDeletion: + description: | + An optional property indicating when to delete the secret version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + versionNumber: + description: The version number of the secret. + format: int64 + type: integer + type: object + x-example: | + [ + { + "contentType": null, + "name": null, + "secretId": "ocid1.vaultsecret.region1.sea.exampleanpy7c7qa6vugpr2lcvblz7bwbzahf25fdueaivyoy5jzlexample", + "stages": ["CURRENT", "LATEST"], + "timeCreated": "2020-03-19T04:56:53.048Z", + "timeOfDeletion": null, + "timeOfExpiry": null, + "versionNumber": 1 + ,"isContentAutoGenerated": false + } + ] + ScheduleSecretVersionDeletionDetails: + description: Schedules the deletion of the specified secret version. + properties: + timeOfDeletion: + description: | + An optional property indicating when to delete the secret version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + type: object + x-example: | + { + "timeOfDeletion": "2020-04-18T05:30:00.000Z" + } + SecretVersionSummary: + description: The secret version summary object, which doesn't include the contents of the secret. + properties: + contentType: + description: The content type of the secret version's secret contents. + enum: + - BASE64 + type: string + isContentAutoGenerated: + description: | + Boolean flag indicating whether secret content for this secret version was auto-generated or not. + type: boolean + name: + description: | + The name of the secret version. A name is unique across versions of a secret. + type: string + secretId: + description: The OCID of the secret. + type: string + stages: + description: | + A list of possible rotation states for the secret version. A secret version marked `CURRENT` is currently in use. A secret version + marked `PENDING` is staged and available for use, but has not been applied on the target system and, therefore, has not been rotated + into current, active use. The secret most recently uploaded to a vault is always marked `LATEST`. (The first version of a secret is + always marked as both `CURRENT` and `LATEST`.) A secret version marked `PREVIOUS` is the secret version that was most recently marked + `CURRENT`, before the last secret version rotation. A secret version marked `DEPRECATED` is neither current, pending, nor the previous + one in use. Only secret versions marked `DEPRECATED` can be scheduled for deletion. + items: + enum: + - CURRENT + - PENDING + - LATEST + - PREVIOUS + - DEPRECATED + type: string + type: array + systemTags: + additionalProperties: + additionalProperties: + description: |- + The value of the tag. Only the String type is supported. + (opaque JSON object) + type: string + description: | + Key-value pair representing system tag keys and values scoped to a namespace. + Example: `{"bar-key": "value"}` + 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: | + A optional property indicating when the secret version was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + timeOfDeletion: + description: | + An optional property indicating when to delete the secret version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + timeOfExpiry: + description: | + An optional property indicating when the secret version will expire, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. + Example: `2019-04-03T21:10:29.600Z` + format: date-time + type: string + versionNumber: + description: The version number of the secret. + format: int64 + type: integer + required: + - secretId + - timeCreated + - versionNumber + type: object + x-example: | + [ { + "contentType" : null, + "name" : null, + "secretId" : "ocid1.vaultsecret.oc1.iad.exampleaz5qacpqadl27cvbdsakdg5bbk4uodmjilfhworxzxfhmfexample", + "stages" : [ + "CURRENT", + "LATEST" ], + "timeCreated" : "2020-03-19T02:58:46.010Z", + "timeOfDeletion" : null, + "timeOfExpiry" : null, + "versionNumber" : 2, + "systemTags": {} + ,"isContentAutoGenerated": true + }, { + "contentType" : null, + "name" : null, + "secretId" : "ocid1.vaultsecret.oc1.iad.exampleaz5qacpqadl27cvbdsakdg5bbk4uodmjilfhworxzxfhmfexample", + "stages" : [ "PREVIOUS" ], + "timeCreated" : "2020-03-17T00:52:19.820Z", + "timeOfDeletion" : null, + "timeOfExpiry" : null, + "versionNumber" : 1, + "systemTags": {} + ,"isContentAutoGenerated": false + } ] + RotationConfig: + description: Defines the frequency of the rotation and the information about the target system + properties: + isScheduledRotationEnabled: + description: | + Enables auto rotation, when set to true rotationInterval must be set. + type: boolean + rotationInterval: + description: | + The time interval that indicates the frequency for rotating secret data, as described in ISO 8601 format. + The minimum value is 1 day and maximum value is 360 days. + For example, if you want to set the time interval for rotating a secret data as 30 days, the duration is expressed as "P30D." + format: x-obmcs-duration + type: string + targetSystemDetails: + $ref: '#/components/schemas/TargetSystemDetails' + required: + - targetSystemDetails + type: object + SecretGenerationContext: + description: Captures a configurable set of secret generation rules such as length, base characters, additional characters, and so on. + discriminator: + propertyName: generationType + properties: + generationType: + description: Name of the predefined secret generation type. + enum: + - PASSPHRASE + - SSH_KEY + - BYTES + type: string + secretTemplate: + description: | + SecretTemplate captures structure in which customer wants to store secrets. This is optional and a default structure is available for each secret type. + The template can have any structure with static values that are not generated. Within the template, you can insert predefined placeholders to store secrets. + These placeholders are later replaced with the generated content and saved as a Base64 encoded content. + type: string + required: + - generationType + type: object + x-example: | + { + "generationType": "SSH_KEY", + "generationTemplate": "RSA_3072" + } + Error: + description: An error. + properties: + code: + description: | + A short error code that defines the error, meant for programmatic parsing. See + [API Errors](/Content/API/References/apierrors.htm). + type: string + message: + description: A human-readable error string. + type: string + required: + - code + - message + type: object + SecretContentDetails: + description: The content of the secret and metadata to help identify it. + discriminator: + propertyName: contentType + properties: + contentType: + description: The base64-encoded content of the secret. + enum: + - BASE64 + type: string + name: + description: Names should be unique within a secret. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods. + maxLength: 50 + type: string + stage: + default: CURRENT + description: | + The rotation state of the secret content. The default is `CURRENT`, meaning that the secret is currently in use. A secret version + that you mark as `PENDING` is staged and available for use, but you don't yet want to rotate it into current, active use. For example, + you might create or update a secret and mark its rotation state as `PENDING` if you haven't yet updated the secret on the target system. + When creating a secret, only the value `CURRENT` is applicable, although the value `LATEST` is also automatically applied. When updating + a secret, you can specify a version's rotation state as either `CURRENT` or `PENDING`. + enum: + - CURRENT + - PENDING + type: string + required: + - contentType + type: object + x-example: | + { + "content": "<secret_text>", + "contentType": "BASE64", + "stage": "PENDING" + } + SecretRule: + description: A rule that you can apply to a secret to enforce certain conditions on the secret's usage and management. + discriminator: + propertyName: ruleType + properties: + ruleType: + description: The type of rule, which either controls when the secret contents expire or whether they can be reused. + enum: + - SECRET_EXPIRY_RULE + - SECRET_REUSE_RULE + type: string + required: + - ruleType + type: object + x-example: | + { + "ruleType": "SECRET_EXPIRY_RULE" + } + TargetSystemDetails: + description: | + The TargetSystemDetails provides the targetSystem type and type-specific connection metadata + discriminator: + propertyName: targetSystemType + properties: + targetSystemType: + description: | + Unique identifier of the target system that Vault Secret connects to. + enum: + - ADB + - FUNCTION + type: string + required: + - targetSystemType + type: object + ListSecretsResponse: + type: object + properties: + secrets: + type: array + items: + $ref: '#/components/schemas/SecretSummary' + ListSecretVersionsResponse: + type: object + properties: + secret_versions: + type: array + items: + $ref: '#/components/schemas/SecretVersionSummary' + responses: + '400': + description: Bad Request + 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: + '*/*': + schema: + $ref: '#/components/schemas/Error' + '401': + description: Unauthorized + 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: + '*/*': + schema: + $ref: '#/components/schemas/Error' + '404': + description: Not Found + 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: + '*/*': + schema: + $ref: '#/components/schemas/Error' + '409': + description: Conflict + 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: + '*/*': + schema: + $ref: '#/components/schemas/Error' + '412': + description: Precondition Failed + 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: + '*/*': + schema: + $ref: '#/components/schemas/Error' + '429': + description: Too many requests. User-rate limit exceeded. + 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 + retry-after: + description: | + If the request gets throttled, time in seconds to retry the request. + schema: + type: integer + content: + '*/*': + schema: + $ref: '#/components/schemas/Error' + '500': + description: Internal Server 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: + '*/*': + schema: + $ref: '#/components/schemas/Error' + DefaultError: + description: An error has occurred. + 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: + '*/*': + schema: + $ref: '#/components/schemas/Error' + parameters: + CompartmentIdQueryParam: + description: The OCID of the compartment. + in: query + name: compartmentId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + FilterByNameQueryParam: + description: The secret name. + in: query + name: name + required: false + x-default-description: The default value is null. + schema: + type: string + maxLength: 255 + PaginationLimitQueryParam: + description: | + The maximum number of items to return in a paginated "List" call. + in: query + name: limit + required: false + schema: + type: integer + minimum: 1 + maximum: 1000 + PaginationTokenQueryParam: + description: | + The value of the `opc-next-page` response header + from the previous "List" call. + in: query + name: page + required: false + schema: + type: string + minLength: 1 + maxLength: 1024 + RequestIdHeader: + description: | + Unique identifier for the request. If provided, the returned request ID + will include this value. Otherwise, a random request ID will be + generated by the service. + in: header + name: opc-request-id + required: false + schema: + type: string + SecretSortByQueryParam: + description: | + The field to sort by. You can specify only one sort order. The default order for + `TIMECREATED` is descending. The default order for `NAME` is ascending. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - TIMECREATED + - NAME + default: NAME + SortOrderQueryParam: + description: | + The sort order to use, either ascending (`ASC`) or descending (`DESC`). + in: query + name: sortOrder + required: false + schema: + type: string + enum: + - ASC + - DESC + default: DESC + VaultIdQueryParam: + description: The OCID of the vault. + in: query + name: vaultId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + RetryTokenHeader: + description: | + A token that uniquely identifies a request so it can be retried in case + of a timeout or server error without risk of executing that same action + again. Retry tokens expire after 24 hours, but can be invalidated + before then due to conflicting operations (e.g., if a resource has been + deleted and purged from the system, then a retry of the original + creation request may be rejected). + in: header + name: opc-retry-token + required: false + schema: + type: string + minLength: 1 + maxLength: 64 + SecretIdRequiredPathParam: + description: The OCID of the secret. + in: path + name: secretId + required: true + schema: + type: string + 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 + SecretVersionNumberRequiredPathParam: + description: The version number of the secret. + in: path + name: secretVersionNumber + required: true + schema: + type: integer + format: int64 + SecretVersionSortByQueryParam: + description: | + The field to sort by. Only one sort order may be provided. Time created is default ordered as descending. Display name is default ordered as ascending. + in: query + name: sortBy + required: false + schema: + type: string + enum: + - VERSION_NUMBER + default: VERSION_NUMBER + x-stackQL-resources: + secrets: + id: oci.vault.secrets + name: secrets + title: Secrets + methods: + list: + operation: + $ref: '#/paths/~1secrets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.secrets + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListSecretsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"secrets\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1secrets/post' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1secrets~1{secretId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1secrets~1{secretId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + cancel_secret_deletion: + operation: + $ref: '#/paths/~1secrets~1{secretId}~1actions~1cancelDeletion/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + cancel_secret_rotation: + operation: + $ref: '#/paths/~1secrets~1{secretId}~1actions~1cancelRotation/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + change_compartment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1secrets~1{secretId}~1actions~1changeCompartment/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + rotate_secret: + operation: + $ref: '#/paths/~1secrets~1{secretId}~1actions~1rotate/post' + response: + mediaType: application/json + openAPIDocKey: '202' + request: + nativeCasing: camel + schedule_secret_deletion: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1secrets~1{secretId}~1actions~1scheduleDeletion/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/secrets/methods/get' + - $ref: '#/components/x-stackQL-resources/secrets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/secrets/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/secrets/methods/update' + delete: [] + replace: [] + secret_versions: + id: oci.vault.secret_versions + name: secret_versions + title: Secret Versions + methods: + get: + operation: + $ref: '#/paths/~1secrets~1{secretId}~1version~1{secretVersionNumber}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + list: + operation: + $ref: '#/paths/~1secrets~1{secretId}~1versions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.secret_versions + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListSecretVersionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"secret_versions\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/secret_versions/methods/get' + - $ref: '#/components/x-stackQL-resources/secret_versions/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + versions: + id: oci.vault.versions + name: versions + title: Versions + methods: + cancel_secret_version_deletion: + operation: + $ref: '#/paths/~1secrets~1{secretId}~1version~1{secretVersionNumber}~1actions~1cancelDeletion/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + schedule_secret_version_deletion: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1secrets~1{secretId}~1version~1{secretVersionNumber}~1actions~1scheduleDeletion/post' + response: + mediaType: application/json + openAPIDocKey: '204' + request: + nativeCasing: camel + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://vaults.{region}.oci.oraclecloud.com/20180608 + variables: + region: + default: us-ashburn-1 + description: OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. + x-stackQL-envVar: OCI_REGION +x-stackQL-config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: opc-next-page + location: header diff --git a/providers/src/oci/v00.00.00000/services/work_requests.yaml b/providers/src/oci/v00.00.00000/services/work_requests.yaml new file mode 100644 index 00000000..07b25069 --- /dev/null +++ b/providers/src/oci/v00.00.00000/services/work_requests.yaml @@ -0,0 +1,716 @@ +openapi: 3.0.0 +info: + title: work_requests API + description: oci work_requests API + version: '20160918' +paths: + /workRequests: + get: + description: | + Lists the work requests in a compartment or for a specified resource. + operationId: ListWorkRequests + parameters: + - $ref: '#/components/parameters/CompartmentIdQueryParam' + - $ref: '#/components/parameters/ResourceIdQueryParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: The list of work requests. + 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/ListWorkRequestsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Lists work requests in a compartment or for a resource. + tags: + - workRequest + x-example: | + GET /20160918/workRequests?compartmentId=<compartment_OCID> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /workRequests/{workRequestId}: + get: + description: Gets the details of a work request. + operationId: GetWorkRequest + parameters: + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: The details of the work request. + 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/WorkRequest' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Gets the details of a work request. + tags: + - workRequest + x-example: | + GET /20160918/workRequests/<work_request_OCID> + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /workRequests/{workRequestId}/errors: + get: + description: | + Gets the errors for a work request. + operationId: ListWorkRequestErrors + parameters: + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: The list of work request errors. + 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/ListWorkRequestErrorsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Lists work request errors + tags: + - workRequest + x-example: | + GET /20160918/workRequests/<work_request_OCID>/errors + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + /workRequests/{workRequestId}/logs: + get: + description: | + Gets the logs for a work request. + operationId: ListWorkRequestLogs + parameters: + - $ref: '#/components/parameters/WorkRequestIdPathParam' + - $ref: '#/components/parameters/PaginationLimitQueryParam' + - $ref: '#/components/parameters/PaginationTokenQueryParam' + - $ref: '#/components/parameters/SortOrderQueryParam' + - $ref: '#/components/parameters/OpcRequestIdHeaderParam' + responses: + '200': + description: The list of work request logs. + 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/ListWorkRequestLogsResponse' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '404': + $ref: '#/components/responses/404' + '500': + $ref: '#/components/responses/500' + default: + $ref: '#/components/responses/DefaultError' + summary: Lists work request logs + tags: + - workRequest + x-example: | + GET /20160918/workRequests/<work_request_OCID>/logs + Host: iaas.us-phoenix-1.oraclecloud.com + <authorization and other headers> + x-related-resource: '#/definitions/WorkRequestLogEntry' +components: + schemas: + WorkRequestSummary: + description: A summary of the status of a work request. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing + this work request. + type: string + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + type: string + operationType: + description: The asynchronous operation tracked by this work request. + type: string + percentComplete: + description: The percentage complete of the operation tracked by this work request. + format: float + type: number + status: + description: The status of the work request. + enum: + - ACCEPTED + - IN_PROGRESS + - FAILED + - SUCCEEDED + - CANCELING + - CANCELED + type: string + timeAccepted: + description: The date and time the work request was created, in the format defined by RFC3339. + format: date-time + type: string + timeFinished: + description: | + The date and time the work request reached a terminal state, either `FAILED` or `SUCCEEDED`. + Format is defined by RFC3339. + format: date-time + type: string + timeStarted: + description: | + The date and time the work request transitioned from `ACCEPTED` to `IN_PROGRESS`, in + the format defined by RFC3339. + format: date-time + type: string + required: + - operationType + - status + - id + - compartmentId + - percentComplete + - timeAccepted + x-example: | + { + "operationType":"LaunchInstancesInPool", + "status":"SUCCEEDED", + "id":"ocid1.coreservicesworkrequest.oc1.phx.exampleunique_ID", + "compartmentId":"ocid1.tenancy.oc1..exampleuniqueID", + "percentComplete":100.0, + "timeAccepted":"2019-05-07T00:50:03.248Z", + "timeStarted":"2019-05-07T00:50:03.374Z", + "timeFinished":"2019-05-07T00:52:05.704Z" + } + type: object + WorkRequest: + description: An asynchronous work request. + properties: + compartmentId: + description: | + The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment + that contains the work request. + type: string + id: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + type: string + operationType: + description: The asynchronous operation tracked by this work request. + type: string + percentComplete: + description: The percentage complete of the operation tracked by this work request. + format: float + type: number + resources: + description: The resources that are affected by this work request. + items: + $ref: '#/components/schemas/WorkRequestResource' + type: array + status: + description: The status of the work request. + enum: + - ACCEPTED + - IN_PROGRESS + - FAILED + - SUCCEEDED + - CANCELING + - CANCELED + type: string + timeAccepted: + description: The date and time the work request was created, in the format defined by RFC3339. + format: date-time + type: string + timeFinished: + description: | + The date and time the work request reached a terminal state, either `FAILED` or `SUCCEEDED`. + Format is defined by RFC3339. + format: date-time + type: string + timeStarted: + description: | + The date and time the work request transitioned from `ACCEPTED` to `IN_PROGRESS`, + in the format defined by RFC3339. + format: date-time + type: string + required: + - operationType + - status + - id + - compartmentId + - resources + - percentComplete + - timeAccepted + x-example: | + Example response: Work request that tracks the launch instance operation + { + "operationType": "LaunchInstance", + "status": "SUCCEEDED", + "id": "ocid1.coreservicesworkrequest.oc1.phx.exampleunique_ID", + "compartmentId": "ocid1.tenancy.oc1..exampleunique_ID", + "resources": [ + { + "actionType": "CREATED", + "entityType": "instance", + "identifier": "ocid1.instance.oc1.phx.exampleunique_ID", + "entityUri": "/20160918/instances/ocid1.instance.oc1.phx.exampleunique_ID" + } + ], + "percentComplete": 100.0, + "timeAccepted": "2019-05-06T23:02:52.319Z", + "timeStarted": "2019-05-06T23:02:57.592Z", + "timeFinished": "2019-05-06T23:03:59.744Z" + } + type: object + WorkRequestError: + description: An error encountered while executing an operation that is tracked by a work request. + properties: + code: + description: A machine-usable code for the error that occured. + type: string + message: + description: A human-readable error string. + type: string + timestamp: + description: The date and time the error occurred. + format: date-time + type: string + required: + - code + - message + - timestamp + x-example: | + { + "code" : "InternalError", + "message" : "Launch instance failed, Retrying failed to complete successfully after 5 attempts.", + "timestamp" : "2019-05-07T01:04:43.543Z" + } + type: object + WorkRequestLogEntry: + description: A log message from executing an operation that is tracked by a work request. + properties: + message: + description: A human-readable log message. + type: string + timestamp: + description: The date and time the log message was written. + format: date-time + type: string + required: + - message + - timestamp + x-example: | + { + "message" : "Powering on virtual machine.", + "timestamp" : "2019-05-07T00:50:44.446Z" + } + type: object + Error: + description: An error code and message from an API request failure. + properties: + code: + description: | + A short error code that defines the error, meant for programmatic parsing. See + [API Errors](/iaas/Content/API/References/apierrors.htm). + type: string + message: + description: A human-readable error string. + type: string + required: + - code + - message + type: object + WorkRequestResource: + description: | + A resource that is created or operated on by an asynchronous operation that is tracked by + a work request. + properties: + actionType: + description: | + The way in which this resource was affected by the operation that spawned the work + request. + enum: + - CREATED + - UPDATED + - DELETED + - RELATED + - IN_PROGRESS + type: string + entityType: + description: The resource type the work request affects. + type: string + entityUri: + description: The URI path that you can use for a GET request to access the resource metadata. + type: string + identifier: + description: | + An [OCID](/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the + resource. + type: string + required: + - actionType + - entityType + - identifier + type: object + ListWorkRequestsResponse: + type: object + properties: + work_requests: + type: array + items: + $ref: '#/components/schemas/WorkRequestSummary' + ListWorkRequestErrorsResponse: + type: object + properties: + work_request_errors: + type: array + items: + $ref: '#/components/schemas/WorkRequestError' + ListWorkRequestLogsResponse: + type: object + properties: + work_request_logs: + type: array + items: + $ref: '#/components/schemas/WorkRequestLogEntry' + responses: + '400': + description: Bad Request + 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' + '401': + description: Unauthorized + 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' + '404': + description: Not Found + 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' + '500': + description: Internal Server 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' + DefaultError: + description: An error has occurred. + 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' + parameters: + CompartmentIdQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. + in: query + name: compartmentId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + ResourceIdQueryParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. + in: query + name: resourceId + required: false + schema: + type: string + minLength: 1 + maxLength: 255 + default: null + PaginationLimitQueryParam: + description: | + For list pagination. The maximum number of results per page, or items to return in a + paginated "List" call. For important details about how pagination works, see + [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + in: query + name: limit + required: false + schema: + type: integer + minimum: 1 + maximum: 1000 + default: 100 + PaginationTokenQueryParam: + description: | + For list pagination. The value of the `opc-next-page` response header from the + previous "List" call. For important details about how pagination works, see + [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). + in: query + name: page + required: false + schema: + type: string + minLength: 1 + maxLength: 2000 + default: null + OpcRequestIdHeaderParam: + description: | + Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a + particular request, please provide the request ID. + in: header + name: opc-request-id + required: false + schema: + type: string + pattern: '[A-Za-z0-9\-_\.]+' + WorkRequestIdPathParam: + description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. + in: path + name: workRequestId + required: true + schema: + type: string + minLength: 1 + maxLength: 255 + SortOrderQueryParam: + description: | + The sort order to use, either ascending (`ASC`) or descending (`DESC`). + in: query + name: sortOrder + required: false + x-default-description: no sorting + schema: + type: string + enum: + - ASC + - DESC + x-stackQL-resources: + work_requests: + id: oci.work_requests.work_requests + name: work_requests + title: Work Requests + methods: + list: + operation: + $ref: '#/paths/~1workRequests/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.work_requests + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListWorkRequestsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"work_requests\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + get: + operation: + $ref: '#/paths/~1workRequests~1{workRequestId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/work_requests/methods/get' + - $ref: '#/components/x-stackQL-resources/work_requests/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + work_request_errors: + id: oci.work_requests.work_request_errors + name: work_request_errors + title: Work Request Errors + methods: + list: + operation: + $ref: '#/paths/~1workRequests~1{workRequestId}~1errors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.work_request_errors + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListWorkRequestErrorsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"work_request_errors\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/work_request_errors/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + work_request_logs: + id: oci.work_requests.work_request_logs + name: work_request_logs + title: Work Request Logs + methods: + list: + operation: + $ref: '#/paths/~1workRequests~1{workRequestId}~1logs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.work_request_logs + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListWorkRequestLogsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"work_request_logs\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 + config: + queryParamPushdown: + top: + paramName: limit + maxValue: 1000 + request: + nativeCasing: camel + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/work_request_logs/methods/list' + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://iaas.{region}.oraclecloud.com/20160918 + variables: + region: + default: us-ashburn-1 + description: OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. + x-stackQL-envVar: OCI_REGION +x-stackQL-config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: opc-next-page + location: header