プロバイダ設定
設定例
provider sakuracloud {
token = "your API token"
secret = "your API secret"
zone = "target zone"
# retry_max = 10
# retry_interval = 5 # 単位:秒
# timeout = 20 # 単位:分
# api_root_url = "https://secure.sakura.ad.jp/cloud/zone"
# trace = false
# api_request_timeout = 300 # 単位:秒
# api_request_rate_limit = 5 # 秒あたりの最大APIリクエスト数
}
パラメーター
以下のパラメーターをサポートしています。
パラメーター | 必須 | 名称 | 初期値 | 設定値 | 説明 |
---|---|---|---|---|---|
token |
◯ | APIキー (トークン) |
- | 文字列 | 環境変数SAKURACLOUD_ACCESS_TOKEN での指定も可 |
secret |
◯ | APIキー (シークレット) |
- | 文字列 | 環境変数SAKURACLOUD_ACCESS_TOKEN_SECRET での指定も可 |
zone |
- | 対象ゾーン | is1b |
is1b tk1a tk1v |
環境変数SAKURACLOUD_ZONE での指定も可 |
retry_max |
- | リトライ回数 | 10 |
数値 | 環境変数SAKURACLOUD_RETRY_MAX での指定も可 |
retry_interval |
- | リトライ時待機時間 | 5 |
数値(秒) | 環境変数SAKURACLOUD_RETRY_INTERVAL での指定も可 |
timeout |
- | タイムアウト | 20 |
数値(分) | 環境変数SAKURACLOUD_TIMEOUT での指定も可 |
api_root_url |
- | さくらのクラウドAPI ルートURL | - | 文字列 | テストなどのためにAPIのルートAPIを変更したい場合に設定する。 末尾にスラッシュを含めないでください。 指定しない場合のルートURLは https://secure.sakura.ad.jp/cloud/zone 環境変数 SAKURACLOUD_API_ROOT_URL での指定も可 |
api_request_timeout |
- | APIリクエストタイムアウト | 300 |
数値(秒) | 環境変数SAKURACLOUD_API_REQUEST_TIMEOUT での指定も可 |
api_request_rate_limit |
- | APIリクエストレートリミット | 5 |
数値(1 〜10 ) |
秒あたりのさくらのクラウドAPIリクエスト最大数。環境変数SAKURACLOUD_RATE_LIMIT での指定も可 |
trace |
- | トレースフラグ | false |
true false |
(開発者向け)詳細ログの出力ON/OFFを指定します。 環境変数 SAKURACLOUD_TRACE_MODE での指定も可 |
各パラメータとも環境変数での指定が可能です。
token
とsecret
を環境変数で指定した場合、プロバイダ設定の記述は省略可能です。
環境変数の指定例
$ export SAKURACLOUD_ACCESS_TOKEN="取得したAPIトークン"
$ export SAKURACLOUD_ACCESS_TOKEN_SECRET="取得したAPIシークレット"