System management
GET /configuration/storage-master-node-primary-flag
Required Role: None
Obtains the information indicating whether the storage node that received the API request is the cluster master node (primary). For the cluster master node (primary), HTTP status code 200 (OK) is returned. For other nodes, HTTP status code 404 (Not Found) 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/configuration/storage-master-node-primary-flag
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: 35
Date: Fri, 30 Jul 2021 07:56:18 GMT
{"isStorageMasterNodePrimary":true}
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 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.
GET /v1/objects/control-ports
Required Role: Security, Storage, Monitor, Service, Audit, or Resource
Obtains a list of control port information.
|
Name |
Description |
Type |
Data type |
|
storageNodeId |
Storage node 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/control-ports
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: 1498
Date: Fri, 30 Jul 2021 07:56:19 GMT
{"data":[{"id":"1d7fa4ae-9bc6-446c-8cf1-09de0ea01dcd","storageNodeId":"ad36eab7-20c3-41cd-acac-d334ff5347d7","macAddress":"80:30:e0:39:b7:a5","mtuSize":1500,"interfaceName":"eth0","deviceName":"NetXtreme BCM5719 Gigabit Ethernet PCIe (Ethernet 1Gb 4-port 331i Adapter)","configuredPortSpeed":"Auto","portSpeedDuplex":"1Gbps Full","isTeamingEnabled":"false","ipv4Information":{"address":"192.168.24.242","subnetMask":"255.255.192.0"},"teaming":null,"redundancy":0,"status":"Normal","statusSummary":"Normal"},{"id":"74d48fce-bd5d-4ed9-ab64-f7c86e213cde","storageNodeId":"3123caa9-f13a-4905-a6ee-815ffb7f98a2","macAddress":"80:30:e0:39:a7:1d","mtuSize":1500,"interfaceName":"eth0","deviceName":"NetXtreme BCM5719 Gigabit Ethernet PCIe (Ethernet 1Gb 4-port 331i Adapter)","configuredPortSpeed":"Auto","portSpeedDuplex":"1Gbps Full","isTeamingEnabled":"false","ipv4Information":{"address":"192.168.24.243","subnetMask":"255.255.192.0"},"teaming":null,"redundancy":0,"status":"Normal","statusSummary":"Normal"},{"id":"bd4e17e1-57ba-4a16-bff8-b1d8923b8662","storageNodeId":"8e01e189-38bc-4002-a1fe-7a73633bce8c","macAddress":"80:30:e0:39:08:3d","mtuSize":1500,"interfaceName":"eth0","deviceName":"NetXtreme BCM5719 Gigabit Ethernet PCIe (Ethernet 1Gb 4-port 331i Adapter)","configuredPortSpeed":"Auto","portSpeedDuplex":"1Gbps Full","isTeamingEnabled":"false","ipv4Information":{"address":"192.168.24.241","subnetMask":"255.255.192.0"},"teaming":null,"redundancy":0,"status":"Normal","statusSummary":"Normal"}]}
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.
DESCRIPTION
A list of control port 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/control-ports/<id>
Required Role: Security, Storage, Monitor, Service, Audit, or Resource
Obtains the control port information.
|
Name |
Description |
Type |
Data type |
|
id |
Control port 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/control-ports/f93b583a-478d-413c-abe9-028d8ae4f67b
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: 247
Date: Fri, 30 Jul 2021 07:56:55 GMT
{"id":"f93b583a-478d-413c-abe9-028d8ae4f67b","storageNodeId":"9f29d742-9a75-4cef-9539-35b3e76c8a20","macAddress":"00:50:56:bd:a3:fb","mtuSize":1500,"interfaceName":"eth0","ipv4Information":{"address":"192.168.1.101","subnetMask":"255.255.192.0"}}
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/internode-ports
Required Role: Security, Storage, Monitor, Service, Audit, or Resource
Obtains a list of internode port information.
|
Name |
Description |
Type |
Data type |
|
storageNodeId |
Storage node 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/internode-ports
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: 1498
Date: Fri, 30 Jul 2021 07:56:20 GMT
{"data":[{"id":"07ccc0b9-b9b2-4996-a63d-9aaaddc5b2e3","storageNodeId":"8e01e189-38bc-4002-a1fe-7a73633bce8c","macAddress":"80:30:e0:14:6b:20","mtuSize":1500,"interfaceName":"eth1","deviceName":"NetXtreme II BCM57810 10 Gigabit Ethernet (FlexFabric 10Gb 2-port 533FLR-T Adapter)","configuredPortSpeed":"Auto","portSpeedDuplex":"10Gbps Full","isTeamingEnabled":"false","ipv4Information":{"address":"192.168.78.241","subnetMask":"255.255.192.0"},"teaming":null,"redundancy":0,"status":"Normal","statusSummary":"Normal"},{"id":"4c1a93b9-1eaa-42e5-9893-3020f4ff93e3","storageNodeId":"ad36eab7-20c3-41cd-acac-d334ff5347d7","macAddress":"80:30:e0:14:63:28","mtuSize":1500,"interfaceName":"eth1","deviceName":"NetXtreme II BCM57810 10 Gigabit Ethernet (FlexFabric 10Gb 2-port 533FLR-T Adapter)","configuredPortSpeed":"Auto","portSpeedDuplex":"10Gbps Full","isTeamingEnabled":"false","ipv4Information":{"address":"192.168.78.242","subnetMask":"255.255.192.0"},"teaming":null,"redundancy":0,"status":"Normal","statusSummary":"Normal"},{"id":"67a671ae-c1aa-4471-887d-a25feeff180e","storageNodeId":"3123caa9-f13a-4905-a6ee-815ffb7f98a2","macAddress":"80:30:e0:14:4f:78","mtuSize":1500,"interfaceName":"eth1","deviceName":"NetXtreme II BCM57810 10 Gigabit Ethernet (FlexFabric 10Gb 2-port 533FLR-T Adapter)","configuredPortSpeed":"Auto","portSpeedDuplex":"10Gbps Full","isTeamingEnabled":"false","ipv4Information":{"address":"192.168.78.243","subnetMask":"255.255.192.0"},"teaming":null,"redundancy":0,"status":"Normal","statusSummary":"Normal"}]}
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 internode port 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/internode-ports/<id>
Required Role: Security, Storage, Monitor, Service, Audit, or Resource
Obtains the internode port information.
|
Name |
Description |
Type |
Data type |
|
id |
Internode port 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/internode-ports/f9713eb8-5c93-4150-a969-84f7f1ad9582
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: 247
Date: Fri, 30 Jul 2021 07:56:55 GMT
{"id":"f9713eb8-5c93-4150-a969-84f7f1ad9582","storageNodeId":"dd5ed12b-cf39-47da-9a30-5ba53404050e","macAddress":"00:50:56:bd:73:f1","mtuSize":1500,"interfaceName":"eth1","ipv4Information":{"address":"192.168.73.212","subnetMask":"255.255.192.0"}}
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 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
POST /v1/objects/storage/actions/resume-suppressed-start-processing/invoke
Required Role: Service
Resumes the starting processing forcibly for the storage cluster whose starting was suppressed.
A storage node that is not started is blocked and the storage cluster is started.
This API may succeed if the storage cluster cannot be forcibly started. Check the success or failure of the storage cluster startup process after resuming by referring to the event log.
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 -H 'Content-Length: 0' -X POST https://192.168.1.100/ConfigurationManager/simple/v1/objects/storage/actions/resume-suppressed-start-processing/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
GET /v1/objects/storage-auto-recovery-setting
Required Role: Service
Obtains the setting of whether to enable or disable the auto-recovery function and the status of the function.
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-auto-recovery-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: 83
Date: Fri, 30 Jul 2021 07:56:21 GMT
{"isEnabled":true,"storageNodePersistentBlockingThresholdTime":0,"status":"Normal"}
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
PATCH /v1/objects/storage-auto-recovery-setting
Required Role: Service
Enables or disables the auto-recovery function.
Enabling the auto-recovery function allows storage nodes in temporarily blocked status to be detected automatically and recovery processing to be performed. A maintenance recovery job is submitted for recovery.
Uses default content-types: application/json
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 '{"isEnabled":true}' https://192.168.13.100/ConfigurationManager/simple/v1/objects/storage-auto-recovery-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/storage-auto-recovery-setting
example.json is defined as follows:
{
"isEnabled":true
}
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/storage-network-setting
Required Role: Security, Storage, Monitor, Service, Audit, or Resource
Obtains the storage cluster network 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/storage-network-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: 102
Date: Fri, 30 Jul 2021 07:56:21 GMT
{"primaryDnsServerIpAddress":"","secondaryDnsServerIpAddress":"","virtualIpv4Address":"192.168.1.100"}
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-node-network-settings
Required Role: Security, Storage, Monitor, Service, or Resource
Obtains a list of storage node network settings.
|
Name |
Description |
Type |
Data type |
|
storageNodeId |
Storage node 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/storage-node-network-settings
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: 790
Date: Fri, 30 Jul 2021 07:56:22 GMT
{"data":[{"id":"44f1d113-405e-448f-ad77-fd5554971c36","ipv4Route":[{"destination":"default","gateway":"192.168.1.14","interface":"eth0"}]},{"id":"8fdbc008-ec6c-42b3-b930-146c94c5cef9","ipv4Route":[{"destination":"default","gateway":"192.168.1.14","interface":"eth0"}]},{"id":"9d36c162-e379-4c85-bcc2-ccf98fe774a6","ipv4Route":[{"destination":"default","gateway":"192.168.1.14","interface":"eth0"}]},{"id":"9f29d742-9a75-4cef-9539-35b3e76c8a20","ipv4Route":[{"destination":"default","gateway":"192.168.1.14","interface":"eth0"}]},{"id":"a5b19d19-ca5d-4d19-988d-d625850c85de","ipv4Route":[{"destination":"default","gateway":"192.168.1.14","interface":"eth0"}]},{"id":"dd5ed12b-cf39-47da-9a30-5ba53404050e","ipv4Route":[{"destination":"default","gateway":"192.168.1.14","interface":"eth0"}]}]}
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 storage node network settings.
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/storage-node-network-settings/<id>
Required Role: Security, Storage, Monitor, Service, or Resource
Obtains the storage node network settings.
|
Name |
Description |
Type |
Data type |
|
id |
Storage node 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/storage-node-network-settings/dd5ed12b-cf39-47da-9a30-5ba53404050e
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: 129
Date: Fri, 30 Jul 2021 07:56:56 GMT
{"id":"dd5ed12b-cf39-47da-9a30-5ba53404050e","ipv4Route":[{"destination":"default","gateway":"192.168.1.14","interface":"eth0"}]}
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/storage-time-setting
Required Role: Security, Storage, Monitor, Service, Audit, or Resource
Obtains the storage cluster time 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/storage-time-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: 95
Date: Fri, 30 Jul 2021 07:56:23 GMT
{"systemTime":"2021-07-30T07:56:23Z","ntpServerNames":["192.168.1.14"],"timezone":"Asia/Tokyo"}
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/system-requirements-file/actions/import/invoke
Required Role: Service
Imports a system requirements file.
Specify a system requirements file that describes authorized hardware and system requirements.
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.
An import succeeds only when the version of the specified system requirements file is later than the version of the system requirements file existing in the storage cluster.
An import is skipped and an event log is output when the version of the specified system requirements file is equal to or older than the version of the system requirements file existing in the storage cluster.
multipart/form-data
|
Name |
Description |
Type |
Data type |
|
systemRequirementsFile |
System requirements file to be imported to the storage cluster. Specify a system requirements file that describes system requirements to be updated. |
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 systemRequirementsFile=@SystemRequirementsFile.yml https://192.168.1.100/ConfigurationManager/simple/v1/objects/system-requirements-file/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
POST /v1/objects/configuration-file/actions/create/invoke (Bare metal)
Required Role: Service
Restores a configuration definition file.
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 -X POST -u admin:password -H "Content-Length: 0" https://192.168.1.100/ConfigurationManager/simple/v1/objects/configuration-file/actions/create/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/configuration-file/download (Bare metal)
Required Role: Service
Downloads a restored configuration definition file.
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 -J -O -X GET -u admin:password -H "Content-Length: 0" https://192.168.1.100/ConfigurationManager/simple/v1/objects/configuration-file/download
Uses default content-types: application/gzip, 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 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