openapi: 3.2.0 info: description: Use the Globally Distributed Database service APIs to create and manage the Globally distributed databases. title: Globally Distributed Database Distributed Db Work Request Service API version: '20250101' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/7768559c5720cb1b8396abdb1463b1ad39f9b837f25af9d8852377ad772e93bf.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Globally Distributed Database OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/7768559c5720cb1b8396abdb1463b1ad39f9b837f25af9d8852377ad772e93bf.yaml what: the harvested document for Globally Distributed Database servers: - url: https://127.0.0.1/20250101 tags: - name: DistributedDbWorkRequestService paths: /workRequests: get: description: 'Lists the work requests in a compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestIdQueryParam' - $ref: '#/components/parameters/WorkRequestStatusQueryParam' - $ref: '#/components/parameters/ResourceIdentifierQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' responses: 200: description: The list of work request summaries. 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/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/default' summary: List work requests tags: - DistributedDbWorkRequestService x-example: 'GET /20250101/workRequests?compartmentId= Host: globaldb.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: get: description: Gets details of the work request with the given ID. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' 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 retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: 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/default' summary: Get work request status tags: - DistributedDbWorkRequestService x-example: 'GET /20250101/workRequests/{workRequestId} Host: globaldb.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Returns a (paginated) list of errors for the work request with the given ID. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' 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 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/default' summary: List work request errors tags: - DistributedDbWorkRequestService x-example: 'GET /20250101/workRequests/{workRequestId}/errors Host: globaldb.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Returns a (paginated) list of logs for the work request with the given ID. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' 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 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/default' summary: List work request logs tags: - DistributedDbWorkRequestService x-example: 'GET /20250101/workRequests/{workRequestId}/logs Host: globaldb.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/WorkRequestLogEntry' components: parameters: PaginationTokenQueryParam: description: A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. in: query name: page schema: type: string minLength: 1 ResourceIdentifierQueryParam: description: The ID of the resource affected by the work request. in: query name: resourceId schema: type: string CompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId required: true schema: type: string WorkRequestStatusQueryParam: description: A filter to return only resources their lifecycleState matches the given OperationStatus. in: query name: status required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OperationStatus' schema: type: string enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED - NEEDS_ATTENTION PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 WorkRequestIdPathParam: description: The ID of the asynchronous request. in: path name: workRequestId required: true schema: type: string SortOrderQueryParam: description: The sort order to use, either 'ASC' or 'DESC'. in: query name: sortOrder 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 WorkRequestIdQueryParam: description: The ID of the asynchronous work request. in: query name: workRequestId x-default-description: 'null' 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 RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string schemas: 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 WorkRequestSummaryCollection: description: Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata. properties: items: description: List of workRequestSummary objects. items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items 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 - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ActionType' 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 identifier of the resource the work request affects. type: string metadata: additionalProperties: type: string description: Additional information that helps to explain the resource. enum: - IS_DRY_RUN type: object x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceMetadataKey' required: - actionType - entityType - identifier WorkRequestErrorCollection: description: Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata. properties: items: description: List of workRequestError objects. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object WorkRequestSummary: description: A summary of the status of a work request. properties: compartmentId: description: 'The ocid of the compartment that contains the work request. Work requests should be 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, it is up to the service team to pick the primary resource whose compartment should be used ' type: string id: description: The id of the work request. type: string operationType: description: Type of the work request enum: - CREATE_DISTRIBUTED_DB - PATCH_DISTRIBUTED_DB_INSERT_SHARDS - PATCH_DISTRIBUTED_DB_REMOVE_SHARDS - PATCH_DISTRIBUTED_DB_MERGE_CATALOG_SHARDS - DELETE_DISTRIBUTED_DB - CHANGE_DISTRIBUTED_DB_COMPARTMENT - CONFIGURE_DISTRIBUTED_DB_GSMS - CONFIGURE_DISTRIBUTED_DB_SHARDING - GENERATE_DISTRIBUTED_DB_GSM_CERT_SIGNING_REQ - ROTATE_DISTRIBUTED_DB_PASSWORDS - START_DISTRIBUTED_DB - STOP_DISTRIBUTED_DB - START_DISTRIBUTED_DB_SHARD - START_DISTRIBUTED_DB_CATALOG - STOP_DISTRIBUTED_DB_SHARD - STOP_DISTRIBUTED_DB_CATALOG - UPLOAD_DISTRIBUTED_DB_SIGNED_CERT_AND_GENERATE_WALLET - CREATE_DISTRIBUTED_DB_SHARD - CREATE_DISTRIBUTED_DB_CATALOG - CREATE_DISTRIBUTED_DB_GSM - UPDATE_DISTRIBUTED_DB_CATALOG_SHARDS - VALIDATE_NETWORK - EXECUTE_VALIDATE_NETWORK_TESTS - CREATE_PRIVATE_ENDPOINT - DELETE_PRIVATE_ENDPOINT - CHANGE_PRIVATE_ENDPOINT_COMPARTMENT - REINSTATE_PROXY_INSTANCE - DELETE_DISTRIBUTED_DB_SHARD - DELETE_DISTRIBUTED_DB_CATALOG - DELETE_DISTRIBUTED_DB_GSM - ADD_GDSCONTROL_NODE - CHANGE_DISTRIBUTED_DB_BACKUP_CONFIG - ADD_DISTRIBUTED_DB_DG - REMOVE_DISTRIBUTED_DB_DG - CONFIGURE_DISTRIBUTED_DB_GSMS_WALLET - VALIDATE_CA_BUNDLE - RECREATE_FAILED_RESOURCE - MOVE_REPLICATION_UNITS type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED - NEEDS_ATTENTION 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 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 on (https://docs.cloud.oracle.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 datetime string. format: date-time type: string required: - code - message - timestamp WorkRequestLogEntry: 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 datetime string format: date-time type: string required: - message - timestamp WorkRequestLogEntryCollection: description: Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata. properties: items: description: List of workRequestLogEntries. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object WorkRequest: description: A description of workrequest status properties: compartmentId: description: 'The ocid of the compartment that contains the work request. Work requests should be 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, it is up to the service team to pick the primary resource whose compartment should be used ' type: string id: description: The id of the work request. type: string operationType: description: Type of the work request enum: - CREATE_DISTRIBUTED_DB - PATCH_DISTRIBUTED_DB_INSERT_SHARDS - PATCH_DISTRIBUTED_DB_REMOVE_SHARDS - PATCH_DISTRIBUTED_DB_MERGE_CATALOG_SHARDS - DELETE_DISTRIBUTED_DB - CHANGE_DISTRIBUTED_DB_COMPARTMENT - CONFIGURE_DISTRIBUTED_DB_GSMS - CONFIGURE_DISTRIBUTED_DB_SHARDING - GENERATE_DISTRIBUTED_DB_GSM_CERT_SIGNING_REQ - ROTATE_DISTRIBUTED_DB_PASSWORDS - START_DISTRIBUTED_DB - STOP_DISTRIBUTED_DB - START_DISTRIBUTED_DB_SHARD - START_DISTRIBUTED_DB_CATALOG - STOP_DISTRIBUTED_DB_SHARD - STOP_DISTRIBUTED_DB_CATALOG - UPLOAD_DISTRIBUTED_DB_SIGNED_CERT_AND_GENERATE_WALLET - CREATE_DISTRIBUTED_DB_SHARD - CREATE_DISTRIBUTED_DB_CATALOG - CREATE_DISTRIBUTED_DB_GSM - UPDATE_DISTRIBUTED_DB_CATALOG_SHARDS - VALIDATE_NETWORK - EXECUTE_VALIDATE_NETWORK_TESTS - CREATE_PRIVATE_ENDPOINT - DELETE_PRIVATE_ENDPOINT - CHANGE_PRIVATE_ENDPOINT_COMPARTMENT - REINSTATE_PROXY_INSTANCE - DELETE_DISTRIBUTED_DB_SHARD - DELETE_DISTRIBUTED_DB_CATALOG - DELETE_DISTRIBUTED_DB_GSM - ADD_GDSCONTROL_NODE - CHANGE_DISTRIBUTED_DB_BACKUP_CONFIG - ADD_DISTRIBUTED_DB_DG - REMOVE_DISTRIBUTED_DB_DG - CONFIGURE_DISTRIBUTED_DB_GSMS_WALLET - VALIDATE_CA_BUNDLE - RECREATE_FAILED_RESOURCE - MOVE_REPLICATION_UNITS type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED - NEEDS_ATTENTION 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 responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: distributedAutonomousDbDeploymentType: description: 'The distributed autonomous database deployment type. ' enum: - ADB_D type: string distributedAutonomousDbLifecycleState: description: Lifecycle states for the Globally distributed autonomous database. enum: - ACTIVE - FAILED - NEEDS_ATTENTION - INACTIVE - DELETING - DELETED - UPDATING - CREATING type: string distributedAutonomousDbSource: description: 'The source of Globally distributed autonomous database type: Use ADB_D for the Globally distributed autonomous database with autonomous dedicated cloudautonomousvmclusters. ' enum: - ADB_D type: string distributedDbDeploymentType: description: 'The distributed database deployment type. ' enum: - EXADB_XS type: string distributedDbLifecycleState: description: Lifecycle states for the Globally distributed database. enum: - ACTIVE - FAILED - NEEDS_ATTENTION - INACTIVE - DELETING - DELETED - UPDATING - CREATING type: string distributedDbSource: description: 'Type of Globally distributed database Shard or Catalog. Use NEW_VAULT_AND_CLUSTER for a Globally distributed database on Exascale with new vaults and clusters created from scratch. Use EXISTING_CLUSTER for a Globally distributed database on Exascale based on pre-existing clusters. EXADB_XS is currently the same as EXISTING_CLUSTER and will be deprecated after the deprecation cycle. ' enum: - EXADB_XS - NEW_VAULT_AND_CLUSTER - EXISTING_CLUSTER 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 systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object 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 x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' 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 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. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object 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 x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.distributeddb