Get Info

Get Info

Operation ID: getInfo
'Get the information of the REST Services, including platform name, OSIS version and etc'

Request
URI
GET
https://{api_host}/osis/api/info
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Information of type(s) application/json 
{
    "platform_name": "ceph",
    "platform_version": "15.2.3",
    "api_version": "1.0",
    "iam": true,
    "logo_uri": "https://ceph.ose.vmware.com/static/images/ceph.svg",
    "status": "string",
    "auth_modes": [
        "string"
    ],
    "services": {
        "iam": "https://iam.ceph.ose.vmware.com"
    },
    "regions": [
        "us-west-2"
    ],
    "storage_classes": [
        "standard"
    ],
    "not_implemented": [
        "getUsage",
        "getConsole"
    ]
}
string
platform_name
Required

name of the storage platform

string
platform_version
Optional

version of the storage platform

string
api_version
Required

OSIS version the REST services complying with

boolean
iam
Optional

the OSIS adaptor is using Amazon fashion IAM for user mapping

string As uri As uri
logo_uri
Optional

uri of the platform logo so that OSE can use it on UI

string
status
Required

status

Possible values are : NORMAL, WARNING, ERROR, UNKNOWN,
array of string
auth_modes
Optional

auth_modes

Possible values are : Basic, Bearer,
object
services
Optional

Supported Services' URL of the storage platform

array of string
regions
Optional

regions for the storage platform; if it is not appliable for the platform, return default

array of string
storage_classes
Optional

storage classes of the storage platforms; if it is not applicable for the platform, return standard

array of string
not_implemented
Required

the operation id array of optional OSIS APIs which is not implemented


On This Page
Info Operations
GET
Get Info