Skip to content

How to use the StorageInfoService API

Introduction

To get general information about an AOS instance and its running components you can use the StorageInfoService API.

Mainly, this can be either interesting for developers to know which versions they're dealing with or, for example, to introduce a service health monitor with the current status of the instance.

Get Storage Version

API example for fetching the versions of all components running in the specific AOS instance.

Info

This request does not need any specific permissions.

1
2
3
4
# Native JSON request to get AOS stoarge instance component versions 
curl -H 'Authorization: Bearer <API_TOKEN>' \
     -H 'Content-Type: application/json' \
     -X GET https://<URL-to-AOS-instance-API-gateway>/v1/info/version

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
// Create tonic/ArunaAPI request to fetch component versions of the AOS instance
let get_request = GetStorageVersionRequest {};

// Send the request to the AOS instance gRPC gateway
let response = info_client.get_storage_version(get_request)
                          .await
                          .unwrap()
                          .into_inner();

// Do something with the response
println!("{:#?}", response);

1
2
3
4
5
6
7
8
# Create tonic/ArunaAPI request to fetch component versions of the AOS instance
request = GetStorageVersionRequest()

# Send the request to the AOS instance gRPC gateway
response = client.info_client.GetStorageVersion(request=request)

# Do something with the response
print(f'{response}')

Get Storage Status

API example for fetching current status of the AOS instance.

The possible 

1
2
3
4
# Native JSON request to get AOS stoarge instance status
curl -H 'Authorization: Bearer <API_TOKEN>' \
     -H 'Content-Type: application/json' \
     -X GET https://<URL-to-AOS-instance-API-gateway>/v1/info/status

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
// Create tonic/ArunaAPI request to fetch the current status of the AOS instance
let get_request = GetStorageStatusRequest {};

// Send the request to the AOS instance gRPC gateway
let response = info_client.get_storage_status(get_request)
                          .await
                          .unwrap()
                          .into_inner();

// Do something with the response
println!("{:#?}", response);

1
2
3
4
5
6
7
8
# Create tonic/ArunaAPI request to fetch the current status of the AOS instance
request = GetStorageStatusRequest()

# Send the request to the AOS instance gRPC gateway
response = client.info_client.GetStorageStatus(request=request)

# Do something with the response
print(f'{response}')