\UniverseInformationApi

All URIs are relative to http://localhost

Method	HTTP request	Description
DownloadNodeLogs	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/{nodeName}/download_logs	Download a node's logs - deprecated
GetLiveQueries	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/live_queries	Get live queries for a universe
GetMasterInfos	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/master_infos	Get master information list
GetMasterLeaderIP	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/leader	Get IP address of a universe's master leader
GetSlowQueries	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/slow_queries	Get slow queries for a universe
GetUniverseCost	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/cost	Get a cost estimate for a universe - deprecated
GetUniverseCostForAll	Get /api/v1/customers/{cUUID}/cost	Get a cost estimate for all universes
GetUniverseResources	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/universe_resources	Get a resource usage estimate for a universe
HealthCheckUniverse	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/health_check	Return results for the last health check
ResetSlowQueries	Delete /api/v1/customers/{cUUID}/universes/{uniUUID}/slow_queries	Reset slow queries for a universe
TriggerHealthCheck	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/trigger_health_check	Trigger a universe health check
UniverseStatus	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/status	Get a universe's status

DownloadNodeLogs

string DownloadNodeLogs(ctx, cUUID, uniUUID, nodeName).Execute()

Download a node's logs - deprecated

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 
    uniUUID := TODO // string | 
    nodeName := "nodeName_example" // string | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UniverseInformationApi.DownloadNodeLogs(context.Background(), cUUID, uniUUID, nodeName).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UniverseInformationApi.DownloadNodeLogs``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DownloadNodeLogs`: string
    fmt.Fprintf(os.Stdout, "Response from `UniverseInformationApi.DownloadNodeLogs`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string
uniUUID	string
nodeName	string

Other Parameters

Other parameters are passed through a pointer to a apiDownloadNodeLogsRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

string

Authorization

apiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/x-compressed

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLiveQueries

map[string]interface{} GetLiveQueries(ctx, cUUID, uniUUID).Execute()

Get live queries for a universe

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 
    uniUUID := TODO // string | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UniverseInformationApi.GetLiveQueries(context.Background(), cUUID, uniUUID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UniverseInformationApi.GetLiveQueries``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetLiveQueries`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `UniverseInformationApi.GetLiveQueries`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string
uniUUID	string

Other Parameters

Other parameters are passed through a pointer to a apiGetLiveQueriesRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

map[string]interface{}

Authorization

apiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMasterInfos

[]MasterInfo GetMasterInfos(ctx, cUUID, uniUUID).Execute()

Get master information list

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 
    uniUUID := TODO // string | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UniverseInformationApi.GetMasterInfos(context.Background(), cUUID, uniUUID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UniverseInformationApi.GetMasterInfos``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetMasterInfos`: []MasterInfo
    fmt.Fprintf(os.Stdout, "Response from `UniverseInformationApi.GetMasterInfos`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string
uniUUID	string

Other Parameters

Other parameters are passed through a pointer to a apiGetMasterInfosRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]MasterInfo

Authorization

apiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMasterLeaderIP

map[string]interface{} GetMasterLeaderIP(ctx, cUUID, uniUUID).Execute()

Get IP address of a universe's master leader

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 
    uniUUID := TODO // string | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UniverseInformationApi.GetMasterLeaderIP(context.Background(), cUUID, uniUUID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UniverseInformationApi.GetMasterLeaderIP``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetMasterLeaderIP`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `UniverseInformationApi.GetMasterLeaderIP`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string
uniUUID	string

Other Parameters

Other parameters are passed through a pointer to a apiGetMasterLeaderIPRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

map[string]interface{}

Authorization

apiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSlowQueries

map[string]interface{} GetSlowQueries(ctx, cUUID, uniUUID).Execute()

Get slow queries for a universe

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 
    uniUUID := TODO // string | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UniverseInformationApi.GetSlowQueries(context.Background(), cUUID, uniUUID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UniverseInformationApi.GetSlowQueries``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSlowQueries`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `UniverseInformationApi.GetSlowQueries`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string
uniUUID	string

Other Parameters

Other parameters are passed through a pointer to a apiGetSlowQueriesRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

map[string]interface{}

Authorization

apiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUniverseCost

UniverseResourceDetails GetUniverseCost(ctx, cUUID, uniUUID).Execute()

Get a cost estimate for a universe - deprecated

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 
    uniUUID := TODO // string | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UniverseInformationApi.GetUniverseCost(context.Background(), cUUID, uniUUID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UniverseInformationApi.GetUniverseCost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetUniverseCost`: UniverseResourceDetails
    fmt.Fprintf(os.Stdout, "Response from `UniverseInformationApi.GetUniverseCost`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string
uniUUID	string

Other Parameters

Other parameters are passed through a pointer to a apiGetUniverseCostRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

UniverseResourceDetails

Authorization

apiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUniverseCostForAll

[]UniverseResourceDetails GetUniverseCostForAll(ctx, cUUID).Execute()

Get a cost estimate for all universes

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UniverseInformationApi.GetUniverseCostForAll(context.Background(), cUUID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UniverseInformationApi.GetUniverseCostForAll``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetUniverseCostForAll`: []UniverseResourceDetails
    fmt.Fprintf(os.Stdout, "Response from `UniverseInformationApi.GetUniverseCostForAll`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string

Other Parameters

Other parameters are passed through a pointer to a apiGetUniverseCostForAllRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]UniverseResourceDetails

Authorization

apiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUniverseResources

UniverseResourceDetails GetUniverseResources(ctx, cUUID, uniUUID).Execute()

Get a resource usage estimate for a universe

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 
    uniUUID := TODO // string | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UniverseInformationApi.GetUniverseResources(context.Background(), cUUID, uniUUID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UniverseInformationApi.GetUniverseResources``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetUniverseResources`: UniverseResourceDetails
    fmt.Fprintf(os.Stdout, "Response from `UniverseInformationApi.GetUniverseResources`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string
uniUUID	string

Other Parameters

Other parameters are passed through a pointer to a apiGetUniverseResourcesRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

UniverseResourceDetails

Authorization

apiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HealthCheckUniverse

[]Details HealthCheckUniverse(ctx, cUUID, uniUUID).Execute()

Return results for the last health check

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 
    uniUUID := TODO // string | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UniverseInformationApi.HealthCheckUniverse(context.Background(), cUUID, uniUUID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UniverseInformationApi.HealthCheckUniverse``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `HealthCheckUniverse`: []Details
    fmt.Fprintf(os.Stdout, "Response from `UniverseInformationApi.HealthCheckUniverse`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string
uniUUID	string

Other Parameters

Other parameters are passed through a pointer to a apiHealthCheckUniverseRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]Details

Authorization

apiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ResetSlowQueries

map[string]interface{} ResetSlowQueries(ctx, cUUID, uniUUID).Request(request).Execute()

Reset slow queries for a universe

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 
    uniUUID := TODO // string | 
    request := TODO // interface{} |  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UniverseInformationApi.ResetSlowQueries(context.Background(), cUUID, uniUUID).Request(request).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UniverseInformationApi.ResetSlowQueries``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ResetSlowQueries`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `UniverseInformationApi.ResetSlowQueries`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string
uniUUID	string

Other Parameters

Other parameters are passed through a pointer to a apiResetSlowQueriesRequest struct via the builder pattern

Name	Type	Description	Notes

request | interface{} | |

Return type

map[string]interface{}

Authorization

apiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TriggerHealthCheck

TriggerHealthCheckResult TriggerHealthCheck(ctx, cUUID, uniUUID).Execute()

Trigger a universe health check

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 
    uniUUID := TODO // string | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UniverseInformationApi.TriggerHealthCheck(context.Background(), cUUID, uniUUID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UniverseInformationApi.TriggerHealthCheck``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `TriggerHealthCheck`: TriggerHealthCheckResult
    fmt.Fprintf(os.Stdout, "Response from `UniverseInformationApi.TriggerHealthCheck`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string
uniUUID	string

Other Parameters

Other parameters are passed through a pointer to a apiTriggerHealthCheckRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

TriggerHealthCheckResult

Authorization

apiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UniverseStatus

map[string]map[string]interface{} UniverseStatus(ctx, cUUID, uniUUID).Execute()

Get a universe's status

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 
    uniUUID := TODO // string | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.UniverseInformationApi.UniverseStatus(context.Background(), cUUID, uniUUID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UniverseInformationApi.UniverseStatus``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UniverseStatus`: map[string]map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `UniverseInformationApi.UniverseStatus`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string
uniUUID	string

Other Parameters

Other parameters are passed through a pointer to a apiUniverseStatusRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

map[string]map[string]interface{}

Authorization

apiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

UniverseInformationApi.md

Latest commit

History

UniverseInformationApi.md

File metadata and controls

\UniverseInformationApi

DownloadNodeLogs

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetLiveQueries

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetMasterInfos

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetMasterLeaderIP

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetSlowQueries

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetUniverseCost

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetUniverseCostForAll

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetUniverseResources

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

HealthCheckUniverse

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ResetSlowQueries

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

TriggerHealthCheck

Example

Path Parameters