{ "opencollection": "1.0.0", "info": { "name": "Golden Gate API", "version": "20200407" }, "items": [ { "info": { "name": "goldenGate", "type": "folder" }, "items": [ { "info": { "name": "Lists AI models for the specified provider.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/aiModels", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the work request. Work requests should be scoped \nto the same compartment as the resource the work request affects. If the work request concerns \nmultiple resources, and those resources are not in the same compartment, it is up to the service team \nto pick the primary resource whose compartment should be used.\n" }, { "name": "providerType", "value": "", "type": "query", "description": "The AI provider type for which model information is requested.\n" }, { "name": "region", "value": "", "type": "query", "description": "OCI region identifier, for example us-ashburn-1.\n" }, { "name": "tenancyId", "value": "", "type": "query", "description": "OCI tenancy OCID to use when resolving provider models, for example for\nOCI Generative AI model discovery across a specific tenancy.\n" } ] }, "docs": "Returns the list of AI models for the specified provider. If the\nprovider requires additional context to resolve its supported models,\nthat context must be supplied in the request.\n" }, { "info": { "name": "Lists supported AI providers and their models.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/aiProviders", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the work request. Work requests should be scoped \nto the same compartment as the resource the work request affects. If the work request concerns \nmultiple resources, and those resources are not in the same compartment, it is up to the service team \nto pick the primary resource whose compartment should be used.\n" } ] }, "docs": "Returns the list of AI providers along with their supported models.\n" }, { "info": { "name": "Returns a list of the Connections Assignments in the compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/connectionAssignments", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the work request. Work requests should be scoped \nto the same compartment as the resource the work request affects. If the work request concerns \nmultiple resources, and those resources are not in the same compartment, it is up to the service team \nto pick the primary resource whose compartment should be used.\n" }, { "name": "deploymentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment in which to list resources.\n" }, { "name": "connectionId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the connection.\n" }, { "name": "connectionType", "value": "", "type": "query", "description": "The array of connection types.\n" }, { "name": "connectionTypeNotEqualTo", "value": "", "type": "query", "description": "The array of connection types to exclude.\n" }, { "name": "name", "value": "", "type": "query", "description": "The name of the connection in the assignment (aliasName)." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only connection assignments having the 'lifecycleState' given." }, { "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\nretrieved 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 can be provided. Default order for 'timeCreated' is\ndescending. Default order for 'displayName' is ascending. If no value is specified\ntimeCreated is the default.\n" } ] }, "docs": "Lists the Connection Assignments in the compartment." }, { "info": { "name": "Creates a new Connection Assignment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/connectionAssignments", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Connection Assignment." }, { "info": { "name": "Retrieves a Connection Assignment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/connectionAssignments/:connectionAssignmentId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "connectionAssignmentId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Connection Assignment.\n" } ] }, "docs": "Retrieves a Connection Assignment.\n" }, { "info": { "name": "Deletes a Connection Assignment.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200407/connectionAssignments/:connectionAssignmentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "connectionAssignmentId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Connection Assignment.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes a Connection Assignment." }, { "info": { "name": "Tests DB/service connectivity from a deployment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/connectionAssignments/:connectionAssignmentId/actions/test", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "connectionAssignmentId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Connection Assignment.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Tests the connectivity between given GoldenGate deployment and one of the associated database / service.\nWhen provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Returns a list of the Connections in the compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/connections", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the work request. Work requests should be scoped \nto the same compartment as the resource the work request affects. If the work request concerns \nmultiple resources, and those resources are not in the same compartment, it is up to the service team \nto pick the primary resource whose compartment should be used.\n" }, { "name": "technologyType", "value": "", "type": "query", "description": "The array of technology types.\n" }, { "name": "connectionType", "value": "", "type": "query", "description": "The array of connection types.\n" }, { "name": "connectionTypeNotEqualTo", "value": "", "type": "query", "description": "The array of connection types to exclude.\n" }, { "name": "assignedDeploymentId", "value": "", "type": "query", "description": "The OCID of the deployment which for the connection must be assigned.\n" }, { "name": "assignableDeploymentId", "value": "", "type": "query", "description": "Filters for compatible connections which can be, but currently not assigned to the deployment specified by its id.\n" }, { "name": "assignableDeploymentType", "value": "", "type": "query", "description": "Filters for connections which can be assigned to the latest version of the specified deployment type.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only connections having the 'lifecycleState' given.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only the resources that match the entire 'displayName' 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\nretrieved 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 can be provided. Default order for 'timeCreated' is\ndescending. Default order for 'displayName' is ascending. If no value is specified\ntimeCreated is the default.\n" } ] }, "docs": "Lists the Connections in the compartment.\n" }, { "info": { "name": "Creates a new Connection.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/connections", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Connection.\n" }, { "info": { "name": "Retrieves a Connection.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/connections/:connectionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "connectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Connection.\n" }, { "name": "view", "value": "", "type": "query", "description": "Selects the connection fields returned in connection details.\n" } ] }, "docs": "Retrieves a Connection.\n" }, { "info": { "name": "Update the Connection identified by the id.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200407/connections/:connectionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "connectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Connection.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Connection.\n" }, { "info": { "name": "Deletes a Connection.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200407/connections/:connectionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "connectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Connection.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes a Connection.\n" }, { "info": { "name": "Adds a lock to a Connection resource.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/connections/:connectionId/actions/addLock", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "connectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Connection.\n" } ] }, "docs": "Adds a lock to a Connection resource." }, { "info": { "name": "Moves the Connection to a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/connections/:connectionId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "connectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Connection.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the Connection into a different compartment within the same tenancy. When\nprovided, If-Match is checked against ETag values of the resource. For information about\nmoving resources between compartments, see [Moving Resources Between\nCompartments](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Associate a GoldenGate connection with a different subscription.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/connections/:connectionId/actions/changeSubscription", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "connectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Connection.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associate a GoldanGate connection with a different subscription.\n" }, { "info": { "name": "Migrate Connection attributes.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/connections/:connectionId/actions/migrate", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "connectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Connection.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Migrate Connection attributes.\n" }, { "info": { "name": "Refresh external Connection attributes.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/connections/:connectionId/actions/refresh", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "connectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Connection.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Refresh the external Connection attributes.\n" }, { "info": { "name": "Removes a lock to a Connection resource.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/connections/:connectionId/actions/removeLock", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "connectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Connection.\n" } ] }, "docs": "Removes a lock from a Connection resource." }, { "info": { "name": "Returns a list of the DatabaseRegistrations in the compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/databaseRegistrations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the work request. Work requests should be scoped \nto the same compartment as the resource the work request affects. If the work request concerns \nmultiple resources, and those resources are not in the same compartment, it is up to the service team \nto pick the primary resource whose compartment should be used.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the resources that match the 'lifecycleState' given.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only the resources that match the entire 'displayName' 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\nretrieved 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 can be provided. Default order for 'timeCreated' is\ndescending. Default order for 'displayName' is ascending. If no value is specified\ntimeCreated is the default.\n" } ] }, "docs": "Note: Deprecated. Use the /connections API instead.\nLists the DatabaseRegistrations in the compartment.\n" }, { "info": { "name": "Creates a new DatabaseRegistration.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/databaseRegistrations", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Note: Deprecated. Use the /connections API instead.\nCreates a new DatabaseRegistration.\n" }, { "info": { "name": "Retrieves a DatabaseRegistration.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/databaseRegistrations/:databaseRegistrationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseRegistrationId", "value": "", "type": "path", "description": "A unique DatabaseRegistration identifier.\n" } ] }, "docs": "Note: Deprecated. Use the /connections API instead.\nRetrieves a DatabaseRegistration.\n" }, { "info": { "name": "Update the DatabaseRegistration identified by the id.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200407/databaseRegistrations/:databaseRegistrationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseRegistrationId", "value": "", "type": "path", "description": "A unique DatabaseRegistration identifier.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Note: Deprecated. Use the /connections API instead.\nUpdates the DatabaseRegistration.\n" }, { "info": { "name": "Deletes a DatabaseRegistration.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200407/databaseRegistrations/:databaseRegistrationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseRegistrationId", "value": "", "type": "path", "description": "A unique DatabaseRegistration identifier.\n" } ] }, "docs": "Note: Deprecated. Use the /connections API instead.\nDeletes a DatabaseRegistration.\n" }, { "info": { "name": "Moves the DatabaseRegistration to a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/databaseRegistrations/:databaseRegistrationId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "databaseRegistrationId", "value": "", "type": "path", "description": "A unique DatabaseRegistration identifier.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Note: Deprecated. Use the /connections API instead.\nMoves the DatabaseRegistration into a different compartment within the same tenancy. When\nprovided, If-Match is checked against ETag values of the resource. For information about\nmoving resources between compartments, see [Moving Resources Between\nCompartments](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Lists the DeploymentBackups in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/deploymentBackups", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the work request. Work requests should be scoped \nto the same compartment as the resource the work request affects. If the work request concerns \nmultiple resources, and those resources are not in the same compartment, it is up to the service team \nto pick the primary resource whose compartment should be used.\n" }, { "name": "deploymentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment in which to list resources.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the deployment backups having the 'lifecycleState' given.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only the resources that match the entire 'displayName' 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\nretrieved 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 can be provided. Default order for 'timeCreated' is\ndescending. Default order for 'displayName' is ascending. If no value is specified\ntimeCreated is the default.\n" } ] }, "docs": "Lists the Backups in a compartment.\n" }, { "info": { "name": "Creates a new DeploymentBackup", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deploymentBackups", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new DeploymentBackup." }, { "info": { "name": "Retrieves a DeploymentBackup", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/deploymentBackups/:deploymentBackupId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deploymentBackupId", "value": "", "type": "path", "description": "A unique DeploymentBackup identifier.\n" } ] }, "docs": "Retrieves a DeploymentBackup.\n" }, { "info": { "name": "Modifies a Deployment Backup", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200407/deploymentBackups/:deploymentBackupId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deploymentBackupId", "value": "", "type": "path", "description": "A unique DeploymentBackup identifier.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies a Deployment Backup.\n" }, { "info": { "name": "Deletes a DeploymentBackup.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200407/deploymentBackups/:deploymentBackupId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deploymentBackupId", "value": "", "type": "path", "description": "A unique DeploymentBackup identifier.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes a DeploymentBackup.\n" }, { "info": { "name": "Adds a lock to a DeploymentBackup resource.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deploymentBackups/:deploymentBackupId/actions/addLock", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "deploymentBackupId", "value": "", "type": "path", "description": "A unique DeploymentBackup identifier.\n" } ] }, "docs": "Adds a lock to a DeploymentBackup resource." }, { "info": { "name": "Cancels deployment backup creation process", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deploymentBackups/:deploymentBackupId/actions/cancel", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentBackupId", "value": "", "type": "path", "description": "A unique DeploymentBackup identifier.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancels a Deployment Backup creation process." }, { "info": { "name": "Moves the DeploymentBackup into a different compartment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deploymentBackups/:deploymentBackupId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentBackupId", "value": "", "type": "path", "description": "A unique DeploymentBackup identifier.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a DeploymentBackup into a different compartment within the same tenancy. When provided,\nIf-Match is checked against ETag values of the resource. For information about moving\nresources between compartments, see [Moving Resources Between\nCompartments](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Creates a copy of a Deployment Backup.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deploymentBackups/:deploymentBackupId/actions/copyToBucket", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deploymentBackupId", "value": "", "type": "path", "description": "A unique DeploymentBackup identifier.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a copy of a Deployment Backup." }, { "info": { "name": "Removes a lock to a DeploymentBackup resource.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deploymentBackups/:deploymentBackupId/actions/removeLock", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "deploymentBackupId", "value": "", "type": "path", "description": "A unique DeploymentBackup identifier.\n" } ] }, "docs": "Removes a lock from a DeploymentBackup resource." }, { "info": { "name": "Restores a deployment from the Object Store", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deploymentBackups/:deploymentBackupId/actions/restore", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentBackupId", "value": "", "type": "path", "description": "A unique DeploymentBackup identifier.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restores a Deployment from a Deployment Backup created from the same Deployment." }, { "info": { "name": "Get available deployment environment specific meta-data.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/deploymentEnvironments", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the work request. Work requests should be scoped \nto the same compartment as the resource the work request affects. If the work request concerns \nmultiple resources, and those resources are not in the same compartment, it is up to the service team \nto pick the primary resource whose compartment should be used.\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\nretrieved 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 can be provided. Default order for 'timeCreated' is\ndescending. Default order for 'displayName' is ascending. If no value is specified\ntimeCreated is the default.\n" } ] }, "docs": "Returns an array of DeploymentEnvironmentDescriptor\n" }, { "info": { "name": "Get available deployment type specific meta-data.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/deploymentTypes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the work request. Work requests should be scoped \nto the same compartment as the resource the work request affects. If the work request concerns \nmultiple resources, and those resources are not in the same compartment, it is up to the service team \nto pick the primary resource whose compartment should be used.\n" }, { "name": "deploymentType", "value": "", "type": "query", "description": "The type of deployment, the value determines the exact 'type' of the service executed in the deployment. Default value is DATABASE_ORACLE.\n" }, { "name": "oggVersion", "value": "", "type": "query", "description": "Allows to query by a specific GoldenGate version.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only the resources that match the entire 'displayName' 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\nretrieved 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 can be provided. Default order for 'timeCreated' is\ndescending. Default order for 'displayName' is ascending. If no value is specified\ntimeCreated is the default.\n" } ] }, "docs": "Returns an array of DeploymentTypeDescriptor\n" }, { "info": { "name": "Lists the Deployment Upgrades in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/deploymentUpgrades", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the work request. Work requests should be scoped \nto the same compartment as the resource the work request affects. If the work request concerns \nmultiple resources, and those resources are not in the same compartment, it is up to the service team \nto pick the primary resource whose compartment should be used.\n" }, { "name": "deploymentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment in which to list resources.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the deployment upgrades having the 'lifecycleState' given.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only the resources that match the entire 'displayName' 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\nretrieved 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 can be provided. Default order for 'timeCreated' is\ndescending. Default order for 'displayName' is ascending. If no value is specified\ntimeCreated is the default.\n" } ] }, "docs": "Lists the Deployment Upgrades in a compartment.\n" }, { "info": { "name": "Retrieves a deployment upgrade.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/deploymentUpgrades/:deploymentUpgradeId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deploymentUpgradeId", "value": "", "type": "path", "description": "A unique Deployment Upgrade identifier.\n" } ] }, "docs": "Retrieves a deployment upgrade.\n" }, { "info": { "name": "Cancels a DeploymentUpgrade.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deploymentUpgrades/:deploymentUpgradeId/actions/cancel", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentUpgradeId", "value": "", "type": "path", "description": "A unique Deployment Upgrade identifier.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancels a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Cancel snooze of a DeploymentUpgrade.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deploymentUpgrades/:deploymentUpgradeId/actions/cancelSnooze", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentUpgradeId", "value": "", "type": "path", "description": "A unique Deployment Upgrade identifier.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancel snooze of a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Reschedules a DeploymentUpgrade.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deploymentUpgrades/:deploymentUpgradeId/actions/reschedule", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentUpgradeId", "value": "", "type": "path", "description": "A unique Deployment Upgrade identifier.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reschedules a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Rollback a DeploymentUpgrade.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deploymentUpgrades/:deploymentUpgradeId/actions/rollback", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentUpgradeId", "value": "", "type": "path", "description": "A unique Deployment Upgrade identifier.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Rollback a deployment to it's previous version. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Snooze a DeploymentUpgrade.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deploymentUpgrades/:deploymentUpgradeId/actions/snooze", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentUpgradeId", "value": "", "type": "path", "description": "A unique Deployment Upgrade identifier.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Snooze a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Upgrade a deployment to specific version.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deploymentUpgrades/:deploymentUpgradeId/actions/upgrade", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentUpgradeId", "value": "", "type": "path", "description": "A unique Deployment Upgrade identifier.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upgrade a deployment. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Get available deployment versions.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/deploymentVersions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the work request. Work requests should be scoped \nto the same compartment as the resource the work request affects. If the work request concerns \nmultiple resources, and those resources are not in the same compartment, it is up to the service team \nto pick the primary resource whose compartment should be used.\n" }, { "name": "deploymentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment in which to list resources.\n" }, { "name": "deploymentType", "value": "", "type": "query", "description": "The type of deployment, the value determines the exact 'type' of the service executed in the deployment. Default value is DATABASE_ORACLE.\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\nretrieved 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 can be provided. Default order for 'timeCreated' is\ndescending. Default order for 'displayName' is ascending. If no value is specified\ntimeCreated is the default.\n" } ] }, "docs": "Returns the list of available deployment versions.\n" }, { "info": { "name": "Lists the Deployments in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/deployments", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the work request. Work requests should be scoped \nto the same compartment as the resource the work request affects. If the work request concerns \nmultiple resources, and those resources are not in the same compartment, it is up to the service team \nto pick the primary resource whose compartment should be used.\n" }, { "name": "supportedConnectionType", "value": "", "type": "query", "description": "The connection type which the deployment must support.\n" }, { "name": "assignedConnectionId", "value": "", "type": "query", "description": "The OCID of the connection which for the deployment must be assigned.\n" }, { "name": "assignableConnectionId", "value": "", "type": "query", "description": "Return the deployments to which the specified connectionId may be assigned.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the deployments having the 'lifecycleState' given.\n" }, { "name": "lifecycleSubState", "value": "", "type": "query", "description": "A filter to return only the resources that match the 'lifecycleSubState' given.\n" }, { "name": "deploymentType", "value": "", "type": "query", "description": "A filter that returns only the resources matching the specified 'deploymentType'.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only the resources that match the entire 'displayName' given.\n" }, { "name": "fqdn", "value": "", "type": "query", "description": "A filter to return only the resources that match the 'fqdn' 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\nretrieved 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 can be provided. Default order for 'timeCreated' is\ndescending. Default order for 'displayName' is ascending. If no value is specified\ntimeCreated is the default.\n" } ] }, "docs": "Lists the Deployments in a compartment.\n" }, { "info": { "name": "Creates a new Deployment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deployments", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Deployment.\n" }, { "info": { "name": "Retrieves a deployment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/deployments/:deploymentId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" } ] }, "docs": "Retrieves a deployment.\n" }, { "info": { "name": "Modifies a Deployment", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200407/deployments/:deploymentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies a Deployment.\n" }, { "info": { "name": "Deletes the Deployment.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200407/deployments/:deploymentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes the Deployment.\n" }, { "info": { "name": "Add a new deployment local peer", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/actions/addLocalPeer", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new local peer to the deployment, this will add the given placement to deployment placement attribute. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Adds a lock to a Deployment resource.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/actions/addLock", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" } ] }, "docs": "Adds a lock to a Deployment resource." }, { "info": { "name": "Moves the Deployment into a different compartment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the Deployment into a different compartment within the same tenancy. When provided,\nIf-Match is checked against ETag values of the resource. For information about moving\nresources between compartments, see [Moving Resources Between\nCompartments](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Associate a GoldenGate deployment with a different subscription.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/actions/changeSubscription", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associate a GoldanGate deployment with a different subscription.\n" }, { "info": { "name": "Collects the diagnostic of a Deployment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/actions/collectDiagnostics", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Collects the diagnostic of a Deployment. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Export the OGG wallet from the deployment to OCI vault", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/actions/exportWallet", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Export the OGG wallet from the deployment to OCI vault. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Disaster Recovery precheck.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/actions/generateDisasterRecoveryPrecheckReport", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates disaster recovery precheck report for standby peer.\n" }, { "info": { "name": "Generates a Pre-Authenticated Request Object URL to the DB2 for z/OS library.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/actions/generateLibraryUrl", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates a Pre-Authenticated Request Object URL to a DB2 for z/OS library that needs to be uploaded to your DB2 for z/OS server in order to establish GoldenGate connections to it. For licensing reasons, the URL is accessible for 10 minutes only.\n" }, { "info": { "name": "Imports an OGG wallet to the Deployment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/actions/importWallet", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Imports an OGG wallet from the OCI Vault to the Deployment. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Removes a local peer", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/actions/removeLocalPeer", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a local peer of the deployment, this will remove the given placement entry from the deployment placement attribute. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Removes a lock to a Deployment resource.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/actions/removeLock", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" } ] }, "docs": "Removes a lock from a Deployment resource." }, { "info": { "name": "Starts a Deployment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/actions/start", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Starts a Deployment. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Stops a Deployment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/actions/stop", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Stops a Deployment. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Switchover to the deployment peer", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/actions/switchover", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Switchover to the selected standby peer, which can be a local placement or a standby deployment in different region. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Upgrade a Deployment to different version.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/actions/upgrade", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upgrade a Deployment. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Checks if a wallet is already present in the deployment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/actions/walletExists", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Checks if a wallet is already present in the deployment. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Returns a list of certificates from truststore.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/certificates", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only connections having the 'lifecycleState' 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\nretrieved 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 can be provided. Default order for 'timeCreated' is\ndescending. Default order for 'displayName' is ascending. If no value is specified\ntimeCreated is the default.\n" } ] }, "docs": "Returns a list of certificates from truststore." }, { "info": { "name": "Creates a new certificate to truststore.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/certificates", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new certificate to truststore.\n" }, { "info": { "name": "Retrieves a Certificate.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/certificates/:certificateKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" }, { "name": "certificateKey", "value": "", "type": "path", "description": "A unique certificate identifier.\n" } ] }, "docs": "Retrieves a Certificate.\n" }, { "info": { "name": "Deletes the certificate from truststore.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/certificates/:certificateKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" }, { "name": "certificateKey", "value": "", "type": "path", "description": "A unique certificate identifier.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes the certificate from truststore.\n" }, { "info": { "name": "Returns a list of the wallets export/import operations to/from a deployment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/deploymentWalletsOperations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only the resources that match the entire 'displayName' 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\nretrieved from a previous list call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided. Default order for 'timeStarted' is\ndescending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" } ] }, "docs": "Lists the wallets export/import operations to/from a deployment.\n" }, { "info": { "name": "Returns DR precheck report for a standby peer.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/disasterRecoveryPrecheckReport", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" }, { "name": "availabilityDomain", "value": "", "type": "query", "description": "The availability domain of the placement to evaluate DR pre-checks for.\n" }, { "name": "faultDomain", "value": "", "type": "query", "description": "The fault domain of the placement to evaluate DR pre-checks for.\n" } ] }, "docs": "Returns DR precheck report for a standby peer with the specified placement (availabilityDomain and faultDomain).\n" }, { "info": { "name": "Lists the local and remote peers in a deployment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/deployments/:deploymentId/peers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "A unique Deployment identifier.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the deployment peers having the 'lifecycleState' given.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only the resources that match the entire 'displayName' 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\nretrieved 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 can be provided. Default order for 'timeCreated' is\ndescending. Default order for 'displayName' is ascending. If no value is specified\ntimeCreated is the default.\n" } ] }, "docs": "Lists the local and remote peers in a deployment.\n" }, { "info": { "name": "Returns a list of the DeploymentMessages for a deployment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/messages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "query", "description": "A unique Deployment identifier.\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\nretrieved from a previous list call.\n" } ] }, "docs": "Lists the DeploymentMessages for a deployment. The sorting order is not important. By default first will be Upgrade message, next Exception message and then Storage Utilization message.\n" }, { "info": { "name": "Returns a list of the Pipelines in the compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/pipelines", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the work request. Work requests should be scoped \nto the same compartment as the resource the work request affects. If the work request concerns \nmultiple resources, and those resources are not in the same compartment, it is up to the service team \nto pick the primary resource whose compartment should be used.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filtered list of pipelines to return for a given lifecycleState.\n" }, { "name": "lifecycleSubState", "value": "", "type": "query", "description": "A filtered list of pipelines to return for a given lifecycleSubState.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only the resources that match the entire 'displayName' 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\nretrieved 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 can be provided. Default order for 'timeCreated' is\ndescending. Default order for 'displayName' is ascending. If no value is specified\ntimeCreated is the default.\n" } ] }, "docs": "Lists the Pipelines in the compartment.\n" }, { "info": { "name": "Creates a new pipeline.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/pipelines", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Pipeline.\n" }, { "info": { "name": "Creates a clone of the pipeline.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/pipelines/actions/clone", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Clones the pipeline.\n" }, { "info": { "name": "Retrieves a Pipeline details.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/pipelines/:pipelineId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pipelineId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the pipeline created.\n" } ] }, "docs": "Retrieves a Pipeline details.\n" }, { "info": { "name": "Update the Pipeline identified by the pipeline id.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200407/pipelines/:pipelineId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pipelineId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the pipeline created.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Pipeline.\n" }, { "info": { "name": "Deletes a Pipeline.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200407/pipelines/:pipelineId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pipelineId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the pipeline created.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes a Pipeline.\n" }, { "info": { "name": "Moves the Pipeline to a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/pipelines/:pipelineId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "pipelineId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the pipeline created.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the Pipeline into a different compartment within the same tenancy. When\nprovided, If-Match is checked against ETag values of the resource. For information about\nmoving resources between compartments, see [Moving Resources Between\nCompartments](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Collects diagnostics for the pipeline", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/pipelines/:pipelineId/actions/collectDiagnostics", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "pipelineId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the pipeline created.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Collects diagnostics for the pipeline\n" }, { "info": { "name": "pauses the pipeline.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/pipelines/:pipelineId/actions/pause", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "pipelineId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the pipeline created.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Pauses the pipeline.\n" }, { "info": { "name": "Starts the pipeline for data replication.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/pipelines/:pipelineId/actions/start", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "pipelineId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the pipeline created.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Starts the pipeline for data replication.\n" }, { "info": { "name": "Stops the pipeline for data replication.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/pipelines/:pipelineId/actions/stop", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "pipelineId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the pipeline created.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Stops the pipeline for data replication.\n" }, { "info": { "name": "Tests pipeline connections against pipeline to verify the connectivity.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200407/pipelines/:pipelineId/actions/testConnection", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "pipelineId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the pipeline created.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Tests pipeline connections against pipeline to verify the connectivity.\nWhen provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Retrieves a Pipeline recipe steps and its progress details.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/pipelines/:pipelineId/initializationSteps", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pipelineId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the pipeline created.\n" } ] }, "docs": "Retrieves a Pipeline recipe steps and its progress details.\n" }, { "info": { "name": "Retrieves a Pipeline's running replication process's status like Capture/Apply.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/pipelines/:pipelineId/runningProcesses", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pipelineId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the pipeline created.\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\nretrieved 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 can be provided. Default order for 'timeCreated' is\ndescending. Default order for 'displayName' is ascending. If no value is specified\ntimeCreated is the default.\n" } ] }, "docs": "Retrieves a Pipeline's running replication process's status like Capture/Apply.\n" }, { "info": { "name": "Get an array of tables under the given schemas passed as required source and target query params of the pipeline.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/pipelines/:pipelineId/schemaTables", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pipelineId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the pipeline created.\n" }, { "name": "sourceSchemaName", "value": "", "type": "query", "description": "Name of the source schema obtained from get schema endpoint of the created pipeline.\n" }, { "name": "targetSchemaName", "value": "", "type": "query", "description": "Name of the target schema obtained from get schema endpoint of the created pipeline.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only the resources that match the entire 'displayName' 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\nretrieved 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 can be provided. Default order for 'timeCreated' is\ndescending. Default order for 'displayName' is ascending. If no value is specified\ntimeCreated is the default.\n" } ] }, "docs": "Returns an array of tables under the given schemas of the pipeline for given source and target schemas passed as query params.\n" }, { "info": { "name": "Get an array of schemas based on mapping rules for a pipeline.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/pipelines/:pipelineId/schemas", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pipelineId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the pipeline created.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only the resources that match the entire 'displayName' 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\nretrieved 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 can be provided. Default order for 'timeCreated' is\ndescending. Default order for 'displayName' is ascending. If no value is specified\ntimeCreated is the default.\n" } ] }, "docs": "Returns an array of schemas based on mapping rules for a pipeline.\n" }, { "info": { "name": "Get available recipes supported by GoldenGate.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/recipes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the work request. Work requests should be scoped \nto the same compartment as the resource the work request affects. If the work request concerns \nmultiple resources, and those resources are not in the same compartment, it is up to the service team \nto pick the primary resource whose compartment should be used.\n" }, { "name": "recipeType", "value": "", "type": "query", "description": "The pipeline's recipe type. The default value is ZERO_ETL.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only the resources that match the entire 'displayName' 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\nretrieved 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 can be provided. Default order for 'timeCreated' is\ndescending. Default order for 'displayName' is ascending. If no value is specified\ntimeCreated is the default.\n" } ] }, "docs": "Returns an array of Recipe Summary.\n" }, { "info": { "name": "Returns a list of the TrailFiles for a deployment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/trailFiles", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "query", "description": "A unique Deployment identifier.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only the resources that match the entire 'displayName' given.\n" }, { "name": "trailFileId", "value": "", "type": "query", "description": "A Trail File identifier\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\nretrieved from a previous list call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided. Default order for 'timeLastUpdated' is\ndescending. Default order for 'displayName' is ascending. If no value is specified\ndisplayName is the default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" } ] }, "docs": "Lists the TrailFiles for a deployment.\nDeprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c.\n" }, { "info": { "name": "Returns a list of the Trail Sequences for a deployment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/trailSequences", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "query", "description": "A unique Deployment identifier.\n" }, { "name": "trailFileId", "value": "", "type": "query", "description": "A Trail File identifier\n" }, { "name": "trailSequenceId", "value": "", "type": "query", "description": "A Trail Sequence identifier\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only the resources that match the entire 'displayName' 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\nretrieved from a previous list call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided. Default order for 'timeLastUpdated' is\ndescending. Default order for 'displayName' is ascending. If no value is specified\ndisplayName is the default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" } ] }, "docs": "Lists the Trail Sequences for a TrailFile in a given deployment.\nDeprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c.\n" }, { "info": { "name": "Lists the work requests in the compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the work request. Work requests should be scoped \nto the same compartment as the resource the work request affects. If the work request concerns \nmultiple resources, and those resources are not in the same compartment, it is up to the service team \nto pick the primary resource whose compartment should be used.\n" }, { "name": "resourceId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the resource in which to list resources.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually\nretrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" } ] }, "docs": "Lists the work requests in the compartment.\n" }, { "info": { "name": "Retrieves a work request.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous request.\n" } ] }, "docs": "Retrieve the WorkRequest identified by the given OCID.\n" }, { "info": { "name": "Lists work request errors.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous request.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually\nretrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" } ] }, "docs": "Lists work request errors.\n" }, { "info": { "name": "Lists work request logs.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200407/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous request.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually\nretrieved from a previous list call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return.\n" } ] }, "docs": "Lists work request logs.\n" } ] } ], "bundled": true }