AppRun専有型 API (1.0.0)

Download OpenAPI specification:Download

「AppRun専有型」が提供するAPIの利用方法とサンプルを公開しております。

基本的な使い方

APIキーの発行

APIを利用するためには、認証のための「APIキー」が必要です。事前にキーを発行しておきます。
APIキーは「ユーザーID」「パスワード」に相当する「トークン」と呼ばれる認証情報で構成されています。

項目名	APIキー発行時の項目名	このドキュメント内での例
ユーザーID	アクセストークン(UUID)	01234567-89ab-cdef-0123-456789abcdef
パスワード	アクセストークンシークレット	SAMPLETOKENSAMPLETOKENSAMPLETOKENSAM

操作マニュアル

APIキー | さくらのクラウドドキュメント

APIエンドポイント

https://secure.sakura.ad.jp/cloud/api/apprun-dedicated/1.0/

application

新しいアプリケーションの作成

指定したクラスタに新しいアプリケーションを作成します。1アカウントにつき最大10個まで作成可能です。

Authorizations:

BasicAuth

Request Body schema: application/json

name required	string [ 1 .. 20 ] characters ^[a-zA-Z0-9_-]+$ アプリケーションの名前｡クラスタの中ではユニーク｡英数字とハイフン、アンダースコアのみ使用可能
clusterID required	string <uuid> デプロイ先クラスタ

Responses

Request samples

Payload

Content type

application/json

{"name": "bbs",
"clusterID": "13B9EA83-DDB0-4385-9533-3D693A6A310F"
}

Response samples

200
default

Content type

application/json

{"application": {"applicationID": "979babab-c201-4997-9c92-520a4ce5feff"
}
}

アカウント内のアプリケーション一覧の取得

指定したアカウントに紐づくアプリケーションの一覧を返します。

Authorizations:

BasicAuth

query Parameters

clusterID	string <uuid> (ClusterID) Example: clusterID=13B9EA83-DDB0-4385-9533-3D693A6A310F
cursor	string 前ページの最後のID。これ以降のデータを取得するためのカーソル。ページネーションに利用します。
maxItems required	integer <int64> [ 1 .. 30 ] Default: 20 1ページあたりの最大取得件数。

Responses

Response samples

200
default

Content type

application/json

{"applications": [{"applicationID": "A0199B39-B361-45B9-8DF4-FC8BE494D690",
"name": "my-app",
"clusterID": "13B9EA83-DDB0-4385-9533-3D693A6A310F",
"clusterName": "mock-cluster",
"activeVersion": 3,
"desiredCount": 3,
"scalingCooldownSeconds": 300
}
]
}

アプリケーションの詳細情報を取得する

指定したアプリケーションIDの詳細情報を返します。

Authorizations:

BasicAuth

path Parameters

applicationID

required

string <uuid> (ApplicationID)

Responses

Response samples

200
default

Content type

application/json

{"application": {"applicationID": "A0199B39-B361-45B9-8DF4-FC8BE494D690",
"name": "my-app",
"clusterID": "13B9EA83-DDB0-4385-9533-3D693A6A310F",
"clusterName": "mock-cluster",
"activeVersion": 3,
"desiredCount": 3,
"scalingCooldownSeconds": 300
}
}

アプリケーション情報の更新

アプリケーションのactiveVersionなどを更新します。クラスタの変更はできません。activeVersionを変更すると指定したバージョンがデプロイされます。activeVersionをnullにするとアプリケーションは非アクティブ状態になり､デプロイされなくなります。アプリケーション削除前には activeVersion を null にする必要があります｡

Authorizations:

BasicAuth

path Parameters

applicationID

required

string <uuid> (ApplicationID)

Request Body schema: application/json

activeVersion

required

integer or null <int32>

利用しているバージョン

Responses

Request samples

Payload

Content type

application/json

{"activeVersion": 3
}

Response samples

default

Content type

application/json

{"status": 0,
"title": "string"
}

アプリケーションの削除

指定したアプリケーションを削除します。

前提条件

当該アプリケーションに アクティブなバージョンが存在しない こと
いずれのワーカーノードでも当該アプリケーションの コンテナが稼働していない こと

Authorizations:

BasicAuth

path Parameters

applicationID

required

string <uuid> (ApplicationID)

Responses

Response samples

default

Content type

application/json

{"status": 0,
"title": "string"
}

アプリケーションのノードごとのコンテナ配置情報を取得

