Go SDK: アプリケーションの管理

このページのメソッドはすべて c.Apps にあり、第 1 引数に ctx、次にアプリ ID を取ります。appID には、workspace を通じて共有されたアプリの複合 ID <appId>-<workspaceId> も指定できます。以下の各スニペットは、このプログラムの中で単独で動作します。1 つずつ main に貼り付けて goimports を実行してください (サンプルの実行を参照)。

package main

import (
	"context"
	"os"

	"github.com/squarecloudofc/sdk-api-go/v3"
)

var (
	ctx   = context.Background()
	c     = squarecloud.New(os.Getenv("SQUARECLOUD_API_KEY"))
	appID = "abc123def456abc123def456"
)

func main() {
	// Paste one snippet here, then run goimports.
}

アプリを一覧するには c.Account.Me を使います。その Applications スライスに、キーから見えるすべてのアプリが含まれています。

アプリケーションの取得

app, err := c.Apps.Get(ctx, appID)
if err != nil {
	log.Fatal(err)
}

fmt.Println(app.ID, app.Name, app.Language, app.RAM, app.Cluster, app.CreatedAt)

フィールド	型	説明
`ID` (`id`)	`string`	アプリ ID
`Name` (`name`)	`string`	表示名
`Description` (`desc`)	`string`	説明。設定されていない場合は `""`
`Owner` (`owner`)	`string`	所有者のユーザー ID
`Cluster` (`cluster`)	`string`	アプリが動作しているクラスター
`RAM` (`ram`)	`int`	割り当てられた RAM (MB)
`Language` (`language`)	`string`	ランタイムの言語
`Domain` (`domain`)	`*string`	デフォルトの `<subdomain>.squareweb.app` ホスト。Web 以外のアプリでは `nil`
`Custom` (`custom`)	`*string`	カスタムドメイン。設定されていない場合は `nil`
`CreatedAt` (`created_at`)	`time.Time`	作成日

ステータス

Status(ctx, appID) は、フォーマット済みの値でライブの状態を返します:

status, err := c.Apps.Status(ctx, appID)
if err != nil {
	log.Fatal(err)
}

fmt.Println(status.Status)  // e.g. "running", "exited"
fmt.Println(status.Running) // true
fmt.Println(status.CPU)     // "0.5%"
fmt.Println(status.RAM)     // "120.4MB" (RAM in use)
fmt.Println(status.Storage, status.Network.Total, status.Network.Now)
if status.Uptime != nil {
	fmt.Println(*status.Uptime) // Unix ms of the last start; nil when stopped
}

StatusRaw(ctx, appID) は代わりに数値を返します (CPU は %、RAM は MB、Storage はバイト、Network.Total と Network.Now は [in, out] のバイト数のペア):

raw, err := c.Apps.StatusRaw(ctx, appID)
if err != nil {
	log.Fatal(err)
}

fmt.Println(raw.CPU, raw.RAM, raw.Network.Total) // 0.5 120.4 [1024 2048]

Uptime は期間ではなくタイムスタンプ (アプリが起動した時刻) です。稼働時間を求めるには time.Since(time.UnixMilli(*status.Uptime)) を使います。

すべてのアプリケーションのステータス

StatusAll(ctx, workspaceID) は、キーから見えるアプリごとに 1 つのサマリーを、1 回のリクエストで返します。すべてのアプリを対象にするには "" を、特定の workspace のアプリだけを対象にするにはその workspace の ID を渡します。CPU と RAM はアプリの実行中にのみ設定されます ("" になりません)。

items, err := c.Apps.StatusAll(ctx, "")
if err != nil {
	log.Fatal(err)
}
for _, it := range items {
	if it.Running {
		fmt.Println(it.ID, it.CPU, it.RAM)
	} else {
		fmt.Println(it.ID, "stopped")
	}
}

起動、停止、再起動

if err := c.Apps.Start(ctx, appID); err != nil {
	log.Fatal(err)
}
if err := c.Apps.Stop(ctx, appID); err != nil {
	log.Fatal(err)
}
if err := c.Apps.Restart(ctx, appID); err != nil {
	log.Fatal(err)
}

