{ "opencollection": "1.0.0", "info": { "name": "File Storage with Lustre Lustre File Storage API", "version": "20250228" }, "items": [ { "info": { "name": "lustreFileStorage", "type": "folder" }, "items": [ { "info": { "name": "Gets the list of available maintenance schedule start times for both Create and Update operation", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/availableMaintenanceScheduleStartTimes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Lustre file system." }, { "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.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "dayOfWeek", "value": "", "type": "query", "description": "Day of the week filter" }, { "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": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." } ] }, "docs": "Gets the list of available maintenance schedule start times for both Create and Update operation" }, { "info": { "name": "Gets the list of available maintenance start times for Override operation", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/availableOverrideMaintenanceStartTimes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Lustre file system." }, { "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": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "date", "value": "", "type": "query", "description": "Date in format `YYYY-MM-DD`" } ] }, "docs": "Gets the list of available maintenance start times for Override operation" }, { "info": { "name": "Gets a list of LustreFileSystems.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/lustreFileSystems", "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.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "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 Lustre file system." }, { "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": "Gets a list of Lustre file systems.\n" }, { "info": { "name": "Creates a LustreFileSystem.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/lustreFileSystems", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Lustre file system.\n" }, { "info": { "name": "Get LustreFileSystem", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/lustreFileSystems/:lustreFileSystemId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "lustreFileSystemId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Lustre file system." } ] }, "docs": "Gets information about a Lustre file system." }, { "info": { "name": "Updates a LustreFileSystem.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20250228/lustreFileSystems/:lustreFileSystemId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "lustreFileSystemId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Lustre file system." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a Lustre file system." }, { "info": { "name": "Deletes a LustreFileSystem.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250228/lustreFileSystems/:lustreFileSystemId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "lustreFileSystemId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Lustre file system." } ] }, "docs": "Deletes a Lustre file system." }, { "info": { "name": "Moves a LustreFileSystem into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/lustreFileSystems/:lustreFileSystemId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "lustreFileSystemId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Lustre file system." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a Lustre file system into a different compartment within the same tenancy. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Overrides the upcoming maintenance to the value provided by user", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/lustreFileSystems/:lustreFileSystemId/actions/overrideMaintenance", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "lustreFileSystemId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Lustre file system." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Overrides the upcoming maintenance to the value provided by user" }, { "info": { "name": "Gets a list of ObjectStorageLinks.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/objectStorageLinks", "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.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "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 Object Storage link." }, { "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" }, { "name": "lustreFileSystemId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Lustre file system." } ] }, "docs": "Gets a list of Object Storage links.\n" }, { "info": { "name": "Creates a ObjectStorageLink.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/objectStorageLinks", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an Object Storage link.\n" }, { "info": { "name": "Get ObjectStorageLink", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/objectStorageLinks/:objectStorageLinkId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "objectStorageLinkId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Object Storage link." } ] }, "docs": "Gets information about an Object Storage link." }, { "info": { "name": "Updates a ObjectStorageLink.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20250228/objectStorageLinks/:objectStorageLinkId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "objectStorageLinkId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Object Storage link." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an Object Storage link." }, { "info": { "name": "Deletes a ObjectStorageLink.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250228/objectStorageLinks/:objectStorageLinkId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "objectStorageLinkId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Object Storage link." } ] }, "docs": "Deletes an Object Storage link." }, { "info": { "name": "Moves a ObjectStorageLink into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/objectStorageLinks/:objectStorageLinkId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "objectStorageLinkId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Object Storage link." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an Object Storage link into a different compartment within the same tenancy. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Starts exporting data from LustreFileSystem path to ObjectStorage Prefix.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/objectStorageLinks/:objectStorageLinkId/actions/startExportToObject", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "objectStorageLinkId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Object Storage link." } ] }, "docs": "Starts the export of data from the Lustre file system to Object Storage.\nThe Lustre file system path and Object Storage object prefix are defined in the Object Storage link resource.\n" }, { "info": { "name": "Starts importing data from ObjectStorage to the LustreFileSystem path.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/objectStorageLinks/:objectStorageLinkId/actions/startImportFromObject", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "objectStorageLinkId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Object Storage link." } ] }, "docs": "Starts the import of data from Object Storage to the Lustre file system.\nThe Lustre file system path and Object Storage object prefix are defined in the Object Storage link resource.\n" }, { "info": { "name": "Stops exporting data to ObjectStorage from LustreFileSystem path.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/objectStorageLinks/:objectStorageLinkId/actions/stopExportToObject", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "objectStorageLinkId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Object Storage link." } ] }, "docs": "Stops the export of data from the Lustre file system to Object Storage. \nThe Lustre file system path and Object Storage object prefix are defined in the Object Storage link resource.\n" }, { "info": { "name": "Stops importing data from ObjectStorage to the LustreFileSystem path.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/objectStorageLinks/:objectStorageLinkId/actions/stopImportFromObject", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "objectStorageLinkId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Object Storage link." } ] }, "docs": "Stops the import of data from Object Storage to the Lustre file system.\nThe Lustre file system path and Object Storage object prefix are defined in the Object Storage link resource.\n" }, { "info": { "name": "Lists all sync jobs associated with ObjectStorageLink.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/objectStorageLinks/:objectStorageLinkId/syncJobs", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "objectStorageLinkId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Object Storage link." }, { "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": "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": "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 all sync jobs associated with the Object Storage link. Contains a unique ID for each sync job.\n" }, { "info": { "name": "Gets details of sync job associated with ObjectStorageLink.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/objectStorageLinks/:objectStorageLinkId/syncJobs/:syncJobId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "objectStorageLinkId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Object Storage link." }, { "name": "syncJobId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the sync job." } ] }, "docs": "Gets details of a sync job associated with an Object Storage link when `objectStorageLink` and a unique ID are provided.\n" }, { "info": { "name": "List work requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/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.\n" }, { "info": { "name": "Get work request status", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/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": "Cancel work request", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250228/workRequests/:workRequestId", "headers": [ { "name": "if-match", "value": "" }, { "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": "Cancels a work request." }, { "info": { "name": "List work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/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 `timestamp` 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.\n" }, { "info": { "name": "List work request logs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/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 `timestamp` 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.\n" } ] } ], "bundled": true }