{ "opencollection": "1.0.0", "info": { "name": "Full Stack Disaster Recovery API", "version": "20220125" }, "items": [ { "info": { "name": "disasterRecovery", "type": "folder" }, "items": [ { "info": { "name": "List Automatic DR configurations.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220125/automaticDrConfigurations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drProtectionGroupId", "value": "", "type": "query", "description": "The OCID of the DR protection group. Mandatory query param.\n\nExample: `ocid1.drprotectiongroup.oc1..uniqueID`\n" }, { "name": "automaticDrConfigurationId", "value": "", "type": "query", "description": "The OCID of the automatic DR configuration.\n\nExample: `ocid1.automaticDrConfiguration.oc1..uniqueID`\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only Automatic DR configurations that match the given lifecycle state.\n" }, { "name": "lifecycleStateNotEqualTo", "value": "", "type": "query", "description": "A filter to return only Automatic DR configurations that do not match the given lifecycle state.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name.\n\nExample: `MyResourceDisplayName`\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `100`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response\nheader from the previous \"List\" call.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\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. Default order for timeCreated is descending.\nDefault order for displayName is ascending. If no value is specified timeCreated is default.\n\nExample: `MyResourceDisplayName`\n" } ] }, "docs": "Get a summary list of automatic DR configurations for a DR protection group." }, { "info": { "name": "Create a Automatic DR configuration.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220125/automaticDrConfigurations", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Automatic DR configuration." }, { "info": { "name": "Get a Automatic DR configuration.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220125/automaticDrConfigurations/:automaticDrConfigurationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "automaticDrConfigurationId", "value": "", "type": "path", "description": "The OCID of the Automatic DR configuration.\n\nExample: `ocid1.automaticDrConfiguration.oc1..uniqueID`\n" } ] }, "docs": "Get details for the Automatic DR configuration identified by *automaticDrConfigurationId*." }, { "info": { "name": "Update Automatic DR configuration.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220125/automaticDrConfigurations/:automaticDrConfigurationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "automaticDrConfigurationId", "value": "", "type": "path", "description": "The OCID of the Automatic DR configuration.\n\nExample: `ocid1.automaticDrConfiguration.oc1..uniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the Automatic DR configuration identified by *automaticDrConfigurationId*." }, { "info": { "name": "Delete automatic DR configuration.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220125/automaticDrConfigurations/:automaticDrConfigurationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "automaticDrConfigurationId", "value": "", "type": "path", "description": "The OCID of the Automatic DR configuration.\n\nExample: `ocid1.automaticDrConfiguration.oc1..uniqueID`\n" } ] }, "docs": "Delete the automatic DR configuration identified by *automaticDrConfigurationId*." }, { "info": { "name": "List DR plan executions.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220125/drPlanExecutions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drProtectionGroupId", "value": "", "type": "query", "description": "The OCID of the DR protection group. Mandatory query param.\n\nExample: `ocid1.drprotectiongroup.oc1..uniqueID`\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only DR plan executions that match the given lifecycle state.\n" }, { "name": "drPlanExecutionId", "value": "", "type": "query", "description": "The OCID of the DR plan execution.\n\nExample: `ocid1.drplanexecution.oc1..uniqueID`\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name.\n\nExample: `MyResourceDisplayName`\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `100`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response\nheader from the previous \"List\" call.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\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. Default order for timeCreated is descending.\nDefault order for displayName is ascending. If no value is specified timeCreated is default.\n\nExample: `MyResourceDisplayName`\n" } ] }, "docs": "Get a summary list of all DR plan executions for a DR protection group." }, { "info": { "name": "Execute a DR plan.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220125/drPlanExecutions", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Execute a DR plan for a DR protection group." }, { "info": { "name": "Get a DR plan execution.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220125/drPlanExecutions/:drPlanExecutionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drPlanExecutionId", "value": "", "type": "path", "description": "The OCID of the DR plan execution.\n\nExample: `ocid1.drplanexecution.oc1..uniqueID`\n" } ] }, "docs": "Get details for the DR plan execution identified by *drPlanExecutionId*." }, { "info": { "name": "Update a DR plan execution.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220125/drPlanExecutions/:drPlanExecutionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drPlanExecutionId", "value": "", "type": "path", "description": "The OCID of the DR plan execution.\n\nExample: `ocid1.drplanexecution.oc1..uniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the DR plan execution identified by *drPlanExecutionId*." }, { "info": { "name": "Delete a DR plan execution.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220125/drPlanExecutions/:drPlanExecutionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drPlanExecutionId", "value": "", "type": "path", "description": "The OCID of the DR plan execution.\n\nExample: `ocid1.drplanexecution.oc1..uniqueID`\n" } ] }, "docs": "Delete the DR plan execution identified by *drPlanExecutionId*." }, { "info": { "name": "Cancel a DR plan execution.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220125/drPlanExecutions/:drPlanExecutionId/actions/cancel", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drPlanExecutionId", "value": "", "type": "path", "description": "The OCID of the DR plan execution.\n\nExample: `ocid1.drplanexecution.oc1..uniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancel the DR plan execution identified by *drPlanExecutionId*." }, { "info": { "name": "Ignore a failed group or step execution.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220125/drPlanExecutions/:drPlanExecutionId/actions/ignore", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drPlanExecutionId", "value": "", "type": "path", "description": "The OCID of the DR plan execution.\n\nExample: `ocid1.drplanexecution.oc1..uniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Ignore the failed group or step in DR plan execution identified by *drPlanExecutionId* and resume execution." }, { "info": { "name": "Pause a DR plan execution.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220125/drPlanExecutions/:drPlanExecutionId/actions/pause", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drPlanExecutionId", "value": "", "type": "path", "description": "The OCID of the DR plan execution.\n\nExample: `ocid1.drplanexecution.oc1..uniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Pause the DR plan execution identified by *drPlanExecutionId*." }, { "info": { "name": "Resume a DR plan execution.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220125/drPlanExecutions/:drPlanExecutionId/actions/resume", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drPlanExecutionId", "value": "", "type": "path", "description": "The OCID of the DR plan execution.\n\nExample: `ocid1.drplanexecution.oc1..uniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Resume the DR plan execution identified by *drPlanExecutionId*." }, { "info": { "name": "Retry a failed group or step execution.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220125/drPlanExecutions/:drPlanExecutionId/actions/retry", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drPlanExecutionId", "value": "", "type": "path", "description": "The OCID of the DR plan execution.\n\nExample: `ocid1.drplanexecution.oc1..uniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retry the failed group or step in DR plan execution identified by *drPlanExecutionId* and resume execution." }, { "info": { "name": "List DR plans.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220125/drPlans", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drProtectionGroupId", "value": "", "type": "query", "description": "The OCID of the DR protection group. Mandatory query param.\n\nExample: `ocid1.drprotectiongroup.oc1..uniqueID`\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only DR plans that match the given lifecycle state.\n" }, { "name": "drPlanId", "value": "", "type": "query", "description": "The OCID of the DR plan.\n\nExample: `ocid1.drplan.oc1..uniqueID`\n" }, { "name": "drPlanType", "value": "", "type": "query", "description": "The DR plan type." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name.\n\nExample: `MyResourceDisplayName`\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `100`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response\nheader from the previous \"List\" call.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\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. Default order for timeCreated is descending.\nDefault order for displayName is ascending. If no value is specified timeCreated is default.\n\nExample: `MyResourceDisplayName`\n" }, { "name": "lifecycleSubState", "value": "", "type": "query", "description": "A filter to return only DR plans that match the given lifecycle sub-state.\n" } ] }, "docs": "Get a summary list of all DR plans for a DR protection group." }, { "info": { "name": "Create a DR plan.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220125/drPlans", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a DR plan of the specified DR plan type." }, { "info": { "name": "Get a DR plan.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220125/drPlans/:drPlanId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drPlanId", "value": "", "type": "path", "description": "The OCID of the DR plan.\n\nExample: `ocid1.drplan.oc1..uniqueID`\n" } ] }, "docs": "Get details for the DR plan identified by *drPlanId*." }, { "info": { "name": "Update a DR plan.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220125/drPlans/:drPlanId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drPlanId", "value": "", "type": "path", "description": "The OCID of the DR plan.\n\nExample: `ocid1.drplan.oc1..uniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the DR plan identified by *drPlanId*." }, { "info": { "name": "Delete a DR plan.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220125/drPlans/:drPlanId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drPlanId", "value": "", "type": "path", "description": "The OCID of the DR plan.\n\nExample: `ocid1.drplan.oc1..uniqueID`\n" } ] }, "docs": "Delete the DR plan identified by *drPlanId*." }, { "info": { "name": "Refresh DR Plan.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220125/drPlans/:drPlanId/actions/refresh", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drPlanId", "value": "", "type": "path", "description": "The OCID of the DR plan.\n\nExample: `ocid1.drplan.oc1..uniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Refresh DR Plan identified by *drPlanId*." }, { "info": { "name": "Verify DR Plan.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220125/drPlans/:drPlanId/actions/verify", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drPlanId", "value": "", "type": "path", "description": "The OCID of the DR plan.\n\nExample: `ocid1.drplan.oc1..uniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Verify DR Plan identified by *drPlanId*." }, { "info": { "name": "Get a list of DR protection groups.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220125/drProtectionGroups", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID (OCID) of the compartment in which to list resources.\n\nExample: `ocid1.compartment.oc1..uniqueID`\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only DR protection groups that match the given lifecycle state.\n" }, { "name": "drProtectionGroupId", "value": "", "type": "query", "description": "The OCID of the DR protection group. Optional query param.\n\nExample: `ocid1.drprotectiongroup.oc1..uniqueID`\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name.\n\nExample: `MyResourceDisplayName`\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `100`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response\nheader from the previous \"List\" call.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\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. Default order for timeCreated is descending.\nDefault order for displayName is ascending. If no value is specified timeCreated is default.\n\nExample: `MyResourceDisplayName`\n" }, { "name": "role", "value": "", "type": "query", "description": "The DR protection group Role." }, { "name": "lifecycleSubState", "value": "", "type": "query", "description": "A filter to return only DR protection groups that match the given lifecycle sub-state.\n" } ] }, "docs": "Get a summary list of all DR protection groups in a compartment." }, { "info": { "name": "Create a DR protection group.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220125/drProtectionGroups", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a DR protection group." }, { "info": { "name": "Get a DR protection group.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220125/drProtectionGroups/:drProtectionGroupId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drProtectionGroupId", "value": "", "type": "path", "description": "The OCID of the DR protection group.\n\nExample: `ocid1.drprotectiongroup.oc1..uniqueID`\n" } ] }, "docs": "Get the DR protection group identified by *drProtectionGroupId*." }, { "info": { "name": "Update a DR protection group.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220125/drProtectionGroups/:drProtectionGroupId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drProtectionGroupId", "value": "", "type": "path", "description": "The OCID of the DR protection group.\n\nExample: `ocid1.drprotectiongroup.oc1..uniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the DR protection group identified by *drProtectionGroupId*." }, { "info": { "name": "Delete a DR protection group.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220125/drProtectionGroups/:drProtectionGroupId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drProtectionGroupId", "value": "", "type": "path", "description": "The OCID of the DR protection group.\n\nExample: `ocid1.drprotectiongroup.oc1..uniqueID`\n" } ] }, "docs": "Delete the DR protection group identified by *drProtectionGroupId*." }, { "info": { "name": "Create an association between two DR protection groups.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220125/drProtectionGroups/:drProtectionGroupId/actions/associate", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drProtectionGroupId", "value": "", "type": "path", "description": "The OCID of the DR protection group.\n\nExample: `ocid1.drprotectiongroup.oc1..uniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an association between the DR protection group identified by *drProtectionGroupId* and\nanother DR protection group.\n" }, { "info": { "name": "Move a DR protection group.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220125/drProtectionGroups/:drProtectionGroupId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drProtectionGroupId", "value": "", "type": "path", "description": "The OCID of the DR protection group.\n\nExample: `ocid1.drprotectiongroup.oc1..uniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Move the DR protection group identified by *drProtectionGroupId* to a different compartment." }, { "info": { "name": "Delete the association between two DR protection groups.\n", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220125/drProtectionGroups/:drProtectionGroupId/actions/disassociate", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drProtectionGroupId", "value": "", "type": "path", "description": "The OCID of the DR protection group.\n\nExample: `ocid1.drprotectiongroup.oc1..uniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete the association between the DR protection group identified by *drProtectionGroupId*.\nand its peer DR protection group.\n" }, { "info": { "name": "Update the role of a DR protection group.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220125/drProtectionGroups/:drProtectionGroupId/actions/updateRole", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drProtectionGroupId", "value": "", "type": "path", "description": "The OCID of the DR protection group.\n\nExample: `ocid1.drprotectiongroup.oc1..uniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the role of the DR protection group identified by *drProtectionGroupId*." }, { "info": { "name": "List work requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220125/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID (OCID) of the compartment in which to list resources.\n\nExample: `ocid1.compartment.oc1..uniqueID`\n" }, { "name": "workRequestId", "value": "", "type": "query", "description": "The ID (OCID) of the asynchronous work request.\n\nExample: `ocid1.workrequest.oc1..uniqueID`\n" }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycleState matches the given OperationStatus.\n" }, { "name": "resourceId", "value": "", "type": "query", "description": "The ID (OCID) of the resource affected by the work request.\n\nExample: `ocid1.drplanexecution.oc1..uniqueID`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response\nheader from the previous \"List\" call.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `100`\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 timeAccepted is descending.\n" } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "Get work request status", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220125/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID (OCID) of the asynchronous request.\n\nExample: `ocid1.workrequest.oc1..uniqueID`\n" } ] }, "docs": "Get the status of the work request identified by *workRequestId*." }, { "info": { "name": "Cancel a work request", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220125/workRequests/:workRequestId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID (OCID) of the asynchronous request.\n\nExample: `ocid1.workrequest.oc1..uniqueID`\n" } ] }, "docs": "Cancel the work request identified by *workRequestId*." }, { "info": { "name": "List work request errors.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220125/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID (OCID) of the asynchronous request.\n\nExample: `ocid1.workrequest.oc1..uniqueID`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response\nheader from the previous \"List\" call.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `100`\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nDefault order for timeAccepted is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" } ] }, "docs": "Get a list of work request errors for the work request identified by *workRequestId*.\n" }, { "info": { "name": "List work request logs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220125/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID (OCID) of the asynchronous request.\n\nExample: `ocid1.workrequest.oc1..uniqueID`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response\nheader from the previous \"List\" call.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `100`\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nDefault order for timeAccepted is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" } ] }, "docs": "Get a list of logs for the work request identified by *workRequestId*.\n" } ] } ], "bundled": true }