サーバーはコンテナが処理を終えるまでこれらの呼び出しを保持するため、ctx に期限がない場合、タイムアウトまで最低 2 分待機します。プラットフォームが操作を拒否した場合、呼び出しはステータス 409、Code、そして空の Message を持つ *APIError を返します:

コード	意味
`CONTAINER_ALREADY_STARTED`	実行中のアプリに対する `start`
`CONTAINER_ALREADY_STOPPED`	停止中のアプリに対する `stop`
`CONTAINER_TEMPORARILY_SUSPENDED`	アプリが一時停止されている
`CONTAINER_NOT_FOUND`	コンテナがクラスター上に存在しない
`CONTAINER_INSUFFICIENT_DISK_SPACE`	起動に必要なディスク容量が足りない
`CONTAINER_NETWORK_CONFLICT`	クラスター上でネットワークの競合が発生した
`ACTION_FAILED`	クラスターが操作を実行できなかった

「すでに起動済み」と「すでに停止済み」もエラーです。それらが成功を意味する場合は、自分で処理してください:

err := c.Apps.Start(ctx, appID)

var apiErr *squarecloud.APIError
if err != nil && !(errors.As(err, &apiErr) && apiErr.Code == squarecloud.CodeContainerAlreadyStarted) {
	log.Fatal(err)
}

ログ

Logs(ctx, appID) は、最新のコンソール出力を 1 つの文字列として返します (何もない場合は "")。

logs, err := c.Apps.Logs(ctx, appID)
if err != nil {
	log.Fatal(err)
}
fmt.Println(logs)

ログをライブでストリーミングするには、リアルタイムを使います。

メトリクス

Metrics(ctx, appID) は直近 24 時間分を、5 分ごとに 1 ポイント、新しい順で返します。

points, err := c.Apps.Metrics(ctx, appID)
if err != nil {
	log.Fatal(err)
}
if len(points) > 0 {
	latest := points[0]
	fmt.Println(latest.Date, latest.CPU, latest.RAM, latest.Net)
}

ドメインとロードバランサー

Domains(ctx) は、すべてのアプリのデフォルトホスト名とカスタムホスト名を一覧します。LoadBalancers(ctx) は、複数のアプリで共有されているドメインを、プランの上限とともに一覧します。

domains, err := c.Apps.Domains(ctx)
if err != nil {
	log.Fatal(err)
}
for _, d := range domains {
	fmt.Println(d.AppID, d.Hostname, d.Type) // Type: "subdomain" | "custom"
}

lb, err := c.Apps.LoadBalancers(ctx)
if err != nil {
	log.Fatal(err)
}
fmt.Println(lb.Limit)
for _, balancer := range lb.Balancers {
	ids := make([]string, 0, len(balancer.Apps))
	for _, app := range balancer.Apps {
		ids = append(ids, app.ID)
	}
	fmt.Println(balancer.Hostname, ids)
}

カスタムドメインを設定するには、ネットワークを参照してください。

アプリケーションの削除

if err := c.Apps.Delete(ctx, appID); err != nil {
	log.Fatal(err)
}

削除は元に戻せません。ファイルが再び必要になる可能性がある場合は、先に snapshot を作成してください。

次のステップ

Commit とアップロード

zip からアプリを作成するか、既存のアプリにファイルを送信します。

アプリケーション API リファレンス

これらのメソッドが呼び出す REST endpoint。

CLI でアプリを管理

同じ操作をターミナルから行います。

CLI

VS Code

SDKs

Go SDK: アプリケーションの管理

アプリケーションの取得

ステータス

すべてのアプリケーションのステータス

起動、停止、再起動

ログ

メトリクス

ドメインとロードバランサー

アプリケーションの削除

次のステップ

Commit とアップロード

アプリケーション API リファレンス

CLI でアプリを管理

​アプリケーションの取得

​ステータス

​すべてのアプリケーションのステータス

​起動、停止、再起動

​ログ

​メトリクス

​ドメインとロードバランサー

​アプリケーションの削除

​次のステップ

Commit とアップロード

アプリケーション API リファレンス

CLI でアプリを管理

アプリケーションの取得

ステータス

すべてのアプリケーションのステータス

起動、停止、再起動

ログ

メトリクス

ドメインとロードバランサー

アプリケーションの削除

次のステップ