指定したアプリケーションの各ワーカーノード上でのコンテナ配置情報を返します。

Authorizations:

BasicAuth

path Parameters

applicationID

required

string <uuid> (ApplicationID)

Responses

Response samples

200
default

Content type

application/json

{"nodes": [{"nodeID": "b7e6a1c2-3f4d-4e2a-9b1a-2c3d4e5f6a7b",
"containersStats": {"collectedAtSec": 1721203200,
"containers": [{"id": "container-1",
"image": "nginx:latest",
"state": "running",
"status": "Up 5 minutes",
"cpuUsagePercent": 12.5,
"applicationID": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"applicationVersion": 2
}
]
},
"desired": {"containers": [ ]
}
},
{"nodeID": "c8f7b2d3-4e5f-5a6b-8c2d-3e4f5a6b7c8d",
"containersStats": {"collectedAtSec": 1721203200,
"containers": [ ]
},
"desired": {"containers": [{"applicationID": "9c858901-8a57-4791-81fe-4c455b099bc9",
"applicationVersion": 1,
"cpuMillis": 250,
"memoryMB": 128,
"image": "redis:alpine"
}
]
}
}
]
}

application_version

アプリケーションバージョンの作成

アプリケーションバージョンを作成します｡アプリケーションバージョンを作成するだけではノードにデプロイされません｡アプリケーションのアクティブバージョンに指定するとノードにデプロイされます｡

Authorizations:

BasicAuth

path Parameters

applicationID

required

string <uuid> (ApplicationID)

Request Body schema: application/json

cpu required	integer <int64> [ 100 .. 64000 ]
memory required	integer <int64> [ 128 .. 131072 ]
scalingMode required	string (ScalingMode) Enum: "manual" "cpu"
fixedScale	integer <int32> [ 1 .. 50 ]
minScale	integer <int32> [ 1 .. 50 ]
maxScale	integer <int32> [ 1 .. 50 ]
scaleInThreshold	integer <int32> [ 30 .. 70 ]
scaleOutThreshold	integer <int32> [ 50 .. 99 ]
image required	string <= 512 characters
cmd	Array of strings <= 20 items コンテナ起動時に実行するコマンドと引数
registryUsername required	string or null <= 255 characters
registryPassword required	string or null <= 255 characters
registryPasswordAction required	string Enum: "keep" "remove" "new" レジストリパスワードの設定方法
required	Array of objects (ExposedPort) <= 5 items アプリケーションが公開するポート番号｡同一クラスタ内で､ポートの重複不可｡
required	Array of objects (CreateEnvironmentVariable) <= 50 items 環境変数

Responses

Request samples

Payload

Content type

application/json

{"cpu": 500,
"memory": 1000,
"scalingMode": "manual",
"fixedScale": 1,
"minScale": 1,
"maxScale": 3,
"scaleInThreshold": 30,
"scaleOutThreshold": 95,
"image": "nginx:latest",
"cmd": ["string"
],
"registryUsername": "string",
"registryPassword": "string",
"registryPasswordAction": "keep",
"exposedPorts": [{"targetPort": 8443,
"loadBalancerPort": 8443,
"useLetsEncrypt": true,
"host": ["string"
],
"healthCheck": {"path": "/healthz",
"intervalSeconds": 30,
"timeoutSeconds": 5
}
}
],
"env": [{"key": "string",
"value": "string",
"secret": true
}
]
}

Response samples

200
default

Content type

application/json

{"applicationVersion": {"version": 3
}
}

アプリケーションバージョン一覧の取得

指定されたアプリケーションのバージョン一覧取得

Authorizations:

BasicAuth

path Parameters

applicationID

required

string <uuid> (ApplicationID)

query Parameters

cursor	integer <int32> (ApplicationVersionNumber) >= 1 Example: cursor=3 前ページの最後のID。これ以降のデータを取得するためのカーソル。
maxItems required	integer <int64> [ 1 .. 30 ] Default: 30

Responses

Response samples

200
default

Content type

application/json

{"versions": [{"version": 3,
"image": "nginx:2",
"activeNodeCount": 1,
"created": 1577836800
},
{"version": 2,
"image": "nginx:2",
"activeNodeCount": 0,
"created": 1577836800
},
{"version": 1,
"image": "nginx:1",
"activeNodeCount": 0,
"created": 1577836800
}
]
}

アプリケーションバージョンの削除

現在ノードにデプロイされているバージョンおよびアクティブなバージョンは削除出来ない｡

