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: 4.4.1
Package version: 1.0.0
Generator version: 7.11.0
Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sakura_vps "github.com/g1eng/sakura_vps_client_go"

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 sakura_vps.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sakura_vps.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sakura_vps.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sakura_vps.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 sakura_vps.ContextOperationServerIndices and sakura_vps.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sakura_vps.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sakura_vps.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://secure.sakura.ad.jp/vps/api/v7

Class	Method	HTTP request	Description
ApiKeyAPI	DeleteApiKey	Delete /api-keys/{api_key_id}	APIキーを削除する
ApiKeyAPI	DeleteRole	Delete /roles/{role_id}	ロールを削除する
ApiKeyAPI	GetApiKey	Get /api-keys/{api_key_id}	APIキーを取得する
ApiKeyAPI	GetApiKeyList	Get /api-keys	APIキーの一覧を取得する
ApiKeyAPI	GetPermissionList	Get /permissions	権限の一覧を取得する
ApiKeyAPI	GetRole	Get /roles/{role_id}	ロールを取得する
ApiKeyAPI	GetRoleList	Get /roles	ロール一覧を取得する
ApiKeyAPI	PostApiKey	Post /api-keys	APIキーを作成する
ApiKeyAPI	PostApiKeyRotate	Post /api-keys/{api_key_id}/rotate	APIキーのトークンのローテーションを行う
ApiKeyAPI	PostRole	Post /roles	ロールを作成する
ApiKeyAPI	PutApiKey	Put /api-keys/{api_key_id}	APIキーを更新する
ApiKeyAPI	PutRole	Put /roles/{role_id}	ロールを更新する
DiscAPI	GetDiscList	Get /discs	ディスク情報一覧を取得する
NfsServerAPI	GetNfsServer	Get /nfs-servers/{nfs_server_id}	NFS情報を取得する
NfsServerAPI	GetNfsServerInterface	Get /nfs-servers/{nfs_server_id}/interface	NFSのインターフェースを取得する
NfsServerAPI	GetNfsServerList	Get /nfs-servers	NFS情報一覧を取得する
NfsServerAPI	GetNfsServerPowerStatus	Get /nfs-servers/{nfs_server_id}/power-status	NFSの電源状態を取得する
NfsServerAPI	GetNfsServerStorage	Get /nfs-servers/{nfs_server_id}/storage	NFSのストレージ容量情報を取得する
NfsServerAPI	PostNfsServerChangeIpv4	Post /nfs-servers/{nfs_server_id}/change-ipv4	NFSのipv4を更新する
NfsServerAPI	PutNfsServer	Put /nfs-servers/{nfs_server_id}	NFS情報を更新する
NfsServerAPI	PutNfsServerInterface	Put /nfs-servers/{nfs_server_id}/interface	NFSのインターフェース情報を更新する
ServerAPI	DeleteServerMonitorings	Delete /servers/{server_id}/monitorings/{server_monitoring_id}	サーバーのサーバー監視情報を削除する
ServerAPI	GetServer	Get /servers/{server_id}	サーバー情報を取得する
ServerAPI	GetServerInterface	Get /servers/{server_id}/interfaces/{interface_id}	サーバーのインターフェース情報を取得する
ServerAPI	GetServerInterfaceList	Get /servers/{server_id}/interfaces	サーバーのインターフェース情報一覧を取得する
ServerAPI	GetServerLimitation	Get /servers/{server_id}/limitation	サーバーの制限情報を取得する
ServerAPI	GetServerList	Get /servers	サーバー情報一覧を取得する
ServerAPI	GetServerMonitoring	Get /servers/{server_id}/monitorings/{server_monitoring_id}	サーバーのサーバー監視情報を取得する
ServerAPI	GetServerMonitoringHealth	Get /servers/{server_id}/monitorings/{server_monitoring_id}/health	サーバー監視の監視状態を取得する
ServerAPI	GetServerMonitoringList	Get /servers/{server_id}/monitorings	サーバーのサーバー監視情報一覧を取得する
ServerAPI	GetServerPowerStatus	Get /servers/{server_id}/power-status	サーバーの電源状態を取得する
ServerAPI	GetServerVideoDevice	Get /servers/{server_id}/video-device	サーバーのビデオデバイスの設定を取得する
ServerAPI	GetServerVncConsoleKeymap	Get /servers/{server_id}/vnc-console-keymap	コンパネのVNCコンソールのキーマップ情報を取得する
ServerAPI	PostServerForceReboot	Post /servers/{server_id}/force-reboot	サーバーを強制再起動する
ServerAPI	PostServerMonitoring	Post /servers/{server_id}/monitorings	サーバーのサーバー監視を作成する
ServerAPI	PostServerMountDisc	Post /servers/{server_id}/mount-disc	サーバーにディスクをマウントする
ServerAPI	PostServerPowerOn	Post /servers/{server_id}/power-on	サーバーを起動する
ServerAPI	PostServerShutdown	Post /servers/{server_id}/shutdown	サーバーをシャットダウンする
ServerAPI	PutServer	Put /servers/{server_id}	サーバー情報を更新する
ServerAPI	PutServerInterface	Put /servers/{server_id}/interfaces/{interface_id}	サーバーのインターフェース情報を更新する
ServerAPI	PutServerIpv4Ptr	Put /servers/{server_id}/ipv4-ptr	サーバーのipv4の逆引きホスト名を更新する
ServerAPI	PutServerIpv6Ptr	Put /servers/{server_id}/ipv6-ptr	サーバーのipv6の逆引きホスト名を更新する
ServerAPI	PutServerMonitoring	Put /servers/{server_id}/monitorings/{server_monitoring_id}	サーバーのサーバー監視情報を更新する
ServerAPI	PutServerVideoDevice	Put /servers/{server_id}/video-device	サーバーのビデオデバイスの設定を更新する
ServerAPI	PutServerVncConsoleKeymap	Put /servers/{server_id}/vnc-console-keymap	コンパネのVNCコンソールのキーマップ情報を変更する
SwitchAPI	DeleteSwitch	Delete /switches/{switch_id}	スイッチを削除する
SwitchAPI	GetSwitch	Get /switches/{switch_id}	スイッチ情報を取得する
SwitchAPI	GetSwitchList	Get /switches	スイッチ情報一覧を取得する
SwitchAPI	PostSwitch	Post /switches	スイッチを作成する
SwitchAPI	PutSwitch	Put /switches/{switch_id}	スイッチ情報を更新する
ZoneAPI	GetZoneList	Get /zones	ゾーン情報一覧を取得する

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), sakura_vps.ContextAccessToken, "BEARER_TOKEN_STRING")
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

# Packages

# README

これは何

利用方法

ライセンス

Go API client for sakura_vps

Overview