The method storage_component/test tests whether a storage component is accessible.
HTTP request syntax (URI)
POST https://host_ip:9099/mapi/v1/storage_component/test
Request structure
The request body is:
{ "id": "uuid" }
Parameter | Required | Type | Description |
---|---|---|---|
id | Yes | UUID | The ID of the storage component. |
Response structure
The response body is:
{ "id": "uuid", "storageType": "type", "verified": true|false, "httpStatus": nnn, "errorCode": "code_text", "errorMessage": "error_text", "daysUntilCertificateExpiration": nnn, "state": "state" }
Parameter |
Type |
Description |
---|---|---|
id | UUID | The ID of the storage component. |
storageType | String | The type of storage component:
|
verified | Boolean | If true, the storage component is activated. If false, it has not been verified and is awaiting for an administrative action. |
httpStatus | Integer | The HTTP status code the storage component responded with. If 0, the storage component can't be reached. Otherwise, the code can help explain why it can't be verified. |
errorCode | String | Any error codes associated with the storage component; otherwise, null. |
errorMessage | String | Any error messages associated with the storage component; otherwise, null. |
daysUntilCertificateExpiration | 32-bit integer | The number of days left until the current HTTP certificate expires. |
state | Enum | The state of the storage component, indicating its availability to serve requests:
|
Return codes
Status code |
HTTP name |
Description |
---|---|---|
200 | OK | The request was executed successfully. |
400 | Bad Request | The request is missing a valid storage component ID. |
401 | Unauthorized | Access was denied because credentials are not valid. |
404 | Not Found | The specified storage component was not found. |
405 | Method Not Allowed | The specified HTTP method is not allowed for a storage component. Resend using POST. |
Example
Request example:
POST https://10.10.24.195:9099/mapi/v1/storage_component/test
JSON request:
{ "id": "3fa85f64-1024-4562-b3fc-2c963f66afa6" }
JSON response:
{ "id": "3fa85f64-1024-4562-b3fc-2c963f66afa6", "storageType": "AMAZON_S3", "verified": true, "httpStatus": 200, "errorCode": null, "errorMessage": null, "daysUntilCertificateExpiration": null, "state": "ACTIVE" }