{ "opencollection": "1.0.0", "info": { "name": "Batch Batch Computing API", "version": "20251031" }, "items": [ { "info": { "name": "batchComputing", "type": "folder" }, "items": [ { "info": { "name": "Lists the list of batch context shapes.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251031/batchContextShapes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "shapeType", "value": "", "type": "query", "description": "The type of a shape." } ] }, "docs": "Lists the shapes allowed to be specified during batch context creation. Ordered by the shape name." }, { "info": { "name": "Gets the batch contexts.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251031/batchContexts", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state. The\nstate value is case-insensitive.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch context." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Lists the batch contexts by compartment or context [OCID](/iaas/Content/General/Concepts/identifiers.htm). You can filter and sort them by various properties like lifecycle state, name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchContext to get the full details on a specific context" }, { "info": { "name": "Creates a batch context.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251031/batchContexts", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a batch context." }, { "info": { "name": "Gets a batch context.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251031/batchContexts/:batchContextId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchContextId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch context." } ] }, "docs": "Gets information about a batch context." }, { "info": { "name": "Updates a batch context.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20251031/batchContexts/:batchContextId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchContextId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch context." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a batch context." }, { "info": { "name": "Deletes a batch context.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20251031/batchContexts/:batchContextId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchContextId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch context." } ] }, "docs": "Deletes a batch context. All batch job pools associated with the batch context must be deleted beforehand." }, { "info": { "name": "Moves a batch context into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251031/batchContexts/:batchContextId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchContextId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch context." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a batch context into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes)." }, { "info": { "name": "Activates a batch context to accept new jobs.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251031/batchContexts/:batchContextId/actions/start", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchContextId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch context." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Activates a batch context to accept new jobs." }, { "info": { "name": "Stops a batch context from accepting new jobs.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251031/batchContexts/:batchContextId/actions/stop", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchContextId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch context." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Stops a batch context from accepting new jobs." }, { "info": { "name": "Lists the batch job pools.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251031/batchJobPools", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state. The\nstate value is case-insensitive.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool." }, { "name": "batchContextId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch context." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Lists the batch job pools by compartment or job pool [OCID](/iaas/Content/General/Concepts/identifiers.htm). You can filter and sort them by various properties like lifecycle state, display name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchJobPool to get the full details on a specific context" }, { "info": { "name": "Creates a batch job pool.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251031/batchJobPools", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a batch job pool." }, { "info": { "name": "Gets a batch job pool.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251031/batchJobPools/:batchJobPoolId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchJobPoolId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool." } ] }, "docs": "Gets information about a batch job pool." }, { "info": { "name": "Updates a batch job pool.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20251031/batchJobPools/:batchJobPoolId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchJobPoolId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a batch job pool." }, { "info": { "name": "Deletes a batch job pool.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20251031/batchJobPools/:batchJobPoolId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchJobPoolId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool." } ] }, "docs": "Deletes a batch job pool. All batch jobs associated with the batch job pool must be canceled beforehand." }, { "info": { "name": "Moves a batch job pool into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251031/batchJobPools/:batchJobPoolId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchJobPoolId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a batch job pool into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes)." }, { "info": { "name": "Activates the batch job pool.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251031/batchJobPools/:batchJobPoolId/actions/start", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchJobPoolId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Activates the batch job pool." }, { "info": { "name": "Deactivates the batch job pool.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251031/batchJobPools/:batchJobPoolId/actions/stop", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchJobPoolId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deactivates the batch job pool." }, { "info": { "name": "Lists the list of batch jobs.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251031/batchJobs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state. The\nstate value is case-insensitive.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job." }, { "name": "batchJobPoolId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Lists the batch jobs by compartment or job [OCID](/iaas/Content/General/Concepts/identifiers.htm). You can filter and sort them by various properties like lifecycle state, display name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchJob to get the full details on a specific context" }, { "info": { "name": "Creates a batch job.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251031/batchJobs", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a batch job." }, { "info": { "name": "Lists the list of batch tasks.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251031/batchJobs/tasks", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "batchJobId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state. The\nstate value is case-insensitive.\n" }, { "name": "name", "value": "", "type": "query", "description": "The hierarchical name of the batch task. Mutually exclusive with the task id query parameter: you can't pass both." }, { "name": "taskId", "value": "", "type": "query", "description": "The UUID of the batch task. Mutually exclusive with the task name and group task name query parameters: you can't pass both." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `name` is ascending.\n" } ] }, "docs": "Lists the batch tasks associated with batch jobs." }, { "info": { "name": "Gets a batch job.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251031/batchJobs/:batchJobId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchJobId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job." } ] }, "docs": "Gets information about a batch job." }, { "info": { "name": "Updates a batch job.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20251031/batchJobs/:batchJobId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchJobId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a batch job." }, { "info": { "name": "Cancels a batch job.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20251031/batchJobs/:batchJobId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchJobId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job." } ] }, "docs": "Cancels a batch job." }, { "info": { "name": "Moves a batch job into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251031/batchJobs/:batchJobId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchJobId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a batch job into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes)." }, { "info": { "name": "Pauses the batch job and all its tasks.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251031/batchJobs/:batchJobId/actions/pause", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchJobId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Pauses the batch job and all its tasks." }, { "info": { "name": "Resumes the batch job and all its tasks.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251031/batchJobs/:batchJobId/actions/unpause", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchJobId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Resumes the batch job and all its tasks." }, { "info": { "name": "Lists the batch tasks by batch job.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251031/batchJobs/:batchJobId/tasks", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchJobId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state. The\nstate value is case-insensitive.\n" }, { "name": "name", "value": "", "type": "query", "description": "The hierarchical name of the batch task. Mutually exclusive with the task id query parameter: you can't pass both." }, { "name": "taskId", "value": "", "type": "query", "description": "The UUID of the batch task. Mutually exclusive with the task name and group task name query parameters: you can't pass both." }, { "name": "groupTaskName", "value": "", "type": "query", "description": "Hierarchical name of the group task. A filter to return only tasks contained within the selected group task. Omit to return top-level tasks only. Can be combined with task name query parameter, in which case task name becomes a hierarchical name relative to the selected group task, e.g. ?groupTaskName=A.B&taskName=C.D is equal to ?taskName=A.B.C.D. Mutually exclusive with the task id query parameter: you can't pass both." }, { "name": "type", "value": "", "type": "query", "description": "Filter tasks by type. Valid values are: COMPUTE, GROUP." }, { "name": "hierarchyView", "value": "", "type": "query", "description": "Defines the hierarchical scope of the tasks to be returned. When set to SHALLOW, which is default, only tasks contained directly (non-recursively) within current hierarchy entry are returned. When set to DEEP, tasks contained within current hierarchy entry and all its descendants recursively are returned. The default hierarchy entry is root, i.e. batch job itself. To use a different hierarchy entry, provide the group task name as a query parameter. The specified group task becomes the entry point instead of the batch job." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `name` is ascending.\n" } ] }, "docs": "Lists the batch tasks by batch job [OCID](/iaas/Content/General/Concepts/identifiers.htm). You can filter and sort them by various properties like lifecycle state, name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchTask to get the full details on a specific context\nList is incomplete until jobs lifecycle is in_progress" }, { "info": { "name": "Gets a specific batch task by its name.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251031/batchJobs/:batchJobId/tasks/:taskName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchJobId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job." }, { "name": "taskName", "value": "", "type": "path", "description": "The hierarchical name of the batch task. Mutually exclusive with the task id query parameter: you can't pass both." } ] }, "docs": "Gets a specific batch task associated with a batch job by its name." }, { "info": { "name": "Lists the task environments.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251031/batchTaskEnvironments", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state. The\nstate value is case-insensitive.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch task environment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Lists the task environments by compartment or environment [OCID](/iaas/Content/General/Concepts/identifiers.htm). You can filter and sort them by various properties like lifecycle state, display name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchTaskEnvironment to get the full details on a specific context" }, { "info": { "name": "Creates a batch task environment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251031/batchTaskEnvironments", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a batch task environment." }, { "info": { "name": "Gets a batch task environment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251031/batchTaskEnvironments/:batchTaskEnvironmentId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchTaskEnvironmentId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch task environment." } ] }, "docs": "Gets information about a batch task environment." }, { "info": { "name": "Updates a batch task environment.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20251031/batchTaskEnvironments/:batchTaskEnvironmentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchTaskEnvironmentId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch task environment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a batch task environment." }, { "info": { "name": "Deletes a batch task environment.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20251031/batchTaskEnvironments/:batchTaskEnvironmentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchTaskEnvironmentId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch task environment." } ] }, "docs": "Deletes a batch task environment. All batch tasks associated with the batch task environment must be canceled beforehand." }, { "info": { "name": "Moves a batch task environment into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251031/batchTaskEnvironments/:batchTaskEnvironmentId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchTaskEnvironmentId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch task environment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a batch task environment into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes)." }, { "info": { "name": "Lists the task profiles.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251031/batchTaskProfiles", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state. The\nstate value is case-insensitive.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch task profile." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Lists the task profiles by compartment or profile [OCID](/iaas/Content/General/Concepts/identifiers.htm). You can filter and sort them by various properties like lifecycle state, name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchTaskProfile to get the full details on a specific context" }, { "info": { "name": "Creates a batch task profile.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251031/batchTaskProfiles", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a batch task profile." }, { "info": { "name": "Gets a batch task profile", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251031/batchTaskProfiles/:batchTaskProfileId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchTaskProfileId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch task profile." } ] }, "docs": "Gets information about a batch task profile." }, { "info": { "name": "Updates a batch task profile.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20251031/batchTaskProfiles/:batchTaskProfileId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchTaskProfileId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch task profile." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a batch task profile." }, { "info": { "name": "Deletes a batch task profile.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20251031/batchTaskProfiles/:batchTaskProfileId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchTaskProfileId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch task profile." } ] }, "docs": "Deletes a batch task profile. All batch tasks associated with the batch task profile must be canceled beforehand." }, { "info": { "name": "Moves a batch task profile into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251031/batchTaskProfiles/:batchTaskProfileId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "batchTaskProfileId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch task profile." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a batch task profile into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes)." }, { "info": { "name": "Lists the work requests.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251031/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "workRequestId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only the resources that match the given lifecycle state." }, { "name": "resourceId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[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, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.\n" } ] }, "docs": "Lists the work requests in a compartment." }, { "info": { "name": "Gets the work request status.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251031/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." } ] }, "docs": "Gets the details of a work request." }, { "info": { "name": "List the work request errors.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251031/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[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, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\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.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." } ] }, "docs": "Lists the errors for a work request." }, { "info": { "name": "List the work request logs.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251031/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[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, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\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.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." } ] }, "docs": "Lists the logs for a work request." } ] } ], "bundled": true }