openapi: 3.2.0 info: description: A description of the Oracle Cloud Migrations API. title: Oracle Cloud Migrations Migration API version: '20220919' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/116df44b4c0ea89e6d319573e28ba66409fadf2e643473e3d5da38faffa79e5d.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Oracle Cloud Migrations API 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/116df44b4c0ea89e6d319573e28ba66409fadf2e643473e3d5da38faffa79e5d.yaml what: the harvested document for Oracle Cloud Migrations API servers: - url: http://127.0.0.1/20220919 - url: https://127.0.0.1/20220919 tags: - name: migration paths: /migrationAssets: get: description: 'Returns a list of migration assets. ' operationId: ListMigrationAssets parameters: - $ref: '#/components/parameters/MigrationIdentifierQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/MigrationAssetIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/MigrationAssetLifecycleStateQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page with a summary of migration asset 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/MigrationAssetCollection' 400: $ref: '#/components/responses/400' 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 migration assets for migration. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MigrationAssetCollection' post: description: 'Creates a migration asset. ' operationId: CreateMigrationAsset parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The migration asset will be created. headers: content-location: description: 'The full URI of the resource related to the request ' schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control, see `if-match.` ' schema: type: string location: description: 'The full URI of the resource related to the request ' schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: '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/MigrationAsset' 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 migration asset. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MigrationAsset' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMigrationAssetDetails' description: Details for the new migration asset. required: true /migrationAssets/{migrationAssetId}: delete: description: Deletes a migration asset resource by an identifier. operationId: DeleteMigrationAsset parameters: - $ref: '#/components/parameters/MigrationAssetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The migration asset 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 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' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a provisioned migration asset. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MigrationAsset' get: description: Gets a migration asset by identifier. operationId: GetMigrationAsset parameters: - $ref: '#/components/parameters/MigrationAssetIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the migration asset 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/MigrationAsset' 400: $ref: '#/components/responses/400' 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 migration asset. tags: - migration x-obmcs-client-retries-enabled: true put: description: Updates the migration asset. operationId: UpdateMigrationAsset parameters: - $ref: '#/components/parameters/MigrationAssetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The migration asset 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/MigrationAsset' 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 the migration asset identified by the ID. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MigrationAsset' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMigrationAssetDetails' description: The information to be updated. required: true /migrationAssets/{migrationAssetId}/actions/refresh: post: description: 'Refreshes the migration asset with the migration asset ID. ' operationId: RefreshMigrationAsset parameters: - $ref: '#/components/parameters/MigrationAssetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The migration asset will be refreshed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the 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' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Refreshes asset with inventory. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MigrationAsset' /migrationAssets/{migrationAssetId}/actions/replicationProgress: get: description: 'Gets the progress percentage of a migration asset''s replication process. ' operationId: GetReplicationProgress parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/MigrationAssetIdentifierPathParam' responses: 200: description: '' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ReplicationProgress' 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: Gets the progress percentage of the migration asset's replication process. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MigrationAsset' /migrationAssets/{migrationAssetId}/actions/startAssetReplication: post: description: 'Starts replication for the asset with the migration asset ID. ' operationId: StartAssetReplication parameters: - $ref: '#/components/parameters/MigrationAssetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The replication will start. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the 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' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Starts a replication for the asset. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MigrationAsset' /migrationPlans: get: description: 'Returns a list of migration plans. ' operationId: ListMigrationPlans parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/MigrationIdentifierQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/MigrationPlanIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/MigrationPlanLifecycleStateQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of migration plan 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 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/MigrationPlanCollection' 400: $ref: '#/components/responses/400' 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 migration plans in a compartment. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MigrationPlanCollection' post: description: 'Creates a migration plan. ' operationId: CreateMigrationPlan parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The migration plan will be created. headers: content-location: description: 'The full URI of the resource related to the request ' schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control, see `if-match.` ' schema: type: string location: description: 'The full URI of the resource related to the request ' schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: '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/MigrationPlan' 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 migration plan. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MigrationPlan' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMigrationPlanDetails' description: Details for the new migration plan. required: true /migrationPlans/{migrationPlanId}: delete: description: Deletes a migration plan resource by an identifier. operationId: DeleteMigrationPlan parameters: - $ref: '#/components/parameters/MigrationPlanIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The migration plan 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 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' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned migration plan. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MigrationPlan' get: description: Gets a migration plan by identifier. operationId: GetMigrationPlan parameters: - $ref: '#/components/parameters/MigrationPlanIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the migration plan by 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/MigrationPlan' 400: $ref: '#/components/responses/400' 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 migration plan. tags: - migration x-obmcs-client-retries-enabled: true put: description: Updates the migration plan. operationId: UpdateMigrationPlan parameters: - $ref: '#/components/parameters/MigrationPlanIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The migration plan will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: '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' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the migration plan identified by the ID. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MigrationPlan' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMigrationPlanDetails' description: The information to be updated. required: true /migrationPlans/{migrationPlanId}/actions/changeCompartment: post: description: Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeMigrationPlanCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/MigrationPlanIdentifierPathParam' responses: 202: description: Accepted the request. The migration plan will be 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 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' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MigrationPlan' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeMigrationPlanCompartmentDetails' description: Details for the compartment move. required: true /migrationPlans/{migrationPlanId}/actions/execute: post: description: 'Executes the migration plan with the migration plan ID. ' operationId: ExecuteMigrationPlan parameters: - $ref: '#/components/parameters/MigrationPlanIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The migration plan will be executed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the 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' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Executes the migration plan to create an RMS stack. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MigrationPlan' /migrationPlans/{migrationPlanId}/actions/export: get: description: Exports the migration plan to a csv file. operationId: ExportMigrationPlan parameters: - $ref: '#/components/parameters/MigrationPlanIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The exported file. headers: opc-request-id: description: 'Unique Oracle-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/csv: 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' summary: Exports the migration plan to a csv file. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MigrationPlan' /migrationPlans/{migrationPlanId}/actions/import: post: description: Imports a migration plan from a csv file. operationId: ImportMigrationPlan parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/MigrationPlanIdentifierPathParam' responses: 202: description: Accepted the request. The migration plan will be imported. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the 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' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Imports a migration plan from a csv file. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MigrationPlan' requestBody: content: application/octet-stream: schema: format: binary type: string description: The csv file to be uploaded. required: true /migrationPlans/{migrationPlanId}/actions/refresh: post: description: 'Refreshes the migration plan with the migration plan ID. ' operationId: RefreshMigrationPlan parameters: - $ref: '#/components/parameters/MigrationPlanIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The migration plan will be refreshed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the 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' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Refreshes the migration plan with inventory. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MigrationPlan' /migrationPlans/{migrationPlanId}/availableShapes: get: description: List of shapes by parameters. operationId: ListAvailableShapes parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DvhHostIdQueryParam' - $ref: '#/components/parameters/AvailabilityDomainQueryParam' - $ref: '#/components/parameters/ReservedCapacityQueryParam' - $ref: '#/components/parameters/MigrationPlanIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 200: description: List of available shapes based on parameters. 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/AvailableShapesCollection' 400: $ref: '#/components/responses/400' 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 of available shapes. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/AvailableShapesCollection' /migrations: get: description: 'Returns a list of migrations. ' operationId: ListMigrations parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/MigrationLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/MigrationIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page with migration 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 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/MigrationCollection' 400: $ref: '#/components/responses/400' 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 migrations in a compartment. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/MigrationCollection' post: description: 'Creates a migration. ' operationId: CreateMigration parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The migration project 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/Migration' 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 migration. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Migration' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMigrationDetails' description: Details for the new migration. required: true /migrations/{migrationId}: delete: description: Deletes a migration resource by identifier. operationId: DeleteMigration parameters: - $ref: '#/components/parameters/MigrationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The migration project 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 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' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a provisioned migration. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Migration' get: description: Gets a migration by identifier. operationId: GetMigration parameters: - $ref: '#/components/parameters/MigrationIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the migration 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/Migration' 400: $ref: '#/components/responses/400' 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 migration tags: - migration x-obmcs-client-retries-enabled: true put: description: Updates the migration. operationId: UpdateMigration parameters: - $ref: '#/components/parameters/MigrationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The migration project 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/Migration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the migration identified by the ID. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Migration' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMigrationDetails' description: The information to be updated. required: true /migrations/{migrationId}/actions/changeCompartment: post: description: Moves a migration resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeMigrationCompartment parameters: - $ref: '#/components/parameters/MigrationIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The migration resource will be 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: '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' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Migration' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeMigrationCompartmentDetails' description: The information to be updated. required: true /migrations/{migrationId}/actions/refresh: post: description: 'Refreshes migration based on the migration ID. ' operationId: RefreshMigration parameters: - $ref: '#/components/parameters/MigrationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The migration will be refreshed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the 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' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Refreshes migration tags: - migration x-example: 'POST /20220919/migrations/<migration_OCID>?action=REFRESH Host: ocmmigration.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> {} ' x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Migration' /migrations/{migrationId}/actions/startMigrationReplication: post: description: 'Starts replication for a migration or for some asset. ' operationId: StartMigrationReplication parameters: - $ref: '#/components/parameters/MigrationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The replication will start. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the 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' summary: Starts replication for the migration tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Migration' /replicationSchedules: get: description: 'Returns a list of replication schedules. ' operationId: ListReplicationSchedules parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ReplicationScheduleLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ReplicationScheduleIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page with a summary of replication schedule 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/ReplicationScheduleCollection' 400: $ref: '#/components/responses/400' 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 replication schedules in a compartment. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ReplicationScheduleCollection' post: description: 'Creates a replication schedule. ' operationId: CreateReplicationSchedule parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The replication schedule will be created. headers: content-location: description: 'The full URI of the resource related to the request ' schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control, see `if-match.` ' schema: type: string location: description: 'The full URI of the resource related to the request ' schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: '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/ReplicationSchedule' 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 replication schedule. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ReplicationSchedule' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateReplicationScheduleDetails' description: Details for the new replication schedule. required: true /replicationSchedules/{replicationScheduleId}: delete: description: Deletes a replication schedule resource by identifier. operationId: DeleteReplicationSchedule parameters: - $ref: '#/components/parameters/ReplicationScheduleIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The replication schedule 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 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' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a provisioned replication schedule. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ReplicationSchedule' get: description: Gets a replication schedule by identifier. operationId: GetReplicationSchedule parameters: - $ref: '#/components/parameters/ReplicationScheduleIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the replication schedule 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/ReplicationSchedule' 400: $ref: '#/components/responses/400' 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 replication schedule. tags: - migration x-obmcs-client-retries-enabled: true put: description: Updates the replication schedule. operationId: UpdateReplicationSchedule parameters: - $ref: '#/components/parameters/ReplicationScheduleIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The replication schedule will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: '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' 405: $ref: '#/components/responses/405' 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: Updates the replication schedule identified by the ID. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ReplicationSchedule' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateReplicationScheduleDetails' description: The information to be updated. required: true /replicationSchedules/{replicationScheduleId}/actions/changeCompartment: post: description: Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeReplicationScheduleCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ReplicationScheduleIdentifierPathParam' responses: 202: description: Accepted the request. The replication schedule will be 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 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' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ReplicationSchedule' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeReplicationScheduleCompartmentDetails' description: Details for the compartment move. required: true /targetAssets: get: description: 'Returns a list of target assets. ' operationId: ListTargetAssets parameters: - $ref: '#/components/parameters/MigrationPlanIdentifierQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/TargetAssetIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/TargetAssetLifecycleStateQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A list with a summary of target asset 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/TargetAssetCollection' 400: $ref: '#/components/responses/400' 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 target assets for migration plan. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/TargetAssetCollection' post: description: 'Creates a target asset. ' operationId: CreateTargetAsset parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The target asset will be created. headers: content-location: description: 'The full URI of the resource related to the request ' schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control, see `if-match.` ' schema: type: string location: description: 'The full URI of the resource related to the request ' schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: '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/TargetAsset' 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 target asset. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/TargetAsset' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTargetAssetDetails' description: Details for the new target asset. required: true /targetAssets/{targetAssetId}: delete: description: Deletes a target asset resource by identifier. operationId: DeleteTargetAsset parameters: - $ref: '#/components/parameters/TargetAssetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The target asset 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 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' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a provisioned target asset. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/TargetAsset' get: description: Gets a target asset by identifier. operationId: GetTargetAsset parameters: - $ref: '#/components/parameters/TargetAssetIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the target asset 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/TargetAsset' 400: $ref: '#/components/responses/400' 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 target asset. tags: - migration x-obmcs-client-retries-enabled: true put: description: Updates the target asset. operationId: UpdateTargetAsset parameters: - $ref: '#/components/parameters/TargetAssetIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The target asset will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: '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' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the target asset identified by the ID. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/TargetAsset' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTargetAssetDetails' description: The information to be updated. required: true /workRequests: get: description: 'List of work requests in a compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestIdQueryParam' - $ref: '#/components/parameters/WorkRequestStatusQueryParam' - $ref: '#/components/parameters/WorkRequestOperationTypeQueryParam' - $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 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/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 of work requests. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: delete: description: Cancels work request with the given ID. operationId: CancelWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The work request will be canceled. headers: opc-request-id: description: 'Unique 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' 429: $ref: '#/components/responses/429' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancels the work request. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequest' get: description: Gets the status 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: etag: description: 'For optimistic concurrency control, see `if-match.` ' schema: type: string opc-request-id: description: 'Unique 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: Gets the work request status. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Returns a paginated 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' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' 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 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 of work request errors tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Returns a paginated 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' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' 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 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 of work request logs. tags: - migration x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequestLogEntry' components: parameters: MigrationLifecycleStateQueryParam: description: A filter to return only resources where the resource's lifecycle state matches the given lifecycle state. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Migration/lifecycleState' schema: type: string AvailabilityDomainQueryParam: description: The availability domain in which to list resources. in: query name: availabilityDomain x-default-description: 'null' schema: type: string MigrationPlanIdentifierPathParam: description: Unique migration plan identifier in: path name: migrationPlanId 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 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 ReplicationScheduleIdentifierPathParam: description: Unique replication schedule identifier in path in: path name: replicationScheduleId required: true schema: type: string MigrationPlanLifecycleStateQueryParam: description: The current state of the migration plan. in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/MigrationPlan/lifecycleState' schema: type: string RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string SortByQueryParam: description: 'The field to sort by. Only one sort order can be provided. The default order for ''timeCreated'' is descending. The default order for ''displayName'' is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated ResourceIdentifierQueryParam: description: The ID of the resource affected by the work request. in: query name: resourceId x-default-description: 'null' schema: type: string WorkRequestStatusQueryParam: description: A filter to return only resources where the resource's lifecycle state matches the given operation 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 - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED - NEEDS_ATTENTION MigrationAssetIdentifierPathParam: description: Unique migration asset identifier in: path name: migrationAssetId required: true schema: type: string WorkRequestIdPathParam: description: The ID of the asynchronous request. in: path name: workRequestId required: true schema: type: string MigrationPlanIdentifierQueryParam: description: Unique migration plan identifier in: query name: migrationPlanId required: false x-default-description: 'null' schema: type: string WorkRequestOperationTypeQueryParam: description: A filter to return only resources where the resource's lifecycle state matches the given operation type. in: query name: operationType required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OperationType' schema: type: string enum: - CREATE_MIGRATION - UPDATE_MIGRATION - REFRESH_MIGRATION - DELETE_MIGRATION - MOVE_MIGRATION - START_ASSET_REPLICATION - START_MIGRATION_REPLICATION - CREATE_REPLICATION_SCHEDULE - UPDATE_REPLICATION_SCHEDULE - DELETE_REPLICATION_SCHEDULE - MOVE_REPLICATION_SCHEDULE - CREATE_MIGRATION_PLAN - UPDATE_MIGRATION_PLAN - DELETE_MIGRATION_PLAN - MOVE_MIGRATION_PLAN - REFRESH_MIGRATION_PLAN - EXECUTE_MIGRATION_PLAN - REFRESH_MIGRATION_ASSET - CREATE_MIGRATION_ASSET - DELETE_MIGRATION_ASSET - CREATE_TARGET_ASSET - UPDATE_TARGET_ASSET - DELETE_TARGET_ASSET MigrationAssetIdentifierQueryParam: description: Unique migration asset identifier in: query name: migrationAssetId required: false schema: type: string DisplayNameQueryParam: description: A filter to return only resources that match the entire given display name. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PaginationTokenQueryParam: description: A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of the previous response. in: query name: page x-default-description: 'null' schema: type: string minLength: 1 DvhHostIdQueryParam: description: The ID of the Dvh in which to list resources. in: query name: dvhHostId x-default-description: 'null' schema: type: string MigrationAssetLifecycleStateQueryParam: description: The current state of the migration asset. in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/MigrationAsset/lifecycleState' schema: type: string MigrationIdentifierQueryParam: description: Unique migration identifier in: query name: migrationId required: false x-default-description: 'null' schema: type: string ReservedCapacityQueryParam: description: The reserved capacity ID for which to list resources. in: query name: reservedCapacityId x-default-description: 'null' schema: type: string ReplicationScheduleLifecycleStateQueryParam: description: The current state of the replication schedule. in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/ReplicationSchedule/lifecycleState' schema: type: string WorkRequestIdQueryParam: description: The ID of the asynchronous work request. in: query name: workRequestId x-default-description: 'null' 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 that 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 maxLength: 64 minLength: 1 ReplicationScheduleIdentifierQueryParam: description: Unique replication schedule identifier in query in: query name: replicationScheduleId schema: type: string WorkRequestSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. The default order for ''timeAccepted'' is descending. ' in: query name: sortBy schema: type: string enum: - timeAccepted default: timeAccepted TargetAssetIdentifierQueryParam: description: Unique target asset identifier in: query name: targetAssetId required: false schema: type: string MigrationIdentifierPathParam: description: Unique migration identifier in: path name: migrationId required: true schema: type: string CompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId x-default-description: 'null' schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 TargetAssetIdentifierPathParam: description: Unique target asset identifier in: path name: targetAssetId required: true schema: type: string TargetAssetLifecycleStateQueryParam: description: The current state of the target asset. in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/TargetAsset/lifecycleState' schema: type: string schemas: MigrationCollection: description: Results of a migration search. Contains both migration summary items and other information, such as metadata. properties: items: description: List of migrations. items: $ref: '#/components/schemas/MigrationSummary' type: array required: - items type: object Error: description: Error information. properties: code: description: A short error code that defines the error that is meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message OsImageEstimation: description: Cost estimation for the OS image. properties: totalPerHour: description: Total price per hour type: number totalPerHourBySubscription: description: Total price per hour by subscription type: number required: - totalPerHour MigrationAsset: description: Description of the migration asset. properties: availabilityDomain: description: Availability domain maxLength: 255 minLength: 1 type: string compartmentId: description: Compartment Identifier maxLength: 255 minLength: 1 type: string dependedOnBy: description: List of migration assets that depend on the asset. items: type: string type: array dependsOn: description: List of migration assets that depends on the asset. items: type: string type: array 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: Asset ID generated by mirgration service. It is used in the mirgration service pipeline. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, it 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 migration asset. enum: - CREATING - UPDATING - NEEDS_ATTENTION - ACTIVE - DELETING - DELETED - FAILED type: string migrationId: description: OCID of the associated migration. maxLength: 255 minLength: 1 type: string notifications: description: List of notifications items: enum: - OUT_OF_DATE - SOURCE_REMOVED type: string type: array parentSnapshot: description: The parent snapshot of the migration asset to be used by the replication task. maxLength: 255 minLength: 1 type: string replicationCompartmentId: description: Replication compartment identifier maxLength: 255 minLength: 1 type: string replicationScheduleId: description: Replication schedule identifier maxLength: 255 minLength: 1 type: string snapShotBucketName: description: Name of snapshot bucket maxLength: 255 minLength: 1 type: string snapshots: additionalProperties: $ref: '#/components/schemas/HydratedVolume' description: 'Key-value pair representing disks ID mapped to the OCIDs of replicated or hydration server volume snapshots. Example: `{"bar-key": "value"}` ' type: object sourceAssetData: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing asset metadata keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object sourceAssetId: description: OCID that is referenced to an asset for an inventory. maxLength: 255 minLength: 1 type: string tenancyId: description: Tenancy identifier maxLength: 255 minLength: 1 type: string timeCreated: description: The time when the migration asset was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the migration asset was updated. An RFC3339 formatted datetime string. format: date-time type: string type: description: The type of asset referenced for inventory. maxLength: 255 minLength: 1 type: string required: - id - type - lifecycleState - timeCreated - migrationId - availabilityDomain - replicationCompartmentId - snapShotBucketName type: object ReplicationProgress: description: Progress of a migration asset's replication process. properties: lastReplicationError: description: Error message if the last finished replication failed. type: string lastReplicationStatus: description: Status of the last replication task. It can be Completed or Failed. enum: - NONE - COMPLETED - FAILED type: string percentage: description: Percentage of the current replication progress from 0 to 100. type: integer status: description: Status of the current replication progress. It can be None or InProgress. enum: - NONE - IN_PROGRESS type: string timeOfLastReplicationEnd: description: End time of the last replication process. It can be Completed or Failed. format: date-time type: string timeOfLastReplicationSuccess: description: End time of the last successful replication process, which has been completed. format: date-time type: string timeOflastReplicationStart: description: Start time of the last replication process. It can be Completed or Failed. format: date-time type: string timeStarted: description: Start time of the current replication process format: date-time type: string required: - percentage type: object UpdateMigrationDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag''s 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 displayName: description: Migration identifier maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` ' type: object isCompleted: description: Indicates whether migration is marked as complete. type: boolean replicationScheduleId: description: Replication schedule identifier maxLength: 255 minLength: 0 type: string type: object CreateMigrationDetails: description: The information about new migration. properties: 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. ' type: object description: 'Key-value pair representing predefined tag''s 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 displayName: description: Migration identifier maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` ' type: object isCompleted: description: Indicates whether migration is marked as complete. type: boolean replicationScheduleId: description: Replication schedule identifier maxLength: 255 minLength: 1 type: string required: - displayName - compartmentId type: object CostEstimation: description: Cost estimation description properties: compute: $ref: '#/components/schemas/ComputeCostEstimation' currencyCode: description: Currency code in the ISO format. maxLength: 4 minLength: 1 type: string osImage: $ref: '#/components/schemas/OsImageEstimation' storage: $ref: '#/components/schemas/StorageCostEstimation' subscriptionId: description: Subscription ID maxLength: 255 minLength: 0 type: string totalEstimationPerMonth: description: Total estimation per month type: number totalEstimationPerMonthBySubscription: description: Total estimation per month by subscription. type: number required: - compute - storage - osImage - totalEstimationPerMonth UpdateMigrationAssetDetails: description: Details of the updated migration asset. properties: dependsOn: description: List of migration assets that depends on this asset. items: type: string type: array 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 replicationScheduleId: description: Replication schedule identifier maxLength: 255 minLength: 0 type: string type: object WorkRequestSummaryCollection: description: Results of the work request search. Contains both work request items and other information, such as metadata. properties: items: description: List of work request summary objects. items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items type: object MigrationPlanSummary: description: Summary of the migration plan. properties: calculatedLimits: additionalProperties: type: integer description: 'Limits of the resources that are needed for migration. Example: {"BlockVolume": 2, "VCN": 1}' type: object compartmentId: description: The OCID of the compartment containing the migration plan. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag''s 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 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: 'Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` ' type: object id: description: The unique Oracle ID (OCID) that is immutable on creation. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, it 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 migration plan. type: string x-obmcs-enumref: '#/definitions/MigrationPlan/lifecycleState' migrationId: description: The OCID of the associated migration. maxLength: 255 minLength: 1 type: string migrationPlanStats: $ref: '#/components/schemas/MigrationPlanStats' referenceToRmsStack: description: OCID of the referenced ORM job. maxLength: 255 minLength: 1 type: string sourceMigrationPlanId: description: Source migraiton plan ID to be cloned. maxLength: 255 minLength: 0 type: string strategies: description: List of strategies for the resources to be migrated. items: $ref: '#/components/schemas/ResourceAssessmentStrategy' type: array 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 tag''s 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 targetEnvironments: description: List of target environments. items: $ref: '#/components/schemas/TargetEnvironment' type: array timeCreated: description: The time when the migration plan was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the migration plan was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - lifecycleState - migrationId - strategies - timeCreated - calculatedLimits - targetEnvironments type: object UpdateReplicationScheduleDetails: description: Information about replication schedule to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag''s 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 displayName: description: A user-friendly name for a replication schedule. Does not have to be unique, and is mutable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string executionRecurrences: description: Recurrence specification for replication schedule execution. format: x-obmcs-recurring-time type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` ' type: object type: object StorageCostEstimation: description: Cost estimation for storage properties: totalGbPerMonth: description: Gigabyte storage capacity per month. type: number totalGbPerMonthBySubscription: description: Gigabyte storage capacity per month by subscription. type: number volumes: description: Volume estimation items: $ref: '#/components/schemas/VolumeCostEstimation' type: array required: - volumes - totalGbPerMonth MigrationPlanCollection: description: Results of a migration plan search. Contains both migration plan summary items and other information, such as metadata. properties: items: description: List of migration plan summaries. items: $ref: '#/components/schemas/MigrationPlanSummary' 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 that is affected by the work request. If the work request affects multiple resources, and these resources are not in the same compartment, the service team can choose the primary resource of the compartment to be used. ' type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag''s 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. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` ' type: object id: description: The ID of the work request. type: string operationType: description: The type of work request. enum: - CREATE_MIGRATION - UPDATE_MIGRATION - REFRESH_MIGRATION - DELETE_MIGRATION - MOVE_MIGRATION - START_ASSET_REPLICATION - START_MIGRATION_REPLICATION - CREATE_REPLICATION_SCHEDULE - UPDATE_REPLICATION_SCHEDULE - DELETE_REPLICATION_SCHEDULE - MOVE_REPLICATION_SCHEDULE - CREATE_MIGRATION_PLAN - UPDATE_MIGRATION_PLAN - DELETE_MIGRATION_PLAN - MOVE_MIGRATION_PLAN - REFRESH_MIGRATION_PLAN - EXECUTE_MIGRATION_PLAN - REFRESH_MIGRATION_ASSET - CREATE_MIGRATION_ASSET - DELETE_MIGRATION_ASSET - CREATE_TARGET_ASSET - UPDATE_TARGET_ASSET - DELETE_TARGET_ASSET type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: The percentage of 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 the current work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' 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 tag''s 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 timeAccepted: description: 'The date and time when 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 when the object was complete, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time when the request 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 TargetAssetSummary: description: Summary of the target asset. discriminator: propertyName: type properties: compartmentId: description: Compartment identifier maxLength: 255 minLength: 1 type: string compatibilityMessages: description: Messages about compatibility issues. items: $ref: '#/components/schemas/CompatibilityMessage' type: array createdResourceId: description: Created resource identifier 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 estimatedCost: $ref: '#/components/schemas/CostEstimation' id: description: Unique identifier that is immutable on creation. maxLength: 255 minLength: 1 type: string isExcludedFromExecution: description: A boolean indicating whether the asset should be migrated. type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, it 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 target asset. type: string x-obmcs-enumref: '#/definitions/TargetAsset/lifecycleState' migrationAsset: $ref: '#/components/schemas/MigrationAssetSummary' migrationPlanId: description: OCID of the associated migration plan. maxLength: 255 minLength: 1 type: string timeAssessed: description: The time when the assessment was done. An RFC3339 formatted datetime string. format: date-time type: string timeCreated: description: The time when the target asset was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the target asset was updated. An RFC3339 formatted datetime string. format: date-time type: string type: description: The type of target asset. enum: - INSTANCE type: string required: - id - lifecycleState - migrationPlanId - type - isExcludedFromExecution - estimatedCost - timeCreated - timeUpdated - timeAssessed type: object ChangeMigrationPlanCompartmentDetails: description: Details about the compartment into which the resource can be moved. 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 CreateTargetAssetDetails: description: Details of the new target asset. discriminator: propertyName: type properties: isExcludedFromExecution: description: A boolean indicating whether the asset should be migrated. type: boolean migrationPlanId: description: OCID of the associated migration plan. maxLength: 255 minLength: 1 type: string type: description: The type of target asset. enum: - INSTANCE type: string required: - migrationPlanId - type - isExcludedFromExecution type: object ReplicationSchedule: description: Replication schedule. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the replication schedule exists. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag''s 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 displayName: description: A name of the replication schedule. maxLength: 255 minLength: 1 type: string executionRecurrences: description: Recurrence specification for the replication schedule execution. format: x-obmcs-recurring-time type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the replication schedule. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: The detailed state of the replication schedule. type: string lifecycleState: description: Current state of the replication schedule. enum: - CREATING - UPDATING - NEEDS_ATTENTION - ACTIVE - DELETING - DELETED - FAILED type: string 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 tag''s 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 when the replication schedule was created in RFC3339 format. format: date-time type: string timeUpdated: description: The time when the replication schedule was last updated in RFC3339 format. format: date-time type: string required: - id - compartmentId - displayName - executionRecurrences - lifecycleState - lifecycleDetails - timeCreated - timeUpdated type: object MigrationAssetCollection: description: Results of a migration asset search. It contains an array of migration assets. properties: items: description: List of migration asset summaries. items: $ref: '#/components/schemas/MigrationAssetSummary' type: array required: - items type: object MigrationPlan: description: Description of the migration plan. properties: calculatedLimits: additionalProperties: type: integer description: 'Limits of the resources that are needed for migration. Example: {"BlockVolume": 2, "VCN": 1}' type: object compartmentId: description: The OCID of the compartment containing the migration plan. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag''s 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 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: 'Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` ' type: object id: description: The unique Oracle ID (OCID) that is immutable on creation. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, it 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 migration plan. enum: - CREATING - UPDATING - NEEDS_ATTENTION - ACTIVE - DELETING - DELETED - FAILED type: string migrationId: description: The OCID of the associated migration. maxLength: 255 minLength: 1 type: string migrationPlanStats: $ref: '#/components/schemas/MigrationPlanStats' referenceToRmsStack: description: OCID of the referenced ORM job. maxLength: 255 minLength: 1 type: string sourceMigrationPlanId: description: Source migraiton plan ID to be cloned. maxLength: 255 minLength: 0 type: string strategies: description: List of strategies for the resources to be migrated. items: $ref: '#/components/schemas/ResourceAssessmentStrategy' type: array 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 tag''s 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 targetEnvironments: description: List of target environments. items: $ref: '#/components/schemas/TargetEnvironment' type: array timeCreated: description: The time when the migration plan was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the migration plan was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - lifecycleState - migrationId - strategies - timeCreated - calculatedLimits - targetEnvironments type: object TargetAsset: description: Description of the target asset. discriminator: propertyName: type properties: compartmentId: description: Compartment identifier maxLength: 255 minLength: 1 type: string compatibilityMessages: description: Messages about the compatibility issues. items: $ref: '#/components/schemas/CompatibilityMessage' type: array createdResourceId: description: Created resource identifier 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 estimatedCost: $ref: '#/components/schemas/CostEstimation' id: description: Unique identifier that is immutable on creation. maxLength: 255 minLength: 1 type: string isExcludedFromExecution: description: A boolean indicating whether the asset should be migrated. type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, it 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 target asset. enum: - CREATING - UPDATING - NEEDS_ATTENTION - ACTIVE - DELETING - DELETED - FAILED type: string migrationAsset: $ref: '#/components/schemas/MigrationAsset' migrationPlanId: description: OCID of the associated migration plan. maxLength: 255 minLength: 1 type: string timeAssessed: description: The time when the assessment was done. An RFC3339 formatted datetime string. format: date-time type: string timeCreated: description: The time when the target asset was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the target asset was updated. An RFC3339 formatted datetime string. format: date-time type: string type: description: The type of target asset. enum: - INSTANCE - SDDC type: string required: - id - lifecycleState - migrationPlanId - type - isExcludedFromExecution - estimatedCost - timeCreated - timeUpdated - timeAssessed MigrationAssetSummary: description: Summary of the migration asset. properties: compartmentId: description: Compartment identifier maxLength: 255 minLength: 1 type: string dependedOnBy: description: List of migration assets that depend on this asset. items: type: string type: array dependsOn: description: List of migration assets that depend on this asset. items: type: string type: array 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 asset ID generated by the mirgration service. It is used in the migration service pipeline. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, it 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 migration asset. type: string x-obmcs-enumref: '#/definitions/MigrationAsset/lifecycleState' migrationId: description: OCID of the associated migration. maxLength: 255 minLength: 1 type: string notifications: description: List of notifications. items: enum: - OUT_OF_DATE - SOURCE_REMOVED type: string type: array parentSnapshot: description: The parent snapshot of the mgration asset to be used by the replication task. maxLength: 255 minLength: 1 type: string replicationScheduleId: description: Replication schedule identifier maxLength: 255 minLength: 1 type: string snapshotInfo: description: The snapshot information. maxLength: 255 minLength: 1 type: string snapshots: additionalProperties: $ref: '#/components/schemas/HydratedVolume' description: 'Key-value pair representing disk''s ID that is mapped to the OCIDs of replicated/hydration server volume snapshots. Example: `{"bar-key": "value"}` ' type: object sourceAssetData: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing asset metadata keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object sourceAssetId: description: OCID that is referenced to an asset, for an inventory. maxLength: 255 minLength: 1 type: string tenancyId: description: Tenancy Identifier maxLength: 255 minLength: 1 type: string timeCreated: description: The time when the migration asset was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the migration asset was updated. An RFC3339 formatted datetime string. format: date-time type: string type: description: The type of asset referenced for an inventory. maxLength: 255 minLength: 1 type: string required: - id - type - lifecycleState - timeCreated - migrationId type: object 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 when the log message was written. An RFC3339 formatted datetime string. format: date-time type: string required: - message - timestamp Migration: description: A top-level container to track all aspects of a long-running migration workflow to OCI. properties: 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. ' type: object description: 'Key-value pair representing predefined tag''s 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 displayName: description: Migration Identifier that can be renamed maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` ' type: object id: description: Unique identifier that is immutable on creation maxLength: 255 minLength: 1 type: string isCompleted: description: Indicates whether migration is marked as completed. type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, it 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 migration. enum: - CREATING - UPDATING - NEEDS_ATTENTION - ACTIVE - DELETING - DELETED - FAILED type: string replicationScheduleId: description: Replication schedule identifier maxLength: 255 minLength: 0 type: string 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 tag''s 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 when the migration project was created. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time when the migration project was updated. An RFC3339 formatted datetime string format: date-time type: string required: - id - compartmentId - timeCreated - lifecycleState type: object AvailableShapesCollection: description: Results of an available shapes search. Contains list of shapes. properties: items: description: Available shapes list. items: $ref: '#/components/schemas/AvailableShapeSummary' type: array required: - items type: object WorkRequest: description: A description of a work request 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 that is affected by the work request. If the work request affects multiple resources, and these resources are not in the same compartment, the service team can choose the primary resource of the compartment to be used. ' type: string id: description: The ID of the work request. type: string operationType: description: The type of the work request. enum: - CREATE_MIGRATION - UPDATE_MIGRATION - REFRESH_MIGRATION - DELETE_MIGRATION - MOVE_MIGRATION - START_ASSET_REPLICATION - START_MIGRATION_REPLICATION - CREATE_REPLICATION_SCHEDULE - UPDATE_REPLICATION_SCHEDULE - DELETE_REPLICATION_SCHEDULE - MOVE_REPLICATION_SCHEDULE - CREATE_MIGRATION_PLAN - UPDATE_MIGRATION_PLAN - DELETE_MIGRATION_PLAN - MOVE_MIGRATION_PLAN - REFRESH_MIGRATION_PLAN - EXECUTE_MIGRATION_PLAN - REFRESH_MIGRATION_ASSET - CREATE_MIGRATION_ASSET - DELETE_MIGRATION_ASSET - CREATE_TARGET_ASSET - UPDATE_TARGET_ASSET - DELETE_TARGET_ASSET type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: The percentage of 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 when 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 when the object was complete, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time when the request 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 TargetAssetCollection: description: Results of a target asset search. properties: items: description: List of target asset summaries. items: $ref: '#/components/schemas/TargetAssetSummary' type: array required: - items type: object CreateMigrationAssetDetails: description: Details of the new migration asset. properties: availabilityDomain: description: Availability domain maxLength: 255 minLength: 1 type: string dependsOn: description: List of migration assets that depends on this asset. items: type: string type: array displayName: description: A user-friendly name. If empty, then source asset name will be used. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 0 type: string inventoryAssetId: description: OCID of an asset for an inventory. maxLength: 255 minLength: 1 type: string migrationId: description: OCID of the associated migration. maxLength: 255 minLength: 1 type: string replicationCompartmentId: description: Replication compartment identifier maxLength: 255 minLength: 1 type: string replicationScheduleId: description: Replication schedule identifier maxLength: 255 minLength: 1 type: string snapShotBucketName: description: Name of snapshot bucket maxLength: 255 minLength: 1 type: string required: - inventoryAssetId - migrationId - availabilityDomain - replicationCompartmentId - snapShotBucketName type: object ReplicationScheduleCollection: description: Results of a replication schedule search. Contains replication schedule summaries. properties: items: description: Replication schedule summaries. items: $ref: '#/components/schemas/ReplicationScheduleSummary' type: array required: - items type: object CreateMigrationPlanDetails: description: The information about the new migration plan. properties: 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. ' type: object description: 'Key-value pair representing predefined tag''s 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 displayName: description: Migration plan identifier maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` ' type: object migrationId: description: The OCID of the associated migration. maxLength: 255 minLength: 1 type: string sourceMigrationPlanId: description: Source migraiton plan ID to be cloned. maxLength: 255 minLength: 0 type: string strategies: description: List of strategies for the resources to be migrated. items: $ref: '#/components/schemas/ResourceAssessmentStrategy' type: array targetEnvironments: description: List of target environments. items: $ref: '#/components/schemas/TargetEnvironment' type: array required: - displayName - compartmentId - migrationId type: object WorkRequestResource: description: A resource that is created and operated by a work request. properties: actionType: description: 'The way in which this resource is affected by the work is 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 this 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 is affected by the work request. type: string entityUri: description: The URI path where you can do a GET operation to access the resource metadata. type: string identifier: description: The identifier of the resource that is affected by the work request. type: string required: - actionType - entityType - identifier MigrationSummary: description: Summary of the migration project. properties: 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. ' type: object description: 'Key-value pair representing predefined tag''s 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 displayName: description: Migration identifier that can be renamed maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` ' type: object id: description: Unique identifier that is immutable on creation. maxLength: 255 minLength: 1 type: string isCompleted: description: Indicates whether migration is marked as complete. type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, it 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 migration. type: string x-obmcs-enumref: '#/definitions/Migration/lifecycleState' replicationScheduleId: description: Replication schedule identifier maxLength: 255 minLength: 1 type: string 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 tag''s 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 when the migration project was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the migration project was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - timeCreated - lifecycleState type: object ChangeReplicationScheduleCompartmentDetails: description: Information about compartment into which the replication schedule should be moved. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the replication schedule should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ChangeMigrationCompartmentDetails: description: The information to be updated. 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 AvailableShapeSummary: description: Sumarized information about a shape. properties: availabilityDomain: description: Availability domain of the shape. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag''s 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. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` ' type: object gpuDescription: description: Description of the GPUs. maxLength: 255 minLength: 1 type: string gpus: description: Number of GPUs. type: integer localDiskDescription: description: Description of local disks. maxLength: 255 minLength: 1 type: string localDisks: description: Number of local disks. type: integer localDisksTotalSizeInGBs: description: Total size of local disks for shape. format: float type: number maxVnicAttachments: description: Maximum number of virtual network interfaces that can be attached. type: integer memoryInGBs: description: Amount of memory for the shape. format: float type: number minTotalBaselineOcpusRequired: description: Minimum CPUs required. format: string maxLength: 255 minLength: 1 type: number networkingBandwidthInGbps: description: Shape bandwidth. format: float type: number ocpus: description: Number of CPUs. format: float type: number paginationToken: description: Shape name and availability domain. Used for pagination. maxLength: 255 minLength: 1 type: string processorDescription: description: Description of the processor. maxLength: 255 minLength: 1 type: string shape: description: Name of the shape. maxLength: 255 minLength: 1 type: string 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 tag''s 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 required: - shape - processorDescription - ocpus - memoryInGBs - availabilityDomain - paginationToken type: object 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 when the error occured. An RFC3339 formatted datetime string. format: date-time type: string required: - code - message - timestamp VolumeCostEstimation: description: Cost estimation for volume properties: capacityGb: description: Gigabyte storage capacity type: number description: description: Volume description maxLength: 255 minLength: 1 type: string totalGbPerMonth: description: Gigabyte storage capacity per month. type: number totalGbPerMonthBySubscription: description: Gigabyte storage capacity per month by subscription type: number required: - capacityGb - totalGbPerMonth MigrationPlanStats: description: Status of the migration plan. properties: timeUpdated: description: The time when the migration plan was calculated. An RFC3339 formatted datetime string. format: date-time type: string totalEstimatedCost: $ref: '#/components/schemas/CostEstimation' vmCount: description: The total count of VMs in migration type: integer type: object ResourceAssessmentStrategy: description: Migration strategy for the resource to be migrated. discriminator: propertyName: strategyType properties: resourceType: description: The type of resource. enum: - CPU - MEMORY - ALL type: string strategyType: description: The type of strategy used for migration. enum: - AS_IS - AVERAGE - PEAK - PERCENTILE type: string required: - resourceType - strategyType TargetEnvironment: description: Description of the target environment. discriminator: propertyName: targetEnvironmentType properties: targetCompartmentId: description: Target compartment identifier maxLength: 255 minLength: 1 type: string targetEnvironmentType: description: The type of target environment. enum: - VM_TARGET_ENV type: string required: - targetEnvironmentType CompatibilityMessage: description: Information about shape compatibility with the client's current resource configuration. properties: message: description: Detailed description of the compatibility issue. maxLength: 255 minLength: 1 type: string name: description: Name of the compatibility issue. enum: - NOT_ENOUGH_DATA - INVALID_DATA - CPU_COMPATIBILITY_WARNING - CPU_METRIC_INFO - MEMORY_COMPATIBILITY_WARNING - MEMORY_METRIC_INFO - VNICS_COMPATIBILITY_WARNING - BANDWIDTH_COMPATIBILITY_WARNING - GPU_COMPATIBILITY_WARNING - OS_WARNING type: string severity: description: Severity level of the compatibility issue. enum: - ERROR - WARNING - INFO type: string type: object UpdateTargetAssetDetails: description: Details of the updated target asset. discriminator: propertyName: type properties: isExcludedFromExecution: description: A boolean indicating whether the asset should be migrated. type: boolean type: description: The type of target asset. enum: - INSTANCE type: string required: - type type: object ComputeCostEstimation: description: Cost estimation for compute properties: gpuCount: description: Total number of GPU type: number gpuPerHour: description: GPU per hour type: number gpuPerHourBySubscription: description: GPU per hour by subscription type: number memoryAmountGb: description: Total usage of memory type: number memoryGbPerHour: description: Gigabyte per hour type: number memoryGbPerHourBySubscription: description: Gigabyte per hour by subscription type: number ocpuCount: description: Total number of OCPUs type: number ocpuPerHour: description: OCPU per hour type: number ocpuPerHourBySubscription: description: OCPU per hour by subscription type: number totalPerHour: description: Total per hour type: number totalPerHourBySubscription: description: Total usage per hour by subscription type: number required: - ocpuPerHour - memoryGbPerHour - gpuPerHour - totalPerHour UpdateMigrationPlanDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag''s 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 displayName: description: Migration plan identifier maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` ' type: object strategies: description: List of strategies for the resources to be migrated. items: $ref: '#/components/schemas/ResourceAssessmentStrategy' type: array targetEnvironments: description: List of target environments. items: $ref: '#/components/schemas/TargetEnvironment' type: array type: object ReplicationScheduleSummary: description: Sumarized information about a replication schedule. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the replication schedule exists. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag''s 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 displayName: description: A name of the replication schedule. maxLength: 255 minLength: 1 type: string executionRecurrences: description: Recurrence specification for replication schedule execution. format: x-obmcs-recurring-time type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the replication schedule. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: The detailed state of the replication schedule. type: string lifecycleState: description: Current state of the replication schedule. type: string x-obmcs-enumref: '#/definitions/ReplicationSchedule/lifecycleState' 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 tag''s 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 when the replication schedule was created in RFC3339 format. format: date-time type: string timeUpdated: description: The time when the replication schedule was last updated in RFC3339 format. format: date-time type: string required: - id - compartmentId - displayName - lifecycleState - lifecycleDetails - executionRecurrences - timeCreated - timeUpdated type: object WorkRequestErrorCollection: description: Results of the work request error search. Contains both work request error items and other information, such as metadata. properties: items: description: List of work request error objects. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object HydratedVolume: description: Description of the hydration server volume. properties: unmodifiedVolumeId: description: ID of the unmodified volume maxLength: 255 minLength: 1 type: string uuid: description: ID of the vCenter disk obtained from Inventory. maxLength: 255 minLength: 1 type: string volumeId: description: ID of the hydration server volume maxLength: 255 minLength: 1 type: string volumeType: description: The hydration server volume type enum: - BOOT - BLOCK type: string required: - uuid - volumeId - volumeType - unmodifiedVolumeId type: object CreateReplicationScheduleDetails: description: Information about replication schedule to be created. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the replication schedule should be created. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag''s 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 displayName: description: A user-friendly name for a replication schedule. Does not have to be unique, and is mutable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string executionRecurrences: description: Recurrence specification for replication schedule execution. format: x-obmcs-recurring-time type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` ' type: object required: - displayName - compartmentId - executionRecurrences type: object WorkRequestLogEntryCollection: description: Results of the work request log search. Contains both work request log items and other information, such as metadata. properties: items: description: List of work request log entries. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control, see `if-match.` ' type: string opc-next-page: description: 'For 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 request. You can use this to query status of the asynchronous operation. ' 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, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag''s 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. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` ' type: object location: description: 'The full URI of the resource related to the request ' format: uri-reference type: string 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 tag''s 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-oracle-package: com.oracle.pic.ocm.migration