Skip to content

Latest commit

 

History

History
369 lines (244 loc) · 10.6 KB

NodeAgentsApi.md

File metadata and controls

369 lines (244 loc) · 10.6 KB
Raw

\NodeAgentsApi

All URIs are relative to http://localhost

Method HTTP request Description
DownloadNodeAgentInstaller Get /api/v1/node_agents/download Download Node Agent Installer or Package
GetNodeAgent Get /api/v1/customers/{cUUID}/node_agents/{nUUID} Get Node Agent
ListNodeAgents Get /api/v1/customers/{cUUID}/node_agents List Node Agents
PageListNodeAgents Post /api/v1/customers/{cUUID}/node_agents/page List Node Agents (paginated)
ReinstallNodeAgent Post /api/v1/customers/{cUUID}/universes/{uniUUID}/node_agents Reinstall Node Agent

DownloadNodeAgentInstaller

string DownloadNodeAgentInstaller(ctx).DownloadType(downloadType).Os(os).Arch(arch).Execute()

Download Node Agent Installer or Package

Example

package main

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

func main() {
    downloadType := "downloadType_example" // string |  (optional) (default to "INSTALLER")
    os := "os_example" // string |  (optional)
    arch := "arch_example" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.NodeAgentsApi.DownloadNodeAgentInstaller(context.Background()).DownloadType(downloadType).Os(os).Arch(arch).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NodeAgentsApi.DownloadNodeAgentInstaller``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DownloadNodeAgentInstaller`: string
    fmt.Fprintf(os.Stdout, "Response from `NodeAgentsApi.DownloadNodeAgentInstaller`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
downloadType string [default to "INSTALLER"]
os string
arch string

Return type

string

Authorization

apiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/gzip, application/x-sh

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

GetNodeAgent

NodeAgentResp GetNodeAgent(ctx, cUUID, nUUID).Execute()

Get Node Agent

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

NodeAgentResp

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]

ListNodeAgents

[]NodeAgentResp ListNodeAgents(ctx, cUUID).NodeIp(nodeIp).Execute()

List Node Agents

Example

package main

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

func main() {
    cUUID := TODO // string | 
    nodeIp := "nodeIp_example" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.NodeAgentsApi.ListNodeAgents(context.Background(), cUUID).NodeIp(nodeIp).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NodeAgentsApi.ListNodeAgents``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListNodeAgents`: []NodeAgentResp
    fmt.Fprintf(os.Stdout, "Response from `NodeAgentsApi.ListNodeAgents`: %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 apiListNodeAgentsRequest struct via the builder pattern

Name Type Description Notes

nodeIp | string | |

Return type

[]NodeAgentResp

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]

PageListNodeAgents

NodeAgentPagedApiResponse PageListNodeAgents(ctx, cUUID).PageNodeAgentRequest(pageNodeAgentRequest).Request(request).Execute()

List Node Agents (paginated)

Example

package main

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

func main() {
    cUUID := TODO // string | 
    pageNodeAgentRequest := *openapiclient.NewNodeAgentPagedApiQuery("Direction_example", *openapiclient.NewNodeAgentApiFilter("CloudType_example", []string{"NodeIps_example"}, "ProviderUuid_example", "RegionUuid_example", "UniverseUuid_example", "ZoneUuid_example"), int32(123), false, int32(123), "SortBy_example") // NodeAgentPagedApiQuery | 
    request := TODO // interface{} |  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.NodeAgentsApi.PageListNodeAgents(context.Background(), cUUID).PageNodeAgentRequest(pageNodeAgentRequest).Request(request).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NodeAgentsApi.PageListNodeAgents``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PageListNodeAgents`: NodeAgentPagedApiResponse
    fmt.Fprintf(os.Stdout, "Response from `NodeAgentsApi.PageListNodeAgents`: %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 apiPageListNodeAgentsRequest struct via the builder pattern

Name Type Description Notes

pageNodeAgentRequest | NodeAgentPagedApiQuery | | request | interface{} | |

Return type

NodeAgentPagedApiResponse

Authorization

apiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

ReinstallNodeAgent

NodeAgent ReinstallNodeAgent(ctx, cUUID, uniUUID).ReinstallNodeAgentForm(reinstallNodeAgentForm).Request(request).Execute()

Reinstall Node Agent

Example

package main

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

func main() {
    cUUID := TODO // string | 
    uniUUID := TODO // string | 
    reinstallNodeAgentForm := *openapiclient.NewReinstallNodeAgentForm() // ReinstallNodeAgentForm | 
    request := TODO // interface{} |  (optional)

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

Path Parameters

Name Type Description Notes
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 apiReinstallNodeAgentRequest struct via the builder pattern

Name Type Description Notes

reinstallNodeAgentForm | ReinstallNodeAgentForm | | request | interface{} | |

Return type

NodeAgent

Authorization

apiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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