Storage cluster management
GET /v1/objects/fault-domains
Required Role: Security, Storage, Monitor, Service, Audit, or Resource
Obtains a list of fault domain information.
|
Name |
Description |
Type |
Data type |
|
protectionDomainId |
Protection domain ID. |
query |
string (uuid) |
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/fault-domains
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: 148
Date: Fri, 30 Jul 2021 07:55:56 GMT
{"data":[{"id":"4f538215-e568-4cc0-8bcc-16bc0b71b386","name":"SC01-PD01-FD01","statusSummary":"Normal","status":"Normal","numberOfStorageNodes":6}]}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when no information is obtained.
DESCRIPTION
A list of fault domain information.
PROPERTIES
data:object[]
ITEMS
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 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
GET /v1/objects/fault-domains/<id>
Required Role: Security, Storage, Monitor, Service, Audit, or Resource
Obtains fault domain information.
|
Name |
Description |
Type |
Data type |
|
id |
Fault domain ID. |
path |
string (uuid) 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 -i -u admin:password -X GET https://192.168.1.100/ConfigurationManager/simple/v1/objects/fault-domains/4f538215-e568-4cc0-8bcc-16bc0b71b386
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: 390
Date: Fri, 30 Jul 2021 07:56:38 GMT
{"storageNodeIds":["44f1d113-405e-448f-ad77-fd5554971c36","8fdbc008-ec6c-42b3-b930-146c94c5cef9","9d36c162-e379-4c85-bcc2-ccf98fe774a6","9f29d742-9a75-4cef-9539-35b3e76c8a20","a5b19d19-ca5d-4d19-988d-d625850c85de","dd5ed12b-cf39-47da-9a30-5ba53404050e"],"id":"4f538215-e568-4cc0-8bcc-16bc0b71b386","name":"SC01-PD01-FD01","statusSummary":"Normal","status":"Normal","numberOfStorageNodes":6}
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 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
GET /v1/objects/health-status
Required Role: Security, Storage, Monitor, Service, Audit, Resource
Obtains the health status.
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/health-status
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: 688
Date: Fri, 30 Jul 2021 07:55:57 GMT
{"resources":[{"type":"Storage","status":"Normal","protectionDomainId":null},{"type":"License","status":"Normal","protectionDomainId":null},{"type":"Drive","status":"Normal","protectionDomainId":"0778a123-42e5-43ff-8fbc-c8580b79f2cf"},{"type":"Pool","status":"Normal","protectionDomainId":"0778a123-42e5-43ff-8fbc-c8580b79f2cf"},{"type":"StorageNode","status":"Normal","protectionDomainId":"0778a123-42e5-43ff-8fbc-c8580b79f2cf"},{"type":"Port","status":"Normal","protectionDomainId":"0778a123-42e5-43ff-8fbc-c8580b79f2cf"},{"type":"Volume","status":"Normal","protectionDomainId":"0778a123-42e5-43ff-8fbc-c8580b79f2cf"},{"type":"FaultDomain","status":"Normal","protectionDomainId":null}]}
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 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
PATCH /v1/objects/snmp-setting
Required Role: Security
Edits SNMP settings.
If you run this API without specifying already set values as parameters, settings of corresponding attributes in SNMP settings are deleted.
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 PATCH -H "Content-Type: application/json" -H "Expect:" -d '{"isSNMPAgentEnabled":true, "snmpVersion":"v2c", "sendingTrapSetting":{"snmpv2cSettings":[{"community":"public","sendTrapTo":["192.168.16.117"]}, {"community":"private","sendTrapTo":["192.168.13.232"]}, {"community":"public","sendTrapTo":["192.168.13.235"]}]}, "requestAuthenticationSetting":{"snmpv2cSettings":[{"community":"public","requestsPermitted":["192.168.16.117"]}, {"community":"private","requestsPermitted":["192.168.13.232"]}, {"community":"public","requestsPermitted":["192.168.13.235"]}]}, "systemGroupInformation":{"storageSystemName":"Hitachi VSSB","contact":"Hitachi Vantara LLC.","location":"HSP3F-Rack0320"}}' https://192.168.13.100/ConfigurationManager/simple/v1/objects/snmp-setting
The following shows an example using a json body.
curl -u admin:password -i -X PATCH -H "Content-Type: application/json" -H "Expect:" -d @example.json https://192.168.13.100/ConfigurationManager/simple/v1/objects/snmp-setting
example.json is defined as follows:
{
"isSNMPAgentEnabled":true,
"snmpVersion":"v2c",
"sendingTrapSetting":
{
"snmpv2cSettings":
[
{
"community":"public",
"sendTrapTo":["192.168.16.117"]
},
{
"community":"private",
"sendTrapTo":["192.168.13.232"]
},
{
"community":"public",
"sendTrapTo":["192.168.13.235"]
}
]
},
"requestAuthenticationSetting":
{
"snmpv2cSettings":
[
{
"community":"public",
"requestsPermitted":["192.168.16.117"]
},
{
"community":"private",
"requestsPermitted":["192.168.13.232"]
},
{
"community":"public",
"requestsPermitted":["192.168.13.235"]
}
]
},
"systemGroupInformation":
{
"storageSystemName":"Hitachi VSSB",
"contact":"Hitachi Vantara LLC.",
"location":"HSP3F-Rack0320"
}
}
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 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/protection-domains
Required Role: Security, Storage, Monitor, Service, Audit, or Resource
Obtains a list of protection domain information.
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/protection-domains
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: 462
Date: Fri, 30 Jul 2021 07:55:57 GMT
{"data":[{"id":"0778a123-42e5-43ff-8fbc-c8580b79f2cf","name":"SC01-PD01","redundantPolicy":"HitachiPolyphaseErasureCoding","redundantType":"4D+1P","driveDataRelocationStatus":"Stopped","driveDataRelocationProgressRate":null,"rebuildStatus":"Stopped","rebuildProgressRate":null,"memoryMode":"VolatileMemory","asyncProcessingResourceUsageRate":"High","numberOfFaultSets":1,"storageControllerClusteringPolicy":"OneRedundantStorageNode","minimumMemorySize":131072}]}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when no information is obtained.
DESCRIPTION
A list of summary information about protection domain.
PROPERTIES
data: object[]
ITEMS
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 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
GET /v1/objects/protection-domains/<id>
Required Role: Security, Storage, Monitor, Service, Audit, or Resource
Obtains the protection domain information.
|
Name |
Description |
Type |
Data type |
|
id |
Protection domain ID. |
path |
string (uuid) 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 -i -u admin:password -X GET https://192.168.1.100/ConfigurationManager/simple/v1/objects/protection-domains/0778a123-42e5-43ff-8fbc-c8580b79f2cf
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: 511
Date: Fri, 30 Jul 2021 07:56:38 GMT
{"totalPhysicalCapacity":1118208,"isFastRebuildEnabled":true,"id":"0778a123-42e5-43ff-8fbc-c8580b79f2cf","name":"SC01-PD01","redundantPolicy":"HitachiPolyphaseErasureCoding","redundantType":"4D+1P","driveDataRelocationStatus":"Stopped","driveDataRelocationProgressRate":null,"rebuildStatus":"Stopped","rebuildProgressRate":null,"memoryMode":"VolatileMemory","asyncProcessingResourceUsageRate":"High","numberOfFaultSets":1,"storageControllerClusteringPolicy":"OneRedundantStorageNode","minimumMemorySize":131072}
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 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
PATCH /v1/objects/protection-domains/<id>
Required Role: Storage or Service
Edits the protection domain settings.
|
Name |
Description |
Type |
Data type |
|
id |
Protection domain ID. |
path |
string (uuid) 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 PATCH -H "Content-Type: application/json" -H "Expect:" -d '{ "asyncProcessingResourceUsageRate":"Middle" }' https://192.168.1.10/ConfigurationManager/simple/v1/objects/protection-domains/c482915f-cb5f-4311-a66b-bd1c9281cdfb
The following shows an example using a json body.
curl -u admin:password -i -X PATCH -H "Content-Type: application/json" -H "Expect:" -d @example.json https://192.168.1.10/ConfigurationManager/simple/v1/objects/protection-domains/c482915f-cb5f-4311-a66b-bd1c9281cdfb
example.json is defined as follows:
{
"asyncProcessingResourceUsageRate":"Middle"
}
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 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 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/protection-domains/<id>/actions/resume-drive-data-relocation/invoke
Required Role: Storage or Service
Requests resumption of drive data relocation.
driveDataRelocationStatus of the target protection domain changes to "Stopped" if the drive data relocation conditions are not met when the state of the API job becomes "Succeeded".
|
Name |
Description |
Type |
Data type |
|
id |
Protection domain ID. |
path |
string (uuid) 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-Length: 0" https://192.168.1.100/ConfigurationManager/simple/v1/objects/protection-domains/12345678-1234-1234-1234-1234567891b/actions/resume-drive-data-relocation/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 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 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/protection-domains/<id>/actions/suspend-drive-data-relocation/invoke
Required Role: Storage or Service
Requests suspension of drive data relocation.
When the suspension request is completed, driveDataRelocationStatus of the target protection domain changes to "Suspended" after job status becomes "Succeeded". Depending on the timing when the API is executed, it might take time until driveDataRelocationStatus of the target protection domain becomes "Suspended".
|
Name |
Description |
Type |
Data type |
|
id |
Protection domain ID. |
path |
string (uuid) 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-Length: 0" https://192.168.1.100/ConfigurationManager/simple/v1/objects/protection-domains/12345678-1234-1234-1234-1234567891b/actions/suspend-drive-data-relocation/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 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 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
GET /v1/objects/snmp-setting
Required Role: Security
Obtains the SNMP settings.
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/snmp-setting
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: 455
Date: Fri, 30 Jul 2021 07:55:58 GMT
{"isSNMPAgentEnabled":false,"snmpVersion":"v2c","sendingTrapSetting":{"snmpv2cSettings":[{"community":"","sendTrapTo":[""]},{"community":"","sendTrapTo":[""]},{"community":"","sendTrapTo":[""]}]},"requestAuthenticationSetting":{"snmpv2cSettings":[{"community":"","requestsPermitted":[""]},{"community":"","requestsPermitted":[""]},{"community":"","requestsPermitted":[""]}]},"systemGroupInformation":{"storageSystemName":"-","contact":"-","location":"-"}}
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 an unsupported media type was specified for the Accept header.
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
GET /v1/objects/storage
Required Role: Security, Storage, Monitor, Service, Audit, or Resource
Obtains the storage cluster information.
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
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: 966
Date: Tue, 28 Dec 2021 02:51:16 GMT
{"storageDeviceId":"400000019322","id":"4d17fde1-0cdb-4761-8d46-5cf5fb38c2ae","modelName":"VSSB","internalId":"019322","nickname":"SC01","numberOfTotalVolumes":1,"numberOfTotalServers":1,"numberOfTotalStorageNodes":6,"numberOfReadyStorageNodes":6,"numberOfFaultDomains":1,"totalPoolRawCapacity":1054032,"totalPoolPhysicalCapacity":1118208,"totalPoolCapacity":275940,"usedPoolCapacity":0,"freePoolCapacity":275940,"savingEffects":{"efficiencyDataReduction":null,"preCapacityDataReduction":null,"postCapacityDataReduction":null,"totalEfficiencyStatus":"NoTargetData","dataReductionWithoutSystemDataStatus":"NoTargetData","totalEfficiency":null,"dataReductionWithoutSystemData":null,"preCapacityDataReductionWithoutSystemData":null,"postCapacityDataReductionWithoutSystemData":null,"calculationStartTime":null,"calculationEndTime":null},"softwareVersion":"01.10.02.00","statusSummary":"Normal","status":"Ready","systemRequirementsFileVersion":20211019,"serviceId":null}
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 an unsupported media type was specified for the Accept header.
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
POST /v1/objects/bmc-root-certificate/actions/delete/invoke (Bare metal)
Required Role: Security
Deletes the root certificate that is used for communication with the BMC of the storage node from the storage cluster.
You can run this API only for the cluster master node (primary).
If you run 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-Length: 0" https://192.168.1.100/ConfigurationManager/simple/v1/objects/bmc-root-certificate/actions/delete/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 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/bmc-root-certificate/actions/import/invoke (Bare metal)
Required Role: Security
Imports the root certificate that is used for communication with the BMC of the storage node into the storage cluster. Certificate files in PEM and DER formats are supported.
You can run this API only for the cluster master node (primary).
If you run 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 |
|
rootCertificate |
Root certificate file to be imported into the storage cluster and used for communication with the BMC of the storage node. |
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 rootCertificate=@ca-crt.pem https://192.168.1.100/ConfigurationManager/simple/v1/objects/bmc-root-certificate/actions/import/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 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/bmc-root-certificate/download (Bare metal)
Required Role: Security or Service
Obtains the root certificate imported into the storage cluster for use in communication with the BMC of the storage node.
The obtained root certificate is output as a DER-format file.
Using the API with no root certificate imported returns HTTP status code 404 (Not Found).
You can run this API only for the cluster master node (primary).
If you run 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 -J -O -X GET https://192.168.1.100/ConfigurationManager/simple/v1/objects/bmc-root-certificate/download
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 865 100 865 0 0 685 0 0:00:01 0:00:01 --:--:-- 685
curl: Saved to filename 'bmcRootCertificate.crt'
Uses default content-types: application/x-x509-ca-cert, application/json
200 OK
Root certificate that is used for connection with the BMC.
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 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
GET /v1/objects/spare-nodes (Bare metal)
Required Role: Service
Obtains a list of spare node information.
|
Name |
Description |
Type |
Data type |
|
faultDomainId |
The ID of the fault domain that the nodes belong to. |
query |
string (uuid) |
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/spare-nodes
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: 478
Date: Fri, 07 Oct 2022 11:55:19 GMT
{"data":[{"id":"cbcd1d3c-39db-4ebf-8860-022b07f5be96","name":"node04","faultDomainId":"f1e47bcc-ebcc-4240-891b-ab8fde4a6187","faultDomainName":"SC01-PD01-FD01","controlPortIpv4Address":"192.168.13.104","softwareVersion":"01.12.00.40.3691","biosUuid":"7d113042-dc1f-9cfe-ad91-959645761c9c","modelName":"HA8000V/DL360 Gen10","serialNumber":"SGH829X6MJ","bmcName":"10.164.118.13","bmcUser":"administrator@local,10.164.119.79_CLWS1-SN02"}]}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when no information is obtained.
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 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
POST /v1/objects/spare-nodes (Bare metal)
Required Role: Service
Registers spare node information.
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 '{"faultDomainId":"b5b7c613-6323-4950-af06-0cdf39b0a4cd","controlPortIpv4Address":"192.168.13.104","setupUserPassword":"node1007","bmcName":"10.164.118.13","bmcUser":"administrator@local,10.164.119.79_CLWS1-SN02","bmcPassword":"bpassword"}' https://192.168.1.100/ConfigurationManager/simple/v1/objects/spare-nodes
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/spare-nodes
example.json is defined as follows:
{
"faultDomainId":"b5b7c613-6323-4950-af06-0cdf39b0a4cd",
"controlPortIpv4Address":"192.168.13.104",
"setupUserPassword":"node1007",
"bmcName":"10.164.118.13",
"bmcUser":"administrator@local,10.164.119.79_CLWS1-SN02",
"bmcPassword":"bpassword"
}
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 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 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
DELETE /v1/objects/spare-nodes/<id> (Bare metal)
Required Role: Service
Deletes spare node information.
|
Name |
Description |
Type |
Data type |
|
id |
The ID of a spare node. |
path |
string (uuid) 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 DELETE -H "Content-Length: 0" https://192.168.1.100/ConfigurationManager/simple/v1/objects/spare-nodes/cbcd1d3c-39db-4ebf-8860-022b07f5be96
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 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 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/spare-nodes/<id> (Bare metal)
Required Role: Service
Obtains information about a spare node.
|
Name |
Description |
Type |
Data type |
|
id |
The ID of a spare node. |
path |
string (uuid) 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 -i -u admin:password -X GET https://192.168.1.100/ConfigurationManager/simple/v1/objects/spare-nodes/cbcd1d3c-39db-4ebf-8860-022b07f5be96
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: 467
Date: Fri, 07 Oct 2022 12:15:10 GMT
{"id":"cbcd1d3c-39db-4ebf-8860-022b07f5be96","name":"node04","faultDomainId":"f1e47bcc-ebcc-4240-891b-ab8fde4a6187","faultDomainName":"SC01-PD01-FD01","controlPortIpv4Address":"192.168.13.104","softwareVersion":"01.12.00.40.3691","biosUuid":"7d113042-dc1f-9cfe-ad91-959645761c9c","modelName":"HA8000V/DL360 Gen10","serialNumber":"SGH829X6MJ","bmcName":"10.164.118.13","bmcUser":"administrator@local,10.164.119.79_CLWS1-SN02"}
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 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
PATCH /v1/objects/spare-nodes/<id> (Bare metal)
Required Role: Service
Allows you to edit information about a spare node.
|
Name |
Description |
Type |
Data type |
|
id |
The ID of a spare node. |
path |
string (uuid) 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 PATCH -H "Content-Type: application/json" -H "Expect:" -d '{"faultDomainId":"f1e47bcc-ebcc-4240-891b-ab8fde4a6187","controlPortIpv4Address":"192.168.13.104","setupUserPassword":"node1007","bmcName":"10.164.118.13","bmcUser":"administrator@local,10.164.119.79_CLWS1-SN02","bmcPassword":"bpassword"}' https://192.168.1.100/ConfigurationManager/simple/v1/objects/spare-nodes/cbcd1d3c-39db-4ebf-8860-022b07f5be96
The following shows an example using a json body.
curl -u admin:password -i -X PATCH -H "Content-Type: application/json" -H "Expect:" -d @example.json https://192.168.1.100/ConfigurationManager/simple/v1/objects/spare-nodes/cbcd1d3c-39db-4ebf-8860-022b07f5be96
example.json is defined as follows:
{
"faultDomainId":"f1e47bcc-ebcc-4240-891b-ab8fde4a6187",
"controlPortIpv4Address":"192.168.13.104",
"setupUserPassword":"node1007",
"bmcName":"10.164.118.13",
"bmcUser":"administrator@local,10.164.119.79_CLWS1-SN02",
"bmcPassword":"bpassword"
}
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 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 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