{ "opencollection": "1.0.0", "info": { "name": "MySQL Database Service Channels API", "version": "20190415" }, "items": [ { "info": { "name": "channels", "type": "folder" }, "items": [ { "info": { "name": "Lists Channels.", "type": "http" }, "http": { "method": "GET", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/channels", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "dbSystemId", "value": "", "type": "query", "description": "The DB System [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "channelId", "value": "", "type": "query", "description": "The OCID of the Channel." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only the resource matching the given display name exactly." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The LifecycleState of the Channel." }, { "name": "isEnabled", "value": "", "type": "query", "description": "If true, returns only Channels that are enabled. If false, returns only\nChannels that are disabled.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Time fields are default ordered as descending. Display name is default ordered as ascending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use (ASC or DESC)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated list call. For information about pagination, see\n[List Pagination](../../../#API/Concepts/usingapi.htm#List_Pagination).\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` or `opc-prev-page` response header from\nthe previous list call. For information about pagination, see [List\nPagination](../../../#API/Concepts/usingapi.htm#List_Pagination).\n" } ] }, "docs": "Lists all the Channels that match the specified filters." }, { "info": { "name": "Creates a Channel.", "type": "http" }, "http": { "method": "POST", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/channels", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Channel to establish replication from a source to a target.\n" }, { "info": { "name": "Gets a Channel.", "type": "http" }, "http": { "method": "GET", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/channels/:channelId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-none-match", "value": "" } ], "params": [ { "name": "channelId", "value": "", "type": "path", "description": "The Channel [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets the full details of the specified Channel, including the user-specified\nconfiguration parameters (passwords are omitted), as well as information about\nthe state of the Channel, its sources and targets.\n" }, { "info": { "name": "Updates a Channel.", "type": "http" }, "http": { "method": "PUT", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/channels/:channelId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "channelId", "value": "", "type": "path", "description": "The Channel [OCID](/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of the specified Channel.\nIf the Channel is Active the Update operation will asynchronously apply the new configuration\nparameters to the Channel and the Channel may become temporarily unavailable. Otherwise, the\nnew configuration will be applied the next time the Channel becomes Active.\n" }, { "info": { "name": "Deletes a Channel.", "type": "http" }, "http": { "method": "DELETE", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/channels/:channelId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "channelId", "value": "", "type": "path", "description": "The Channel [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the specified Channel." }, { "info": { "name": "Generate Channel status.", "type": "http" }, "http": { "method": "POST", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/channels/:channelId/actions/generateChannelStatus", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "channelId", "value": "", "type": "path", "description": "The Channel [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Initiates an asynchronous request to collect the current status of the specified Channel.\n" }, { "info": { "name": "Resets a Channel.", "type": "http" }, "http": { "method": "POST", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/channels/:channelId/actions/reset", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "channelId", "value": "", "type": "path", "description": "The Channel [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Resets the specified Channel by purging its cached information, leaving the Channel\nas if it had just been created. This operation is only accepted in Inactive Channels.\n" }, { "info": { "name": "Resumes a Channel.", "type": "http" }, "http": { "method": "POST", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/channels/:channelId/actions/resume", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "channelId", "value": "", "type": "path", "description": "The Channel [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Resumes an enabled Channel that has become Inactive due to an error. The resume operation\nrequires that the error that cause the Channel to become Inactive has already been fixed,\notherwise the operation may fail.\n" }, { "info": { "name": "Get Channel status.", "type": "http" }, "http": { "method": "GET", "url": "http://mysql.{region}.ocp.oraclecloud.com/20190415/channels/:channelId/channelStatus", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "channelId", "value": "", "type": "path", "description": "The Channel [OCID](/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Returns the most up-to-date status of the specified Channel.\n" } ] } ], "bundled": true }