Categorygithub.com/sacloud/webaccel-api-go
modulepackage
1.2.0
Repository: https://github.com/sacloud/webaccel-api-go.git
Documentation: pkg.go.dev

# README

webaccel-api-go

Go Reference Tests Go Report Card

ウェブアクセラレータAPI をGo言語から扱うためのライブラリ

Overview

従来はiaas-api-go(libsacloud v2)で提供していたAPIライブラリを独立したリポジトリとして切り出したものです。

webaccel-api-goを利用したクライアントコードの例

package example

import (
	"context"
	"log"

	"github.com/sacloud/webaccel-api-go"
)

func Example() {
	// デフォルトではusacloudプロファイルや環境変数が利用される。
	// パラメータを指定することで上書きしたり無効化したりできる
	client := &webaccel.Client{
		//Profile:           "default",
		//AccessToken:       "token",
		//AccessTokenSecret: "secret",
		//DisableProfile:    false,
		//DisableEnv:        false,
	}
	op := webaccel.NewOp(client)

	// サイト一覧
	found, err := op.List(context.Background())
	if err != nil {
		panic(err)
	}
	log.Println(found)

	// 全キャッシュ削除
	deleteAllCacheRequest := &webaccel.DeleteAllCacheRequest{
		Domain: "example.com",
	}
	if err := op.DeleteAllCache(context.Background(), deleteAllCacheRequest); err != nil {
		panic(err)
	}

	// URLごとにキャッシュ削除
	deleteCacheRequest := &webaccel.DeleteCacheRequest{
		URL: []string{
			"https://example.com/url1",
			"https://example.com/url2",
		},
	}
	if _, err := op.DeleteCache(context.Background(), deleteCacheRequest); err != nil {
		panic(err)
	}
}

Installation

Use go get.

go get github.com/sacloud/webaccel-api-go

Then import the webaccel package into your own code.

import "github.com/sacloud/webaccel-api-go"

License

webaccel-api-go Copyright 2022-2023 The webaccel-api-go authors.

This project is published under Apache 2.0 License.

# Functions

IsNotFoundError 指定のerrorがAPI呼び出し時の404エラーであるか判定.
NewAPIError APIコール時のエラー情報.
NewOp creates new Op instance.

# Constants

DefaultAPIRootURL デフォルトのAPIルートURL.
無効.
有効.
OriginProtocol.
OriginProtocol.
オブジェクトストレージ.
ウェブサーバ.
http/https.
httpsのみ.
httpsに」リダイレクト.
無効.
有効.

# Variables

UserAgent APIリクエスト時のユーザーエージェント.
Version app version.

# Structs

No description provided by the author
APIErrorResponse APIエラー型.
Certificates 証明書.
Client APIクライアント.
CORSRule .
CreateOrUpdateCertificateRequest .
CurrentCertificate 現在有効な証明書.
DeleteAllCacheRequest .
DeleteCacheRequest .
DeleteCacheResult .
Issuer .
ListSitesResult .
No description provided by the author
MonthlyUsageResults 月別使用量.
OldCertificate .
Op implements WebAccelAPI interface.
Site サイト.
Subject .
UpdateSiteRequest サイト更新リクエスト.

# Interfaces

API is interface for operate WebAccel resource.
No description provided by the author
APIError APIコール時のエラー情報.