\NodeInstancesAPI

All URIs are relative to http://localhost

Method	HTTP request	Description
CreateNodeInstance	Post /api/v1/customers/{cUUID}/zones/{azUUID}/nodes	Create a node instance
DeleteInstance	Delete /api/v1/customers/{cUUID}/providers/{pUUID}/instances/{instanceIP}	Delete a node instance
DetachedNodeAction	Post /api/v1/customers/{cUUID}/providers/{pUUID}/instances/{instanceIP}	Detached node action
GetNodeDetails	Get /api/v1/customers/{cUUID}/universes/{universeUUID}/nodes/{nodeName}/details	Get node details
GetNodeInstance	Get /api/v1/customers/{cUUID}/nodes/{nodeUUID}/list	Get a node instance
List	Get /api/v1/customers/{cUUID}/nodes	List all node instances of a customer
ListByProvider	Get /api/v1/customers/{cUUID}/providers/{pUUID}/nodes/list	List all of a provider's node instances
ListByZone	Get /api/v1/customers/{cUUID}/zones/{azUUID}/nodes/list	List all of a zone's node instances
NodeAction	Put /api/v1/customers/{cUUID}/universes/{universeUUID}/nodes/{nodeName}	Perform the specified action on the universe node
UpdateState	Put /api/v1/customers/{cUUID}/providers/{pUUID}/instances/{instanceIP}/state	Update node instance state
ValidateNodeInstance	Post /api/v1/customers/{cUUID}/zones/{azUUID}/nodes/validate	Validate a node instance

CreateNodeInstance

map[string]NodeInstance CreateNodeInstance(ctx, cUUID, azUUID).NodeInstance(nodeInstance).Request(request).Execute()

Create a node instance

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	azUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	nodeInstance := *openapiclient.NewNodeInstanceFormData([]openapiclient.NodeInstanceData{*openapiclient.NewNodeInstanceData("Mumbai instance", "c5large", "1.1.1.1", "south-east", "south-east")}) // NodeInstanceFormData | Node instance data to be created
	request := TODO // interface{} |  (optional)

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

nodeInstance | NodeInstanceFormData | Node instance data to be created | request | interface{} | |

Return type

map[string]NodeInstance

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]

DeleteInstance

YBPSuccess DeleteInstance(ctx, cUUID, pUUID, instanceIP).Request(request).Execute()

Delete a node instance

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	pUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	instanceIP := "instanceIP_example" // string | 
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.NodeInstancesAPI.DeleteInstance(context.Background(), cUUID, pUUID, instanceIP).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `NodeInstancesAPI.DeleteInstance``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteInstance`: YBPSuccess
	fmt.Fprintf(os.Stdout, "Response from `NodeInstancesAPI.DeleteInstance`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

request | interface{} | |

Return type

YBPSuccess

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]

DetachedNodeAction

YBPTask DetachedNodeAction(ctx, cUUID, pUUID, instanceIP).NodeAction(nodeAction).Request(request).Execute()

Detached node action

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	pUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	instanceIP := "instanceIP_example" // string | 
	nodeAction := *openapiclient.NewNodeActionFormData("NodeAction_example") // NodeActionFormData | Node action data to be updated
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.NodeInstancesAPI.DetachedNodeAction(context.Background(), cUUID, pUUID, instanceIP).NodeAction(nodeAction).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `NodeInstancesAPI.DetachedNodeAction``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DetachedNodeAction`: YBPTask
	fmt.Fprintf(os.Stdout, "Response from `NodeInstancesAPI.DetachedNodeAction`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

nodeAction | NodeActionFormData | Node action data to be updated | request | interface{} | |

Return type

YBPTask

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]

GetNodeDetails

NodeDetailsResp GetNodeDetails(ctx, cUUID, universeUUID, nodeName).Execute()

Get node details

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	universeUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	nodeName := "nodeName_example" // string | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

NodeDetailsResp

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]

GetNodeInstance

NodeInstance GetNodeInstance(ctx, cUUID, nodeUUID).Execute()

Get a node instance

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	nodeUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

NodeInstance

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]

List

NodeInstance List(ctx, cUUID).NodeIp(nodeIp).Execute()

List all node instances of a customer

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	nodeIp := "nodeIp_example" // string |  (optional) (default to "null")

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

Name	Type	Description	Notes

nodeIp | string | | [default to "null"]

Return type

NodeInstance

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]

ListByProvider

[]NodeInstance ListByProvider(ctx, cUUID, pUUID).Execute()

List all of a provider's node instances

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	pUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

[]NodeInstance

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]

ListByZone

[]NodeInstance ListByZone(ctx, cUUID, azUUID).Execute()

List all of a zone's node instances

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	azUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

[]NodeInstance

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]

NodeAction

YBPTask NodeAction(ctx, cUUID, universeUUID, nodeName).NodeAction(nodeAction).Request(request).Execute()

Perform the specified action on the universe node

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	universeUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	nodeName := "nodeName_example" // string | 
	nodeAction := *openapiclient.NewNodeActionFormData("NodeAction_example") // NodeActionFormData | Details of the node action to be performed
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.NodeInstancesAPI.NodeAction(context.Background(), cUUID, universeUUID, nodeName).NodeAction(nodeAction).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `NodeInstancesAPI.NodeAction``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `NodeAction`: YBPTask
	fmt.Fprintf(os.Stdout, "Response from `NodeInstancesAPI.NodeAction`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

nodeAction | NodeActionFormData | Details of the node action to be performed | request | interface{} | |

Return type

YBPTask

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]

UpdateState

YBPTask UpdateState(ctx, cUUID, pUUID, instanceIP).NodeInstanceStateFormData(nodeInstanceStateFormData).Request(request).Execute()

Update node instance state

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	pUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	instanceIP := "instanceIP_example" // string | 
	nodeInstanceStateFormData := *openapiclient.NewNodeInstanceStateFormData() // NodeInstanceStateFormData | Resultant node instance state to transition to
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.NodeInstancesAPI.UpdateState(context.Background(), cUUID, pUUID, instanceIP).NodeInstanceStateFormData(nodeInstanceStateFormData).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `NodeInstancesAPI.UpdateState``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateState`: YBPTask
	fmt.Fprintf(os.Stdout, "Response from `NodeInstancesAPI.UpdateState`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

nodeInstanceStateFormData | NodeInstanceStateFormData | Resultant node instance state to transition to | request | interface{} | |

Return type

YBPTask

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]

ValidateNodeInstance

map[string]ValidationResult ValidateNodeInstance(ctx, cUUID, azUUID).Request(request).Execute()

Validate a node instance

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	azUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	request := TODO // interface{} |  (optional)

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

request | interface{} | |

Return type

map[string]ValidationResult

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]

FilesExpand file tree

NodeInstancesAPI.md

Latest commit

History

NodeInstancesAPI.md

File metadata and controls

\NodeInstancesAPI

CreateNodeInstance

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteInstance

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DetachedNodeAction

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetNodeDetails

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetNodeInstance

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

List

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListByProvider

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListByZone

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

NodeAction

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateState

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ValidateNodeInstance

Example

Path Parameters