さくらのクラウド さくらのクラウド API ポータル クラウドマニュアルへ
API docs by Redocly

AppRun専有型 API (1.4.0)

Download OpenAPI specification:Download OpenAPI Spec (YAML)Download OpenAPI Spec (JSON)

License: Copyright(C) SAKURA internet Inc. all rights reserved.
リリースノート | さくらのクラウド マニュアル

更新履歴

  • 2026-07-29 (v1.4.0): クラスタのロードバランサ設定取得・更新エンドポイントを追加
  • 2026-07-15 (v1.3.1): Response samplesを修正

「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
required
name
required
string [ 1 .. 20 ] characters ^[a-zA-Z0-9_-]+$

アプリケーションの名前。クラスタの中ではユニーク。英数字とハイフン、アンダースコアのみ使用可能

clusterID
required
string <uuid>

デプロイ先クラスタ

Responses

Request samples

Content type
application/json
{
  • "name": "bbs",
  • "clusterID": "13B9EA83-DDB0-4385-9533-3D693A6A310F"
}

Response samples

Content type
application/json
{
  • "application": {
    }
}

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

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

Authorizations:
BasicAuth
query Parameters
clusterID
string <uuid> (ClusterID)
Example: clusterID=13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

cursor
string <uuid> (ApplicationID)

前ページの最後のID。これ以降のデータを取得するためのカーソル。ページネーションに利用します。

maxItems
required
integer <int64> [ 1 .. 30 ]
Default: 20

1ページあたりの最大取得件数。

Responses

Response samples

Content type
application/json
{
  • "applications": [
    ]
}

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

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

Authorizations:
BasicAuth
path Parameters
applicationID
required
string <uuid> (ApplicationID)

Responses

Response samples

Content type
application/json
{
  • "application": {
    }
}

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

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

Authorizations:
BasicAuth
path Parameters
applicationID
required
string <uuid> (ApplicationID)
Request Body schema: application/json
required
activeVersion
required
integer or null <int32> >= 1

利用しているバージョン

Responses

Request samples

Content type
application/json
{
  • "activeVersion": 3
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string"
}

アプリケーションの削除

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

前提条件

  • 当該アプリケーションに アクティブなバージョンが存在しない こと
  • いずれのワーカノードでも当該アプリケーションの コンテナが稼働していない こと
Authorizations:
BasicAuth
path Parameters
applicationID
required
string <uuid> (ApplicationID)

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string"
}

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

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

Authorizations:
BasicAuth
path Parameters
applicationID
required
string <uuid> (ApplicationID)

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ]
}

application_version

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

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

Authorizations:
BasicAuth
path Parameters
applicationID
required
string <uuid> (ApplicationID)
Request Body schema: application/json
required
image
required
string <= 512 characters
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 ]
cmd
Array of strings <= 20 items

コンテナ起動時に実行するコマンドと引数

registryUsername
required
string or null <= 255 characters

レジストリのユーザ名。未設定の場合はnull。

registryPassword
required
string or null <= 255 characters

レジストリのパスワード。レスポンスではマスクされる。未設定の場合はnull。

registryPasswordAction
required
string
Enum: "keep" "remove" "new"

レジストリパスワードの設定方法

required
Array of objects (ExposedPort) <= 5 items

アプリケーションが公開するポート番号。同一クラスタ内で、ポートの重複不可。

required
Array of objects (CreateEnvironmentVariable) <= 50 items

環境変数

Responses

Request samples

Content type
application/json
{
  • "image": "nginx:latest",
  • "cpu": 500,
  • "memory": 1000,
  • "scalingMode": "manual",
  • "fixedScale": 1,
  • "minScale": 1,
  • "maxScale": 3,
  • "scaleInThreshold": 30,
  • "scaleOutThreshold": 95,
  • "cmd": [
    ],
  • "registryUsername": "string",
  • "registryPassword": "string",
  • "registryPasswordAction": "keep",
  • "exposedPorts": [
    ],
  • "env": [
    ]
}

Response samples

Content type
application/json
{
  • "applicationVersion": {
    }
}

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

指定されたアプリケーションのバージョン一覧を返します。

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

Content type
application/json
{
  • "versions": [
    ]
}

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

現在ノードにデプロイされているバージョンおよびアクティブなバージョンは削除できません。

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

Responses

Response samples

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

Content type
application/json
{
  • "applicationVersion": {
    }
}

cluster

クラスタの作成

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

Authorizations:
BasicAuth
Request Body schema: application/json
required
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 チャレンジになるため、80 番ポートを HTTPプロトコルで外向きに解放する必要があります。

required
Array of objects (ClusterLoadBalancerPort) <= 5 items

ロードバランサのポート群

servicePrincipalID
required
string (ServicePrincipalID) = 12 characters

