Software update
POST /v1/objects/storage/actions/stop-software-update/invoke
Required Role: Service
Requests the stop of updating the storage software.
When this API is executed, a job requesting the stop of updating the storage software is submitted. When the stop request is completed, the state of the job changes to Succeeded, and the state of the storage software update job to be stopped changes to Stopping. Depending on the timing of executing the API, it might take time until the state of the target storage software update job changes to Stopping.
When the target storage software update job could be stopped, the state of this job changes to Stopped. However, depending on the timing when the API is executed, the target storage software update job might be executed to the end without being stopped.
In this case, the state of the target storage software update job changes to Succeeded (instead of Stopped) when the storage software update is successful or Failed when it is not successful.
The storage software update job to be stopped can be found using the attribute, affectedResources in the response data of the API.
None
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X POST -H "Content-Length: 0" https://192.168.1.100/ConfigurationManager/simple/v1/objects/storage/actions/stop-software-update/invoke
Uses default content-types: application/json
Indicates that an asynchronous process request was accepted.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the Content-Length header must be specified. It is returned when the request body was not specified and "Content-Length: 0" was not specified as the header parameter.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
POST /v1/objects/storage/actions/update-software/invoke
Required Role: Service
Updates the storage software.
You can run this API only for the cluster master node (primary). If you call this API for a node other than the cluster master node (primary), HTTP status code 412 (Precondition Failed) is returned.
None
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X POST -H "Content-Type: application/json" -H "Expect:" -d '{ "mode": "Non-disruptive" }' https://192.168.1.100/ConfigurationManager/simple/v1/objects/storage/actions/update-software/invoke
The following shows an example using a json body.
curl -u admin:password -i -X POST -H "Content-Type: application/json" -H "Expect:" -d @example.json https://192.168.1.100/ConfigurationManager/simple/v1/objects/storage/actions/update-software/invoke
example.json is defined as follows:
{
"mode": "Non-disruptive"
}
Uses default content-types: application/json
Indicates that an asynchronous process request was accepted.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the Content-Length header must be specified. It is returned when the request body was not specified and "Content-Length: 0" was not specified as the header parameter.
Indicates that the conditions for executing the API are not met.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
POST /v1/objects/storage/actions/upload-software-update-file/invoke
Required Role: Service
Transfers (uploads) the update file of the storage software to the storage cluster.
You can run this API only for the cluster master node (primary). If you call this API for a node other than the cluster master node (primary), HTTP status code 412 (Precondition Failed) is returned.
multipart/form-data
|
Name |
Description |
Type |
Data type |
|
softwareUpdateFile |
The update file of the storage software to be transferred to the storage cluster. |
formData |
file required |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X POST -H "content-type: multipart/form-data" -H "Expect:" -F softwareUpdateFile=@/home/user/update/hsds-update-01050000-2345.tar https://192.168.1.100/ConfigurationManager/simple/v1/objects/storage/actions/upload-software-update-file/invoke
Uses default content-types: application/json
Indicates that the request was processed correctly, but no response data to be returned exists.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the Content-Length header must be specified. It is returned when the request body was not specified and "Content-Length: 0" was not specified as the header parameter.
Indicates that the conditions for executing the API are not met.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
GET /v1/objects/storage/software-update-file
Required Role: Service
Obtains the information of the update file of the storage software which performed transfer (upload) in the storage cluster.
If the update file of the storage software is not transferred to the storage cluster, returns HTTP status code 404 (Not Found).
In the case of the file that an update file of the storage software transferred to the storage cluster is unauthorized, returns HTTP status code 409 (Conflict).
You can run this API only for the cluster master node (primary). If you call this API for a node other than the cluster master node (primary), HTTP status code 412 (Precondition Failed) is returned.
None
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -i -u admin:password -X GET https://192.168.1.100/ConfigurationManager/simple/v1/objects/storage/software-update-file
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: private, no-store, no-cache, must-revalidate
Content-Security-Policy: default-src 'self'; style-src 'self' 'unsafe-inline';
Access-Control-Allow-Methods: GET, POST, DELETE, PATCH
Access-Control-Allow-Headers: Content-Type
Content-Type: application/json
Content-Length: 25
Date: Fri, 30 Jul 2021 08:47:45 GMT
{"version":"01.10.02.00"}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when the deletion request was executed successfully.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that the resource specified by the URL was not found, or you are not authorized to see the resource.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that an inconsistent or impossible request was issued for the resource specified by URL (for example, creating a resource whose ID is same as the resource already created).
Indicates that the conditions for executing the API are not met.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication