Getting information about object storage accounts and repository servers

You can get a list of object storage servers and repository servers and obtain information about each account and server. Or, you can specify one object storage account or repository server and obtain information about the specified account or server.

Method and URI

To get information about all object storage servers and repository servers, use a GET method and a URI:

GET     https://{hostname|IP}/api/cloud

To get information about a specific object storage server or repository server, use a GET method and a URI:

GET     https://{hostname|IP}/api/cloud/{cloudProviderInfoId}

Tip

To get a {cloudProviderInfoId} value based on the name of the cloud provider, follow the instructions in Getting a {cloudProviderInfoId}.

Parameters

None.

Example: Get information about all object storage accounts and repository servers

A Python snippet that is similar to the following example can be used to request object storage and repository server information:

requests.get('https://' + spp_ipv4 + '/api/cloud',
    headers={...}, verify=...)
_images/reference_cloud_get01objectstorage.png

Figure 36 To display object storage information in the IBM Spectrum Protect Plus web user interface, in the navigation pane, click System Configuration > Backup Storage > Object Storage.

_images/reference_cloud_get02repositoryserver.png

Figure 37 To see a list of repository servers, in the navigation pane, click System Configuration > Backup Storage > Repository Server.

The following example response from the Python snippet shows information about object storage and repository servers:

{
    "links": {...},
    "total": 6,
    "clouds": [
        {
            "links": {
                "self": {
                    ...
                    "href": "https://10.0.0.100/api/cloud/1",
                    ...
                 },
             ...
             },

            "id": "1",
            "name": "S3 Offload Repo",
            "type": "s3",
            "comment": null,
            "accesskey": {
                "href": "https://10.0.0.100/api/identity/key/1003"
            },
            "properties": {
                "type": "s3",
                "certificate": {
                    "href": "https://10.0.0.101/api/security/certificate/1005"
                },
                "endpoint": "https://demo.s3provider.com.invalid",
                "bucket": "bluemachines",
                "archiveBucket": "bluemachines-archive"
            },
            "provider": "generic",
            "wormProtected": false,
            "defaultRetention": 0,
            "offloadEnabled": true,
            "archiveEnabled": true,
            "ec2ServiceEnabled": null,
            "deepArchiveEnabled": false,
            "rbacPath": "root:0/cloud:0/cloudType:s3/cloud:2",
            "cloudCapacity": null
        },
        {
            "links": {...},
            "id": "2",
            "name": "BlueMachines - IBM COS - Singapore",
            "type": "s3",
            "comment": null,
            "accesskey": {
                "href": "https://10.0.0.100/api/identity/key/1002"
            },
            "properties": {
                "type": "s3",
                "endpoint": "https://ibmcos.bluemachines.com.invalid",
                "bucket": "00000000-0000-0000-0000-000000000000",
                "protectionConfiguration": {
                    "status": "COMPLIANCE",
                    "minimumRetention": 0,
                    "maximumRetention": 2,
                    "defaultRetention": 1
                }
            },
            "provider": "IBM Cloud Object Storage",
            "wormProtected": true,
            "defaultRetention": 1,
            "offloadEnabled": true,
            "archiveEnabled": false,
            "ec2ServiceEnabled": null,
            "deepArchiveEnabled": false,
            "rbacPath": "root:0/cloud:0/cloudType:s3/cloud:1",
            "cloudCapacity": null
        },
        {
            "links": {...},
            "id": "3",
            "name": "BlueMachines - Microsoft Azure - East US",
            "type": "s3",
            "comment": null,
            "accesskey": {
                "href": "https://10.0.0.100/api/identity/key/1003"
            },
            "properties": {
                "type": "s3",
                "endpoint": "https://ibmcos.bluemachines.com.invalid",
                "bucket": "00000000-0000-0000-0000-000000000000",
                "protectionConfiguration": {
                    "status": "COMPLIANCE",
                    "minimumRetention": 0,
                    "maximumRetention": 2,
                    "defaultRetention": 1
                }
            },
            "provider": "Microsoft Azure Blob Storage",
            "wormProtected": true,
            "defaultRetention": 1,
            "offloadEnabled": true,
            "archiveEnabled": false,
            "ec2ServiceEnabled": null,
            "deepArchiveEnabled": false,
            "rbacPath": "root:0/cloud:0/cloudType:s3/cloud:1",
            "cloudCapacity": null
        },
        {
            "links": {...},
            "id": "4",
            "name": "BlueMachines Amazon S3 US-East1",
            "type": "s3",
            "comment": null,
            "accesskey": {
                "href": "https://10.0.0.100/api/identity/key/1003"
            },
            "properties": {
                "type": "s3",
                "endpoint": "https://ibmcos.bluemachines.com.invalid",
                "bucket": "00000000-0000-0000-0000-000000000000",
                "protectionConfiguration": {
                    "status": "COMPLIANCE",
                    "minimumRetention": 0,
                    "maximumRetention": 2,
                    "defaultRetention": 1
                }
            },
            "provider": "Amazon S3",
            "wormProtected": true,
            "defaultRetention": 1,
            "offloadEnabled": true,
            "archiveEnabled": false,
            "ec2ServiceEnabled": null,
            "deepArchiveEnabled": false,
            "rbacPath": "root:0/cloud:0/cloudType:s3/cloud:1",
            "cloudCapacity": null
        },
        {
            "links": {...},
            "id": "5",
            "name": "Amazon S3-Compatible Storage - Dallas",
            "type": "s3",
            "comment": null,
            "accesskey": {
                "href": "https://10.0.0.100/api/identity/key/1003"
            },
            "properties": {
                "type": "s3",
                "endpoint": "https://ibmcos.bluemachines.com.invalid",
                "bucket": "00000000-0000-0000-0000-000000000000",
                "protectionConfiguration": {
                    "status": "COMPLIANCE",
                    "minimumRetention": 0,
                    "maximumRetention": 2,
                    "defaultRetention": 1
                }
            },
            "provider": "Generic",
            "wormProtected": true,
            "defaultRetention": 1,
            "offloadEnabled": true,
            "archiveEnabled": false,
            "ec2ServiceEnabled": null,
            "deepArchiveEnabled": false,
            "rbacPath": "root:0/cloud:0/cloudType:s3/cloud:1",
            "cloudCapacity": null
        },
        {
            "links": {...},
            "id": "6",
            "name": "BlueMachines - IBM Spectrum Protect - Dallas",
            "type": "s3",
            "comment": null,
            "accesskey": {
                "href": "https://10.0.0.100/api/identity/key/1015"
            },
            "properties": {
                "type": "s3",
                "certificate": {
                    "href": "https://10.0.0.100/api/security/certificate/1004"
                },
                "hostname": "DUMMY-SP01",
                "port": 9000.0,
                "bucket": "spp-spp10-1000000000000"
            },
            "provider": "sp",
            "wormProtected": false,
            "defaultRetention": 0,
            "offloadEnabled": true,
            "archiveEnabled": true,
            "ec2ServiceEnabled": null,
            "deepArchiveEnabled": false,
            "rbacPath": "root:0/cloud:0/cloudType:s3/cloud:1",
            "cloudCapacity": null
        }
    ]
}