{ "openapi": "3.1.0", "info": { "description": "HPE Greenlake for File Storage REST APIs", "license": { "name": "HPE End User License Agreement", "url": "https://www.hpe.com/us/en/software/licensing.html" }, "title": "HPE Greenlake for File Storage REST APIs", "version": "1.0.0" }, "servers": [ { "url": "https://eu1.data.cloud.hpe.com" }, { "url": "https://us1.data.cloud.hpe.com" }, { "url": "https://jp1.data.cloud.hpe.com" } ], "tags": [ { "description": "Refers to a collection of file shares. A file share is a specific folder in a filesystem. It includes that folder's subfolders, which can be made accessible to clients via protocols like NFS and SMB.", "name": "file-shares" }, { "description": "Refers to a collection of filesystems.", "name": "file-systems" }, { "description": "File share settings APIs", "name": "fileshare-settings" }, { "description": "Refers to a collection of file shares. A file share is a specific folder in a filesystem. It includes that folder's subfolders, which can be made accessible to clients via protocols like NFS and SMB.", "name": "fileshares" }, { "description": "Refers to a collection of filesystems.", "name": "filesystems" } ], "paths": { "/file-storage/v1alpha1/devtype4-storage-systems/{systemId}/file-shares": { "get": { "description": "List all file shares on the HPE Alletra MP B10000 storage system identified by `{systemId}`. Use `limit`, `offset`, `select`, `filter`, and `sort` to control the results.", "operationId": "FileSharesList", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/select" }, { "allowReserved": true, "description": "Filters the resources returned by the API.\nThe filter expression compares a property with a literal value. The following comparison operators are supported:\n- `eq`: Equals. Supported for number, boolean, and string properties.\n- `gt`: Greater than. Supported for number and timestamp properties.\n- `lt`: Less than. Supported for number and timestamp properties.\n- `in`: Checks whether a value exists in an array of strings.\nSupported properties:\n- `protocol`\n- `state`\n- `generation`\n- `id`\nExamples:\n- `GET /file-storage/v1alpha1/devtype4-storage-systems/{systemId}/file-shares?filter=name eq 'FS1'`\n", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "allowReserved": true, "description": "A comma-separated list of properties to sort by, followed by a direction\nindicator (\"asc\" or \"desc\"). If no direction indicator is specified the\ndefault order is ascending.\nSorting is supported for the following attributes:\n* path\n* name\n* state\n* protocol\n* createdAt\n* fileSystemName\n* settingsName\nExample: GET /file-storage/v1alpha1/devtype4-storage-systems/{systemId}/file-shares?sort=name desc\n", "in": "query", "name": "sort", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArcusFileshareList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "file shares object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal or unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Appliance in maintenance mode" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "List all file shares on HPE Alletra MP B10000 Storage System identified by {systemId}", "tags": [ "fileshares" ] }, "post": { "description": "Create a file share on the HPE Alletra MP B10000 storage system identified by `{systemId}`. The response includes a task URI in the `Location` header that you can use to monitor the operation.", "operationId": "DeviceType4FileshareCreate", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArcusShareCreateRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted. The response includes a task URI in the `Location` header that you can use to monitor the operation.", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal or unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Appliance in maintenance mode" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Create file share for HPE Alletra MP B10000 Storage System identified by {systemId}", "tags": [ "fileshares" ] } }, "/file-storage/v1alpha1/devtype4-storage-systems/{systemId}/file-shares/{fileShareId}": { "delete": { "description": "Delete a file share identified by `{fileShareId}` from the HPE Alletra MP B10000 storage system identified by `{systemId}`. This operation removes the associated filesystem and share settings. The response includes a task URI in the `Location` header that you can use to monitor the operation.", "operationId": "FileSharesDelete", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/fileshareUid" } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted. The response includes a task URI in the `Location` header that you can use to monitor the operation.", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Response while trying to delete a non-existing file share." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Method not allowed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal or unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Appliance in maintenance mode" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Delete file share identified by {fileShareId} from HPE Alletra MP B10000 storage system identified by {systemId}.", "tags": [ "fileshares" ] }, "get": { "description": "Fetch details of the file share identified by `{fileShareId}` on the HPE Alletra MP B10000 storage system identified by `{systemId}`.", "operationId": "FileSharesGet", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/fileshareUid" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArcusFileShareDetails" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal or unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Appliance in maintenance mode" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Fetch details of a file share identified by {fileShareId} on HPE Alletra MP B10000 storage system identified by {systemId}", "tags": [ "fileshares" ] }, "patch": { "description": "Update the file share identified by `{fileShareId}` on the HPE Alletra MP B10000 storage system identified by `{systemId}`. The response includes a task URI in the `Location` header that you can use to monitor the operation.", "operationId": "DeviceType4FileshareUpdate", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/fileshareUid" } ], "requestBody": { "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/ArcusShareUpdateRequest" } } }, "description": "Request body to update file share", "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted. The response includes a task URI in the `Location` header that you can use to monitor the operation.", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal or unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Appliance in maintenance mode" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Update file share identified by {fileShareId} on HPE Alletra MP B10000 storage system identified by {systemId}", "tags": [ "fileshares" ] } }, "/file-storage/v1alpha1/devtype4-storage-systems/{systemId}/filesystems": { "get": { "description": "List all the filesystems on HPE Alletra MP B10000 Storage System identified by {systemId}", "operationId": "FileSystemsList", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "allowReserved": true, "description": "The filter query parameter is used to filter the set of resources returned in the response.\nThe returned set of resources must match the criteria in the filter query parameter.\nA comparison compares a property name to a literal. The comparisons supported are the following:\n* “eq” : Is a property equal to value. Valid for number, boolean and string properties.\n* “gt” : Is a property greater than a value. Valid for number or string timestamp properties.\n* “lt” : Is a property less than a value. Valid for number or string timestamp properties\n* “in” : Is a value in a property (that is an array of strings)\nExamples:\nGET /file-storage/v1alpha1/devtype4-storage-systems/{systemId}/filesystems?filter=name eq 'FS1'\nFilters are supported on the following attributes:\n* state\n* prov\n* name\n* shareCount\n* id\n* generation\n", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "allowReserved": true, "description": "A comma-separated list of properties to sort by, followed by a direction\nindicator (\"asc\" or \"desc\"). If no direction indicator is specified the\ndefault order is ascending.\nSorting is supported for the following attributes:\n* name\n* createdAt\nExample: GET /file-storage/v1alpha1/devtype4-storage-systems/{systemId}/filesystems?sort=name desc\n", "in": "query", "name": "sort", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArcusFilesystemsList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Filesystem object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal or unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Appliance in maintenance mode" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "List all the filesystems on the HPE Alletra MP B10000 storage system identified by `{systemId}`.", "tags": [ "filesystems" ] } }, "/file-storage/v1alpha1/devtype4-storage-systems/{systemId}/filesystems/{filesystemId}": { "delete": { "description": "Delete the filesystem identified by `{filesystemId}` on the HPE Alletra MP B10000 storage system identified by `{systemId}`. The response includes a task URI in the `Location` header that you can use to monitor the operation.", "operationId": "FilesystemsDelete", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/filesystemUid" } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted. The response includes a task URI in the `Location` header that you can use to monitor the operation.", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Response while trying to delete a non-existing filesystem." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Method not allowed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal or unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Appliance in maintenance mode" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Delete a filesystem identified by {filesystemId} on a HPE Alletra MP B10000 storage system identified by {systemId}", "tags": [ "filesystems" ] }, "get": { "description": "Fetch details of the filesystem identified by `{filesystemId}` on the HPE Alletra MP B10000 storage system identified by `{systemId}`.", "operationId": "FilesystemsGet", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/filesystemUid" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArcusFileSystemDetail" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "filesystems object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal or unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Appliance in maintenance mode" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Fetch details of the filesystem identified by `{filesystemId}` on the HPE Alletra MP B10000 storage system identified by `{systemId}`.", "tags": [ "filesystems" ] } }, "/file-storage/v1alpha1/devtype4-storage-systems/{systemId}/filesystems/{filesystemId}/capacity-history": { "get": { "description": "Get capacity trend data for the filesystem identified by `{filesystemId}` on HPE Alletra MP B10000 Storage System identified by `{systemId}`. Use the `select`, `range`, and `timeintervalmin` query parameters to refine the request.", "operationId": "DeviceType4FilesystemCapacityHistoryGetById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/filesystemUid" }, { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/range" }, { "$ref": "#/components/parameters/timeIntervalMin" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevType4FsCapHistoryList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "filesystems object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal or unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Appliance in maintenance mode" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get filesystem capacity trend data of filesystem identified by {filesystemId} on HPE Alletra MP B10000 Storage System identified by {systemId}", "tags": [ "filesystems" ] } }, "/file-storage/v1alpha1/devtype4-storage-systems/{systemId}/filesystems/{filesystemId}/performance-history": { "get": { "description": "Retrieves historical performance metrics for the filesystem identified by `{filesystemId}` on HPE Alletra MP B10000 Storage System identified by `{systemId}`. Use the `select`, `range`, and `timeintervalmin` query parameters to refine the request.", "operationId": "DeviceType4FilesystemPerformanceHistoryGetById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/filesystemUid" }, { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/range" }, { "$ref": "#/components/parameters/timeIntervalMin" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevType4FsPerfHistoryList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal or unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Appliance in maintenance mode" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get performance trend data of filesystem identified by {filesystemId} on HPE Alletra MP B10000 Storage System identified by {systemId}", "tags": [ "filesystems" ] } }, "/file-storage/v1alpha1/devtype4-storage-systems/{systemId}/share-settings": { "get": { "description": "List all share settings on the HPE Alletra MP B10000 storage system identified by `{systemId}`. Use `limit`, `offset`, `filter`, `sort`, and `reconcile` to control the results.", "operationId": "ShareSettingsList", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "allowReserved": true, "description": "Filters the resources returned by the API.\nThe filter expression compares a property with a literal value. The following comparison operators are supported:\n- `eq`: Equals. Supported for number, boolean, and string properties.\n- `gt`: Greater than. Supported for number and timestamp properties.\n- `lt`: Less than. Supported for number and timestamp properties.\n- `in`: Checks whether a value exists in an array of strings.\nSupported properties:\n- `id`\n- `name`\n- `generation`\n- `shareCount`\nExamples:\n- `GET /file-storage/v1alpha1/devtype4-storage-systems/{systemId}/share-settings?filter=id eq '04e3479f1449267b149eaa2678e7fb99'`\n- `GET /file-storage/v1alpha1/devtype4-storage-systems/{systemId}/share-settings?filter=name eq 'TestShareSetting'`\n", "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "allowReserved": true, "description": "A comma-separated list of properties to sort by, followed by a direction\nindicator (\"asc\" or \"desc\"). If no direction indicator is specified the\ndefault order is ascending.\nSorting is supported for the following attributes:\n* name\n* createdAt\nExample: GET /file-storage/v1alpha1/devtype4-storage-systems/{systemId}/share-settings?sort=name desc\n", "in": "query", "name": "sort", "schema": { "type": "string" } }, { "description": "When true, the API will reconcile the share count of the filesystems.", "in": "query", "name": "reconcile", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArcusShareSettingsList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Share settings object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal or unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Appliance in maintenance mode" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "List all the share-settings associated on HPE Alletra MP B10000 storage system identified by {systemId}", "tags": [ "fileshare-settings" ] } }, "/file-storage/v1alpha1/devtype4-storage-systems/{systemId}/share-settings/{sharesettingsId}": { "get": { "description": "Fetch details of the share settings identified by `{sharesettingsId}` on the HPE Alletra MP B10000 storage system identified by `{systemId}`.", "operationId": "ShareSettingsGet", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/sharesettingsUid" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArcusShareSettingsDetails" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Share settings object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal or unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Appliance in maintenance mode" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Fetch details of a share-settings identified by {sharesettingsId} on HPE Alletra MP B10000 storage system identified by {systemId}", "tags": [ "fileshare-settings" ] } }, "/file-storage/v1alpha1/devtype7-storage-systems/{systemId}/file-shares": { "description": "This path handles all the following file share CRUD operations:\n- GET all file shares on HPE Alletra Storage X10000 system\n- CREATE a specific file share on a HPE Alletra Storage X10000 system", "get": { "operationId": "DeviceType7FileSharesListBySystemId", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/select" }, { "allowReserved": true, "description": "The expression to use for filtering responses.\nFiltering is supported on the below properties:\n- `protocol`\n- `state`\n- `generation`\n- `id`\n- `path`\n- `filesystemId`\n", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "A comma separated list of properties to sort by, followed by a direction\nindicator (\"asc\" or \"desc\"). If no direction indicator is specified the\ndefault order is ascending.\nSorting is supported for the following attributes:\n- `path`\n- `state`\n- `protocol`\n- `createdAt`\n- `updatedAt`\nExample: GET /file-storage/v1alpha1/devtype7-storage-systems/{systemId}/file-shares?sort=path desc\n", "example": "path desc", "in": "query", "name": "sort", "schema": { "default": "path asc", "maxLength": 50, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HomefleetFileshareList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "file shares object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal or unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Appliance in maintenance mode" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get all file shares on HPE Alletra Storage X10000 system", "tags": [ "file-shares" ] }, "post": { "description": "Create a file share on an HPE Alletra Storage X10000 system. The response includes a task URI in the `Location` header that you can use to monitor the operation.", "operationId": "DeviceType7FileshareCreate", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HomefleetShareCreateRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal or unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Appliance in maintenance mode" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Create Fileshare for a HPE Alletra Storage X10000 system", "tags": [ "file-shares" ] } }, "/file-storage/v1alpha1/devtype7-storage-systems/{systemId}/file-shares/{fileShareId}": { "delete": { "description": "This API endpoint deletes the specified file share on an HPE Alletra Storage X10000 system. The response includes a task URI in the `Location` header that you can use to monitor the operation.", "operationId": "DeviceType7FileShareDeleteById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "description": "Unique identifier of the file share", "in": "path", "name": "fileShareId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "allowReserved": true, "description": "Delete underlying filesystem", "example": true, "in": "query", "name": "delete-filesystem", "required": false, "schema": { "type": "boolean" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Response while trying to delete a non-existing file share." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Method not allowed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal or unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Appliance in maintenance mode" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "DELETE Fileshare on a HPE Alletra Storage X10000 system", "tags": [ "file-shares" ] }, "description": "This path handles all the following file share operations on a HPE Alletra Storage X10000 system:\n- GET a specific file share\n- DELETE a specific file share\n- PATCH a specific file share", "get": { "operationId": "DeviceType7FileShareGetById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "description": "Unique identifier of the file share", "in": "path", "name": "fileShareId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HomefleetFileShareDetails" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal or unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Appliance in maintenance mode" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get a specific file share", "tags": [ "file-shares" ] }, "patch": { "description": "Update the file share on an HPE Alletra Storage X10000 system. The response includes a task URI in the `Location` header that you can use to monitor the operation.", "operationId": "DeviceType7FileshareUpdate", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "description": "Unique identifier of the file share", "in": "path", "name": "fileShareId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/HomefleetShareUpdateRequest" } } }, "description": "Request to update file share", "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal or unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Appliance in maintenance mode" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Update Fileshare on a HPE Alletra Storage X10000 system", "tags": [ "file-shares" ] } }, "/file-storage/v1alpha1/devtype7-storage-systems/{systemId}/filesystems": { "description": "This path handles all the following filesystem operations on a HPE Alletra Storage X10000 system:\n- GET all filesystems on a HPE Alletra Storage X10000 system", "get": { "operationId": "DeviceType7FileSystemsListBySystemId", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/select" }, { "allowReserved": true, "description": "The expression to use for filtering responses.\n\nFiltering is supported on the below properties:\n- `state`\n- `name`\n- `id`\n- `shareCount`\n- `hardLimitInBytes`\n- `softLimitInBytes`\n", "example": "GET /file-storage/v1alpha1/devtype7-storage-systems/{systemId}/filesystems?filter=name eq \"fs1\"", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "A comma separated list of properties to sort by, followed by a direction\nindicator (\"asc\" or \"desc\"). If no direction indicator is specified the\ndefault order is ascending.\nSorting is supported for the following attributes:\n- `state`\n- `name`\n- `shareCount`\n- `createdAt`\n- `updatedAt`\n- `hardLimitInBytes`\n- `softLimitInBytes`\nExample: GET /file-storage/v1alpha1/devtype7-storage-systems/{systemId}/filesystems?sort=name desc\n", "example": "id desc", "in": "query", "name": "sort", "schema": { "default": "name asc", "maxLength": 50, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HomefleetGetFilesystemsBySystemId" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Filesystem object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal or unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Appliance in maintenance mode" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get all filesystems on a HPE Alletra Storage X10000 system", "tags": [ "file-systems" ] } }, "/file-storage/v1alpha1/devtype7-storage-systems/{systemId}/filesystems/{filesystemId}": { "delete": { "description": "This API endpoint deletes the specified filesystem on a HPE Alletra Storage X10000 system.\n", "operationId": "DeviceType7FileSystemDeleteById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "description": "Unique identifier of the filesystem", "in": "path", "name": "filesystemId", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Response while trying to delete a non-existing filesystem." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Method not allowed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal or unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Appliance in maintenance mode" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Delete a filesystem on a HPE Alletra Storage X10000 system", "tags": [ "file-systems" ] }, "description": "This path handles all the following filesystem CRUD operations:\n- GET a specific filesystem on HPE Alletra Storage X10000 system\n- DELETE a specific filesystem on HPE Alletra Storage X10000 system", "get": { "operationId": "DeviceType7FileSystemsGetById", "parameters": [ { "description": "SystemUid/Serial Number of the array", "in": "path", "name": "systemId", "required": true, "schema": { "type": "string" } }, { "description": "Unique identifier of the filesystem", "in": "path", "name": "filesystemId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HomefleetFilesystemDetails" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "filesystems object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal or unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Appliance in maintenance mode" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get a specific filesystem", "tags": [ "file-systems" ] } }, "/file-storage/v1alpha1/devtype7-storage-systems/{systemId}/filesystems/{filesystemId}/capacity-history": { "get": { "description": "Retrieves historical capacity metrics for the filesystem identified by `{filesystemId}` on an HPE Alletra Storage X10000 system. Use the `select`, `range`, and `timeintervalmin` query parameters to refine the request.", "operationId": "DeviceType7FilesystemCapacityHistoryGetById", "parameters": [ { "description": "SystemUid/Serial Number of the array", "in": "path", "name": "systemId", "required": true, "schema": { "type": "string" } }, { "description": "Unique identifier of the filesystem", "in": "path", "name": "filesystemId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/range" }, { "$ref": "#/components/parameters/timeIntervalMin" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevType7FsCapHistoryList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "filesystems object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal or unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Appliance in maintenance mode" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get filesystem capacity trend data of a Filesystem identified by {filesystemId} on a HPE Alletra Storage X10000 system", "tags": [ "file-systems" ] } }, "/file-storage/v1alpha1/devtype7-storage-systems/{systemId}/filesystems/{filesystemId}/performance-history": { "get": { "description": "Retrieves historical performance metrics for the filesystem identified by `{filesystemId}` on an HPE Alletra Storage X10000 system. Use the `select`, `range`, and `timeintervalmin` query parameters to refine the request.", "operationId": "DeviceType7VolumePerformanceHistoryGetById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "description": "Unique identifier of the filesystem", "in": "path", "name": "filesystemId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/range" }, { "$ref": "#/components/parameters/timeIntervalMin" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevType7FsPerfHistoryList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal or unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Appliance in maintenance mode" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unexpected error" } }, "summary": "Get performance trend data of a filesystem identified by {filesystemId} on a HPE Alletra Storage X10000 system", "tags": [ "file-systems" ] } } }, "components": { "parameters": { "fileshareUid": { "description": "Unique identifier of the file share", "in": "path", "name": "fileShareId", "required": true, "schema": { "type": "string" } }, "filesystemUid": { "description": "Unique identifier of the filesystem", "in": "path", "name": "filesystemId", "required": true, "schema": { "type": "string" } }, "limit": { "description": "Number of items to return at a time", "example": 10, "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 5000, "minimum": 0, "type": "integer" } }, "offset": { "description": "The offset of the first item in the collection to return", "example": 5, "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "maximum": 100000, "minimum": 0, "type": "integer" } }, "range": { "allowReserved": true, "description": "Defines the start and end time for the query.", "example": "startTime eq 1605063600 and endTime eq 1605186000", "in": "query", "name": "range", "schema": { "type": "string" } }, "select": { "allowReserved": true, "description": "Query to select only the required parameters, separated by . if nested", "example": "id", "in": "query", "name": "select", "schema": { "type": "string" } }, "sharesettingsUid": { "description": "Unique identifier of the file share-settings", "in": "path", "name": "sharesettingsId", "required": true, "schema": { "type": "string" } }, "storageSystemUid": { "description": "systemId of the storage system", "in": "path", "name": "systemId", "required": true, "schema": { "type": "string" } }, "timeIntervalMin": { "allowReserved": true, "description": "It defines granularity in minutes.", "example": 60, "in": "query", "name": "timeintervalmin", "schema": { "enum": [ 5, 60, 1440, 10080 ], "type": "integer" } } }, "schemas": { "ArcusFileShare": { "description": "The response body for file share details.", "properties": { "accessIp": { "description": "Specifies the host IP address", "type": "string" }, "commonResourceAttributes": { "$ref": "#/components/schemas/fileCommonResourceAttributes" }, "createdAt": { "description": "Creation time", "properties": { "ms": { "type": "integer" }, "tz": { "type": "string" } }, "type": "object" }, "customerId": { "description": "The identifier of the customer application", "type": "string" }, "detailedState": { "description": "Filesystem detailed state", "example": "STATE_NORMAL", "type": "string" }, "displayname": { "description": "Display name of the file share", "format": "string", "type": "string" }, "fileSystem": { "properties": { "id": { "description": "An identifier for the resource", "type": "string" }, "name": { "description": "A system specified name for the resource.", "type": "string" }, "resourceUri": { "description": "The 'self' reference for this resource.", "type": "string" } }, "type": "object" }, "generation": { "description": "A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.", "format": "int64", "readOnly": true, "type": "integer" }, "id": { "description": "UID string uniquely identifying the file share object. `Filter`", "type": "string" }, "name": { "description": "Specifies the name of the file share", "type": "string" }, "path": { "description": "File share path", "type": "string" }, "protocol": { "description": "Specifies the list of protocols that are enabled for this file share. For version 10.5.0 only NFSV4 protocol is supported.", "items": { "type": "string" }, "type": "array" }, "resourceUri": { "description": "Resource URI of the file share", "type": "string" }, "settings": { "properties": { "id": { "description": "An identifier for the resource", "type": "string" }, "name": { "description": "A system specified name for the resource.", "type": "string" }, "resourceUri": { "description": "The 'self' reference for this resource.", "type": "string" } }, "type": "object" }, "shareId": { "description": "Numeric ID of the resource", "format": "int64", "type": "integer" }, "state": { "description": "Specifies the state of the file share", "example": "UNKNOWN", "type": "string" }, "systemId": { "description": "SystemUid of the storage system.", "example": "7CE751P312", "type": "string" }, "systemWwn": { "description": "System WWN of the array.", "example": "7CE751P312", "type": "string" }, "type": { "description": "The type of resource.", "readOnly": true, "type": "string" } }, "required": [ "id", "type" ], "title": "File share details", "type": "object" }, "ArcusFileShareDetails": { "allOf": [ { "$ref": "#/components/schemas/ArcusFileShare" } ], "description": "Arcus file-share detail", "properties": {}, "type": "object" }, "ArcusFileSystemDetail": { "allOf": [ { "$ref": "#/components/schemas/ArcusFilesystem" } ], "description": "Arcus filesystem detail", "properties": { "filesystemCapacity": { "$ref": "#/components/schemas/ArcusFilesystemCapacity" }, "filesystemPerformance": { "$ref": "#/components/schemas/ArcusFilesystemPerformance" } }, "type": "object" }, "ArcusFileshareList": { "properties": { "count": { "description": "Number of items in this response.", "type": "integer" }, "items": { "items": { "$ref": "#/components/schemas/ArcusFileShare" }, "type": "array" }, "offset": { "description": "The offset query parameter from the request.", "type": "integer" }, "total": { "description": "Total number of items matching the filter parameter in the request.", "type": "integer" } }, "required": [ "count", "offset", "items" ], "type": "object" }, "ArcusFilesystem": { "properties": { "commonResourceAttributes": { "$ref": "#/components/schemas/fileCommonResourceAttributes" }, "createdAt": { "description": "Creation time", "properties": { "ms": { "type": "integer" }, "tz": { "type": "string" } }, "type": "object" }, "customerId": { "description": "The identifier of the customer application", "type": "string" }, "detailedState": { "description": "Filesystem detailed state", "example": "STATE_NORMAL", "type": "string" }, "filesystemId": { "description": "filesystem ID", "example": 1, "type": "integer" }, "filesystemType": { "description": "Filesystem type", "example": "XFS", "type": "string" }, "fsmaster": { "description": "Master node (owner) of the filesystem.", "example": 1, "type": "integer" }, "generation": { "description": "A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.", "format": "int64", "readOnly": true, "type": "integer" }, "id": { "description": "Unique identifier of the Filesystem", "example": "7CE751P312", "type": "string" }, "isCompressionEnabled": { "description": "Specifies if compression is enabled on this filesystem.", "example": true, "type": "boolean" }, "isDedupeEnabled": { "description": "Specifies if deduplication is enabled on this filesystem.", "example": true, "type": "boolean" }, "isReductionEnabled": { "description": "Specifies if data reduction is enabled on this filesystem.", "example": true, "type": "boolean" }, "name": { "description": "Filesystem name", "example": "FS1", "type": "string" }, "prov": { "description": "Provisioning type", "example": "tdvv", "type": "string" }, "replicant": { "description": "First failover node of the filesystem.", "example": 1, "type": "integer" }, "replicant2": { "description": "Second failover node of the filesystem.", "example": 1, "type": "integer" }, "replicant3": { "description": "Third failover node of the filesystem.", "example": 1, "type": "integer" }, "resourceUri": { "description": "Resource URI of the filesystem", "type": "string" }, "shareCount": { "description": "Number of shares associated with the filesystem", "example": 1, "type": "integer" }, "state": { "description": "Filesystem state", "example": "NORMAL", "type": "string" }, "systemId": { "description": "SystemUid of the storage system.", "example": "7CE751P312", "type": "string" }, "systemWwn": { "description": "WWN of Storage System", "example": "7CE751P312", "type": "string" }, "type": { "description": "The type of resource.", "readOnly": true, "type": "string" }, "volumeDetails": { "items": { "$ref": "#/components/schemas/VolumeDetails" }, "type": "array" } }, "required": [ "id", "type" ], "type": "object" }, "ArcusFilesystemCapacity": { "description": "Arcus filesystem capacity detail", "properties": { "compressionRatio": { "description": "Compression ratio", "format": "float64", "type": "number" }, "freeSizeInMiB": { "description": "Filesystem free size in MiB", "format": "float64", "type": "number" }, "savingsRatio": { "description": "Savings ratio", "format": "float64", "type": "number" }, "sizeInMiB": { "description": "Filesystem total size in MiB", "format": "float64", "type": "number" }, "usedCapacityPercentage": { "description": "Filesystem used capacity percentage", "format": "float64", "type": "number" }, "usedSizeInMiB": { "description": "Filesystem used size in MiB", "format": "float64", "type": "number" }, "vvSizeInMiB": { "description": "Volume size in MiB", "example": 100, "format": "float64", "type": "number" } }, "type": "object" }, "ArcusFilesystemPerformance": { "description": "Filesystem performance details", "properties": { "iops": { "properties": { "read": { "$ref": "#/components/schemas/ArcusPerformanceDetail" }, "total": { "$ref": "#/components/schemas/ArcusPerformanceDetail" }, "write": { "$ref": "#/components/schemas/ArcusPerformanceDetail" } }, "type": "object" }, "latencyMs": { "properties": { "read": { "$ref": "#/components/schemas/ArcusPerformanceDetail" }, "total": { "$ref": "#/components/schemas/ArcusPerformanceDetail" }, "write": { "$ref": "#/components/schemas/ArcusPerformanceDetail" } }, "type": "object" }, "throughputKbps": { "properties": { "read": { "$ref": "#/components/schemas/ArcusPerformanceDetail" }, "total": { "$ref": "#/components/schemas/ArcusPerformanceDetail" }, "write": { "$ref": "#/components/schemas/ArcusPerformanceDetail" } }, "type": "object" } }, "type": "object" }, "ArcusFilesystemsList": { "properties": { "count": { "description": "Number of items in this response.", "type": "integer" }, "items": { "items": { "$ref": "#/components/schemas/ArcusFilesystem" }, "type": "array" }, "offset": { "description": "The offset query parameter from the request.", "type": "integer" }, "total": { "description": "Total number of items matching the filter parameter in the request.", "type": "integer" } }, "required": [ "count", "offset", "items" ], "type": "object" }, "ArcusPerformanceDetail": { "properties": { "avgOf1day": { "description": "last one day average data", "format": "float64", "type": "number" }, "avgOf1hour": { "description": "last one hour average data", "format": "float64", "type": "number" }, "avgOf8hours": { "description": "last 8 hours average data", "format": "float64", "type": "number" }, "avgOfLatest": { "description": "latest performance data", "format": "float64", "type": "number" } }, "type": "object" }, "ArcusShareCreateRequest": { "description": "Request schema", "properties": { "filesystemName": { "description": "Specifies the name of the filesystem", "maxLength": 240, "type": "string" }, "hostAccess": { "description": "Add hosts to access NFS shares using any of the following expressions in a comma-separated list as an array- a single IP, a range of IPs in CIDR format and *. For example 10.1.1.1, 10.1.1.1/15, *\n", "items": { "properties": { "access": { "description": "read-only or write access of the client IP", "enum": [ "READ_ONLY", "READ_WRITE" ], "type": "string" }, "ipaddress": { "description": "client IP that can access the share", "example": "*|10.168.10.1/15|10.31.51.21", "type": "string" }, "options": { "description": "squash type of the client IP", "enum": [ "ALL_SQUASH", "ROOT_SQUASH", "NO_SQUASH" ], "type": "string" } }, "type": "object" }, "maxItems": 16, "type": "array" }, "name": { "description": "Specifies the name of the file share", "example": "share1", "type": "string" }, "protocol": { "description": "Specifies the protocols with which file share has to be created. Currently, only the NFSv4 protocol is supported.", "items": { "enum": [ "NFS" ], "type": "string" }, "maxItems": 1, "minItems": 1, "type": "array" }, "reduce": { "description": "Specifies whether the compression and dedupe is enabled on filesystem. This field will be set to true by default if not provided in create share input.", "example": false, "type": "boolean" }, "settingName": { "description": "Name of the file share setting", "type": "string" }, "sizeInMiB": { "description": "Specifies the size of the file share in MiB", "format": "int64", "maximum": 67108864, "minimum": 1024, "type": "integer" } }, "required": [ "protocol", "name", "filesystemName", "settingName" ], "title": "Request for the file share creation", "type": "object" }, "ArcusShareSettingsDetails": { "properties": { "commonResourceAttributes": { "$ref": "#/components/schemas/fileCommonResourceAttributes" }, "createdAt": { "description": "Creation time", "properties": { "ms": { "type": "integer" }, "tz": { "type": "string" } }, "type": "object" }, "customerId": { "description": "The identifier of the customer application", "type": "string" }, "displayname": { "description": "Display name of the share-setting", "format": "string", "type": "string" }, "domain": { "description": "Domain that the resource belongs to", "type": "string" }, "generation": { "description": "A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.", "format": "int64", "readOnly": true, "type": "integer" }, "hostAccess": { "description": "Add hosts to access NFS shares using any of the following expressions in a comma-separated list as an array- a single IP, a range of IPs in CIDR format (10.168.10.1/15) or *.\n", "items": { "properties": { "access": { "description": "read-only or write access of the client IP", "enum": [ "READ_ONLY", "READ_WRITE" ], "type": "string" }, "ipaddress": { "description": "client IP that can access the share", "example": "*|10.168.10.1/15|10.31.51.21", "type": "string" }, "options": { "description": "squash type of the client IP", "enum": [ "ALL_SQUASH", "ROOT_SQUASH", "NO_SQUASH" ], "type": "string" } }, "type": "object" }, "type": "array" }, "hostCount": { "description": "host count", "example": 1, "type": "integer" }, "id": { "description": "Share-Settings ID", "example": "7CE751P312", "type": "string" }, "name": { "description": "Specifies the name of the share-settings", "type": "string" }, "resourceUri": { "description": "Resource URI of the share-setting", "type": "string" }, "settingId": { "description": "Specifies the id of the share-setting", "type": "number" }, "shareCount": { "description": "Number of shares using the share-setting", "example": 1, "type": "integer" }, "state": { "description": "Specifies the state of the share-settings", "example": "NORMAL", "type": "string" }, "systemId": { "description": "SystemId of the storage system", "example": "7CE751P312", "type": "string" }, "systemWwn": { "description": "SystemWWN of the array.", "example": "7CE751P312", "type": "string" }, "type": { "description": "The type of resource.", "readOnly": true, "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "ArcusShareSettingsList": { "properties": { "count": { "description": "Number of items in this response.", "type": "integer" }, "items": { "items": { "$ref": "#/components/schemas/ArcusShareSettingsDetails" }, "type": "array" }, "offset": { "description": "The offset query parameter from the request.", "type": "integer" }, "total": { "description": "Total number of items matching the filter parameter in the request.", "type": "integer" } }, "required": [ "count", "offset", "items" ], "type": "object" }, "ArcusShareUpdateRequest": { "additionalProperties": false, "description": "Request schema", "minProperties": 1, "properties": { "additionalSizeInMiB": { "description": "Specifies the additional file share expansion size in MiB", "format": "int64", "maximum": 67108864, "minimum": 256, "type": "integer" }, "hostAccess": { "description": "Add hosts to access NFS shares using any of the following expressions in a comma-separated list as an array- a single IP, a range of IPs in CIDR format and *. For example 10.1.1.1, 10.1.1.1/15, *\n", "items": { "properties": { "access": { "description": "read-only or write access of the client IP", "enum": [ "READ_ONLY", "READ_WRITE" ], "type": "string" }, "ipaddress": { "description": "client IP that can access the share", "example": "*|10.168.10.1/15|10.31.51.21", "type": "string" }, "options": { "description": "squash type of the client IP", "enum": [ "ALL_SQUASH", "ROOT_SQUASH", "NO_SQUASH" ], "type": "string" } }, "type": "object" }, "maxItems": 16, "type": "array" } }, "title": "Request for the file share patch", "type": "object" }, "DevType4FsCapHistoryList": { "properties": { "count": { "description": "Number of items in this response", "type": "integer" }, "items": { "items": { "$ref": "#/components/schemas/DeviceType4FilesystemCapacityHistory", "description": "Array of filesystem capacity summaries. This array will have only one object." }, "type": "array" }, "offset": { "description": "The offset query parameter from the request", "type": "integer" }, "total": { "description": "Total number of items matching the filter parameter in the request", "type": "integer" } }, "required": [ "items", "count", "offset" ] }, "DevType4FsPerfHistoryList": { "properties": { "count": { "description": "Number of items in this response", "type": "integer" }, "items": { "items": { "$ref": "#/components/schemas/DeviceType4FilesystemPerformanceHistory", "description": "Array of filesystem capacity summaries. This array will have only one object." }, "type": "array" }, "offset": { "description": "The offset query parameter from the request", "type": "integer" }, "total": { "description": "Total number of items matching the filter parameter in the request", "type": "integer" } }, "required": [ "items", "count", "offset" ] }, "DevType7FsCapHistoryList": { "properties": { "count": { "description": "Number of items in this response", "type": "integer" }, "items": { "items": { "$ref": "#/components/schemas/DeviceType7FilesystemCapacityHistory", "description": "Array of filesystems capacity summary. This array will have only one object." }, "type": "array" }, "offset": { "description": "The offset query parameter from the request", "type": "integer" }, "total": { "description": "Total number of items matching the filter parameter in the request", "type": "integer" } }, "required": [ "items", "count" ] }, "DevType7FsPerfHistoryList": { "properties": { "count": { "description": "Number of items in this response", "type": "integer" }, "items": { "items": { "$ref": "#/components/schemas/DeviceType7FilesystemPerformanceHistory", "description": "Array of filesystems performance summary. This array will have only one object." }, "type": "array" }, "offset": { "description": "The offset query parameter from the request", "type": "integer" }, "total": { "description": "Total number of items matching the filter parameter in the request", "type": "integer" } }, "required": [ "items", "count" ] }, "DeviceType4FilesystemCapacityHistory": { "description": "filesystem capacity trends for a given granularity", "properties": { "capacityData": { "properties": { "customerId": { "description": "The identifier of the customer application", "type": "string" }, "items": { "items": { "$ref": "#/components/schemas/DeviceType4FilesystemCapacitySeriesData" }, "type": "array" }, "total": { "description": "Count of series data", "example": 1, "type": "integer" } }, "type": "object" }, "commonResourceAttributes": { "$ref": "#/components/schemas/fileCommonResourceAttributes" }, "endTime": { "description": "End time of the capacity history", "example": 1625209133, "type": "integer" }, "id": { "description": "Unique resource identifier", "type": "string" }, "startTime": { "description": "Start time of the capacity history", "example": 1625122733, "type": "integer" }, "type": { "description": "The type of resource.", "example": "string", "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "DeviceType4FilesystemCapacitySeriesData": { "properties": { "actualUsageMiB": { "description": "Actual usage value in MiB", "example": 25, "format": "float64", "type": "number" }, "timestampMs": { "description": "epoch timestamp", "example": 1605063600, "format": "int64", "type": "integer" }, "totalCapacityMiB": { "description": "Filesystem total capacity value in MiB", "example": 50, "format": "float64", "type": "number" } }, "type": "object" }, "DeviceType4FilesystemPerformanceHistory": { "description": "filesystem performance trends for a given granularity and time range", "properties": { "commonResourceAttributes": { "$ref": "#/components/schemas/fileCommonResourceAttributes" }, "customerId": { "description": "The identifier of the customer application", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": "string" }, "endTime": { "description": "End time of history data", "example": 162564271, "type": "integer" }, "historyData": { "description": "performance history data", "properties": { "iopsMetricsData": { "$ref": "#/components/schemas/DeviceType4historicalFsMetricData" }, "ioszMetricsDataKbs": { "$ref": "#/components/schemas/DeviceType4historicalFsMetricData" }, "latencyMetricsDataMs": { "$ref": "#/components/schemas/DeviceType4historicalFsMetricData" }, "throughputMetricsDataKbps": { "$ref": "#/components/schemas/DeviceType4historicalFsMetricData" } }, "type": "object" }, "id": { "description": "Unique resource identifier.", "type": "string" }, "startTime": { "description": "start time of history data", "example": 1625556314, "type": "integer" }, "type": { "description": "The type of resource.", "example": "string", "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "DeviceType4FsmetricSeriesData": { "properties": { "readValue": { "description": "Average read metric value at a particular timestamp", "example": 46, "format": "float64", "type": "number" }, "timestampms": { "description": "Epoch timestamp", "example": 1605063600, "format": "int64", "type": "integer" }, "totalValue": { "description": "Total metric value at a particular timestamp", "example": 89.76, "format": "float64", "type": "number" }, "writeValue": { "description": "Average write metric value at a particular timestamp", "example": 23.76, "format": "float64", "type": "number" } }, "type": "object" }, "DeviceType4historicalFsMetricData": { "description": "Timeseries data for particular metric type", "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4FsmetricSeriesData" }, "type": "array" }, "total": { "description": "The number of data points in the series.", "example": 1, "type": "integer" } }, "type": "object" }, "DeviceType7FilesystemCapacityHistory": { "properties": { "capacityData": { "properties": { "seriesData": { "items": { "$ref": "#/components/schemas/DeviceType7FilesystemCapacitySeriesData" }, "type": [ "array", "null" ] }, "total": { "description": "count of series data", "example": 1, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "commonResourceAttributes": { "$ref": "#/components/schemas/fileCommonResourceAttributes" }, "customerId": { "description": "The identifier of the customer application", "example": "string", "type": "string" }, "endTime": { "description": "End time of the capacity history", "example": 1625209133, "type": [ "integer", "null" ] }, "id": { "description": "Unique identifier of the filesystem", "type": "string" }, "startTime": { "description": "Start time of the capacity history", "example": 1625122733, "type": [ "integer", "null" ] }, "systemId": { "description": "SystemUid or serial number of the array", "example": "HFLANBROR6", "type": "string" }, "type": { "description": "The type of resource.", "example": "string", "type": "string" } }, "required": [ "type", "id" ], "type": [ "object", "null" ] }, "DeviceType7FilesystemCapacitySeriesData": { "properties": { "logicalUsageMiB": { "description": "Logical usage value at particular timestamp", "example": 46, "format": "float64", "type": [ "number", "null" ] }, "physicalUsageMiB": { "description": "Physical usage value at particular timestamp", "example": 46, "format": "float64", "type": [ "number", "null" ] }, "timestampMs": { "description": "epoch timestamp", "example": 1605063600, "format": "int64", "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType7FilesystemPerformanceHistory": { "description": "Filesystem performance trend for given granularity", "properties": { "commonResourceAttributes": { "$ref": "#/components/schemas/fileCommonResourceAttributes" }, "customerId": { "description": "The identifier of the customer application", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": "string" }, "endTime": { "description": "End time of history data", "example": 162564271, "type": "integer" }, "historyData": { "properties": { "iopsMetricsData": { "$ref": "#/components/schemas/DeviceType7historicalFsMetricData" }, "latencyMetricsDataMs": { "$ref": "#/components/schemas/DeviceType7historicalFsMetricData" }, "mdLatencyMetricsDataMs": { "$ref": "#/components/schemas/DeviceType7historicalFsMetricData" }, "throughputMetricsDataKbps": { "$ref": "#/components/schemas/DeviceType7historicalFsMetricData" } }, "type": [ "object", "null" ] }, "id": { "description": "Unique identifier of the filesystem", "type": "string" }, "startTime": { "description": "Start time of history data", "example": 1625556314, "type": "integer" }, "systemId": { "description": "SystemUid or serial number of the array", "example": "HFLANBROR6", "type": "string" }, "type": { "description": "The type of resource.", "example": "string", "type": "string" } }, "required": [ "type", "id" ], "type": [ "object", "null" ] }, "DeviceType7FsmetricSeriesData": { "properties": { "readValue": { "description": "Average read metric value at a particular timestamp", "example": 46, "format": "float64", "type": "number" }, "timestampms": { "description": "epoch timestamp", "example": 1605063600, "format": "int64", "type": "integer" }, "totalValue": { "description": "Total metric value at a particular timestamp", "example": 89.76, "format": "float64", "type": "number" }, "writeValue": { "description": "Average write metric value at a particular timestamp", "example": 23.76, "format": "float64", "type": "number" } }, "type": [ "object", "null" ] }, "DeviceType7historicalFsMetricData": { "description": "Timeseries data for a particular metric type", "properties": { "seriesData": { "items": { "$ref": "#/components/schemas/DeviceType7FsmetricSeriesData" }, "type": [ "array", "null" ] }, "total": { "description": "Count of series data", "example": 1, "type": "integer" } }, "type": [ "object", "null" ] }, "ErrorResponse": { "properties": { "debugId": { "description": "A unique identifier for the request", "example": "f57dcca3345820eb579c9317ce36dd92", "type": "string" }, "errorCode": { "description": "A machine friendly identifier for the error response", "type": "string" }, "httpStatusCode": { "description": "The HTTP status code of the response", "type": "integer" }, "message": { "description": "A user-friendly error message", "example": "An example error message", "type": "string" } }, "required": [ "httpStatusCode", "message", "errorCode", "debugId" ] }, "HomefleetFileShareDetails": { "description": "The response body for file share details.", "properties": { "accessClients": { "description": "Specifies the clients(IP or hostname) that can access the NFS share", "items": { "properties": { "clients": { "description": "Client (IP or hostname) that can access the share", "example": "*,10.168.10.*,10.31.51.21,test.com", "type": "string" } }, "type": "object" }, "maxItems": 1, "type": "array" }, "commonResourceAttributes": { "$ref": "#/components/schemas/fileCommonResourceAttributes" }, "createdAt": { "description": "Creation Time", "properties": { "ms": { "type": "integer" }, "tz": { "type": "string" } }, "type": "object" }, "customerId": { "description": "The identifier of the customer application", "type": "string" }, "endPoint": { "description": "The endpoint to access the file share", "type": [ "string", "null" ] }, "fileSystem": { "properties": { "id": { "description": "An identifier for the resource", "type": "string" }, "name": { "description": "A system specified name for the resource.", "type": "string" }, "resourceUri": { "description": "The 'self' reference for this resource.", "type": "string" } }, "type": "object" }, "generation": { "description": "A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.", "format": "int64", "readOnly": true, "type": "integer" }, "id": { "description": "UID string uniquely identifying the file share object.", "format": "uuid", "type": "string" }, "ipRestricted": { "description": "Whether the client can make use of NFSv4 locking for files in the filesystem. Single IP address should be used to mount the file share", "type": [ "boolean", "null" ] }, "path": { "description": "File share path", "type": "string" }, "protocol": { "description": "Specifies the list of protocols that are enabled for this file share. For R3 only NFSV4.1 protocol is supported.", "items": { "type": "string" }, "type": "array" }, "resourceUri": { "description": "Resource URI of the file share", "type": "string" }, "state": { "description": "Specifies the state of the file share", "example": "ACTIVE", "type": "string" }, "systemId": { "description": "SystemUid or serial number of the array.", "example": "7CE751P312", "type": "string" }, "systemWwn": { "description": "System WWN of the array.", "example": "7CE751P312", "type": "string" }, "type": { "description": "The type of resource.", "readOnly": true, "type": "string" }, "updatedAt": { "description": "Update Time", "properties": { "ms": { "type": "integer" }, "tz": { "type": "string" } }, "type": "object" } }, "required": [ "id", "type" ], "title": "File share details", "type": "object" }, "HomefleetFileshareList": { "properties": { "count": { "description": "Number of items in this response.", "type": "integer" }, "items": { "items": { "$ref": "#/components/schemas/HomefleetFileShareDetails" }, "type": "array" }, "offset": { "description": "The offset query parameter from the request.", "type": "integer" }, "total": { "description": "Total number of items matching the filter parameter in the request.", "type": "integer" } }, "required": [ "count", "offset", "items" ], "type": "object" }, "HomefleetFilesystem": { "properties": { "commonResourceAttributes": { "$ref": "#/components/schemas/fileCommonResourceAttributes" }, "createdAt": { "description": "Creation time", "properties": { "ms": { "type": "integer" }, "tz": { "type": "string" } }, "type": "object" }, "customerId": { "description": "The identifier of the customer application", "type": "string" }, "generation": { "description": "A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.", "format": "int64", "readOnly": true, "type": "integer" }, "hardLimitInBytes": { "description": "Specifies the hard limit for the filesystem quota", "type": "integer" }, "id": { "description": "Unique identifier of the Filesystem", "format": "uuid", "type": "string" }, "name": { "description": "Filesystem name", "example": "FS1", "type": "string" }, "resourceUri": { "description": "Resource URI of the filesystem", "type": "string" }, "shareCount": { "description": "Number of file-shares created on the filesystem", "type": "integer" }, "state": { "description": "Filesystem state", "example": "NORMAL", "type": "string" }, "systemId": { "description": "SystemUid or serial number of the array.", "example": "7CE751P312", "type": "string" }, "systemWwn": { "description": "WWN of Storage System", "example": "7CE751P312", "type": "string" }, "type": { "description": "The type of resource.", "readOnly": true, "type": "string" }, "updatedAt": { "description": "Update time", "properties": { "ms": { "type": "integer" }, "tz": { "type": "string" } }, "type": "object" } }, "required": [ "id", "type" ], "type": "object" }, "HomefleetFilesystemCapacity": { "description": "Filesystem capacity details", "properties": { "compressionRatio": { "description": "Compression ratio", "format": "float64", "type": "number" }, "compressionSavings": { "description": "Number of bytes saved due to compression", "format": "float64", "type": "number" }, "logicalUsage": { "description": "Filesystem logical usage in MiB", "example": 301752.345342, "type": [ "number", "null" ] }, "physicalUsage": { "description": "Filesystem physical usage in MiB", "example": 3252.2370367, "type": [ "number", "null" ] }, "totalInodes": { "description": "Total number of files, directories and other objects (symbolic links) in the filesystem", "format": "int64", "type": [ "number", "null" ] } }, "type": "object" }, "HomefleetFilesystemDetails": { "allOf": [ { "$ref": "#/components/schemas/HomefleetFilesystem" } ], "description": "Homefleet filesystem details", "properties": { "filesystemCapacity": { "$ref": "#/components/schemas/HomefleetFilesystemCapacity" }, "filesystemPerformance": { "$ref": "#/components/schemas/HomefleetFilesystemPerformance" } }, "type": "object" }, "HomefleetFilesystemPerformance": { "description": "Filesystem performance metrics for the last one hour", "properties": { "readIops": { "allOf": [ { "$ref": "#/components/schemas/PerformanceMetric" }, { "description": "Average read IOPS for the last one hour", "example": 750.2 } ] }, "readLatencyMs": { "allOf": [ { "$ref": "#/components/schemas/PerformanceMetric" }, { "description": "Average read latency in milliseconds for the last one hour", "example": 12.8 } ] }, "readMdLatencyMs": { "allOf": [ { "$ref": "#/components/schemas/PerformanceMetric" }, { "description": "Average read metadata latency in milliseconds for the last one hour", "example": 12.8 } ] }, "readThroughputKbps": { "allOf": [ { "$ref": "#/components/schemas/PerformanceMetric" }, { "description": "Average read throughput in kbps for the last one hour", "example": 5120.4 } ] }, "totalIops": { "allOf": [ { "$ref": "#/components/schemas/PerformanceMetric" }, { "description": "Average total IOPS for the last one hour", "example": 1250.5 } ] }, "totalLatencyMs": { "allOf": [ { "$ref": "#/components/schemas/PerformanceMetric" }, { "description": "Average total latency in milliseconds for the last one hour", "example": 15.2 } ] }, "totalMdLatencyMs": { "allOf": [ { "$ref": "#/components/schemas/PerformanceMetric" }, { "description": "Average total metadata latency in milliseconds for the last one hour", "example": 15.2 } ] }, "totalThroughputKbps": { "allOf": [ { "$ref": "#/components/schemas/PerformanceMetric" }, { "description": "Average total throughput in kbps for the last one hour", "example": 8192.7 } ] }, "writeIops": { "allOf": [ { "$ref": "#/components/schemas/PerformanceMetric" }, { "description": "Average write IOPS for the last one hour", "example": 500.3 } ] }, "writeLatencyMs": { "allOf": [ { "$ref": "#/components/schemas/PerformanceMetric" }, { "description": "Average write latency in milliseconds for the last one hour", "example": 18.6 } ] }, "writeMdLatencyMs": { "allOf": [ { "$ref": "#/components/schemas/PerformanceMetric" }, { "description": "Average write metadata latency in milliseconds for the last one hour", "example": 18.6 } ] }, "writeThroughputKbps": { "allOf": [ { "$ref": "#/components/schemas/PerformanceMetric" }, { "description": "Average write throughput in kbps for the last one hour", "example": 3072.3 } ] } }, "type": "object" }, "HomefleetGetFilesystemsBySystemId": { "properties": { "count": { "description": "Number of items in this response.", "type": "integer" }, "items": { "items": { "$ref": "#/components/schemas/HomefleetFilesystem" }, "type": "array" }, "offset": { "description": "The offset query parameter from the request.", "type": "integer" }, "total": { "description": "Total number of items matching the filter parameter in the request.", "type": "integer" } }, "required": [ "count", "offset", "items" ], "type": "object" }, "HomefleetShareCreateRequest": { "description": "Request schema", "properties": { "accessClients": { "description": "Specifies the list of clients that can access the NFS share. Accepts IP addresses, hostnames, and wildcard patterns (e.g., 10.1.1.1, 10.1.1.*, *). Can be empty array [] or contain empty entries [{}] or [{\"clients\":\"\"}] to indicate no access.\n", "items": { "properties": { "clients": { "description": "Client (IP or hostname) who can access the share", "example": "10.168.10.*", "maxLength": 253, "minLength": 0, "type": "string" } }, "type": "object" }, "maxItems": 50, "minItems": 0, "type": "array" }, "filesystemName": { "description": "Specifies the name of the filesystem", "type": "string" } }, "required": [ "filesystemName" ], "title": "Request for the file share creation", "type": "object" }, "HomefleetShareUpdateRequest": { "additionalProperties": false, "description": "Request schema", "minProperties": 1, "properties": { "accessClients": { "description": "Specifies the list of clients that can access the NFS share. Accepts IP addresses, hostnames, and wildcard patterns (e.g., 10.1.1.1, 10.1.1.*, *). Can be empty array [] or contain empty entries [{}] or [{\"clients\":\"\"}] to indicate no access. This field completely replaces the existing accessClients configuration.\n", "items": { "properties": { "clients": { "description": "Client (IP or hostname) that can access the share", "example": "test.com", "maxLength": 253, "minLength": 0, "type": "string" } }, "type": "object" }, "maxItems": 50, "minItems": 0, "type": "array" } }, "required": [ "accessClients" ], "title": "Request for the file share Patch request", "type": "object" }, "PerformanceMetric": { "description": "Performance metric value for the last one hour", "format": "float64", "type": [ "number", "null" ] }, "VolumeDetails": { "properties": { "vvDegradedState": { "description": "Volume degraded state, describes the reason for vvState in degraded state", "example": "LDS_NOT_STARTED", "type": "string" }, "vvFailedState": { "description": "Volume failed state, describes the reason for vvState in failed state", "example": "LDS_NOT_STARTED", "type": "string" }, "vvId": { "description": "Volume VVID", "example": 7, "type": "integer" }, "vvName": { "description": "Volume name", "example": "V1", "type": "string" }, "vvState": { "description": "Volume state", "example": "NORMAL", "type": "string" } }, "type": "object" }, "fileCommonResourceAttributes": { "properties": { "cloudState": { "description": "Cloud connectivity status of the system to which the resource belongs.", "example": "CONNECTED", "type": "string" }, "errCode": { "description": "Error code of the blocked status of the system where the resource belongs.", "type": [ "string", "null" ] }, "errMessage": { "description": "Reason why the system associated with the resource is blocked.", "type": [ "string", "null" ] } }, "type": "object" }, "taskResponse": { "properties": { "message": { "description": "The task message", "example": "Successfully submitted", "type": "string" }, "status": { "description": "Status of the task", "example": "SUBMITTED", "type": "string" }, "taskUri": { "description": "Task URI which can be used to monitor the status of the operation.", "example": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c", "type": "string" } }, "required": [ "taskUri" ], "type": "object" } }, "securitySchemes": { "bearer": { "bearerFormat": "JWT", "description": "Storage Fleet API uses a JWT bearer token for authentication.\nAn authentication token can be obtained from the HPE GreenLake console.\n", "scheme": "bearer", "type": "http" } } }, "security": [ { "bearer": [] } ] }