{ "opencollection": "1.0.0", "info": { "name": "File Storage API", "version": "20171215" }, "items": [ { "info": { "name": "fileStorage", "type": "folder" }, "items": [ { "info": { "name": "ListExportSets", "type": "http" }, "http": { "method": "GET", "url": "/20171215/exportSets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "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,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 4096 is the maximum.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `500`\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": "displayName", "value": "", "type": "query", "description": "A user-friendly name. It does not have to be unique, and it is changeable.\n\nExample: `My resource`\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Filter results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n" }, { "name": "id", "value": "", "type": "query", "description": "Filter results by [OCID](/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for\nthe resouce type.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide either value, but not both.\nBy default, when you sort by time created, results are shown\nin descending order. When you sort by display name, results are\nshown in ascending order.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc', where 'asc' is\nascending and 'desc' is descending. The default order is 'desc'\nexcept for numeric values.\n" } ] }, "docs": "Lists the export set resources in the specified compartment.\n" }, { "info": { "name": "GetExportSet", "type": "http" }, "http": { "method": "GET", "url": "/20171215/exportSets/:exportSetId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exportSetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the export set." } ] }, "docs": "Gets the specified export set's information." }, { "info": { "name": "UpdateExportSet", "type": "http" }, "http": { "method": "PUT", "url": "/20171215/exportSets/:exportSetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exportSetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the export set." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified export set's information." }, { "info": { "name": "ListExports", "type": "http" }, "http": { "method": "GET", "url": "/20171215/exports", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "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, 4096 is the maximum.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `500`\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": "exportSetId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the export set." }, { "name": "fileSystemId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Filter results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n" }, { "name": "id", "value": "", "type": "query", "description": "Filter results by [OCID](/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for\nthe resouce type.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide either value, but not both.\nBy default, when you sort by time created, results are shown\nin descending order. When you sort by path, results are\nshown in ascending alphanumeric order.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc', where 'asc' is\nascending and 'desc' is descending. The default order is 'desc'\nexcept for numeric values.\n" } ] }, "docs": "Lists export resources by compartment, file system, or export\nset. You must specify an export set ID, a file system ID, and\n/ or a compartment ID.\n" }, { "info": { "name": "CreateExport", "type": "http" }, "http": { "method": "POST", "url": "/20171215/exports", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new export in the specified export set, path, and\nfile system.\n" }, { "info": { "name": "GetExport", "type": "http" }, "http": { "method": "GET", "url": "/20171215/exports/:exportId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exportId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the export." } ] }, "docs": "Gets the specified export's information." }, { "info": { "name": "UpdateExport", "type": "http" }, "http": { "method": "PUT", "url": "/20171215/exports/:exportId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exportId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the export." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified export's information." }, { "info": { "name": "DeleteExport", "type": "http" }, "http": { "method": "DELETE", "url": "/20171215/exports/:exportId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exportId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the export." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes the specified export.\n" }, { "info": { "name": "Adds a lock to a resource.", "type": "http" }, "http": { "method": "POST", "url": "/20171215/exports/:exportId/actions/addLock", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exportId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the export." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a lock to a resource." }, { "info": { "name": "Removes a lock to a resource.", "type": "http" }, "http": { "method": "POST", "url": "/20171215/exports/:exportId/actions/removeLock", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "exportId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the export." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a lock to a resource." }, { "info": { "name": "ListFileSystems", "type": "http" }, "http": { "method": "GET", "url": "/20171215/fileSystems", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "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,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 4096 is the maximum.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `500`\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": "displayName", "value": "", "type": "query", "description": "A user-friendly name. It does not have to be unique, and it is changeable.\n\nExample: `My resource`\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Filter results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n" }, { "name": "id", "value": "", "type": "query", "description": "Filter results by [OCID](/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for\nthe resouce type.\n" }, { "name": "sourceSnapshotId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the snapshot used to create a cloned file system. See [Cloning a File System](/iaas/Content/File/Tasks/cloningFS.htm)." }, { "name": "parentFileSystemId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system that contains the source snapshot of a cloned file system. See [Cloning a File System](/iaas/Content/File/Tasks/cloningFS.htm)." }, { "name": "filesystemSnapshotPolicyId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system snapshot policy\nthat is associated with the file systems.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide either value, but not both.\nBy default, when you sort by time created, results are shown\nin descending order. When you sort by display name, results are\nshown in ascending order.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc', where 'asc' is\nascending and 'desc' is descending. The default order is 'desc'\nexcept for numeric values.\n" } ] }, "docs": "Lists the file system resources in the specified compartment, or by the specified compartment and\nfile system snapshot policy.\n" }, { "info": { "name": "CreateFileSystem", "type": "http" }, "http": { "method": "POST", "url": "/20171215/fileSystems", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new file system in the specified compartment and\navailability domain. Instances can mount file systems in\nanother availability domain, but doing so might increase\nlatency when compared to mounting instances in the same\navailability domain.\n\nAfter you create a file system, you can associate it with a mount\ntarget. Instances can then mount the file system by connecting to the\nmount target's IP address. You can associate a file system with\nmore than one mount target at a time.\n\nFor inform" }, { "info": { "name": "GetFileSystem", "type": "http" }, "http": { "method": "GET", "url": "/20171215/fileSystems/:fileSystemId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fileSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system." } ] }, "docs": "Gets the specified file system's information." }, { "info": { "name": "UpdateFileSystem", "type": "http" }, "http": { "method": "PUT", "url": "/20171215/fileSystems/:fileSystemId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fileSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified file system's information.\nYou can use this operation to rename a file system.\n" }, { "info": { "name": "DeleteFileSystem", "type": "http" }, "http": { "method": "DELETE", "url": "/20171215/fileSystems/:fileSystemId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fileSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." }, { "name": "canDetachChildFileSystem", "value": "", "type": "query", "description": "If the value is set to true, then the file system will be deleted by detaching its child file system, turning\nthe child file system into an independent File System.\n" } ] }, "docs": "Deletes the specified file system. Before you delete the file system,\nverify that no remaining export resources still reference it. Deleting a\nfile system also deletes all of its snapshots.\n" }, { "info": { "name": "Adds a lock to a resource.", "type": "http" }, "http": { "method": "POST", "url": "/20171215/fileSystems/:fileSystemId/actions/addLock", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fileSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a lock to a resource." }, { "info": { "name": "ChangeFileSystemCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20171215/fileSystems/:fileSystemId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fileSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a file system and its associated snapshots 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)\n" }, { "info": { "name": "DetachClone", "type": "http" }, "http": { "method": "POST", "url": "/20171215/fileSystems/:fileSystemId/actions/detachClone", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fileSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system." } ] }, "docs": "Detaches the file system from its parent file system\n" }, { "info": { "name": "EstimateReplication", "type": "http" }, "http": { "method": "POST", "url": "/20171215/fileSystems/:fileSystemId/actions/estimateReplication", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fileSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system." }, { "name": "changeRateInMBps", "value": "", "type": "query", "description": "The rate of change of data on source file system in MegaBytes per second." } ] }, "docs": "Provides estimates for replication created using specific file system.\n" }, { "info": { "name": "Removes a lock to a resource.", "type": "http" }, "http": { "method": "POST", "url": "/20171215/fileSystems/:fileSystemId/actions/removeLock", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fileSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a lock to a resource." }, { "info": { "name": "Toggles quota enforcement for a file system", "type": "http" }, "http": { "method": "POST", "url": "/20171215/fileSystems/:fileSystemId/actions/toggleQuotaRules", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fileSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable or disable quota enforcement for the file system.\nIf `areQuotaRulesEnabled` = `true`, then the quota enforcement will be enabled.\nIf `areQuotaRulesEnabled` = `false`, then the quota enforcement will be disabled.\n" }, { "info": { "name": "List user or group usages and their quota rules.", "type": "http" }, "http": { "method": "GET", "url": "/20171215/fileSystems/:fileSystemId/quotaRules", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fileSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system." }, { "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, 4096 is the maximum.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `500`\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": "principalType", "value": "", "type": "query", "description": "The type of the owner of this quota rule and usage.\n" }, { "name": "principalId", "value": "", "type": "query", "description": "An identifier for the user or the group associated with quota rule and usage. UNIX-like operating systems use this integer value to\nidentify a user or group to manage access control.\n" }, { "name": "areViolatorsOnly", "value": "", "type": "query", "description": "An option to display only the users or groups that violate their quota rules.\nIf `areViolatorsOnly` is false, results report all the quota and usage.\nIf `areViolatorsOnly` is true, results only report the quota and usage for\nthe users or groups that violate their quota rules.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc', where 'asc' is\nascending and 'desc' is descending. The default order is 'desc'\nexcept for numeric values.\n" } ] }, "docs": "List user or group usages and their quota rules by certain principal type.\n" }, { "info": { "name": "Create an FS level, user or group quota rule.", "type": "http" }, "http": { "method": "POST", "url": "/20171215/fileSystems/:fileSystemId/quotaRules", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "fileSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a file system, user, or group quota rule given the `fileSystemId`, `principalId`, `principalType` and\n`isHardQuota` parameters.\n" }, { "info": { "name": "Get an FS level, user or group quota rule.", "type": "http" }, "http": { "method": "GET", "url": "/20171215/fileSystems/:fileSystemId/quotaRules/:quotaRuleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fileSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system." }, { "name": "quotaRuleId", "value": "", "type": "path", "description": "The identifier of the quota rule. It is the base64 encoded string of the tuple ." } ] }, "docs": "Get a file system, user, or group quota rule given the `fileSystemId` and `quotaRuleId` parameters.\n" }, { "info": { "name": "Edit an FS level, user or group quota rule.", "type": "http" }, "http": { "method": "PUT", "url": "/20171215/fileSystems/:fileSystemId/quotaRules/:quotaRuleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fileSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system." }, { "name": "quotaRuleId", "value": "", "type": "path", "description": "The identifier of the quota rule. It is the base64 encoded string of the tuple ." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit a file system, user, or group quota rule given the `fileSystemId` and `quotaRuleId` parameters.\n" }, { "info": { "name": "Remove an FS level, user or group quota rule.", "type": "http" }, "http": { "method": "DELETE", "url": "/20171215/fileSystems/:fileSystemId/quotaRules/:quotaRuleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fileSystemId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system." }, { "name": "quotaRuleId", "value": "", "type": "path", "description": "The identifier of the quota rule. It is the base64 encoded string of the tuple ." } ] }, "docs": "Remove a file system, user, or group quota rule given the `fileSystemId` and `quotaRuleId` parameters.\n" }, { "info": { "name": "ListFilesystemSnapshotPolicies", "type": "http" }, "http": { "method": "GET", "url": "/20171215/filesystemSnapshotPolicies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "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,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 4096 is the maximum.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `500`\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": "displayName", "value": "", "type": "query", "description": "A user-friendly name. It does not have to be unique, and it is changeable.\n\nExample: `My resource`\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Filter results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n" }, { "name": "id", "value": "", "type": "query", "description": "Filter results by [OCID](/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for\nthe resouce type.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide either value, but not both.\nBy default, when you sort by time created, results are shown\nin descending order. When you sort by displayName, results are\nshown in ascending alphanumeric order.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc', where 'asc' is\nascending and 'desc' is descending. The default order is 'desc'\nexcept for numeric values.\n" } ] }, "docs": "Lists file system snapshot policies in the specified compartment.\n" }, { "info": { "name": "CreateFilesystemSnapshotPolicy", "type": "http" }, "http": { "method": "POST", "url": "/20171215/filesystemSnapshotPolicies", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new file system snapshot policy in the specified compartment and\navailability domain.\n\nAfter you create a file system snapshot policy, you can associate it with\nfile systems.\n" }, { "info": { "name": "GetFilesystemSnapshotPolicy", "type": "http" }, "http": { "method": "GET", "url": "/20171215/filesystemSnapshotPolicies/:filesystemSnapshotPolicyId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "filesystemSnapshotPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system snapshot policy." } ] }, "docs": "Gets the specified file system snapshot policy's information." }, { "info": { "name": "UpdateFilesystemSnapshotPolicy", "type": "http" }, "http": { "method": "PUT", "url": "/20171215/filesystemSnapshotPolicies/:filesystemSnapshotPolicyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "filesystemSnapshotPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system snapshot policy." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified file system snapshot policy's information." }, { "info": { "name": "DeleteFilesystemSnapshotPolicy", "type": "http" }, "http": { "method": "DELETE", "url": "/20171215/filesystemSnapshotPolicies/:filesystemSnapshotPolicyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "filesystemSnapshotPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system snapshot policy." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes the specified file system snapshot policy.\n" }, { "info": { "name": "Adds a lock to a resource.", "type": "http" }, "http": { "method": "POST", "url": "/20171215/filesystemSnapshotPolicies/:filesystemSnapshotPolicyId/actions/addLock", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "filesystemSnapshotPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system snapshot policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a lock to a resource." }, { "info": { "name": "ChangeFilesystemSnapshotPolicyCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20171215/filesystemSnapshotPolicies/:filesystemSnapshotPolicyId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "filesystemSnapshotPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system snapshot policy." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a file system snapshot policy 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).\n" }, { "info": { "name": "Pauses an active filesystem snapshot policy.", "type": "http" }, "http": { "method": "POST", "url": "/20171215/filesystemSnapshotPolicies/:filesystemSnapshotPolicyId/actions/pause", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "filesystemSnapshotPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system snapshot policy." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "This operation pauses the scheduled snapshot creation and snapshot deletion of the policy and updates the lifecycle state of the file system\nsnapshot policy from ACTIVE to INACTIVE. When a file system snapshot policy is paused, file systems that are associated with the\npolicy will not have scheduled snapshots created or deleted.\n\nIf the policy is already paused, or in the INACTIVE state, you cannot pause it again. You can't pause a policy\nthat is in a DELETING, DELETED, FAILED, CREATING or INACT" }, { "info": { "name": "Removes a lock to a resource.", "type": "http" }, "http": { "method": "POST", "url": "/20171215/filesystemSnapshotPolicies/:filesystemSnapshotPolicyId/actions/removeLock", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "filesystemSnapshotPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system snapshot policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a lock to a resource." }, { "info": { "name": "Unpauses a paused (inactive) filesystem snapshot policy.", "type": "http" }, "http": { "method": "POST", "url": "/20171215/filesystemSnapshotPolicies/:filesystemSnapshotPolicyId/actions/unpause", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "filesystemSnapshotPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system snapshot policy." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "This operation unpauses a paused file system snapshot policy and updates the lifecycle state of the file system snapshot policy from\nINACTIVE to ACTIVE. By default, file system snapshot policies are in the ACTIVE state. When a file system snapshot policy is not paused, or in the ACTIVE state, file systems that are associated with the\npolicy will have snapshots created and deleted according to the schedules defined in the policy.\n\nIf the policy is already in the ACTIVE state, you cannot unpause i" }, { "info": { "name": "ListMountTargets", "type": "http" }, "http": { "method": "GET", "url": "/20171215/mountTargets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "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,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 4096 is the maximum.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `500`\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": "displayName", "value": "", "type": "query", "description": "A user-friendly name. It does not have to be unique, and it is changeable.\n\nExample: `My resource`\n" }, { "name": "exportSetId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the export set." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Filter results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n" }, { "name": "id", "value": "", "type": "query", "description": "Filter results by [OCID](/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for\nthe resouce type.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can choose either value, but not both.\nBy default, when you sort by time created, results are shown\nin descending order. When you sort by display name, results are\nshown in ascending order.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc', where 'asc' is\nascending and 'desc' is descending. The default order is 'desc'\nexcept for numeric values.\n" } ] }, "docs": "Lists the mount target resources in the specified compartment.\n" }, { "info": { "name": "CreateMountTarget", "type": "http" }, "http": { "method": "POST", "url": "/20171215/mountTargets", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new mount target in the specified compartment and\nsubnet. You can associate a file system with a mount\ntarget only when they exist in the same availability domain. Instances\ncan connect to mount targets in another availablity domain, but\nyou might see higher latency than with instances in the same\navailability domain as the mount target.\n\nMount targets have one or more private IP addresses that you can\nprovide as the host portion of remote target parameters in\nclient mount commands. Th" }, { "info": { "name": "ValidateKeytabs", "type": "http" }, "http": { "method": "POST", "url": "/20171215/mountTargets/actions/validateKeyTabs", "headers": [ { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validates keytab contents for the secret details passed on the request or validte keytab contents associated with\nthe mount target passed in the request. The keytabs are deserialized, the contents are validated for compatibility\nand the principal, key version number and encryption type of each entry is provided as part of the response.\n" }, { "info": { "name": "GetMountTarget", "type": "http" }, "http": { "method": "GET", "url": "/20171215/mountTargets/:mountTargetId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "mountTargetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the mount target." } ] }, "docs": "Gets the specified mount target's information." }, { "info": { "name": "UpdateMountTarget", "type": "http" }, "http": { "method": "PUT", "url": "/20171215/mountTargets/:mountTargetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "mountTargetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the mount target." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified mount target's information." }, { "info": { "name": "DeleteMountTarget", "type": "http" }, "http": { "method": "DELETE", "url": "/20171215/mountTargets/:mountTargetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "mountTargetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the mount target." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes the specified mount target. This operation also deletes the\nmount target's VNICs.\n" }, { "info": { "name": "Adds a lock to a resource.", "type": "http" }, "http": { "method": "POST", "url": "/20171215/mountTargets/:mountTargetId/actions/addLock", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "mountTargetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the mount target." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a lock to a resource." }, { "info": { "name": "CancelDowngradeShapeMountTarget", "type": "http" }, "http": { "method": "POST", "url": "/20171215/mountTargets/:mountTargetId/actions/cancelShapeDowngrade", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "mountTargetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the mount target." } ] }, "docs": "Cancel scheduled downgrade shape request for mount target.\n" }, { "info": { "name": "ChangeMountTargetCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20171215/mountTargets/:mountTargetId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "mountTargetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the mount target." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a mount target and its associated export set or share set 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)\n" }, { "info": { "name": "Removes a lock to a resource.", "type": "http" }, "http": { "method": "POST", "url": "/20171215/mountTargets/:mountTargetId/actions/removeLock", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "mountTargetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the mount target." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a lock to a resource." }, { "info": { "name": "ScheduleDowngradeShapeMountTarget", "type": "http" }, "http": { "method": "POST", "url": "/20171215/mountTargets/:mountTargetId/actions/scheduleShapeDowngrade", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "mountTargetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the mount target." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Schedule a downgrade shape of the mount target.\n" }, { "info": { "name": "UpgradeShapeMountTarget", "type": "http" }, "http": { "method": "POST", "url": "/20171215/mountTargets/:mountTargetId/actions/upgradeShape", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "mountTargetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the mount target." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upgrade shape request for mount target.\n" }, { "info": { "name": "ListOutboundConnectors", "type": "http" }, "http": { "method": "GET", "url": "/20171215/outboundConnectors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "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,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 4096 is the maximum.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `500`\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": "lifecycleState", "value": "", "type": "query", "description": "Filter results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A user-friendly name. It does not have to be unique, and it is changeable.\n\nExample: `My resource`\n" }, { "name": "id", "value": "", "type": "query", "description": "Filter results by [OCID](/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for\nthe resouce type.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can choose either value, but not both.\nBy default, when you sort by time created, results are shown\nin descending order. When you sort by display name, results are\nshown in ascending order.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc', where 'asc' is\nascending and 'desc' is descending. The default order is 'desc'\nexcept for numeric values.\n" } ] }, "docs": "Lists the outbound connector resources in the specified compartment.\n" }, { "info": { "name": "CreateOutboundConnector", "type": "http" }, "http": { "method": "POST", "url": "/20171215/outboundConnectors", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new outbound connector in the specified compartment.\nYou can associate an outbound connector with a mount target only when\nthey exist in the same availability domain.\n\nFor information about access control and compartments, see\n[Overview of the IAM\nService](/Content/Identity/Concepts/overview.htm).\n\nFor information about availability domains, see [Regions and\nAvailability Domains](/Content/General/Concepts/regions.htm).\nTo get a list of availability domains, use the\n`ListAvailabilityDom" }, { "info": { "name": "GetOutboundConnector", "type": "http" }, "http": { "method": "GET", "url": "/20171215/outboundConnectors/:outboundConnectorId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "outboundConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the outbound connector." } ] }, "docs": "Gets the specified outbound connector's information." }, { "info": { "name": "UpdateOutboundConnector", "type": "http" }, "http": { "method": "PUT", "url": "/20171215/outboundConnectors/:outboundConnectorId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "outboundConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the outbound connector." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified outbound connector's information." }, { "info": { "name": "DeleteOutboundConnector", "type": "http" }, "http": { "method": "DELETE", "url": "/20171215/outboundConnectors/:outboundConnectorId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "outboundConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the outbound connector." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes the specified outbound connector.\n" }, { "info": { "name": "Adds a lock to a resource.", "type": "http" }, "http": { "method": "POST", "url": "/20171215/outboundConnectors/:outboundConnectorId/actions/addLock", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "outboundConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the outbound connector." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a lock to a resource." }, { "info": { "name": "ChangeOutboundConnectorCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20171215/outboundConnectors/:outboundConnectorId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "outboundConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the outbound connector." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an outbound connector into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes)\n" }, { "info": { "name": "Removes a lock to a resource.", "type": "http" }, "http": { "method": "POST", "url": "/20171215/outboundConnectors/:outboundConnectorId/actions/removeLock", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "outboundConnectorId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the outbound connector." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a lock to a resource." }, { "info": { "name": "ListReplicationTargets", "type": "http" }, "http": { "method": "GET", "url": "/20171215/replicationTargets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "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,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 4096 is the maximum.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `500`\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": "lifecycleState", "value": "", "type": "query", "description": "Filter results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A user-friendly name. It does not have to be unique, and it is changeable.\n\nExample: `My resource`\n" }, { "name": "id", "value": "", "type": "query", "description": "Filter results by [OCID](/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for\nthe resouce type.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can choose either value, but not both.\nBy default, when you sort by `timeCreated`, results are shown\nin descending order. When you sort by `displayName`, results are\nshown in ascending order.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc', where 'asc' is\nascending and 'desc' is descending. The default order is 'desc'\nexcept for numeric values.\n" } ] }, "docs": "Lists the replication target resources in the specified compartment.\n" }, { "info": { "name": "GetReplicationTarget", "type": "http" }, "http": { "method": "GET", "url": "/20171215/replicationTargets/:replicationTargetId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "replicationTargetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the replication target." } ] }, "docs": "Gets the specified replication target's information." }, { "info": { "name": "DeleteReplicationTarget", "type": "http" }, "http": { "method": "DELETE", "url": "/20171215/replicationTargets/:replicationTargetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "replicationTargetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the replication target." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes the specified replication target.\nThis operation causes the immediate release of the target file system if there are currently no delta application operations.\nIf there is any current delta being applied the delete operation is blocked until the current\ndelta has been completely applied.\n" }, { "info": { "name": "ListReplications", "type": "http" }, "http": { "method": "GET", "url": "/20171215/replications", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "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,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 4096 is the maximum.\n\nFor important details about how pagination works,\nsee [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `500`\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": "lifecycleState", "value": "", "type": "query", "description": "Filter results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A user-friendly name. It does not have to be unique, and it is changeable.\n\nExample: `My resource`\n" }, { "name": "id", "value": "", "type": "query", "description": "Filter results by [OCID](/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for\nthe resouce type.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can choose either value, but not both.\nBy default, when you sort by time created, results are shown\nin descending order. When you sort by display name, results are\nshown in ascending order.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc', where 'asc' is\nascending and 'desc' is descending. The default order is 'desc'\nexcept for numeric values.\n" }, { "name": "fileSystemId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the source file system." } ] }, "docs": "Lists the replication resources in the specified compartment.\n" }, { "info": { "name": "CreateReplication", "type": "http" }, "http": { "method": "POST", "url": "/20171215/replications", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new replication in the specified compartment.\nReplications are the primary resource that governs the policy of cross-region replication between source\nand target file systems. Replications are associated with a secondary resource called a [`ReplicationTarget`](#/en/iaas/latest/ReplicationTarget)\nlocated in another availability domain.\nThe associated replication target resource is automatically created along with the replication resource.\nThe replication retrieves the delta of data betw" }, { "info": { "name": "GetReplication", "type": "http" }, "http": { "method": "GET", "url": "/20171215/replications/:replicationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "replicationId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the replication." } ] }, "docs": "Gets the specified replication's information." }, { "info": { "name": "UpdateReplication", "type": "http" }, "http": { "method": "PUT", "url": "/20171215/replications/:replicationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "replicationId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the replication." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the information for the specified replication and its associated replication target.\n" }, { "info": { "name": "DeleteReplication", "type": "http" }, "http": { "method": "DELETE", "url": "/20171215/replications/:replicationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "replicationId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the replication." }, { "name": "deleteMode", "value": "", "type": "query", "description": "You can choose a mode for deleting the replication resource.\n- `FINISH_CYCLE_IF_CAPTURING_OR_APPLYING` Before deleting, complete the current delta cycle. If cycle is idle, delete immediately. Safest option.\n- `ONE_MORE_CYCLE` Before deleting, complete the current delta cycle, and initiate one more cycle. If cycle is idle, initiate one more cycle. Use for lossless failover.\n- `FINISH_CYCLE_IF_APPLYING` Before deleting, finish applying. If cycle is idle or capturing, delete immediately. Fastest option.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes the specified replication and the the associated replication target.\n" }, { "info": { "name": "Adds a lock to a resource.", "type": "http" }, "http": { "method": "POST", "url": "/20171215/replications/:replicationId/actions/addLock", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "replicationId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the replication." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a lock to a resource." }, { "info": { "name": "ChangeReplicationCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20171215/replications/:replicationId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "replicationId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the replication." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a replication and its replication target into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Removes a lock to a resource.", "type": "http" }, "http": { "method": "POST", "url": "/20171215/replications/:replicationId/actions/removeLock", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "replicationId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the replication." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a lock to a resource." }, { "info": { "name": "ListSnapshots", "type": "http" }, "http": { "method": "GET", "url": "/20171215/snapshots", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "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, 100 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": "lifecycleState", "value": "", "type": "query", "description": "Filter results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n" }, { "name": "id", "value": "", "type": "query", "description": "Filter results by [OCID](/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for\nthe resouce type.\n" }, { "name": "filesystemSnapshotPolicyId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system snapshot policy\nthat is used to create the snapshots.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "fileSystemId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the file system." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc', where 'asc' is\nascending and 'desc' is descending. The default order is 'desc'\nexcept for numeric values.\n" } ] }, "docs": "Lists snapshots of the specified file system, or by file system snapshot policy and compartment,\nor by file system snapshot policy and file system.\n\nIf file system ID is not specified, a file system snapshot policy ID and compartment ID must be specified.\n\nUsers can only sort by time created when listing snapshots by file system snapshot policy ID and compartment ID\n(sort by name is NOT supported for listing snapshots by policy and compartment).\n" }, { "info": { "name": "CreateSnapshot", "type": "http" }, "http": { "method": "POST", "url": "/20171215/snapshots", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new snapshot of the specified file system. You\ncan access the snapshot at `.snapshot/`.\n" }, { "info": { "name": "GetSnapshot", "type": "http" }, "http": { "method": "GET", "url": "/20171215/snapshots/:snapshotId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "snapshotId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the snapshot." } ] }, "docs": "Gets the specified snapshot's information." }, { "info": { "name": "UpdateSnapshot", "type": "http" }, "http": { "method": "PUT", "url": "/20171215/snapshots/:snapshotId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "snapshotId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the snapshot." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified snapshot's information." }, { "info": { "name": "DeleteSnapshot", "type": "http" }, "http": { "method": "DELETE", "url": "/20171215/snapshots/:snapshotId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "snapshotId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the snapshot." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes the specified snapshot.\n" }, { "info": { "name": "Adds a lock to a resource.", "type": "http" }, "http": { "method": "POST", "url": "/20171215/snapshots/:snapshotId/actions/addLock", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "snapshotId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the snapshot." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a lock to a resource." }, { "info": { "name": "Removes a lock to a resource.", "type": "http" }, "http": { "method": "POST", "url": "/20171215/snapshots/:snapshotId/actions/removeLock", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "snapshotId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the snapshot." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a lock to a resource." } ] } ], "bundled": true }