List Grouped Regions | OSE Provider Administration API

List Grouped Regions

API code: LIST_GROUPED_REGIONS
Pre-authorized role(s): TENANT_USER | TENANT_ADMIN | PROVIDER_ADMIN
Platform(s): CLOUDIAN

List the detailed information of the regions, including platform, Cloud Director, health and many other essential states.

Request

URI

GET

https://apaas-29.eng.vmware.com//api/v1/core/grouped-regions

COPY

Authentication

This operation uses the following authentication methods.

Bearer Authentication

Responses

200

Returns Array of RegionInfo of type(s) application/json

[
    {
        "region": "string",
        "regionState": "string",
        "lastUpdate": "string",
        "ose": {
            "endpoint": "string"
        },
        "connected": false,
        "lastConnected": "string",
        "platform": {
            "name": "string",
            "version": "string",
            "logoUri": "string",
            "accountId": "string",
            "requiredServices": {
                "requiredServices": "string"
            },
            "storageClasses": [
                "string"
            ],
            "regions": [
                "string"
            ],
            "health": {
                "overallStatus": "string",
                "overallMessages": [
                    "string"
                ],
                "lastUpdate": "string"
            }
        },
        "vcd": {
            "site": "string",
            "endpoint": "string"
        }
    }
]

On This Page

Description

Request

Authentication

Response

200 Response Body

Region Management Operations

POST

Add Region Endpoint

POST

Handoff Region Endpoint

GET