サービスプリンシパルのID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "letsEncryptEmail": "string",
  • "ports": [
    ],
  • "servicePrincipalID": "123456789012"
}

Response samples

Content type
application/json
{
  • "cluster": {
    }
}

クラスタの一覧を取得

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

Authorizations:
BasicAuth
query Parameters
lastClusterID
string <uuid> (ClusterID)
Example: lastClusterID=13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

cursor
string <uuid> (ClusterID)
Example: cursor=13B9EA83-DDB0-4385-9533-3D693A6A310F

前ページの最後のID。これ以降のデータを取得するためのカーソル。

maxItems
required
integer <int64> [ 5 .. 30 ]
Default: 20

Responses

Response samples

Content type
application/json
{
  • "clusters": [
    ]
}

クラスタの詳細を取得

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

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

Responses

Response samples

Content type
application/json
{
  • "cluster": {
    }
}

クラスタの削除

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

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string"
}

クラスタの更新

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

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

Request Body schema: application/json
required
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 チャレンジになるため、80 番ポートを HTTPプロトコルで外向きに解放する必要があります。

servicePrincipalID
required
string (ServicePrincipalID) = 12 characters

サービスプリンシパルのID

Array of objects (ClusterLoadBalancerPort) <= 5 items

ロードバランサのポート群

Responses

Request samples

Content type
application/json
{
  • "letsEncryptEmail": "string",
  • "servicePrincipalID": "123456789012",
  • "ports": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string"
}

オートスケーリンググループの作成

新しいオートスケーリンググループを作成します。

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

Request Body schema: application/json
required
name
required
string [ 1 .. 20 ] characters ^[a-zA-Z0-9_-]+$

オートスケーリンググループの名前。クラスタ内でユニーク。英数字、アンダースコア、ハイフンのみ使用可能

zone
required
string

オートスケーリンググループのゾーン

nameServers
Array of strings (Ipv4) [ 1 .. 3 ] items [ items^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,... ]

ネームサーバ設定

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

Content type
application/json
{
  • "name": "string",
  • "zone": "string",
  • "nameServers": [
    ],
  • "workerServiceClassPath": "string",
  • "minNodes": 1,
  • "maxNodes": 1,
  • "interfaces": [
    ]
}

Response samples

Content type
application/json
{
  • "autoScalingGroup": {
    }
}

オートスケーリンググループの一覧を取得

クラスタに所属するオートスケーリンググループの一覧を返します。ページネーションに対応します。

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

query Parameters
lastAutoScalingGroupID
string <uuid> (AutoScalingGroupID)
cursor
string <uuid> (AutoScalingGroupID)

前ページの最後のID。これ以降のデータを取得するためのカーソル。

maxItems
required
integer <int64> [ 1 .. 30 ]
Default: 20

Responses

Response samples

Content type
application/json
{
  • "autoScalingGroups": [
    ]
}

オートスケーリンググループの詳細を取得

指定したオートスケーリンググループの詳細を返します。

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

autoScalingGroupID
required
string <uuid> (AutoScalingGroupID)

Responses

Response samples

Content type
application/json
{
  • "autoScalingGroup": {
    }
}

オートスケーリンググループの削除

指定したオートスケーリンググループを削除します。

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

autoScalingGroupID
required
string <uuid> (AutoScalingGroupID)

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string"
}

ロードバランサの作成

指定したオートスケーリンググループにロードバランサを作成します。

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

autoScalingGroupID
required
string <uuid> (AutoScalingGroupID)
Request Body schema: application/json
required
name
required
string [ 1 .. 20 ] characters ^[a-zA-Z0-9_-]+$

ロードバランサ名。オートスケーリンググループ内でユニーク。英数字とハイフン、アンダースコアのみ使用可能

serviceClassPath
required
string [ 1 .. 255 ] characters

ロードバランサのサービスクラスパス

nameServers
Array of strings (Ipv4) [ 1 .. 3 ] items [ items^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,... ]

ネームサーバ設定

required
Array of objects (LoadBalancerInterface) [ 1 .. 5 ] items

ロードバランサのインターフェース

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "serviceClassPath": "string",
  • "nameServers": [
    ],
  • "interfaces": [
    ]
}

Response samples

Content type
application/json
{
  • "loadBalancer": {
    }
}

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

オートスケーリンググループに属するロードバランサの一覧を返します。ページネーションに対応します。

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

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

Responses

Response samples

Content type
application/json
{
  • "loadBalancers": [
    ]
}

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

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

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

autoScalingGroupID
required
string <uuid> (AutoScalingGroupID)
loadBalancerID
required
string <uuid> (LoadBalancerID)

Responses

Response samples

Content type
application/json
{
  • "loadBalancer": {
    }
}

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

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

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

autoScalingGroupID
required
string <uuid> (AutoScalingGroupID)
loadBalancerID
required
string <uuid> (LoadBalancerID)

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string"
}

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

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

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

