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}/api/info
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Information of type(s) application/json 
{
    "tenant_s3_domain_enabled": false,
    "auth_modes": [
        "Basic",
        "Basic"
    ],
    "storage_classes": [
        "standard",
        "standard"
    ],
    "regions": [
        "us-west-2",
        "us-west-2"
    ],
    "platform_version": "15.2.3",
    "iam": true,
    "logo_uri": "https://ceph.ose.vmware.com/static/images/ceph.svg",
    "platform_name": "ceph",
    "services": {
        "iam": "https://iam.ceph.ose.vmware.com"
    },
    "api_version": "1.0",
    "not_implemented": [
        "getUsage",
        "getConsole"
    ],
    "status": "NORMAL"
}
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.

boolean
tenant_s3_domain_enabled
Optional

Whether the platform has specific S3 endpoint per tenant.

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 the platform has no multiple regions support, return default.

array of string
storage_classes
Optional

Storage classes of the storage platforms. If the platform doesn't support storage class, 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