storage-go-client

Go Client For Nutanix Storage Versioned APIs

The Go client for Nutanix Storage Versioned APIs is designed for Go client application developers offering them simple and flexible access to APIs that manages volume groups and storage containers in Nutanix cluster.

Features

• Invoke Nutanix APIs with a simple interface.
• Handle Authentication seamlessly.
• Reduce boilerplate code implementation.
• Use standard methods for installation.

Version

• API version: v4.0.a3
• Package version: v4.0.2-alpha.3

Requirements.

Go 1.11 or above are fully supported and tested.

Installation & Usage

Installation

Using go get

$ go get github.com/nutanix/ntnx-api-golang-clients/storage-go-client/v4/...

$ go get github.com/nutanix/ntnx-api-golang-clients/storage-go-client/v4/...@v4.0.2-alpha.3

Using go modules

In go.mod file add the following

module your-module

go {GO_VERSION}

require (
	github.com/nutanix/ntnx-api-golang-clients/storage-go-client/v4 latest
)

In go.mod file add the following

module your-module

go {GO_VERSION}

require (
	github.com/nutanix/ntnx-api-golang-clients/storage-go-client/v4 v4.0.2-alpha.3
)

Configuration

The Go client for Nutanix Storage Versioned APIs can be configured with the following parameters

A Proxy can be configured with the following parameters

Sample Configuration

import (
	"github.com/nutanix/ntnx-api-golang-clients/storage-go-client/v4/client"
)
var (
	ApiClientInstance *client.ApiClient
)

ApiClientInstance = client.NewApiClient()
ApiClientInstance.Host = "10.19.50.27" // IPv4/IPv6 address or FQDN of the cluster
ApiClientInstance.Port = 9440 // Port to which to connect to
ApiClientInstance.Username = "admin" // UserName to connect to the cluster
ApiClientInstance.Password = "password" // Password to connect to the cluster

Proxy Configuration

import (
	"github.com/nutanix/ntnx-api-golang-clients/storage-go-client/v4/client"
)
var (
	ApiClientInstance *client.ApiClient
)

ApiClientInstance = client.NewApiClient()
// Configure the client as shown in the previous step
// ...

ApiClientInstance.Proxy = new(client.Proxy)

ApiClientInstance.Proxy.Scheme = "socks5"
ApiClientInstance.Proxy.Username = "proxy_admin"
ApiClientInstance.Proxy.Password = "proxy_password"
ApiClientInstance.Proxy.Host = "127.0.0.1"
ApiClientInstance.Proxy.Port = 1080

Authentication

Nutanix APIs currently support HTTP Basic Authentication only, and the Go client can be configured using the username and password parameters to send Basic headers along with every request.

Retry Mechanism

The Go client can be configured to retry requests that fail with the following status codes. The numbers of seconds before which the next retry is attempted is determined by the RetryInterval.

• 408 - Request Timeout
• 502 - Bad Gateway
• 503 - Service Unavailable

import (
	"github.com/nutanix/ntnx-api-golang-clients/storage-go-client/v4/client"
)
var (
	ApiClientInstance *client.ApiClient
)

ApiClientInstance = client.NewApiClient()
ApiClientInstance.MaxRetryAttempts = 5 // Max retry attempts while reconnecting on a loss of connection
ApiClientInstance.RetryInterval = 5000 // Interval in ms to use during retry attempts

Usage

Invoking an operation

import (
	"github.com/nutanix/ntnx-api-golang-clients/storage-go-client/v4/client"
	"github.com/nutanix/ntnx-api-golang-clients/storage-go-client/v4/api"
)

var (
	ApiClientInstance *client.ApiClient
	StorageContainerApiInstance *api.StorageContainerApi
)

ApiClientInstance = client.NewApiClient()
// Configure the client as shown in the previous step
// ...

// Initialize the API
StorageContainerApiInstance = api.NewStorageContainerApi(ApiClientInstance)
containerExtId := "fEDBAfd3-acBc-efE9-Ad67-580f6fFCa6DD"

// 
getResponse, err := StorageContainerApiInstance.GetStorageContainerByExtId(&containerExtId)
if err != nil {
....
}

Request Options

The library provides the ability to specify additional options that can be applied directly on the 'ApiClient' object used to make network calls to the API. The library also provides a mechanism to specify operation specific headers.

Client headers

The 'ApiClient' can be configured to send additional headers on each request.

import (
	"github.com/nutanix/ntnx-api-golang-clients/storage-go-client/v4/client"
)

var (
	ApiClientInstance *client.ApiClient
)

ApiClientInstance = client.NewApiClient()
ApiClientInstance.AddDefaultHeader("Accept-Encoding", "gzip, deflate, br")

You can also modify the headers sent with each individual operation:

Operation specific headers

Nutanix APIs require that concurrent updates are protected using ETag headers. This would mean that the ETag header received in the response of a fetch (GET) operation should be used as an If-Match header for the modification (PUT) operation.

import (
	"github.com/nutanix/ntnx-api-golang-clients/storage-go-client/v4/client"
	"github.com/nutanix/ntnx-api-golang-clients/storage-go-client/v4/api"
    // import request body DTO for put api
)

var (
	ApiClientInstance *client.ApiClient
	StorageContainerApiInstance *api.StorageContainerApi
)

ApiClientInstance = client.NewApiClient()
// Configure the client as shown in a previous step
// ...

// Initialize the API
StorageContainerApiInstance = api.NewStorageContainerApi(ApiClientInstance)
containerExtId := "fEDBAfd3-acBc-efE9-Ad67-580f6fFCa6DD"

// 
getResponse, err := StorageContainerApiInstance.GetStorageContainerByExtId(&containerExtId)
if err != nil {
    ....
}

// Extract E-Tag Header
etagValue := ApiClientInstance.GetEtag(getResponse)

args := make(map[string] interface {})
args["If-Match"] = etagValue
// ...
// Perform update call with received E-Tag reference
// initialize/change parameters for update
// ...
storageContainer := getResponse.GetData().(import1.StorageContainer)

// The body parameter in the following operation is received from the previous GET request's response which needs to be updated.
response, err := StorageContainerApiInstance.UpdateStorageContainer(&storageContainer, &containerExtId, args)
if err != nil {
....
}

List Operations

List Operations for Nutanix APIs support pagination, filtering, sorting and projections. The table below details the parameters that can be used to set the options for pagination etc.

import (
	"github.com/nutanix/ntnx-api-golang-clients/storage-go-client/v4/client"
	"github.com/nutanix/ntnx-api-golang-clients/storage-go-client/v4/api"
)
var (
	ApiClientInstance *client.ApiClient
	StorageContainerApiInstance *api.StorageContainerApi
)

ApiClientInstance = client.NewApiClient()
// Configure the client
// ...

// Initialize the API
StorageContainerApiInstance = api.NewStorageContainerApi(ApiClientInstance)
page := 0
limit := 50
filter := "string_sample_data"
orderby := "string_sample_data"
select := "string_sample_data"

// 
response, err := StorageContainerApiInstance.GetAllStorageContainers(&page, &limit, &filter, &orderby, &select)
if err != nil {
    ....
}

The list of filterable and sortable fields with expansion keys can be found in the documentation here.

API Reference

This library has a full set of API Reference Documentation. This documentation is auto-generated, and the location may change.

License

This library is licensed under Nutanix proprietary license. Full license text is available in LICENSE.

Contact us

In case of issues please reach out to us at the mailing list