Authorizations:

BasicAuth

path Parameters

applicationID required	string <uuid> (ApplicationID)
version required	integer <int32> (ApplicationVersionNumber) >= 1 Example: 3

Responses

Response samples

default

Content type

application/json

{"status": 0,
"title": "string"
}

アプリケーションバージョンの詳細取得

指定されたバージョンの詳細取得

Authorizations:

BasicAuth

path Parameters

applicationID required	string <uuid> (ApplicationID)
version required	integer <int32> (ApplicationVersionNumber) >= 1 Example: 3

Responses

Response samples

200
default

Content type

application/json

{"applicationVersion": {"version": 3,
"cpu": 500,
"memory": 500,
"scalingMode": "cpu",
"minScale": 1,
"maxScale": 2,
"image": "nginx:2",
"registryUsername": null,
"registryPassword": null,
"exposedPorts": [{"targetPort": 8080,
"loadBalancerPort": 80,
"useLetsEncrypt": false,
"healthCheck": {"path": "/healthz",
"intervalSeconds": 10,
"timeoutSeconds": 30
}
},
{"targetPort": 8084,
"loadBalancerPort": 443,
"host": ["example.com"
],
"useLetsEncrypt": true,
"healthCheck": {"path": "/monitoring/l7check",
"intervalSeconds": 10,
"timeoutSeconds": 30
}
}
],
"env": [{"key": "ENV_VAR",
"value": "value",
"secret": false
},
{"key": "DB_PASSWORD",
"value": "****",
"secret": true
}
],
"activeNodeCount": 1,
"created": 1577836800
}
}

certificate

証明書の作成

新しい証明書を作成します。

Authorizations:

BasicAuth

path Parameters

clusterID

required

string <uuid> (ClusterID)

Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

Request Body schema: application/json

name required	string [ 1 .. 20 ] characters ^[a-zA-Z0-9_.-]+$ 証明書の名前｡クラスタ内でユニーク｡英数字、アンダースコア、ハイフン､ドットのみ使用可能
certificatePem required	string <= 1000000 characters 証明書のPEM形式の文字列
privatekeyPem required	string <= 1000000 characters 証明書の秘密鍵のPEM形式の文字列
intermediateCertificatePem	string <= 1000000 characters 証明書のチェーン証明書のPEM形式の文字列

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"certificatePem": "string",
"privatekeyPem": "string",
"intermediateCertificatePem": "string"
}

Response samples

200
default

Content type

application/json

{"certificate": {"certificateID": "13B9EA83-DDB0-4385-9533-3D693A6A310F"
}
}

証明書の一覧を取得

クラスタ内の証明書一覧を返します。ページネーションに対応します。

Authorizations:

BasicAuth

path Parameters

clusterID

required

string <uuid> (ClusterID)

Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

query Parameters

lastCertificateID	string <uuid> (CertificateID) Example: lastCertificateID=13B9EA83-DDB0-4385-9533-3D693A6A310F
cursor	string <uuid> (CertificateID) Example: cursor=13B9EA83-DDB0-4385-9533-3D693A6A310F 前ページの最後のID。これ以降のデータを取得するためのカーソル。
maxItems required	integer <int64> [ 5 .. 30 ] Default: 20

Responses

Response samples

200
default

Content type

application/json

{"certificates": [{"certificateID": "13B9EA83-DDB0-4385-9533-3D693A6A310F",
"name": "example-certificate",
"commonName": "example.com",
"subjectAlternativeNames": ["www.example.com",
"api.example.com"
],
"notBeforeSec": 1577836800,
"notAfterSec": 1640995200,
"created": 1577836800,
"updated": 1577836800
}
]
}

証明書の詳細を取得

指定した証明書の詳細情報を返します。

Authorizations:

BasicAuth

path Parameters

clusterID required	string <uuid> (ClusterID) Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F
certificateID required	string <uuid> (CertificateID) Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

Responses

Response samples

200
default

Content type

application/json

{"certificate": {"certificateID": "83B9EA83-DDB0-4385-9533-3D693A6A310F",
"name": "my-certificate",
"commonName": "example.com",
"subjectAlternativeNames": ["www.example.com",
"api.example.com"
],
"notBeforeSec": 1577836800,
"notAfterSec": 1640995200,
"created": 1577836800,
"updated": 1577836800
}
}

証明書の削除

指定した証明書を削除します。

Authorizations:

BasicAuth

path Parameters

clusterID required	string <uuid> (ClusterID) Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F
certificateID required	string <uuid> (CertificateID) Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

Responses

Response samples

default

Content type

application/json

{"status": 0,
"title": "string"
}

証明書の更新

指定した証明書を更新します。

Authorizations:

BasicAuth

path Parameters

clusterID required	string <uuid> (ClusterID) Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F
certificateID required	string <uuid> (CertificateID) Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

Request Body schema: application/json

name required	string [ 1 .. 20 ] characters ^[a-zA-Z0-9_.-]+$ 証明書の名前｡クラスタ内でユニーク｡英数字、アンダースコア、ハイフン､ドットのみ使用可能
certificatePem required	string <= 1000000 characters 証明書のPEM形式の文字列
privatekeyPem required	string <= 1000000 characters 証明書の秘密鍵のPEM形式の文字列
intermediateCertificatePem	string <= 1000000 characters 証明書のチェーン証明書のPEM形式の文字列

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"certificatePem": "string",
"privatekeyPem": "string",
"intermediateCertificatePem": "string"
}

Response samples

default

Content type

application/json

{"status": 0,
"title": "string"
}

cluster

クラスタの作成

新しいクラスタを作成します。作成後にクラスタIDを返します。

Authorizations:

BasicAuth

Request Body schema: application/json

name required	string [ 1 .. 20 ] characters ^[a-zA-Z0-9_-]+$ クラスターの名前｡プロジェクト内でユニーク｡英数字、アンダースコア、ハイフンのみ使用可能
letsEncryptEmail	string (let's encrypt のメールアドレス) ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2... let's encrypt による証明書発行を有効にするにはここにメールアドレスを設定します｡ let's encrypt による証明書発行は HTTP-01 Challenge になるため､80 番ポートを HTTP Protocol で外向きに解放する必要があります｡
required	Array of objects (CreateLoadBalancerPort) <= 5 items ロードバランサーのポート群
servicePrincipalID required	string = 12 characters サービスプリンシパルのID

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"letsEncryptEmail": "string",
"ports": [{"port": 8080,
"protocol": "http"
}
],
"servicePrincipalID": "123456789012"
}

Response samples

200
default

Content type

application/json

{"cluster": {"clusterID": "13B9EA83-DDB0-4385-9533-3D693A6A310F"
}
}

クラスタの一覧の取得

アカウントに紐づくクラスタの一覧を返します。ページネーションに対応します。

Authorizations:

BasicAuth

query Parameters

lastClusterID	string <uuid> (ClusterID) Example: lastClusterID=13B9EA83-DDB0-4385-9533-3D693A6A310F
cursor	string <uuid> (ClusterID) Example: cursor=13B9EA83-DDB0-4385-9533-3D693A6A310F 前ページの最後のID。これ以降のデータを取得するためのカーソル。
maxItems required	integer <int64> [ 5 .. 30 ] Default: 20

Responses

Response samples

200
default

Content type

application/json

{"clusters": [{"clusterID": "13B9EA83-DDB0-4385-9533-3D693A6A310F",
"name": "mock-cluster",
"hasLetsEncryptEmail": true,
"ports": [{"port": 80,
"protocol": "http"
},
{"port": 443,
"protocol": "https"
}
],
"autoScalingGroups": [ ],
"servicePrincipalID": "123456789012",
"created": 1577836800
}
]
}

クラスタの詳細の取得

指定したクラスタの詳細情報を返します。

Authorizations:

BasicAuth

path Parameters

clusterID

required

string <uuid> (ClusterID)

Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

Responses

Response samples

200
default

Content type

application/json

{"cluster": {"clusterID": "13B9EA83-DDB0-4385-9533-3D693A6A310F",
"name": "mock-cluster",
"hasLetsEncryptEmail": true,
"ports": [{"port": 80,
"protocol": "http"
},
{"port": 443,
"protocol": "https"
}
],
"servicePrincipalID": "123456789012",
"autoScalingGroups": [ ],
"created": 1577836800
}
}

クラスタの削除

指定したクラスタを削除します。

Authorizations:

BasicAuth

path Parameters

clusterID

required

string <uuid> (ClusterID)

Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

Responses

Response samples

default

Content type

application/json

{"status": 0,
"title": "string"
}

クラスタの更新

指定したクラスタの設定を更新します。

Authorizations:

BasicAuth

path Parameters

clusterID

required

string <uuid> (ClusterID)

Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

Request Body schema: application/json

letsEncryptEmail	string (let's encrypt のメールアドレス) ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2... let's encrypt による証明書発行を有効にするにはここにメールアドレスを設定します｡ let's encrypt による証明書発行は HTTP-01 Challenge になるため､80 番ポートを HTTP Protocol で外向きに解放する必要があります｡
servicePrincipalID required	string サービスプリンシパルのID

Responses

Request samples

Payload

Content type

application/json

{"letsEncryptEmail": "string",
"servicePrincipalID": "123456789012"
}

Response samples

default

Content type

application/json

{"status": 0,
"title": "string"
}

Auto Scaling Groupの作成

新しい Auto Scaling Group を作成します。

Authorizations:

BasicAuth

path Parameters

clusterID

required

string <uuid> (ClusterID)

Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

Request Body schema: application/json

name required	string [ 1 .. 20 ] characters ^[a-zA-Z0-9_-]+$ オートスケーリンググループの名前｡クラスタ内でユニーク｡英数字とアンダースコア、ハイフンのみ使用可能
zone required	string オートスケーリンググループのゾーン
nameServers	Array of strings (IPv4) [ 1 .. 3 ] items ネームサーバー設定
workerServiceClassPath required	string [ 1 .. 255 ] characters ワーカーのサービスクラスパス
minNodes required	integer <int32> [ 1 .. 10 ] オートスケーリンググループの最小ノード数
maxNodes required	integer <int32> [ 1 .. 10 ] オートスケーリンググループの最大ノード数
required	Array of objects (ネットワークインターフェース定義) [ 1 .. 5 ] items

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"zone": "string",
"nameServers": ["string"
],
"workerServiceClassPath": "string",
"minNodes": 1,
"maxNodes": 1,
"interfaces": [{"interfaceIndex": 0,
"upstream": "string",
"ipPool": [{"start": "string",
"end": "string"
}
],
"netmaskLen": 8,
"defaultGateway": "string",
"packetFilterID": "string",
"connectsToLB": true
}
]
}

Response samples

200
default

Content type

application/json

{"autoScalingGroup": {"autoScalingGroupID": "0470126e-1506-4003-9575-234080cbd767"
}
}

Auto Scaling Groupの一覧を取得

クラスタに所属する Auto Scaling Group の一覧を返します。ページネーションに対応します。

Authorizations:

BasicAuth

path Parameters

clusterID

required

string <uuid> (ClusterID)

Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

query Parameters

lastAutoScalingGroupID	string <uuid> (AutoScalingGroupID)
cursor	string <uuid> (AutoScalingGroupID) 前ページの最後のID。これ以降のデータを取得するためのカーソル。
maxItems required	integer <int64> [ 1 .. 30 ] Default: 20

Responses

Response samples

200
default

Content type

application/json

{"autoScalingGroups": [{"autoScalingGroupID": "123e4567-e89b-12d3-a456-426614174001",
"name": "tokyo-asg",
"zone": "tk1b",
"minNodes": 2,
"maxNodes": 10,
"workerNodeCount": 3,
"workerServiceClassPath": "cloud/apprun/dedicated/worker/1vcpu_2gb",
"deleting": false,
"interfaces": [{"interfaceIndex": 1,
"ipPool": [{"start": "192.0.1.0",
"end": "192.0.1.255"
}
],
"netmaskLen": 24,
"upstream": "111111111111",
"packetFilterID": "pf-123456",
"defaultGateway": "192.0.1.1",
"connectsToLB": true
},
{"interfaceIndex": 2,
"ipPool": [{"start": "192.0.2.0",
"end": "192.0.2.255"
}
],
"netmaskLen": 24,
"upstream": "111111111112",
"connectsToLB": false
}
]
}
]
}

Auto Scaling Groupの詳細を取得

指定した Auto Scaling Group の詳細情報を返します。

Authorizations:

BasicAuth

path Parameters

clusterID required	string <uuid> (ClusterID) Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F
autoScalingGroupID required	string <uuid> (AutoScalingGroupID)

Responses

Response samples

200
default

Content type

application/json

{"autoScalingGroup": {"autoScalingGroupID": "123e4567-e89b-12d3-a456-426614174001",
"name": "tokyo-asg",
"zone": "tk1b",
"minNodes": 2,
"maxNodes": 10,
"workerNodeCount": 3,
"workerServiceClassPath": "cloud/apprun/dedicated/worker/1vcpu_2gb",
"deleting": false,
"interfaces": [{"interfaceIndex": 1,
"netmaskLen": 24,
"upstream": "111111111111",
"packetFilterID": "pf-123456",
"defaultGateway": "192.0.1.1",
"connectsToLB": true
},
{"interfaceIndex": 2,
"netmaskLen": 24,
"upstream": "111111111112",
"connectsToLB": false
}
]
}
}