autoScalingGroupID
required
string <uuid> (AutoScalingGroupID)
loadBalancerID
required
string <uuid> (LoadBalancerID)
query Parameters
cursor
string <uuid> (LoadBalancerNodeID)
maxItems
required
integer <int64> [ 2 .. 30 ]
Default: 20

Responses

Response samples

Content type
application/json
{
  • "loadBalancerNodes": [
    ]
}

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

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

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

autoScalingGroupID
required
string <uuid> (AutoScalingGroupID)
loadBalancerID
required
string <uuid> (LoadBalancerID)
loadBalancerNodeID
required
string <uuid> (LoadBalancerNodeID)

Responses

Response samples

Content type
application/json
{
  • "loadBalancerNode": {
    }
}

オートスケーリンググループに所属するワーカノードの一覧を取得

オートスケーリンググループに所属するワーカノードの一覧を返します。ページネーションに対応します。

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

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

Responses

Response samples

Content type
application/json
{
  • "workerNodes": [
    ]
}

オートスケーリンググループに所属するワーカノードの詳細を取得

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

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

autoScalingGroupID
required
string <uuid> (AutoScalingGroupID)
workerNodeID
required
string <uuid> (WorkerNodeID)

Responses

Response samples

Content type
application/json
{
  • "workerNode": {
    }
}

ワーカノードのドレイン状態を変更する

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

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

autoScalingGroupID
required
string <uuid> (AutoScalingGroupID)
workerNodeID
required
string <uuid> (WorkerNodeID)
Request Body schema: application/json
required
draining
required
boolean

ドレイン状態にするかどうか

Responses

Request samples

Content type
application/json
{
  • "draining": true
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string"
}

クラスタのロードバランサ設定を取得

指定したクラスタに紐づくロードバランサ設定（Let's Encrypt メール設定の有無と公開ポート設定）を返します。

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

Responses

Response samples

Content type
application/json
{
  • "loadBalancer": {
    }
}

クラスタのロードバランサ設定を部分更新

指定したクラスタに紐づくロードバランサ設定を部分更新します。未指定の項目は既存値を維持します。

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

Request Body schema: application/merge-patch+json
required
letsEncryptEmail
string or null (Let's Encrypt のメールアドレス) ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2...

Let's Encrypt による証明書発行を有効にするにはここにメールアドレスを設定します。 Let's Encrypt による証明書発行は HTTP-01 チャレンジになるため、80 番ポートを HTTPプロトコルで外向きに解放する必要があります。

Array of objects (ClusterLoadBalancerPortMergePatchCreateOrUpdateReplaceOnly) <= 5 items

ロードバランサのポート群

Responses

Request samples

Content type
application/merge-patch+json
{
  • "letsEncryptEmail": "string",
  • "ports": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string"
}

certificate

証明書の作成

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

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

Request Body schema: application/json
required
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

Content type
application/json
{
  • "name": "string",
  • "certificatePem": "string",
  • "privatekeyPem": "string",
  • "intermediateCertificatePem": "string"
}

Response samples

Content type
application/json
{
  • "certificate": {
    }
}

証明書の一覧を取得

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

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

query Parameters
cursor
string <uuid> (CertificateID)
Example: cursor=13B9EA83-DDB0-4385-9533-3D693A6A310F

前ページの最後のID。これ以降のデータを取得するためのカーソル。

maxItems
required
integer <int64> [ 5 .. 30 ]
Default: 20

Responses

Response samples

Content type
application/json
{
  • "certificates": [
    ]
}

証明書の詳細を取得

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

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

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

Responses

Response samples

Content type
application/json
{
  • "certificate": {
    }
}

証明書の削除

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

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

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

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string"
}

証明書の更新

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

Authorizations:
BasicAuth
path Parameters
clusterID
required
string <uuid> (ClusterID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F

クラスタID

certificateID
required
string <uuid> (CertificateID)
Example: 13B9EA83-DDB0-4385-9533-3D693A6A310F
Request Body schema: application/json
required
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

Content type
application/json
{
  • "name": "string",
  • "certificatePem": "string",
  • "privatekeyPem": "string",
  • "intermediateCertificatePem": "string"
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string"
}

limit

プロジェクトのリソース制限値の取得

プロジェクトに紐づくリソース制限値を返します。

Authorizations:
BasicAuth

Responses

Response samples

Content type
application/json
{
  • "limit": {
    }
}

service_class

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

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

Authorizations:
BasicAuth

Responses

Response samples

Content type
application/json
{
  • "lbServiceClasses": [
    ]
}

ワーカノードサービスクラスの一覧を取得

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

Authorizations:
BasicAuth

Responses

Response samples

Content type
application/json
{
  • "workerServiceClasses": [
    ]
}