{ "opencollection": "1.0.0", "info": { "name": "Database Migration API", "version": "20230518" }, "items": [ { "info": { "name": "databaseMigration", "type": "folder" }, "items": [ { "info": { "name": "Display sample object types to exclude or include for an Assessment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/assessmentObjectTypes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nDefault order for name is custom based on it's usage frequency. If no value is specified name is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" }, { "name": "connectionType", "value": "", "type": "query", "description": "The connection type for assessment objects." } ] }, "docs": "Display sample object types to exclude or include for an Assessment.\n" }, { "info": { "name": "List all Assessments.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/assessments", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.\nDefault order for displayName is ascending. If no value is specified timeCreated is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The lifecycle state of the Assessment.\n" }, { "name": "lifecycleDetails", "value": "", "type": "query", "description": "The lifecycle detailed status of the Migration.\n" } ] }, "docs": "List all Assessments.\n" }, { "info": { "name": "Create an Assessment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/assessments", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an Assessment resource that contains all the details to perform the\ndatabase assessment operation, such as source and destination database\ndetails, network throughput, accepted downtime etc.\n" }, { "info": { "name": "Display Assessment details", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/assessments/:assessmentId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "assessmentId", "value": "", "type": "path", "description": "The OCID of the Assessment\n" } ] }, "docs": "Display Assessment details.\n" }, { "info": { "name": "Update an Assessment.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20230518/assessments/:assessmentId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "assessmentId", "value": "", "type": "path", "description": "The OCID of the Assessment\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Assessment resource details.\n" }, { "info": { "name": "Delete the specified Assessment.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20230518/assessments/:assessmentId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "assessmentId", "value": "", "type": "path", "description": "The OCID of the Assessment\n" } ] }, "docs": "Deletes the Assessment represented by the specified assessment ID.\n" }, { "info": { "name": "Add excluded/included object to the list.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/assessments/:assessmentId/actions/addAssessmentObjects", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "assessmentId", "value": "", "type": "path", "description": "The OCID of the Assessment\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add excluded/included object to the list.\n" }, { "info": { "name": "Change an Assessment compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/assessments/:assessmentId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "assessmentId", "value": "", "type": "path", "description": "The OCID of the Assessment\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Used to change the Assessment compartment.\n" }, { "info": { "name": "Clone an Assessment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/assessments/:assessmentId/actions/clone", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "assessmentId", "value": "", "type": "path", "description": "The OCID of the Assessment\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Clone a configuration from an existing Assessment.\n" }, { "info": { "name": "Remove excluded/included objects.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/assessments/:assessmentId/actions/removeAssessmentObjects", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "assessmentId", "value": "", "type": "path", "description": "The OCID of the Assessment\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove excluded/included objects.\n" }, { "info": { "name": "Display excluded/included objects", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/assessments/:assessmentId/assessmentObjects", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "assessmentId", "value": "", "type": "path", "description": "The OCID of the Assessment\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" } ] }, "docs": "Display excluded/included objects.\n" }, { "info": { "name": "List all Assessors.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/assessments/:assessmentId/assessors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "assessmentId", "value": "", "type": "path", "description": "The OCID of the Assessment\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.\nDefault order for displayName is ascending. If no value is specified timeCreated is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The lifecycle state of the Assessor." } ] }, "docs": "List all Assessors.\n" }, { "info": { "name": "Display Assessor details", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/assessments/:assessmentId/assessors/:assessorName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "assessmentId", "value": "", "type": "path", "description": "The OCID of the Assessment\n" }, { "name": "assessorName", "value": "", "type": "path", "description": "The name of the Assessor" } ] }, "docs": "Display Assessor details." }, { "info": { "name": "Download SQL script Assessor Action.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/assessments/:assessmentId/assessors/:assessorName/actions/download_sql", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "assessmentId", "value": "", "type": "path", "description": "The OCID of the Assessment\n" }, { "name": "assessorName", "value": "", "type": "path", "description": "The name of the Assessor" } ] }, "docs": "Download SQL script Assessor Action." }, { "info": { "name": "Assessor Action.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/assessments/:assessmentId/assessors/:assessorName/assessorActions/:assessorAction", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "assessmentId", "value": "", "type": "path", "description": "The OCID of the Assessment\n" }, { "name": "assessorName", "value": "", "type": "path", "description": "The name of the Assessor" }, { "name": "assessorAction", "value": "", "type": "path", "description": "The Accessor Action" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assessor Action." }, { "info": { "name": "Get Assessor Check Summaries.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/assessments/:assessmentId/assessors/:assessorName/checks", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "assessmentId", "value": "", "type": "path", "description": "The OCID of the Assessment\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.\nDefault order for displayName is ascending. If no value is specified timeCreated is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" }, { "name": "assessorName", "value": "", "type": "path", "description": "The name of the Assessor" } ] }, "docs": "List Assessor Check Summaries.\n" }, { "info": { "name": "Get Assessor Check details.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/assessments/:assessmentId/assessors/:assessorName/checks/:checkName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "assessmentId", "value": "", "type": "path", "description": "The OCID of the Assessment\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.\nDefault order for displayName is ascending. If no value is specified timeCreated is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" }, { "name": "assessorName", "value": "", "type": "path", "description": "The name of the Assessor" }, { "name": "checkName", "value": "", "type": "path", "description": "The Name of the assessor check" } ] }, "docs": "Get Assessor Check details.\n" }, { "info": { "name": "Update advisor report object list.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20230518/assessments/:assessmentId/assessors/:assessorName/checks/:checkName/actions/updateObjects", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nDefault order for name is custom based on it's usage frequency. If no value is specified name is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" }, { "name": "assessmentId", "value": "", "type": "path", "description": "The OCID of the Assessment\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" }, { "name": "assessorName", "value": "", "type": "path", "description": "The name of the Assessor" }, { "name": "checkName", "value": "", "type": "path", "description": "The Name of the assessor check" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the advisor report object list.\n" }, { "info": { "name": "Assessor Check Action.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/assessments/:assessmentId/assessors/:assessorName/checks/:checkName/actions/:assessorCheckAction", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "assessmentId", "value": "", "type": "path", "description": "The OCID of the Assessment\n" }, { "name": "assessorName", "value": "", "type": "path", "description": "The name of the Assessor" }, { "name": "checkName", "value": "", "type": "path", "description": "The Name of the assessor check" }, { "name": "assessorCheckAction", "value": "", "type": "path", "description": "The Accessor Check Action" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assessor Check Action." }, { "info": { "name": "Display Check Affected objects", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/assessments/:assessmentId/assessors/:assessorName/checks/:checkName/affectedObjects", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nDefault order for name is custom based on it's usage frequency. If no value is specified name is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" }, { "name": "assessmentId", "value": "", "type": "path", "description": "The OCID of the Assessment\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" }, { "name": "assessorName", "value": "", "type": "path", "description": "The name of the Assessor" }, { "name": "checkName", "value": "", "type": "path", "description": "The Name of the assessor check" } ] }, "docs": "Display Check Affected objects.\n" }, { "info": { "name": "List all Database Connections.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/connections", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources.\n" }, { "name": "technologyType", "value": "", "type": "query", "description": "The array of technology types." }, { "name": "technologySubType", "value": "", "type": "query", "description": "The database technology sub-type." }, { "name": "connectionType", "value": "", "type": "query", "description": "The array of connection types." }, { "name": "sourceConnectionId", "value": "", "type": "query", "description": "The OCID of the source database connection." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.\nDefault order for displayName is ascending. If no value is specified timeCreated is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the Database Migration Deployment.\n" } ] }, "docs": "List all Database Connections.\n" }, { "info": { "name": "Create a Database Connection.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/connections", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Database Connection resource that contains the details to connect to either a Source or Target Database\nin the migration.\n" }, { "info": { "name": "List supported Database Types, Sub-types and Versions.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/connections/databaseconnectiontype", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources.\n" }, { "name": "technologyType", "value": "", "type": "query", "description": "The array of technology types." }, { "name": "connectionType", "value": "", "type": "query", "description": "The array of connection types." }, { "name": "sourceConnectionId", "value": "", "type": "query", "description": "The OCID of the source connection." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.\nDefault order for displayName is ascending. If no value is specified timeCreated is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" } ] }, "docs": "List supported Database Types, Sub-types and Versions." }, { "info": { "name": "Display Database Connection details", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/connections/:connectionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "connectionId", "value": "", "type": "path", "description": "The OCID of the database connection." } ] }, "docs": "Display Database Connection details.\n" }, { "info": { "name": "Update a Database Connection.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20230518/connections/:connectionId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "connectionId", "value": "", "type": "path", "description": "The OCID of the database connection." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Database Connection resource details.\n" }, { "info": { "name": "Delete the specified Database Connection.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20230518/connections/:connectionId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "connectionId", "value": "", "type": "path", "description": "The OCID of the database connection." } ] }, "docs": "Deletes the Database Connection represented by the specified connection ID.\n" }, { "info": { "name": "Change a Database Connection compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/connections/:connectionId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "connectionId", "value": "", "type": "path", "description": "The OCID of the database connection." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Used to change the Database Connection compartment.\n" }, { "info": { "name": "Perform connection test for a database connection.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/connections/:connectionId/actions/diagnostics", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "connectionId", "value": "", "type": "path", "description": "The OCID of the database connection." }, { "name": "isAssessmentValidation", "value": "", "type": "query", "description": "When true, run assessment validation checks (e.g., DMSROLE) and include database information (name/version/size) in the response." } ] }, "docs": "Perform connection test for a database connection.\n" }, { "info": { "name": "List all the names of the Migration jobs associated to the specified\nmigration site\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/jobs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "migrationId", "value": "", "type": "query", "description": "The ID of the migration in which to list resources.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.\nDefault order for displayName is ascending. If no value is specified timeCreated is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The lifecycle state of the Migration Job.\n" }, { "name": "jobIdNotEqualTo", "value": "", "type": "query", "description": "The ID of the Job to exclude from the list of jobs.\n" } ] }, "docs": "List all the names of the Migration jobs associated to the specified\nmigration site.\n" }, { "info": { "name": "pause migration job.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/jobs/:jobId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The OCID of the job\n" } ] }, "docs": "Get a migration job.\n" }, { "info": { "name": "Update Job details.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20230518/jobs/:jobId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The OCID of the job\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Migration Job resource details.\n" }, { "info": { "name": "Delete the specified Migration Job", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20230518/jobs/:jobId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The OCID of the job\n" } ] }, "docs": "Deletes the migration job represented by the given job ID.\n" }, { "info": { "name": "Abort migration operation.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/jobs/:jobId/actions/abort", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The OCID of the job\n" } ] }, "docs": "Aborts a Migration Job (either Evaluation or Migration).\n" }, { "info": { "name": "Collect DB trace and alert logs.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/jobs/:jobId/actions/collectTraces", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The OCID of the job\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Collects the DB trace and alert logs.\n" }, { "info": { "name": "Resume a previously paused migration Job.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/jobs/:jobId/actions/resume", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The OCID of the job\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Resume a migration Job.\n" }, { "info": { "name": "Suspend a currently executing migration Job.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/jobs/:jobId/actions/suspend", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The OCID of the job\n" } ] }, "docs": "Place the currently executing migration Job in a Suspended State.\n" }, { "info": { "name": "Get the Pre-Migration Advisor report details", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/jobs/:jobId/advisorReport", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The OCID of the job\n" } ] }, "docs": "Get the Pre-Migration Advisor report details\n" }, { "info": { "name": "List of Pre-Migration checks from the advisor.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/jobs/:jobId/advisorReportChecks", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The OCID of the job\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" } ] }, "docs": "List of Pre-Migration checks from the advisor.\n" }, { "info": { "name": "Update the premigration extended advisor report check.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20230518/jobs/:jobId/advisorReportChecks/:advisorReportCheckId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The OCID of the job\n" }, { "name": "advisorReportCheckId", "value": "", "type": "path", "description": "The ID of the advisor check\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the premigration extended Advisor report check.\n" }, { "info": { "name": "Update the Pre-Migration extended advisor report object list.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/jobs/:jobId/advisorReportChecks/:advisorReportCheckId/actions/updateObjects", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The OCID of the job\n" }, { "name": "advisorReportCheckId", "value": "", "type": "path", "description": "The ID of the advisor check\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the Pre-Migration extended Advisor report object list.\n" }, { "info": { "name": "Get the Pre-Migration extended Advisor report object list.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/jobs/:jobId/advisorReportChecks/:advisorReportCheckId/objects", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The OCID of the job\n" }, { "name": "advisorReportCheckId", "value": "", "type": "path", "description": "The ID of the advisor check\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" } ] }, "docs": "Get the Pre-Migration extended Advisor report object list.\n" }, { "info": { "name": "List all excluded database objects.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/jobs/:jobId/excludedObjects", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The OCID of the job\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nDefault order for reasonCategory is ascending.\nIf no value is specified reasonCategory is default.\n" }, { "name": "type", "value": "", "type": "query", "description": "Excluded object type.\n" }, { "name": "owner", "value": "", "type": "query", "description": "Excluded object owner\n" }, { "name": "object", "value": "", "type": "query", "description": "Excluded object name\n" }, { "name": "ownerContains", "value": "", "type": "query", "description": "Excluded object owner which contains provided value.\n" }, { "name": "objectContains", "value": "", "type": "query", "description": "Excluded object name which contains provided value.\n" }, { "name": "reasonCategory", "value": "", "type": "query", "description": "Reason category for the excluded object\n" }, { "name": "sourceRule", "value": "", "type": "query", "description": "Exclude object rule that matches the excluded object, if applicable.\n" } ] }, "docs": "List the excluded database objects.\n" }, { "info": { "name": "List the Job Outputs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/jobs/:jobId/output", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The OCID of the job\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" } ] }, "docs": "List the Job Outputs\n" }, { "info": { "name": "Get Job Output.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/jobs/:jobId/output/content", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The OCID of the job\n" } ] }, "docs": "Get the migration Job Output content as a String.\n" }, { "info": { "name": "Returns a list of parameter file associated with the specified Job.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/jobs/:jobId/parameterFileVersions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The OCID of the job\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.\nDefault order for displayName is ascending. If no value is specified timeCreated is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" } ] }, "docs": "Return a list of the parameter file metadata of the migration execution of the specified job. This will\nonly be acceptable if the job is in particular state. It will be accessible if the job is in\nthe FAILED, PAUSED or SUSPENDED state.\n" }, { "info": { "name": "Creates a new version of the current parameter file contents to the specified value.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/jobs/:jobId/parameterFileVersions", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The OCID of the job\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new version of the current parameter file contents to the specified value.\n" }, { "info": { "name": "Provied the content of the provided parameter file.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/jobs/:jobId/parameterFileVersions/:parameterFileName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "parameterFileName", "value": "", "type": "path", "description": "A unique name associated with the current migration/job and extract/replicat name\n" }, { "name": "jobId", "value": "", "type": "path", "description": "The OCID of the job\n" } ] }, "docs": "Obtain the parameter file version contents for the specified parameter file name and the associated job. This operation will\nbe allowed only if the job is certain acceptable lifecycle states.\n" }, { "info": { "name": "Deletes the specified Parameter File Version", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20230518/jobs/:jobId/parameterFileVersions/:parameterFileName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The OCID of the job\n" }, { "name": "parameterFileName", "value": "", "type": "path", "description": "A unique name associated with the current migration/job and extract/replicat name\n" } ] }, "docs": "Deletes the given parameter file version\n" }, { "info": { "name": "Make current the given parameter file version", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/jobs/:jobId/parameterFileVersions/:parameterFileName/actions/makeCurrent", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The OCID of the job\n" }, { "name": "parameterFileName", "value": "", "type": "path", "description": "A unique name associated with the current migration/job and extract/replicat name\n" } ] }, "docs": "Make current the given parameter file version\n" }, { "info": { "name": "Display sample object types to exclude or include for a Migration.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/migrationObjectTypes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nDefault order for name is custom based on it's usage frequency. If no value is specified name is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" }, { "name": "connectionType", "value": "", "type": "query", "description": "The connection type for migration objects." } ] }, "docs": "Display sample object types to exclude or include for a Migration.\n" }, { "info": { "name": "List of migration parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/migrationParameters", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "migrationType", "value": "", "type": "query", "description": "A filter to return only resources that match a certain Migration Type.\n" }, { "name": "databaseCombination", "value": "", "type": "query", "description": "A filter to return only resources that match a certain Database Combination.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.\nDefault order for displayName is ascending. If no value is specified timeCreated is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" } ] }, "docs": "List of parameters that can be used to customize migrations." }, { "info": { "name": "List all Migrations.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/migrations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.\nDefault order for displayName is ascending. If no value is specified timeCreated is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The lifecycle state of the Migration.\n" }, { "name": "lifecycleDetails", "value": "", "type": "query", "description": "The lifecycle detailed status of the Migration.\n" } ] }, "docs": "List all Migrations.\n" }, { "info": { "name": "Create a Migration.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/migrations", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Migration resource that contains all the details to perform the\ndatabase migration operation, such as source and destination database\ndetails, credentials, etc.\n" }, { "info": { "name": "Display Migration details", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/migrations/:migrationId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "migrationId", "value": "", "type": "path", "description": "The OCID of the migration\n" } ] }, "docs": "Display Migration details.\n" }, { "info": { "name": "Update a Migration.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20230518/migrations/:migrationId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "migrationId", "value": "", "type": "path", "description": "The OCID of the migration\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Migration resource details.\n" }, { "info": { "name": "Delete the specified Migration.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20230518/migrations/:migrationId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "migrationId", "value": "", "type": "path", "description": "The OCID of the migration\n" } ] }, "docs": "Deletes the Migration represented by the specified migration ID.\n" }, { "info": { "name": "Add excluded/included object to the list.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/migrations/:migrationId/actions/addMigrationObjects", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "migrationId", "value": "", "type": "path", "description": "The OCID of the migration\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add excluded/included object to the list.\n" }, { "info": { "name": "Change a Migration compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/migrations/:migrationId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "migrationId", "value": "", "type": "path", "description": "The OCID of the migration\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Used to change the Migration compartment.\n" }, { "info": { "name": "Clone a Migration.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/migrations/:migrationId/actions/clone", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "migrationId", "value": "", "type": "path", "description": "The OCID of the migration\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Clone a configuration from an existing Migration.\n" }, { "info": { "name": "Display Migration Phases for a specified migration.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/migrations/:migrationId/actions/getSupportedPhases", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "migrationId", "value": "", "type": "path", "description": "The OCID of the migration\n" } ] }, "docs": "Display Migration Phases for a specified migration.\n" }, { "info": { "name": "Remove excluded/included objects.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/migrations/:migrationId/actions/removeMigrationObjects", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "migrationId", "value": "", "type": "path", "description": "The OCID of the migration\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove excluded/included objects.\n" }, { "info": { "name": "Start Migration.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/migrations/:migrationId/actions/start", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "migrationId", "value": "", "type": "path", "description": "The OCID of the migration\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Start Migration job.\n" }, { "info": { "name": "Start Validate Migration.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230518/migrations/:migrationId/actions/validate", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "migrationId", "value": "", "type": "path", "description": "The OCID of the migration\n" } ] }, "docs": "Start Validate Migration job.\n" }, { "info": { "name": "Display excluded/included objects", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/migrations/:migrationId/migrationObjects", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "migrationId", "value": "", "type": "path", "description": "The OCID of the migration\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" } ] }, "docs": "Display excluded/included objects.\n" }, { "info": { "name": "Download DMS script.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/scripts/:scriptId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "scriptId", "value": "", "type": "path", "description": "The ID of the script to download." } ] }, "docs": "Download DMS script." }, { "info": { "name": "Lists work requests in a compartment or for a resource.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources.\n" }, { "name": "resourceId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource.\n" }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only resources their lifecycleState matches the given OperationStatus.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" } ] }, "docs": "Lists the work requests in a compartment or for a specified resource.\n" }, { "info": { "name": "Gets the details of a work request.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request.\n" } ] }, "docs": "Gets the details of a work request.\n" }, { "info": { "name": "Lists work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timestamp is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" } ] }, "docs": "Gets the errors for a work request.\n" }, { "info": { "name": "Lists work request logs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230518/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timestamp is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" } ] }, "docs": "Gets the logs for a work request.\n" } ] } ], "bundled": true }