Auto Scaling Groupの削除

指定した Auto Scaling Group を削除します。

Authorizations:

BasicAuth

path Parameters

clusterID required	string <uuid> (ClusterID) Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F
autoScalingGroupID required	string <uuid> (AutoScalingGroupID)

Responses

Response samples

default

Content type

application/json

{"status": 0,
"title": "string"
}

ロードバランサーの作成

指定したAuto Scaling Groupにロードバランサーを作成します。

Authorizations:

BasicAuth

path Parameters

clusterID required	string <uuid> (ClusterID) Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F
autoScalingGroupID required	string <uuid> (AutoScalingGroupID)

Request Body schema: application/json

name required	string [ 1 .. 20 ] characters ^[a-zA-Z0-9_-]+$ 名称
serviceClassPath required	string [ 1 .. 255 ] characters ロードバランサーのサービスクラスパス
nameServers	Array of strings (IPv4) [ 1 .. 3 ] items ネームサーバー設定
required	Array of objects (LoadBalancerInterface) [ 1 .. 5 ] items ロードバランサーのインターフェース

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"serviceClassPath": "string",
"nameServers": ["string"
],
"interfaces": [{"interfaceIndex": 0,
"upstream": "string",
"ipPool": [{"start": "string",
"end": "string"
}
],
"netmaskLen": 8,
"defaultGateway": "string",
"vip": "string",
"virtualRouterID": 0,
"packetFilterID": "string"
}
]
}

Response samples

200
default

Content type

application/json

{"loadBalancer": {"loadBalancerID": "123e4567-e89b-12d3-a456-426614174000"
}
}

ロードバランサーの一覧を取得

Auto Scaling Group に属するロードバランサーの一覧を返します。ページネーションに対応します。

Authorizations:

BasicAuth

path Parameters

clusterID required	string <uuid> (ClusterID) Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F
autoScalingGroupID required	string <uuid> (AutoScalingGroupID)

query Parameters

cursor	string <uuid> (LoadBalancerID)
maxItems required	integer <int64> [ 2 .. 30 ] Default: 20

Responses

Response samples

200
default

Content type

application/json

{"loadBalancers": [{"loadBalancerID": "550e8400-e29b-41d4-a716-446655440000",
"name": "example-lb",
"serviceClassPath": "cloud/apprun/dedicated/lb/1vcpu_2gb_1",
"created": 1577836800,
"deleting": false
},
{"loadBalancerID": "550e8400-e29b-41d4-a716-446655440001",
"name": "another-lb",
"serviceClassPath": "cloud/apprun/dedicated/lb/1vcpu_2gb_1",
"created": 1577836800,
"deleting": true
}
]
}

ロードバランサーの詳細を取得

指定したロードバランサーの詳細情報を返します。

Authorizations:

BasicAuth

path Parameters

clusterID required	string <uuid> (ClusterID) Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F
autoScalingGroupID required	string <uuid> (AutoScalingGroupID)
loadBalancerID required	string <uuid> (LoadBalancerID)

Responses

Response samples

200
default

Content type

application/json

{"loadBalancer": {"loadBalancerID": "550e8400-e29b-41d4-a716-446655440000",
"name": "example-lb",
"serviceClassPath": "cloud/apprun/dedicated/lb/1vcpu_2gb_1",
"deleting": false,
"interfaces": [{"interfaceIndex": 1,
"vip": "192.168.1.100",
"netmaskLen": 24,
"virtualRouterID": 51,
"upstream": "switch1",
"packetFilterID": "pf-123456",
"defaultGateway": "192.168.1.0/32"
},
{"interfaceIndex": 2,
"netmaskLen": 24,
"upstream": "switch2"
}
],
"created": 1577836800
}
}

ロードバランサーを削除する

指定したロードバランサーを削除します。

Authorizations:

BasicAuth

path Parameters

clusterID required	string <uuid> (ClusterID) Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F
autoScalingGroupID required	string <uuid> (AutoScalingGroupID)
loadBalancerID required	string <uuid> (LoadBalancerID)

Responses

Response samples

default

Content type

application/json

