# README
Go API client for networkstorageapi
Create, list, edit, and delete storage networks with the Network Storage API. Use storage networks to expand storage capacity on a private network.
Knowledge base articles to help you can be found
here
All URLs are relative to (https://api.phoenixnap.com/network-storage/v1/)
Overview
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 1.0 For more information, please visit https://phoenixnap.com/
Installation
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
Put the package under your project folder and add the following in import:
import networkstorageapi "github.com/phoenixnap/go-sdk-bmc/networkstorageapi"
To use a proxy, set the environment variable HTTP_PROXY
:
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
Configuration of Server URL
Default configuration comes with Servers
field that contains server objects as defined in the OpenAPI specification.
Select Server Configuration
For using other server than the one defined on index 0 set context value networkstorageapi.ContextServerIndex
of type int
.
ctx := context.WithValue(context.Background(), networkstorageapi.ContextServerIndex, 1)
Templated Server URL
Templated server URL is formatted using default variables from configuration or from context value networkstorageapi.ContextServerVariables
of type map[string]string
.
ctx := context.WithValue(context.Background(), networkstorageapi.ContextServerVariables, map[string]string{
"basePath": "v2",
})
Note, enum values are always validated and all unused variables are silently ignored.
URLs Configuration per Operation
Each operation can use different server URL defined using OperationServers
map in the Configuration
.
An operation is uniquely identified by "{classname}Service.{nickname}"
string.
Similar rules for overriding default operation server index and variables applies by using networkstorageapi.ContextOperationServerIndices
and networkstorageapi.ContextOperationServerVariables
context maps.
ctx := context.WithValue(context.Background(), networkstorageapi.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), networkstorageapi.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
Documentation for API Endpoints
All URIs are relative to https://api.phoenixnap.com/network-storage/v1
Class | Method | HTTP request | Description |
---|---|---|---|
StorageNetworksAPI | StorageNetworksGet | Get /storage-networks | List all storage networks. |
StorageNetworksAPI | StorageNetworksIdDelete | Delete /storage-networks/{storageId} | Delete a storage network and its volume. |
StorageNetworksAPI | StorageNetworksIdGet | Get /storage-networks/{storageId} | Get storage network details. |
StorageNetworksAPI | StorageNetworksIdPatch | Patch /storage-networks/{storageId} | Update storage network details. |
StorageNetworksAPI | StorageNetworksPost | Post /storage-networks | Create a storage network and volume. |
StorageNetworksAPI | StorageNetworksStorageNetworkIdVolumesGet | Get /storage-networks/{storageId}/volumes | Display one or more volumes belonging to a storage network. |
StorageNetworksAPI | StorageNetworksStorageNetworkIdVolumesPost | Post /storage-networks/{storageId}/volumes | Create a volume belonging to a storage network. |
StorageNetworksAPI | StorageNetworksStorageNetworkIdVolumesVolumeIdDelete | Delete /storage-networks/{storageId}/volumes/{volumeId} | Delete a Storage Network's Volume |
StorageNetworksAPI | StorageNetworksStorageNetworkIdVolumesVolumeIdGet | Get /storage-networks/{storageId}/volumes/{volumeId} | Get a storage network's volume details. |
StorageNetworksAPI | StorageNetworksStorageNetworkIdVolumesVolumeIdPatch | Patch /storage-networks/{storageId}/volumes/{volumeId} | Update a storage network's volume details. |
StorageNetworksAPI | StorageNetworksStorageNetworkIdVolumesVolumeIdTagsPut | Put /storage-networks/{storageId}/volumes/{volumeId}/tags | Overwrites tags assigned for the volume. |
Documentation For Models
- Error
- NfsPermissions
- NfsPermissionsCreate
- NfsPermissionsUpdate
- Permissions
- PermissionsCreate
- PermissionsUpdate
- Status
- StorageNetwork
- StorageNetworkCreate
- StorageNetworkUpdate
- StorageNetworkVolumeCreate
- TagAssignment
- TagAssignmentRequest
- Volume
- VolumeCreate
- VolumeUpdate
Documentation For Authorization
Authentication schemes defined for the API:
OAuth2
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes:
- networkstorage: Grants full access to Network Storage API.
- networkstorage.read: Grants read only access to Network Storage API.
Example
auth := context.WithValue(context.Background(), networkstorageapi.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)
Or via OAuth2 module to automatically refresh tokens and perform user authentication.
import "golang.org/x/oauth2"
/* Perform OAuth2 round trip request and obtain a token */
tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, networkstorageapi.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)
Documentation for Utility Methods
Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:
PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime