{ "opencollection": "1.0.0", "info": { "name": "Container Instance API", "version": "20210415" }, "items": [ { "info": { "name": "containerInstance", "type": "folder" }, "items": [ { "info": { "name": "Lists the shapes that can be used to create container instances.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210415/containerInstanceShapes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)." } ] }, "docs": "Lists the shapes that can be used to create container instances." }, { "info": { "name": "Gets a list of all ContainerInstances in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210415/containerInstances", "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 only return resources that match the given lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use (ASC) or (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order. Default order for timeCreated is descending. Default order for displayName is ascending. If you don't specify a value, timeCreated is the default.\n" } ] }, "docs": "Returns a list of container instances.\n" }, { "info": { "name": "Creates a new ContainerInstance", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210415/containerInstances", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a container instance and deploys the containers on it.\n" }, { "info": { "name": "Get ContainerInstance", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210415/containerInstances/:containerInstanceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "containerInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container instance." } ] }, "docs": "Gets information about the specified container instance." }, { "info": { "name": "Update the ContainerInstance identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210415/containerInstances/:containerInstanceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "containerInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container instance." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a container instance." }, { "info": { "name": "Delete a provisioned ContainerInstance", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210415/containerInstances/:containerInstanceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "containerInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container instance." } ] }, "docs": "Deletes a container instance and its containers." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210415/containerInstances/:containerInstanceId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "containerInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container instance." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a container instance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Restart container instance.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210415/containerInstances/:containerInstanceId/actions/restart", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "containerInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container instance." } ] }, "docs": "Restarts a container instance. When provided, If-Match is checked against ETag values of the container instance." }, { "info": { "name": "Starts an inactive container instance.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210415/containerInstances/:containerInstanceId/actions/start", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "containerInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container instance." } ] }, "docs": "Starts a container instance if it is \"inactive\". No effect otherwise. When provided, If-Match is checked against ETag values of the container instance." }, { "info": { "name": "Stops an active container instance.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210415/containerInstances/:containerInstanceId/actions/stop", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "containerInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container instance." } ] }, "docs": "Stops a container instance if it is \"active\". No effect otherwise. When provided, If-Match is checked against ETag values of the container instance." }, { "info": { "name": "Get a list of Containers in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210415/containers", "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 only return resources that match the given lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "containerInstanceId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container instance." }, { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use (ASC) or (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order. Default order for timeCreated is descending. Default order for displayName is ascending. If you don't specify a value, timeCreated is the default.\n" } ] }, "docs": "Returns a list of containers in a compartment.\n" }, { "info": { "name": "Get a single Container.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210415/containers/:containerId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "containerId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container." } ] }, "docs": "Get details about a single container by the container ID." }, { "info": { "name": "Updates a Container.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210415/containers/:containerId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "containerId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a container." }, { "info": { "name": "Retrieve recent log from a container.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210415/containers/:containerId/actions/retrieveLogs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "containerId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container." }, { "name": "isPrevious", "value": "", "type": "query", "description": "Returns the logs for the previous run of the container in a pod.\nIf the container fails, this parameter can help you to determine the root cause of the failure.\n" } ] }, "docs": "Returns the most recent 256 KB of logs from the specified container.\n" }, { "info": { "name": "List Work Requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210415/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 ID 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 \"List\" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)." }, { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "status", "value": "", "type": "query", "description": "A filter to return resources with a lifecycleState that matches the given OperationStatus." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order. Default order for timeAccepted is descending." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." }, { "name": "resourceId", "value": "", "type": "query", "description": "The OCID of the resource affected by the work request." } ] }, "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/20210415/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Gets the status of the work request with the given ID." }, { "info": { "name": "Lists work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210415/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order. Default order for timestamp is descending." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." } ] }, "docs": "Returns a paginated list of errors for a work request.\n" }, { "info": { "name": "Lists work request logs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210415/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order. Default order for timestamp is descending." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC)." } ] }, "docs": "Returns a paginated list of logs for a work request.\n" } ] } ], "bundled": true }