{"status": 0,
"title": "string"
}

ロードバランサーノードの一覧を取得

指定したロードバランサーに属するノードの一覧を返します。

Authorizations:

BasicAuth

path Parameters

clusterID required	string <uuid> (ClusterID) Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F
autoScalingGroupID required	string <uuid> (AutoScalingGroupID)
loadBalancerID required	string <uuid> (LoadBalancerID)

query Parameters

cursor	string <uuid> (LoadBalancerID)
maxItems required	integer <int64> [ 2 .. 30 ] Default: 20

Responses

Response samples

200
default

Content type

application/json

{"loadBalancerNodes": [{"loadBalancerNodeID": "550e8400-e29b-41d4-a716-446655440001",
"resourceID": "12345678901",
"status": "healthy",
"interfaces": [{"interfaceIndex": 1,
"addresses": [{"address": "10.0.0.8/24",
"vip": false
},
{"address": "10.0.1.2/24",
"vip": true
}
]
},
{"interfaceIndex": 2,
"addresses": [{"address": "10.0.2.8/24",
"vip": false
},
{"address": "10.0.3.4/24",
"vip": true
}
]
}
],
"archiveVersion": "2025.1014.1",
"created": 1577836800
},
{"loadBalancerNodeID": "660e8400-e29b-41d4-a716-446655440001",
"resourceID": "12345678901",
"status": "healthy",
"interfaces": [{"interfaceIndex": 1,
"addresses": [{"address": "10.0.0.9/24",
"vip": false
}
]
}
],
"createErrorMessage": "クラスタのサービスプリンシパルにさくらのクラウドの作成・削除権限が付与されているか確認してください",
"created": 1577836800
}
]
}

ロードバランサーノードの詳細情報を取得

指定したロードバランサーノードの詳細情報を返します。

Authorizations:

BasicAuth

path Parameters

clusterID required	string <uuid> (ClusterID) Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F
autoScalingGroupID required	string <uuid> (AutoScalingGroupID)
loadBalancerID required	string <uuid> (LoadBalancerID)
loadBalancerNodeID required	string <uuid> (LoadBalancerNodeID)

Responses

Response samples

200
default

Content type

application/json

{"loadBalancerNode": {"loadBalancerNodeID": "550e8400-e29b-41d4-a716-446655440001",
"resourceID": "12345678901",
"status": "healthy",
"interfaces": [{"interfaceIndex": 1,
"addresses": [{"address": "10.0.0.2/24",
"vip": false
},
{"address": "10.0.1.2/24",
"vip": true
}
]
},
{"interfaceIndex": 2,
"addresses": [{"address": "10.0.2.8/24",
"vip": false
},
{"address": "10.0.3.4/24",
"vip": true
}
]
}
],
"archiveVersion": "2025.1014.1",
"createErrorMessage": "クラスタのサービスプリンシパルにさくらのクラウドの作成・削除権限が付与されているか確認してください",
"created": 1577836800
}
}

Auto Scaling Group に所属するワーカーノード一覧を取得

Auto Scaling Group に所属するワーカーノードの一覧を返します。ページネーションに対応します。

Authorizations:

BasicAuth

path Parameters

clusterID required	string <uuid> (ClusterID) Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F
autoScalingGroupID required	string <uuid> (AutoScalingGroupID)

query Parameters

cursor	string <uuid> (WorkerNodeID)
maxItems required	integer <int64> [ 2 .. 100 ] Default: 20

Responses

Response samples

200
default

Content type

application/json

{"workerNodes": [{"workerNodeID": "123e4567-e89b-12d3-a456-426614174002",
"resourceID": "worker-node-01",
"draining": false,
"status": "healthy",
"networkInterfaces": [{"interfaceIndex": 0,
"addresses": [{"address": "192.168.0.1"
}
]
},
{"interfaceIndex": 1,
"addresses": [{"address": "10.0.0.8"
}
]
}
],
"archiveVersion": "2025.1014.1",
"created": 1577836800
},
{"workerNodeID": "987f6543-e21a-45c3-b123-554433221101",
"resourceID": "worker-node-02",
"draining": true,
"status": "healthy",
"networkInterfaces": [{"interfaceIndex": 0,
"addresses": [{"address": "192.168.0.1"
}
]
},
{"interfaceIndex": 1,
"addresses": [{"address": "10.0.0.8"
}
]
}
],
"archiveVersion": "2025.1014.2",
"created": 1577836800
},
{"workerNodeID": "487f6543-e21a-45c3-b123-554433221101",
"resourceID": "worker-node-03",
"draining": true,
"status": "creating",
"networkInterfaces": [{"interfaceIndex": 0,
"addresses": [{"address": "192.168.0.1"
}
]
},
{"interfaceIndex": 1,
"addresses": [{"address": "10.0.0.8"
}
]
}
],
"archiveVersion": "2025.1014.3",
"created": 1577836800,
"createErrorMessage": "クラスタのサービスプリンシパルにさくらのクラウドの作成・削除権限が付与されているか確認してください"
}
]
}

