さくらクラウド高火力 API
外部プログラムからさくら高火力 DOK コンテナ起動
最初に API キーを取得する必要があります。
API キーの種類には、
リソース操作 API キー
シングルサーバ API キー
の2種類の API キーがありますが
高火力 DOK はコンテナ型クラウドサービスであるため、通常の仮想サーバー(IaaS) を対象とする
「シングルサーバコントロールパネル」の適用対象外になっています。
組織(会員番号 flh***** )では APIキー を利用できません。
リソース操作 API キー を取得します。
API キーを利用するには、プロジェクトを選択してください。
API キーの設定については
APIキー
を参照してください。
この APIキーの作成 の内容を読んで API キーを作成します。
さくらインターネット会員 ID で
さくらのクラウドホームのコントロールパネルにログイン。
ログイン後、左側のメニュー(下方)より「API キー」を選択します。
リスト上部にある「APIキーの作成」ボタンをクリックします。
新規作成画面の設定
API キーの種類
作成する API キーの種類は、通常のリソース操作用を選択します。
名前
API キーを区別するため分かりやすい名前を付与します。
今回は key-**** としました。
説明
APIキーの用途など説明を記入できます。
今回は空欄としました。
アクセスレベル
アクセスレベルと操作権限
を参照してください。
今回は何でもできる
作成・削除
を設定しました。
サービスへのアクセス権
さくらのクラウド(IaaS)以外のサービスへのアクセス権が必要な場合チェックします。
・オブジェクトストレージ
・高火力 DOK
にチェックを入れました。
入力後、画面下部の「作成」ボタンをクリックします。
アクセストークンシークレット確認
API キー作成後、API 経由での操作に使用するアクセストークンおよびアクセストークンシークレット
を確認できます。
アクセストークンシークレットはセキュリティ上の理由から、この画面でのみ表示されます。
一度画面を離れると再表示できませんので、必ずこの時点で控えます。
CSV のダウンロードを実行します。
Access Token
74****77-9885-****-8184-****b108****
Access Token Secret
****cUcgDJ****OMUwl****xnwkQk****gfvKH****CpCs****sKdqw****tkli7
のようにキーが作成されます。
さくらクラウド高火力 API 準備
API キーは取得できました。
さらに準備を進めます。
さくらのクラウドのAPI情報はどこで調べる? — 運用自動化の入口、新APIポータルを使おう
が参考になります。
さくらのクラウド API のリクエストとレスポンスは JSON です。
接続は HTTPS のみ、文字コードは UTF-8 です。
高火力 DOK の API エンドポイントは
石狩第1ゾーン
https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/
になります。
API 呼び出し時には、コントロールパネルで発行した API キー
(アクセストークンとシークレット)
を Basic 認証で送ります。
そのため、事前に以下の環境変数を設定しておきます。
export SAKURA_ACCESS_TOKEN=
" 取得したアクセストークン "
export SAKURA_ACCESS_TOKEN_SECRET=
" 取得したシークレット "
これで準備は完了なのですが、この環境変数は再起動すると消えてしまいます。
なので環境変数を永続化しておくと便利です。
さくらクラウド高火力 API 準備Ⅱ
環境変数の永続化をしていきます。
ubuntuにおける環境変数の設定
が参考になります。
Ubuntu の場合、環境変数の設定ファイルが
home/yamada/.profile
にあります。
ここに、環境変数を設定すれば良いのですが、
~/.bash_profile に環境変数を記述することもできます。
ただ、.bash_profile は新規に自分で作成してパミッションも設定する必要があります。
~/.profile に設定を書き込んだ方が簡単なように思います。
環境変数-キー追加 export SACS_TK="74****77-9885-****-8184-****b108****" export SACS_S="****cUcgDJ****OMUwl****xnwkQk****gfvKH****CpCs****sKdqw****tkli7" 環境変数-石狩第1ゾーン URL 追加 export ISI_URL_Z="https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/zone" export ISI_URL_T="https://secure.sakura.ad.jp/cloud/zone/is1a/api/managed-container/1.0/tasks/"
以上4行を最後に追加します。
なお環境変数名には半角大文字を使用します。
「-」は使用できません。
nano で ~/.profile を編集します。
yamada@yama:~$ nano .profile
# ~/.profile: executed by the command interpreter for login shells.
# This file is not read by bash(1), if ~/.bash_profile or ~/.bash_login
# exists.
# see /usr/share/doc/bash/examples/startup-files for examples.
# the files are located in the bash-doc package.
# the default umask is set in /etc/profile; for setting the umask
# for ssh logins, install and configure the libpam-umask package.
#umask 022
# if running bash
if [ -n "$BASH_VERSION" ]; then
# include .bashrc if it exists
if [ -f "$HOME/.bashrc" ]; then
. "$HOME/.bashrc"
fi
fi
# set PATH so it includes user's private bin if it exists
if [ -d "$HOME/bin" ] ; then
PATH="$HOME/bin:$PATH"
fi
# set PATH so it includes user's private bin if it exists
if [ -d "$HOME/.local/bin" ] ; then
PATH="$HOME/.local/bin:$PATH"
fi
# 環境変数-キー追加
export SACS_TK="74****77-9885-****-8184-****b108****"
export SACS_S="****cUcgDJ****OMUwl****xnwkQk****gfvKH****CpCs****sKdqw****tkli7"
# 環境変数-石狩第1ゾーン URL 追加
export ISI_URL_Z="https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/zone"
export ISI_URL_T="https://secure.sakura.ad.jp/cloud/zone/is1a/api/managed-container/1.0/tasks/"
編集が終了したら
Ctrl + O
で保存し
Enter を押し
Ctrl + X
でエディタを閉じます。
設定を保存ししたら反映します。
ターミナルを再起動(ログアウト)でも可能ですが、
yamada@yama:~$ source .profile
又は
yamada@yama:~$ source ~/.profile
で反映されます。
設定の確認
正しく追加されたか確認するには、echo コマンドや printenv を使います。
yamada@yama:~$ echo $変数名
yamada@yama:~$ echo -e "$SACS_TK \n $SACS_S \n $ISI_URL_Z \n $ISI_URL_T"
-e オプションと改行コード \n を組み合わせるときれいに表示されます。
又は
yamada@yama:~$ printenv
で確認できます。
さくらクラウド高火力 API 実行
私の ubuntu 端末 Windows11 WSL2 Ubuntu 24.04 LTS から高火力 DOK への API
を使用するための具体的な手順を説明します。
API を呼出には curl コマンドを使用します。
この時 curl コマンドのオプションを理解しておく必要があります。
-u / --user: ベーシック認証などのユーザー名とパスワードを指定します。
API キー を設定します。
-X / --request: 使用する HTTPメソッド(GET, POST, PUT, DELETE など)を指定します。
-H / --header: リクエストに任意の HTTP ヘッダーを追加します。
今回レスポンスは JSON なので基本的には
-H "Content-Type: application/json"
とします。
-d / --data: POST リクエストでデータを送信します。
指定すると自動的に POST メソッドになります。
ゾーン情報を取得するAPI 呼出
SAKURA_ACCESS_TOKEN と SAKURA_ACCESS_TOKEN_SECRET
はすでに、環境変数として
$SACS_TK と $SACS_S
に設定済。
ゾーン情報は
"https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/zone"
から取得します。
これも環境変数 $ISI_URL_Z に設定済です。
よって
yamada@yama:~$ curl -u "$SACS_TK:$SACS_S" \
-H "X-Requested-With: XMLHttpRequest" \
"$ISI_URL_Z"
[結果]
{
"From":0,"Count":6,"Total":6,"Zones":
[
{
"Index":0,"ID":21001,"DisplayOrder":20021001,
後略・・・
なにやら沢山情報が表示されたら OK です。
引き続き、API からタスク一覧を取得します。





