Storage controller management
GET /v1/objects/storage-controllers
Required Role: Security, Storage, Monitor, Service, or Resource
Obtains a list of storage controller 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-controllers
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: 5152
Date: Fri, 30 Jul 2021 07:56:15 GMT
{"data":[{"id":"061e07ae-d015-4c69-be25-e4205dcfd0e3","allocatableCapacity":45990,"currentlyAllocatableCapacity":45990,"usedCapacity":0,"logicalLimit":10188318,"volumeMaximumCapacity":10187646,"freeCapacity":45990,"status":"Normal","activeStorageNodeId":"44f1d113-405e-448f-ad77-fd5554971c36","standbyStorageNodeId":"9d36c162-e379-4c85-bcc2-ccf98fe774a6","secondaryStandbyStorageNodeId":null,"isDetailedLoggingMode":false,"allocatableCapacityUsageRate":0,"currentlyAllocatableCapacityUsageRate":0,"capacityStatus":"Normal","dataRebalanceStatus":"Stopped","dataRebalanceProgressRate":null,"totalVolumeCapacity":0,"provisionedVolumeCapacity":0,"otherVolumeCapacity":0,"temporaryVolumeCapacity":0,"capacitiesExcludingSystemData":{"usedVolumeCapacity":0,"compressedCapacity":0,"reclaimedCapacity":0,"systemDataCapacity":0,"preUsedCapacity":0,"preCompressedCapacity":0}},{"id":"1aab5a59-f06a-4edd-abfc-ec8d737eb4c5","allocatableCapacity":45990,"currentlyAllocatableCapacity":45990,"usedCapacity":0,"logicalLimit":10188570,"volumeMaximumCapacity":10187898,"freeCapacity":45990,"status":"Normal","activeStorageNodeId":"9d36c162-e379-4c85-bcc2-ccf98fe774a6","standbyStorageNodeId":"8fdbc008-ec6c-42b3-b930-146c94c5cef9","secondaryStandbyStorageNodeId":null,"isDetailedLoggingMode":false,"allocatableCapacityUsageRate":0,"currentlyAllocatableCapacityUsageRate":0,"capacityStatus":"Normal","dataRebalanceStatus":"Stopped","dataRebalanceProgressRate":null,"totalVolumeCapacity":0,"provisionedVolumeCapacity":0,"otherVolumeCapacity":0,"temporaryVolumeCapacity":0,"capacitiesExcludingSystemData":{"usedVolumeCapacity":0,"compressedCapacity":0,"reclaimedCapacity":0,"systemDataCapacity":0,"preUsedCapacity":0,"preCompressedCapacity":0}},{"id":"307c7147-79fe-4533-ad4d-9f5b9eaf98af","allocatableCapacity":45990,"currentlyAllocatableCapacity":45990,"usedCapacity":0,"logicalLimit":10188570,"volumeMaximumCapacity":10187898,"freeCapacity":45990,"status":"Normal","activeStorageNodeId":"9f29d742-9a75-4cef-9539-35b3e76c8a20","standbyStorageNodeId":"dd5ed12b-cf39-47da-9a30-5ba53404050e","secondaryStandbyStorageNodeId":null,"isDetailedLoggingMode":false,"allocatableCapacityUsageRate":0,"currentlyAllocatableCapacityUsageRate":0,"capacityStatus":"Normal","dataRebalanceStatus":"Stopped","dataRebalanceProgressRate":null,"totalVolumeCapacity":0,"provisionedVolumeCapacity":0,"otherVolumeCapacity":0,"temporaryVolumeCapacity":0,"capacitiesExcludingSystemData":{"usedVolumeCapacity":0,"compressedCapacity":0,"reclaimedCapacity":0,"systemDataCapacity":0,"preUsedCapacity":0,"preCompressedCapacity":0}},{"id":"474635bc-1280-4899-b52c-45e2cf08a86a","allocatableCapacity":45990,"currentlyAllocatableCapacity":45990,"usedCapacity":0,"logicalLimit":10188570,"volumeMaximumCapacity":10187898,"freeCapacity":45990,"status":"Normal","activeStorageNodeId":"dd5ed12b-cf39-47da-9a30-5ba53404050e","standbyStorageNodeId":"a5b19d19-ca5d-4d19-988d-d625850c85de","secondaryStandbyStorageNodeId":null,"isDetailedLoggingMode":false,"allocatableCapacityUsageRate":0,"currentlyAllocatableCapacityUsageRate":0,"capacityStatus":"Normal","dataRebalanceStatus":"Stopped","dataRebalanceProgressRate":null,"totalVolumeCapacity":0,"provisionedVolumeCapacity":0,"otherVolumeCapacity":0,"temporaryVolumeCapacity":0,"capacitiesExcludingSystemData":{"usedVolumeCapacity":0,"compressedCapacity":0,"reclaimedCapacity":0,"systemDataCapacity":0,"preUsedCapacity":0,"preCompressedCapacity":0}},{"id":"97a0c318-dedf-474f-8896-486b90a9ad3f","allocatableCapacity":45990,"currentlyAllocatableCapacity":45990,"usedCapacity":0,"logicalLimit":10188570,"volumeMaximumCapacity":10187898,"freeCapacity":45990,"status":"Normal","activeStorageNodeId":"8fdbc008-ec6c-42b3-b930-146c94c5cef9","standbyStorageNodeId":"9f29d742-9a75-4cef-9539-35b3e76c8a20","secondaryStandbyStorageNodeId":null,"isDetailedLoggingMode":false,"allocatableCapacityUsageRate":0,"currentlyAllocatableCapacityUsageRate":0,"capacityStatus":"Normal","dataRebalanceStatus":"Stopped","dataRebalanceProgressRate":null,"totalVolumeCapacity":0,"provisionedVolumeCapacity":0,"otherVolumeCapacity":0,"temporaryVolumeCapacity":0,"capacitiesExcludingSystemData":{"usedVolumeCapacity":0,"compressedCapacity":0,"reclaimedCapacity":0,"systemDataCapacity":0,"preUsedCapacity":0,"preCompressedCapacity":0}},{"id":"fa9116ec-de89-4034-bc6e-902028bc3d55","allocatableCapacity":45990,"currentlyAllocatableCapacity":45990,"usedCapacity":0,"logicalLimit":10188570,"volumeMaximumCapacity":10187898,"freeCapacity":45990,"status":"Normal","activeStorageNodeId":"a5b19d19-ca5d-4d19-988d-d625850c85de","standbyStorageNodeId":"44f1d113-405e-448f-ad77-fd5554971c36","secondaryStandbyStorageNodeId":null,"isDetailedLoggingMode":false,"allocatableCapacityUsageRate":0,"currentlyAllocatableCapacityUsageRate":0,"capacityStatus":"Normal","dataRebalanceStatus":"Stopped","dataRebalanceProgressRate":null,"totalVolumeCapacity":0,"provisionedVolumeCapacity":0,"otherVolumeCapacity":0,"temporaryVolumeCapacity":0,"capacitiesExcludingSystemData":{"usedVolumeCapacity":0,"compressedCapacity":0,"reclaimedCapacity":0,"systemDataCapacity":0,"preUsedCapacity":0,"preCompressedCapacity":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.
DESCRIPTION
A list of storage controller 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
POST /v1/objects/storage-controllers/actions/configure/invoke
Required Role: Service
Edit the settings for the storage controller.
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-Type: application/json' -d '{"isDetailedLoggingMode":false}' -X POST https://192.168.1.100/ConfigurationManager/simple/v1/objects/storage-controllers/actions/configure/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-controllers/<id>
Required Role: Security, Storage, Monitor, Service, or Resource
Obtains the storage controller information.
|
Name |
Description |
Type |
Data type |
|
id |
Storage controller 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-controllers/fa9116ec-de89-4034-bc6e-902028bc3d55
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: 856
Date: Fri, 30 Jul 2021 07:56:54 GMT
{"id":"fa9116ec-de89-4034-bc6e-902028bc3d55","allocatableCapacity":45990,"currentlyAllocatableCapacity":45990,"usedCapacity":0,"logicalLimit":10188570,"volumeMaximumCapacity":10187898,"freeCapacity":45990,"status":"Normal","activeStorageNodeId":"a5b19d19-ca5d-4d19-988d-d625850c85de","standbyStorageNodeId":"44f1d113-405e-448f-ad77-fd5554971c36","secondaryStandbyStorageNodeId":null,"isDetailedLoggingMode":false,"allocatableCapacityUsageRate":0,"currentlyAllocatableCapacityUsageRate":0,"capacityStatus":"Normal","dataRebalanceStatus":"Stopped","dataRebalanceProgressRate":null,"totalVolumeCapacity":0,"provisionedVolumeCapacity":0,"otherVolumeCapacity":0,"temporaryVolumeCapacity":0,"capacitiesExcludingSystemData":{"usedVolumeCapacity":0,"compressedCapacity":0,"reclaimedCapacity":0,"systemDataCapacity":0,"preUsedCapacity":0,"preCompressedCapacity":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