Auto Scaling Group に所属するワーカーノードの詳細を取得

指定したワーカーノードの詳細情報を返します。

Authorizations:

BasicAuth

path Parameters

clusterID required	string <uuid> (ClusterID) Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F
autoScalingGroupID required	string <uuid> (AutoScalingGroupID)
workerNodeID required	string <uuid> (WorkerNodeID)

Responses

Response samples

200
default

Content type

application/json

{"workerNode": {"workerNodeID": "123e4567-e89b-12d3-a456-426614174002",
"resourceID": "worker-node-01",
"draining": false,
"healthy": true,
"creating": false,
"status": "healthy",
"created": 1577836800,
"runningContainers": [{"containerID": "container-01",
"name": "nginx",
"state": "running",
"status": "running",
"image": "nginx:latest",
"startedAt": 1577836800,
"applicationID": "A0199B39-B361-45B9-8DF4-FC8BE494D690",
"applicationVersion": 1
},
{"containerID": "container-02",
"name": "redis",
"state": "running",
"status": "running",
"image": "redis:latest",
"startedAt": 1577836800,
"applicationID": "A0199B39-B361-45B9-8DF4-FC8BE494D690",
"applicationVersion": 1
}
],
"networkInterfaces": [{"interfaceIndex": 0,
"addresses": [{"address": "10.0.0.1"
}
]
},
{"interfaceIndex": 1,
"addresses": [{"address": "192.168.0.1"
}
]
}
],
"archiveVersion": "2025.1014.1",
"createErrorMessage": "クラスタのサービスプリンシパルにさくらのクラウドの作成・削除権限が付与されているか確認してください"
}
}

ワーカーノードのdraining状態を変更する

指定したワーカーノードのdraining状態を更新します（draining を有効/無効にします）。

Authorizations:

BasicAuth

path Parameters

clusterID required	string <uuid> (ClusterID) Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F
autoScalingGroupID required	string <uuid> (AutoScalingGroupID)
workerNodeID required	string <uuid> (WorkerNodeID)

Request Body schema: application/json

draining

required

boolean

draining状態にするかどうか

Responses

Request samples

Payload

Content type

application/json

{"draining": true
}

Response samples

default

Content type

application/json

{"status": 0,
"title": "string"
}

service_class

ロードバランササービスクラス一覧

ロードバランサ用のサービスクラス一覧を返します。

Authorizations:

BasicAuth

Responses

Response samples

200
default

Content type

application/json

{"lbServiceClasses": [{"name": "1vCPU / 1GB メモリ * 1 (非冗長構成)",
"nodeCount": 1,
"path": "cloud/apprun/dedicated/lb/1vcpu_2gb_1"
},
{"name": "1vCPU / 1GB メモリ * 2 (冗長構成)",
"nodeCount": 2,
"path": "cloud/apprun/dedicated/lb/1vcpu_2gb_2"
},
{"name": "4vCPU / 4GB メモリ * 2 (冗長構成)",
"nodeCount": 2,
"path": "cloud/apprun/dedicated/lb/4vcpu_4gb_2"
}
]
}

ワーカノードサービスクラス一覧

ワーカーノード用のサービスクラス一覧を返します。

Authorizations:

BasicAuth

Responses

Response samples

200
default

Content type

application/json

{"workerServiceClasses": [{"name": "1vCPU / 1GB メモリ",
"path": "cloud/apprun/dedicated/worker/1vcpu_2gb"
},
{"name": "2vCPU / 2GB メモリ",
"path": "cloud/apprun/dedicated/worker/2vcpu_2gb"
},
{"name": "2vCPU / 4GB メモリ",
"path": "cloud/apprun/dedicated/worker/2vcpu_4gb"
},
{"name": "4vCPU / 8GB メモリ",
"path": "cloud/apprun/dedicated/worker/4vcpu_8gb"
}
]
}