Skip to content

Latest commit

 

History

History
155 lines (126 loc) · 3.79 KB

readme.md

File metadata and controls

155 lines (126 loc) · 3.79 KB
Raw

AOC Go SDK

Golang SDK for AOC

Installation

go get github.com/arcfraofficial/aoc-go-sdk

How to

In the example, we use two libs pointy and go-funk，pointy is used to create pointer，go-funk provide some，like Map、Filter、Reduce and etc.

Create instance

Create ApiClient instance

import (
	apiclient "github.com/arcfraoffical/aoc-go-sdk/client"
	httptransport "github.com/go-openapi/runtime/client"
	"github.com/go-openapi/strfmt"
)
transport := httptransport.New("192.168.36.133", "/v2/api", []string{"http"})
client := apiclient.New(transport, strfmt.Default)

add InsecureSkipVerify to skip tls verify for self-signed SSL certificate

import (
	apiclient "github.com/arcfraoffical/aoc-go-sdk/client"
	httptransport "github.com/go-openapi/runtime/client"
	"github.com/go-openapi/strfmt"
)
tlsClient, err := httptransport.TLSClient(httptransport.TLSClientOptions{
	InsecureSkipVerify: true,
})
if err != nil {
	fmt.Print(err)
	return
}
transport := httptransport.NewWithClient("192.168.29.157", "/v2/api", []string{"https"}, tlsClient)
client := apiclient.New(transport, strfmt.Default)

Send request

import proper client package

import (
  	vm "github.com/arcfraoffical/aoc-go-sdk/client/vm"
)

Authentication

Use NewWithUserConfig to create an ApiClient with authentication information

import (
	apiclient "github.com/arcfraoffical/aoc-go-sdk/client"
	"github.com/arcfraoffical/aoc-go-sdk/models"
)

client, err := apiclient.NewWithUserConfig(apiclient.ClientConfig{
	Host:     "localhost:8090",
	BasePath: "v2/api",
	Schemes:  []string{"http"},
}, apiclient.UserConfig{
	Name:     "Name",
	Password: "Password",
	Source:   models.UserSourceLOCAL,
})

Or add authentication information to ApiClient already created

import (
  User "github.com/arcfraoffical/aoc-go-sdk/client/user"
)
loginParams := User.NewLoginParams()
loginParams.RequestBody = &models.LoginInput{
	Username: pointy.String("username"),
	Password: pointy.String("password"),
	Source:   models.NewUserSource(models.UserSourceLOCAL),
}
logRes, err := client.User.Login(loginParams)
if err != nil {
	return err
}
transport.DefaultAuthentication = httptransport.APIKeyAuth("Authorization", "header", *logRes.Payload.Data.Token)

List resource

getVmParams := vm.NewGetVmsParams();
getVmParams.RequestBody = &models.GetVmsRequestBody{
	Where: &models.VMWhereInput{
		ID: pointy.String("vm_id"),
	},
}
vmsRes, err := client.VM.GetVms(getVmParams)
if err != nil {
	return err
}
vms := vmsRes.Payload

Update resource

Update resource will generate related asynchronous tasks, when the asynchronous task is completed, it means the resource operation is completed and the data is updated.

target_vm := vmsRes.Payload[0]
vmStartParams := vm.NewStartVMParams()
vmStartParams.RequestBody = &models.VMStartParams{
	Where: &models.VMWhereInput{
		ID: target_vm.ID,
	},
}
startRes, err := client.VM.StartVM(vmStartParams)
if err != nil {
	return err
}

WaitTask will wait for the asynchronous task to complete, if the task fails or times out, an exception will be returned.

task := *startRes.Payload[0].TaskID
err = utils.WaitTask(context.TODO(), client, task, 1*time.Second)
if err != nil {
	return err
}

For multiple tasks, you can use WaitTasks, which accepts multiple task ids, the rest is the same as WaitTask.

tasks := funk.Map(startRes.Payload, func(tvm *models.WithTaskVM) string {
	return *tvm.TaskID
}).([]string)
err = utils.WaitTask(context.TODO(), client, tasks, 1*time.Second)
if err != nil {
	return err
}