CLI コマンドヘルプ
実際の skr --help の出力を掲載しています。コマンド名を選ぶと、対応する --help の内容を確認できます。
基本
skr skr
Usage: skr <command> [flags]
CLI for Sakura Cloud.
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
version [flags]
Print version information.
config current
Print the current profile name.
config list
List configuration profiles.
config show [<name>]
Show a configuration profile.
config create [<name>] [flags]
コントロールパネルで作成したサービスプリンシパルキーを含む profile を新規作成します。
config edit [<name>] [flags]
既存 profile のサービスプリンシパルキー認証情報を編集します。
config use [<name>]
Set the current configuration profile.
iaas-api archive find [flags]
アーカイブを指定したゾーンで検索して出力します。API の
ID、Name、Description、DiskPlanID、DiskPlanName、SizeMB、Tags を確認できます。OS
種別またはタグで絞り込めます。例: skr iaas-api archive find --zone is1b --os-type ubuntu2404
iaas-api archive read [flags]
指定したゾーンと ID のアーカイブを読み取って出力します。API の DiskPlanID、DiskPlanName、SizeMB、Tags
などを確認できます。例: skr iaas-api archive read --zone ZONE --id 123456789012
iaas-api database find [flags]
データベースアプライアンスを指定したゾーンで検索して出力します。例: skr iaas-api database find --zone tk1v
--name example
iaas-api database read [flags]
データベースアプライアンスを読み取って出力します。例: skr iaas-api database read --zone ZONE --id
123456789012
iaas-api database create [flags]
データベースアプライアンスを作成して出力します。基本項目はフラグ、複雑な値は --request JSON で指定します。例: skr iaas-api
database create --zone tk1v --name example --plan-id 10 --switch-id
123456789012 --ip-address 192.168.0.11 --network-mask-len 24 --database-type
mariadb --username dbuser --password @db-password.txt
iaas-api database update [flags]
データベースアプライアンスの設定を更新します。送信した内容で設定が置き換わるため、保持したい項目も含めて指定してください。ゾーンと ID
はフラグ、更新内容は --request JSON で指定します。例: skr iaas-api database update --zone tk1v
--id 123456789012 --request @db-update.json
iaas-api database delete [flags]
データベースアプライアンスを削除します。成功時は出力しません。例: skr iaas-api database delete --zone ZONE
--id 123456789012
iaas-api database boot [flags]
データベースアプライアンスを起動します。成功時は出力しません。例: skr iaas-api database boot --zone ZONE
--id 123456789012
iaas-api database shutdown [flags]
データベースアプライアンスをシャットダウンします。成功時は出力しません。例: skr iaas-api database shutdown --zone
ZONE --id 123456789012
iaas-api database reset [flags]
データベースアプライアンスを再起動します。成功時は出力しません。例: skr iaas-api database reset --zone ZONE
--id 123456789012
iaas-api database monitor-cpu [flags]
CPU 使用率のモニタリング値を指定した期間で取得して出力します。例: skr iaas-api database monitor-cpu
--zone ZONE --id 123456789012 --start 2025-01-01T00:00:00+09:00 --end
2025-01-02T00:00:00+09:00
iaas-api database monitor-disk [flags]
ディスク使用量のモニタリング値を指定した期間で取得して出力します。例: skr iaas-api database monitor-disk
--zone ZONE --id 123456789012
iaas-api database monitor-interface [flags]
ネットワーク送受信のモニタリング値を指定した期間で取得して出力します。例: skr iaas-api database
monitor-interface --zone ZONE --id 123456789012
iaas-api database monitor-database [flags]
メモリやレプリケーション遅延などデータベース固有のモニタリング値を指定した期間で取得して出力します。例: skr iaas-api database
monitor-database --zone ZONE --id 123456789012
iaas-api database list-parameter [flags]
データベースアプライアンスの設定パラメータ一覧を取得して出力します。パラメータは RDBMS 固有の設定値です。例: skr iaas-api
database list-parameter --zone ZONE --id 123456789012
iaas-api disk find [flags]
ディスクを指定したゾーンで検索して出力します。例: skr iaas-api disk find --zone is1b
iaas-api disk read [flags]
ディスクを読み取って出力します。例: skr iaas-api disk read --zone ZONE --id 123456789012
iaas-api disk create [flags]
ディスクを作成して出力します。基本項目はフラグ、複雑な値は --request JSON で指定します。例: skr iaas-api disk
create --zone is1b --name DISK-NAME --disk-plan-id 4 --connection virtio
--size-gb 20
iaas-api disk update [flags]
ディスクの指定項目を更新して出力します。省略した項目は変更しません。例: skr iaas-api disk update --zone ZONE
--id 123456789012 --name UPDATED-DISK-NAME
iaas-api disk delete [flags]
ディスクを削除します。サーバに接続中のディスクは削除できません。削除後は復旧できません。成功時は出力しません。例: skr iaas-api disk
delete --zone ZONE --id 123456789012 --fail-if-not-found
iaas-api icon find [flags]
アイコンを検索して出力します。Names、Tags、Scope、Sort は --request JSON
で指定できます。条件を省略すると一覧を取得します。例: skr iaas-api icon find --request @icon-find.json
iaas-api icon read [flags]
ID を指定してアイコンを読み取って出力します。例: skr iaas-api icon read --id 123456789012
iaas-api icon create [flags]
画像ファイルからアイコンを作成して出力します。例: skr iaas-api icon create --name example
--image-file ./icon.png
iaas-api icon update [flags]
アイコンの指定項目を更新して出力します。省略した項目は変更しません。例: skr iaas-api icon update --id
123456789012 --name updated
iaas-api icon delete [flags]
アイコンを削除します。成功時は出力しません。例: skr iaas-api icon delete --id 123456789012
iaas-api internet find [flags]
ルータ＋スイッチを指定したゾーンで検索して出力します。例: skr iaas-api internet find --zone is1b
iaas-api internet read [flags]
ルータ＋スイッチを読み取って出力します。
iaas-api internet create [flags]
ルータ＋スイッチを作成して出力します。課金対象になる場合があります。例: skr iaas-api internet create --zone
is1b --name ROUTER-SWITCH-NAME --network-mask-len 28 --band-width-mbps 100
iaas-api internet update [flags]
ルータ＋スイッチの設定を更新して出力します。例: skr iaas-api internet update --zone is1b --id
123456789012 --name UPDATED-NAME
iaas-api internet delete [flags]
ルータ＋スイッチを削除します。--force は IPv6 の無効化と NextHop が設定された追加サブネットの削除も行います。例:
skr iaas-api internet delete --zone is1b --id 123456789012
iaas-api internet list-subnet [flags]
ルータ＋スイッチに設定された IP アドレスブロックを一覧表示します。
iaas-api internet add-subnet [flags]
ルータ＋スイッチに IP アドレスブロックを追加します。ネクストホップとなるサーバを先に用意してください。
iaas-api internet update-subnet [flags]
追加した IP アドレスブロックのネクストホップを更新します。
iaas-api internet delete-subnet [flags]
ルータ＋スイッチに追加した IP アドレスブロックを削除します。
iaas-api internet read-ipv6 [flags]
ルータ＋スイッチに割り当てられた IPv6 ネットワークを読み取ります。
iaas-api internet enable-ipv6 [flags]
ルータ＋スイッチの IPv6 アドレス割り当てを有効にして、割り当て結果を出力します。
iaas-api internet disable-ipv6 [flags]
ルータ＋スイッチの IPv6 アドレス割り当てを無効にします。
iaas-api internet monitor-router [flags]
ルータ＋スイッチのトラフィックを指定期間で取得して出力します。例: skr iaas-api internet monitor-router
--zone is1b --id 123456789012 --start 2026-10-14T00:00:00Z --end
2026-10-15T00:00:00Z
iaas-api ipaddress list [flags]
グローバル IP アドレスを指定したゾーンで一覧表示します。例: skr iaas-api ipaddress list --zone is1b
iaas-api ipaddress read [flags]
指定したグローバル IP アドレスの情報を取得します。例: skr iaas-api ipaddress read --zone is1b
--ip-address 192.0.2.1
iaas-api ipaddress update-host-name [flags]
指定したグローバル IP アドレスの逆引きホスト名を変更します。成功時は出力しません。例: skr iaas-api ipaddress
update-host-name --zone is1b --ip-address 192.0.2.1 --host-name
www.example.com
iaas-api ipv6addr find [flags]
IPv6 アドレスを指定したゾーンで検索して出力します。例: skr iaas-api ipv6addr find --zone is1b
iaas-api ipv6addr create [flags]
IPv6 プレフィクス内のアドレスに逆引きホスト名を登録して出力します。例: skr iaas-api ipv6addr create --zone
is1b --ipv6-addr 2001:db8::1 --host-name www.example.com
iaas-api ipv6addr read [flags]
指定した IPv6 アドレスの情報を取得します。例: skr iaas-api ipv6addr read --zone is1b
--ipv6-addr 2001:db8::1
iaas-api ipv6addr update [flags]
指定した IPv6 アドレスの逆引きホスト名を変更して出力します。例: skr iaas-api ipv6addr update --zone is1b
--ipv6-addr 2001:db8::1 --host-name www.example.com
iaas-api ipv6addr delete [flags]
指定した IPv6 アドレスの逆引きホスト名の登録を解除します。成功時は出力しません。例: skr iaas-api ipv6addr delete
--zone is1b --ipv6-addr 2001:db8::1
iaas-api ipv6net find [flags]
IPv6 ネットワークを指定したゾーンで検索して出力します。例: skr iaas-api ipv6net find --zone is1b
iaas-api ipv6net read [flags]
指定した ID の IPv6 ネットワークを取得します。例: skr iaas-api ipv6net read --zone is1b --id
123456789012
iaas-api packetfilter find [flags]
パケットフィルタを指定したゾーンで検索して出力します。例: skr iaas-api packetfilter find --zone is1b
iaas-api packetfilter read [flags]
パケットフィルタを読み取って出力します。例: skr iaas-api packetfilter read --zone ZONE --id
123456789012
iaas-api packetfilter create [flags]
パケットフィルタを作成して出力します。基本項目はフラグ、ルールは --expressions JSON で指定できます。例:
skr iaas-api packetfilter create --zone is1b --name example --expressions
'[{"Protocol":"tcp","DestinationPort":"443","Action":"allow"}]'
iaas-api packetfilter update [flags]
パケットフィルタの指定項目を更新して出力します。ルール配列は --expressions JSON で指定できます。
iaas-api packetfilter delete [flags]
パケットフィルタを削除します。成功時は出力しません。例: skr iaas-api packetfilter delete --zone ZONE
--id 123456789012
iaas-api product disk find [flags]
指定したゾーンで利用できるディスクプランを検索します。API 応答の Total、From、Count、DiskPlans を含む JSON
を出力します。Availability と Size (サイズ、単位、利用可否) を確認できます。例: skr iaas-api product
disk find --zone is1b
iaas-api product disk read [flags]
指定したゾーンと ID のディスクプランを読み取って出力します。API の Availability と Size (サイズ、単位、利用可否)
を確認できます。例: skr iaas-api product disk read --zone ZONE --id 4
iaas-api product internet find [flags]
指定したゾーンのインターネットプランを検索します。API 応答の Total、From、Count、InternetPlans を含む JSON
を出力します。帯域幅と利用可否を確認できます。例: skr iaas-api product internet find --zone is1b
iaas-api product internet read [flags]
指定したゾーンと ID のインターネットプランを参照します。例: skr iaas-api product internet read --zone
ZONE --id INTERNET-PLAN-ID
iaas-api product license find [flags]
ライセンス情報を検索します。API 応答の Total、From、Count、LicenseInfo を含む JSON
を出力します。名称や利用条件を確認できます。
iaas-api product privatehost find [flags]
指定したゾーンの専有ホストプランを検索します。API 応答の Total、From、Count、PrivateHostPlans を含む JSON
を出力します。CPU、CPU モデル、メモリ、利用可否を確認できます。例: skr iaas-api product privatehost find
--zone is1b
iaas-api product privatehost read [flags]
指定したゾーンと ID の専有ホストプランを参照します。例: skr iaas-api product privatehost read --zone
ZONE --id PRIVATE-HOST-PLAN-ID
iaas-api product server find [flags]
指定したゾーンのサーバプランを検索します。API 応答の Total、From、Count、ServerPlans を含む JSON
を出力します。CPU、メモリ、GPU、CPUコミットメント、世代、利用可否を確認できます。例: skr iaas-api product server
find --zone is1b
iaas-api product server read [flags]
指定したゾーンと ID のサーバプランを参照します。例: skr iaas-api product server read --zone ZONE
--id SERVER-PLAN-ID
iaas-api region find [flags]
リージョン一覧を取得します。必要な項目だけを表示する例: skr iaas-api region find --query
'map({ID,Name,Description})'
iaas-api region read [flags]
指定した ID のリージョン情報を取得します。例: skr iaas-api region read --id REGION-ID
iaas-api switch find [flags]
スイッチを指定したゾーンで検索して出力します。例: skr iaas-api switch find --zone tk1v
iaas-api switch read [flags]
スイッチを読み取って出力します。例: skr iaas-api switch read --zone ZONE --id 123456789012
iaas-api switch create [flags]
スイッチを作成して出力します。例: skr iaas-api switch create --zone ZONE --name example
iaas-api switch update [flags]
指定項目だけを更新して出力します。例: skr iaas-api switch update --zone ZONE --id 123456789012
--name updated
iaas-api switch delete [flags]
スイッチを削除します。成功時は出力しません。例: skr iaas-api switch delete --zone ZONE --id
123456789012
iaas-api server find [flags]
サーバを指定したゾーンで検索して出力します。例: skr iaas-api server find --zone tk1v
iaas-api server read [flags]
サーバを読み取って出力します。例: skr iaas-api server read --zone ZONE --id 123456789012
iaas-api server create [flags]
サーバを作成して出力します。基本項目はフラグ、複雑な構成は --request JSON で指定します。ディスクと NIC
は --disk と --nic を繰り返して指定できます。例: skr iaas-api server create
--zone ZONE --name example --cpu 1 --memory-gb 1 --disk
'archive-id=ARCHIVE-ID,plan-id=DISK-PLAN-ID,size-gb=20' --nic
'upstream=shared'
iaas-api server boot --zone=STRING --id=INT-64 [flags]
サーバを起動します。cloud-init の user-data は任意で、--user-data @path.yaml または --user-data
- で指定します。例: skr iaas-api server boot --zone ZONE --id 123456789012
iaas-api server update [flags]
サーバの指定項目を更新して出力します。省略した項目は変更しません。CPU または MemoryGB の変更はプラン変更です。プラン変更後は新しいサーバ
ID を確認してください。例: skr iaas-api server update --zone ZONE --id 123456789012
--name updated
iaas-api server delete [flags]
サーバを削除します。成功時は出力しません。ディスクも削除する場合は --with-disks を指定します。例: skr iaas-api server
delete --zone ZONE --id 123456789012
iaas-api service-class find [flags]
指定したゾーンのサービスクラスを検索します。例: skr iaas-api service-class find --zone is1b
iaas-api zone find [flags]
ゾーン一覧を取得します。名前の抽出例: skr iaas-api zone find --query 'map(.Name)'
iaas-api zone read [flags]
指定した ID のゾーン情報を取得します。例: skr iaas-api zone read --id ZONE-ID
gslb-api find [flags]
GSLB を検索します。Name は完全一致です。例: skr gslb-api find --name example
gslb-api read [flags]
指定した ID の GSLB を読み取ります。例: skr gslb-api read --id 123456789012
gslb-api create [flags]
GSLB を作成します。監視方法には --health-check-protocol を指定します。実サーバーは
--destination-server を繰り返して指定できます。複雑な設定には --request JSON を使います。
gslb-api update [flags]
GSLB
の指定項目を更新します。省略した設定は変更しません。ヘルスチェックのフラグを指定すると監視設定全体を置き換えるため、保持したい監視項目も再指定してください。実サーバーを指定すると一覧全体を置き換えます。
gslb-api delete [flags]
指定した ID の GSLB を削除します。
eventbus-api process-configuration list
実行設定を一覧表示します。例: skr eventbus-api process-configuration list
eventbus-api process-configuration read <id>
ID を指定して実行設定を読み取ります。ID は list の出力で確認できます。
eventbus-api process-configuration create [flags]
実行設定を作成します。実行先サービス（simplenotification、simplemq、autoscale）は先に作成してください。例:
skr eventbus-api process-configuration create
--request='{"CommonServiceItem":{"Name":"notify","Settings":{"Destination":"simplenotification","Parameters":"{\"group_id\":\"GROUP-ID\",\"message\":\"hello\"}"}}}'
eventbus-api process-configuration update <id> [flags]
実行設定を部分更新します。未指定の項目は変更されません。Settings を指定する場合は Destination と Parameters
を含む設定全体を指定してください。
eventbus-api process-configuration delete <id>
ID を指定して実行設定を削除します。削除前に対象 ID を確認してください。
eventbus-api process-configuration update-secret --secret-file=STRING <id>
実行設定が実行先サービスを呼び出すためのシークレットを登録します。シークレットは --secret-file
でファイルまたは標準入力から読み込み、コマンドラインには記述しないでください。SimpleMQ の例:
{"APIKey":"SIMPLEMQ-API-KEY"}
eventbus-api schedule list
スケジュールを一覧表示します。
eventbus-api schedule read <id>
ID を指定してスケジュールを読み取ります。
eventbus-api schedule create [flags]
実行スケジュールを作成します。StartsAt は Unix epoch ミリ秒の整数です。RecurringStep
と RecurringUnit（min、hour、day）、または Crontab
を指定します。周期は最短 1 分です。例: skr eventbus-api schedule create
--request='{"CommonServiceItem":{"Name":"daily","Settings":{"ProcessConfigurationID":"PROCESS-CONFIGURATION-ID","StartsAt":1893456000000,"RecurringStep":1,"RecurringUnit":"day"}}}'
eventbus-api schedule update <id> [flags]
スケジュールを部分更新します。未指定項目は変更されません。Settings を更新する場合は ProcessConfigurationID と
StartsAt、および周期または Crontab を含めます。
eventbus-api schedule delete <id>
ID を指定してスケジュールを削除します。削除前に対象 ID を確認してください。
eventbus-api trigger list
トリガーを一覧表示します。
eventbus-api trigger read <id>
ID を指定してトリガーを読み取ります。
eventbus-api trigger create [flags]
イベントトリガーを作成します。Settings に Source、Types、ProcessConfigurationID を指定します。Source
と Types の例示値は実際のイベントソースに置き換えてください。例: skr eventbus-api trigger create
--request='{"CommonServiceItem":{"Name":"on-change","Settings":{"Source":"EVENT-SOURCE","Types":["EVENT-TYPE"],"ProcessConfigurationID":"PROCESS-CONFIGURATION-ID"}}}'
eventbus-api trigger update <id> [flags]
トリガーを部分更新します。未指定項目は変更されません。Settings を更新する場合は
Source、Types、ProcessConfigurationID を含めます。
eventbus-api trigger delete <id>
ID を指定してトリガーを削除します。削除前に対象 ID を確認してください。
simplemq-api queue list
キューを一覧表示します。
simplemq-api queue read <id>
ID を指定してキューを読み取ります。
simplemq-api queue create [flags]
キューを作成します。作成後、rotate-api-key でメッセージ API 用のキーを発行してください。
simplemq-api queue config <id> [flags]
キューの設定を更新します。--visibility-timeout-seconds と --expire-seconds
を指定するか、--request JSON を指定してください。
simplemq-api queue delete <id>
ID を指定してキューを削除します。
simplemq-api queue count-messages <id>
キュー内のメッセージ数を取得します。
simplemq-api queue rotate-api-key <id>
メッセージ API キーを発行または再発行し、結果を出力します。APIKey は認証情報として安全に扱ってください。
simplemq-api queue clear-messages <id>
キュー内のメッセージをすべて削除します。
simplemq-api message send --queue-name=STRING --api-key-file=STRING --content=STRING
キューへメッセージを送信します。
simplemq-api message receive --queue-name=STRING --api-key-file=STRING
キューからメッセージを受信します。
simplemq-api message extend-timeout --queue-name=STRING --api-key-file=STRING <message-id>
受信したメッセージの可視性タイムアウトを延長します。
simplemq-api message delete --queue-name=STRING --api-key-file=STRING <message-id>
受信したメッセージを削除します。
simple-notification-api destination list
通知先を一覧表示します。
simple-notification-api destination read <id>
通知先の詳細を読み取ります。
simple-notification-api destination create [flags]
通知先を作成します。メールアドレスは確認が完了するまで送信先として利用できません。
simple-notification-api destination update <id> [flags]
通知先の名前、説明、タグ、Settings を更新します。通知先アドレスは変更できません。
simple-notification-api destination delete <id>
通知先を削除します。グループから参照されている通知先は先にグループ設定から外してください。
simple-notification-api destination read-status <id>
通知先の送信可否ステータスを取得します。
simple-notification-api group list
通知先グループを一覧表示します。
simple-notification-api group read <id>
通知先グループの詳細を読み取ります。
simple-notification-api group create [flags]
通知先グループを作成します。Settings.Destinations に通知先 ID を指定します。
simple-notification-api group update <id> [flags]
通知先グループの名前、説明、タグ、Settings を更新します。
simple-notification-api group delete <id>
通知先グループを削除します。
simple-notification-api group send-message <id> [flags]
通知先グループにメッセージを送信します。応答は受付結果であり、通知先への到達を保証しません。
simple-notification-api routing list
ルーティング設定を一覧表示します。
simple-notification-api routing read <id>
ルーティング設定を読み取ります。
simple-notification-api routing create [flags]
ルーティング設定を作成します。
simple-notification-api routing update <id> [flags]
ルーティング設定を更新します。
simple-notification-api routing delete <id>
ルーティング設定を削除します。
simple-notification-api routing reorder [flags]
ルーティング設定の順序を変更します。
simple-notification-api routing list-source
ルーティング設定に利用できる通知元を一覧表示します。
simple-notification-api history list
通知履歴を一覧表示します。
simple-notification-api history read <id>
通知履歴を読み取ります。
networking-suite-api subnet-group list
サブネットグループを一覧表示します。例: skr networking-suite-api subnet-group list
networking-suite-api subnet-group read <srn>
SRN を指定してサブネットグループを参照します。例: skr networking-suite-api subnet-group read
SUBNET-GROUP-SRN
networking-suite-api subnet-group create [flags]
リージョン単位のサブネットグループを作成します。例: skr networking-suite-api subnet-group create
--name NAME --description DESCRIPTION --ipv4-address-range-cidr 10.0.0.0/16
--region is1
networking-suite-api subnet-group update <srn> [flags]
サブネットグループの名前と説明を更新します。両方の値を指定してください。例: skr networking-suite-api subnet-group
update SUBNET-GROUP-SRN --name NAME --description DESCRIPTION
networking-suite-api subnet-group delete <srn>
サブネットグループを削除します。配下のサブネットを先に削除してください。例: skr networking-suite-api subnet-group
delete SUBNET-GROUP-SRN
networking-suite-api subnet list <subnet-group-srn>
サブネットグループの SRN を指定してサブネットを一覧表示します。例: skr networking-suite-api subnet list
SUBNET-GROUP-SRN
networking-suite-api subnet read <srn>
SRN を指定してサブネットを参照します。例: skr networking-suite-api subnet read SUBNET-SRN
networking-suite-api subnet create [flags]
サブネットグループにゾーン別サブネットを作成します。例: skr networking-suite-api subnet create --name
NAME --description DESCRIPTION --ipv4-address-range-cidr 10.0.1.0/24 --zone
is1b --subnet-group-srn SUBNET-GROUP-SRN
networking-suite-api subnet update <srn> [flags]
サブネットの名前と説明を更新します。両方の値を指定してください。例: skr networking-suite-api subnet update
SUBNET-SRN --name NAME --description DESCRIPTION
networking-suite-api subnet delete <srn>
サブネットを削除します。接続中の NIC がないことを確認してください。例: skr networking-suite-api subnet
delete SUBNET-SRN
networking-suite-api interface-connection create [flags]
指定したサーバ NIC をサブネットへ接続します。例: skr networking-suite-api interface-connection
create --interface-srn INTERFACE-SRN --subnet-srn SUBNET-SRN
networking-suite-api interface-connection delete <srn>
NIC とサブネットの接続を解除します。サーバは停止状態にしてください。例: skr networking-suite-api
interface-connection delete INTERFACE-CONNECTION-SRN
networking-suite-api address list <subnet-srn> [flags]
サブネットに割り当てられた IPv4 アドレスを一覧表示します。例: skr networking-suite-api address list
SUBNET-SRN
networking-suite-api address read <srn>
SRN を指定して IPv4 アドレスを参照します。例: skr networking-suite-api address read
ADDRESS-SRN
apprun-dedicated-api cluster list [flags]
クラスタを一覧表示します。JSON 出力には items と nextCursor が含まれます。
apprun-dedicated-api cluster read <id>
クラスタ ID を指定して詳細を取得します。
apprun-dedicated-api cluster create --request=REQUEST
クラスタを作成します。サービスプリンシパル ID とポート設定を含む JSON を指定します。
apprun-dedicated-api cluster update --request=REQUEST <id>
クラスタの設定を更新します。更新対象の JSON を指定します。
apprun-dedicated-api cluster delete <id>
クラスタを削除します。関連リソースがないことを確認してください。
apprun-dedicated-api application list [flags]
アプリケーションを一覧表示します。
apprun-dedicated-api application create --name=STRING --cluster-id=STRING
アプリケーションをクラスタに登録します。
apprun-dedicated-api application read <id>
アプリケーション ID を指定して詳細を取得します。
apprun-dedicated-api application update <id> [flags]
アクティブバージョンを切り替えるか、--deactivate で停止します。
apprun-dedicated-api application delete <id>
アプリケーションを削除します。削除前に対象 ID を確認してください。
apprun-dedicated-api application containers <id>
アプリケーションのコンテナ配置と状態を取得します。
apprun-dedicated-api version list --application-id=STRING [flags]
アプリケーションのバージョンを一覧表示します。
apprun-dedicated-api version create --application-id=STRING --request=REQUEST
アプリケーションバージョンを作成します。
apprun-dedicated-api version read --application-id=STRING <version>
バージョンの詳細を取得します。
apprun-dedicated-api version delete --application-id=STRING <version>
バージョンを削除します。
apprun-dedicated-api auto-scaling-group list --cluster-id=STRING [flags]
クラスタ内のグループを一覧表示します。
apprun-dedicated-api auto-scaling-group create --cluster-id=STRING --request=REQUEST
クラスタにオートスケーリンググループを作成します。
apprun-dedicated-api auto-scaling-group read --cluster-id=STRING --auto-scaling-group-id=STRING
グループの詳細を取得します。
apprun-dedicated-api auto-scaling-group delete --cluster-id=STRING --auto-scaling-group-id=STRING
グループを削除します。
apprun-dedicated-api worker-node list --cluster-id=STRING --auto-scaling-group-id=STRING [flags]
グループ内のワーカノードを一覧表示します。
apprun-dedicated-api worker-node read --cluster-id=STRING --auto-scaling-group-id=STRING --worker-node-id=STRING
ワーカノードの詳細を取得します。
apprun-dedicated-api worker-node update --cluster-id=STRING --auto-scaling-group-id=STRING --worker-node-id=STRING --draining=STRING
ワーカノードの draining 状態を変更します。
apprun-dedicated-api load-balancer list --cluster-id=STRING --auto-scaling-group-id=STRING [flags]
グループ内のロードバランサを一覧表示します。
apprun-dedicated-api load-balancer create --cluster-id=STRING --auto-scaling-group-id=STRING --request=REQUEST
ロードバランサを作成します。
apprun-dedicated-api load-balancer read --cluster-id=STRING --auto-scaling-group-id=STRING --load-balancer-id=STRING
ロードバランサの詳細を取得します。
apprun-dedicated-api load-balancer delete --cluster-id=STRING --auto-scaling-group-id=STRING --load-balancer-id=STRING
ロードバランサを削除します。
apprun-dedicated-api load-balancer node list --cluster-id=STRING --auto-scaling-group-id=STRING --load-balancer-id=STRING [flags]
ロードバランサのノード一覧を取得します。
apprun-dedicated-api load-balancer node read --cluster-id=STRING --auto-scaling-group-id=STRING --load-balancer-id=STRING --node-id=STRING
ロードバランサノードの詳細を取得します。
apprun-dedicated-api certificate list --cluster-id=STRING [flags]
クラスタの証明書一覧を取得します。
apprun-dedicated-api certificate create --cluster-id=STRING --request=REQUEST
証明書を作成します。PEM を含む JSON は保護したファイルまたは標準入力から渡してください。
apprun-dedicated-api certificate read --cluster-id=STRING --certificate-id=STRING
証明書の詳細を取得します。
apprun-dedicated-api certificate update --cluster-id=STRING --certificate-id=STRING --request=REQUEST
証明書を更新します。PEM を含む JSON は保護したファイルまたは標準入力から渡してください。
apprun-dedicated-api certificate delete --cluster-id=STRING --certificate-id=STRING
証明書を削除します。
apprun-dedicated-api service-class list-lb
ロードバランサのサービスクラス一覧を取得します。
apprun-dedicated-api service-class list-worker
ワーカノードのサービスクラス一覧を取得します。
apprun-api application list [flags]
アプリケーション一覧を取得します。ページングと並び順はフラグで指定できます。
apprun-api application read <id>
アプリケーションの設定と公開 URL を取得します。
apprun-api application create [flags]
コンテナイメージからアプリケーションを作成します。コンテナイメージの設定にはコンポーネント名、CPU、メモリ、レジストリ設定が必要です。認証情報を含む可能性があるためリクエストは保護したファイルまたは標準入力から読み込みます。例:
skr apprun-api application create --request @application.json
apprun-api application update <id> [flags]
アプリケーションを部分更新します。リソース構成の変更により新しいバージョンが作成されます。認証情報を含む JSON
は保護したファイルまたは標準入力から渡してください。
apprun-api application delete <id>
アプリケーションを削除します。削除前に対象 ID を確認してください。
apprun-api application status <id>
アプリケーションのステータスを取得します。
apprun-api version list --application-id=STRING [flags]
アプリケーションのバージョン一覧を取得します。
apprun-api version read --application-id=STRING --version-id=STRING
アプリケーションのバージョン詳細を取得します。
apprun-api version delete --application-id=STRING --version-id=STRING
アプリケーションのバージョンを削除します。最新バージョン、トラフィックの宛先に指定したバージョン、最後の1件は削除できません。
apprun-api version status --application-id=STRING --version-id=STRING
アプリケーションのバージョンステータスを取得します。
apprun-api packet-filter read <application-id>
アプリケーションのパケットフィルターを取得します。
apprun-api packet-filter update <application-id> [flags]
パケットフィルターの有効状態と IPv4 アドレス設定を更新します。
apprun-api traffic list <application-id>
アプリケーションのトラフィック分散設定を取得します。
apprun-api traffic update <application-id> [flags]
最大4バージョンへのトラフィック分散割合を更新します。最新バージョンを対象にする場合は is_latest_version を指定します。
apprun-api user read
ログイン中の AppRun ユーザー情報を取得します。
apprun-api user create
AppRun にサインアップします。
container-registry-api registry list [flags]
コンテナレジストリを検索します。
container-registry-api registry create [flags]
コンテナレジストリを作成します。
container-registry-api registry read <id>
ID を指定してコンテナレジストリを読み取ります。
container-registry-api registry update --request=STRING <id>
コンテナレジストリの説明、タグ、アイコン、独自ドメインを更新します。
container-registry-api registry delete <id>
ID を指定してコンテナレジストリを削除します。
container-registry-api registry user list <registry-id>
コンテナレジストリのユーザーを一覧表示します。
container-registry-api registry user add --user-name=STRING --password-file=STRING --permission=STRING <registry-id>
認証ユーザーを追加します。パスワードは保護されたファイルまたは標準入力から読み込みます。
container-registry-api registry user update <registry-id> <user-name> [flags]
認証ユーザーのパスワードまたは権限を更新します。
container-registry-api registry user delete <registry-id> <user-name>
認証ユーザーを削除します。
object-storage-api site list
利用可能なサイトを一覧表示します。
object-storage-api site read <site-id>
サイトの情報を取得します。
object-storage-api site plans <site-id>
サイトで選択できるバケットプランを一覧表示します。
object-storage-api site status read <site-id>
サイトの状態を取得します。
object-storage-api site status quota <site-id>
サイトのクォータを取得します。
object-storage-api site status bucket-metering --from=STRING --to=STRING <site-id> <bucket-name>
期間を指定してバケットの利用量を取得します。
object-storage-api account create <site-id>
サイトアカウントを作成します。
object-storage-api account read <site-id>
サイトアカウントを取得します。
object-storage-api account delete <site-id>
サイトアカウントを削除します。
object-storage-api account access-key list <site-id>
サイトアカウントのアクセスキーを一覧表示します。
object-storage-api account access-key create <site-id>
アクセスキーを発行します。シークレットは作成時の応答にのみ含まれます。
object-storage-api account access-key read <site-id> <key-id>
アクセスキーの情報を取得します。
object-storage-api account access-key delete <site-id> <key-id>
アクセスキーを削除します。
object-storage-api bucket list <site-id>
サイト内のバケットを一覧表示します。
object-storage-api bucket create <site-id> <bucket-name> [flags]
バケットを作成します。現在利用できるサイトは isk01、tky01、arc02 です。arc02 では --plan
を指定します。作成完了後からバケットの基本料金が発生します。
object-storage-api bucket delete <site-id> <bucket-name>
指定サイトに所属するバケットを削除します。所属を確認できない場合は拒否します。バケット内のオブジェクトを事前に削除してください。
object-storage-api bucket encryption read <site-id> <bucket-name>
暗号化設定を取得します。
object-storage-api bucket encryption enable --kms-key-id=STRING <site-id> <bucket-name>
KMS キーを指定して暗号化を有効にします。
object-storage-api bucket encryption disable <site-id> <bucket-name>
バケット暗号化を無効にします。
object-storage-api bucket replication read <site-id> <bucket-name>
レプリケーション設定を取得します。
object-storage-api bucket replication enable --target-bucket=STRING <site-id> <bucket-name>
別サイトのバケットを宛先にしてレプリケーションを有効にします。
object-storage-api bucket replication disable <site-id> <bucket-name>
レプリケーションを無効にします。
object-storage-api bucket penalty <site-id> <bucket-name>
バケットのペナルティ情報を取得します。
object-storage-api bucket usage <site-id> <bucket-name>
バケットの利用量を取得します。
object-storage-api bucket quota <site-id> <bucket-name>
バケットのクォータを取得します。
object-storage-api permission list <site-id>
サイトのパーミッションを一覧表示します。
object-storage-api permission create --request=STRING <site-id>
バケット制御を指定してパーミッションを作成します。
object-storage-api permission read <site-id> <permission-id>
パーミッションを取得します。
object-storage-api permission update --request=STRING <site-id> <permission-id>
パーミッション名とバケット制御を更新します。
object-storage-api permission delete <site-id> <permission-id>
パーミッションを削除します。
object-storage-api permission access-key list <site-id> <permission-id>
アクセスキーを一覧表示します。
object-storage-api permission access-key create <site-id> <permission-id>
アクセスキーを発行します。シークレットは作成時の応答にのみ含まれます。
object-storage-api permission access-key read <site-id> <permission-id> <key-id>
アクセスキーの情報を取得します。
object-storage-api permission access-key delete <site-id> <permission-id> <key-id>
アクセスキーを削除します。
iam-api user list [flags]
IAM ユーザーを一覧表示します。--page、--per-page、--ordering で取得範囲と並び順を指定できます。
iam-api user create [flags]
IAM ユーザーを作成します。パスワードは --password-file でファイルまたは標準入力から指定します。
iam-api user read <id>
ID を指定して IAM ユーザーを読み取ります。
iam-api user update <id> [flags]
IAM ユーザーの名前、説明、パスワードを更新します。名前と説明は必須です。パスワードは --password-file を指定した場合のみ変更します。
iam-api user delete <id>
ID を指定して IAM ユーザーを削除します。
iam-api user register-email --email=STRING <user-id>
ユーザーのメールアドレスを登録します。作成時の --email は SSO の外部 IdP ログインで使うメールアドレスで、この操作とは別の項目です。
iam-api user unregister-email <user-id>
ユーザーのメールアドレスの登録を解除します。
iam-api group list [flags]
IAM グループを一覧表示します。--user-id で指定したユーザーが所属するグループに絞り込めます。
iam-api group create --name=STRING --description=STRING
IAM グループを作成します。作成後、update-memberships でユーザーを所属させてください。
iam-api group read <id>
ID を指定して IAM グループを読み取ります。
iam-api group update --name=STRING --description=STRING <id>
IAM グループの名前と説明を更新します。どちらも必須で、指定しない項目は空で上書きされます。
iam-api group delete <id>
ID を指定して IAM グループを削除します。
iam-api group read-memberships <group-id>
グループに所属するユーザーを一覧表示します。
iam-api group update-memberships <group-id> [flags]
グループの所属ユーザーを置き換えます。現在の所属は保持されず、指定した配列で上書きされます。read-memberships
で現在の所属を確認できます。
iam-api policy read-organization
組織の IAM ポリシーバインディング（ロールとプリンシパルの割り当て）を一覧表示します。
iam-api policy update-organization [flags]
組織の IAM ポリシーバインディングを置き換えます。現在の割り当て全体を --request に JSON
配列で指定します。read-organization の出力を基に編集してください。
iam-api policy read-project <project-id>
指定したプロジェクトの IAM ポリシーバインディング（ロールとプリンシパルの割り当て）を一覧表示します。
iam-api policy update-project <project-id> [flags]
指定したプロジェクトの IAM ポリシーバインディングを置き換えます。現在の割り当て全体を --request に JSON
配列で指定します。read-project の出力を基に編集してください。
iam-api policy read-folder <folder-id>
指定したフォルダの IAM ポリシーバインディング（ロールとプリンシパルの割り当て）を一覧表示します。
iam-api policy update-folder <folder-id> [flags]
指定したフォルダの IAM ポリシーバインディングを置き換えます。現在の割り当て全体を --request に JSON
配列で指定します。read-folder の出力を基に編集してください。
iam-api auth read-password-policy
組織のパスワードポリシーを参照します。
iam-api auth update-password-policy [flags]
組織のパスワードポリシーを更新します。--request ではすべての項目を含む JSON
を指定します。フラグを使う場合も4項目すべてを指定してください。
iam-api auth read-auth-conditions
組織の認証条件を参照します。
iam-api auth update-auth-conditions [flags]
組織の認証条件を更新します。現在の設定を read-auth-conditions で確認し、すべての項目を含む JSON を指定してください。
iam-api auth read-auth-context
現在の認証情報に対応する IAM 認証コンテキストを参照します。
iam-api folder list [flags]
IAM フォルダを一覧表示します。ページングや絞り込みには --request または対応する個別フラグを指定します。
iam-api folder create [flags]
IAM フォルダを作成します。親フォルダを指定する場合は --parent-id を指定してください。
iam-api folder read <id>
ID を指定して IAM フォルダを読み取ります。
iam-api folder update --name=STRING <id> [flags]
IAM フォルダの名前と説明を更新します。説明を変更しない場合は --description を省略します。
iam-api folder move --ids=IDS,... --parent-id=PARENT-ID
指定したフォルダを親フォルダへ移動します。移動先が有効な階層になることを確認してください。
iam-api folder delete <id>
ID を指定して IAM フォルダを削除します。
iam-api iam-role list [flags]
利用可能な IAM ロールを一覧表示します。
iam-api iam-role read <id>
ID を指定して IAM ロールを読み取ります。
iam-api id-policy read-organization
組織の ID ポリシーを参照します。
iam-api id-policy update-organization [flags]
組織の ID ポリシー全体を置き換えます。変更前に read-organization で現在の設定を保存してください。
iam-api id-role list [flags]
利用可能な ID ロールを一覧表示します。
iam-api id-role read <id>
ID を指定して ID ロールを読み取ります。
iam-api organization read
IAM 組織の情報を参照します。
iam-api organization update --name=STRING
IAM 組織名を更新します。
iam-api organization read-service-policy [flags]
組織のサービス利用ポリシーを参照します。
iam-api organization update-service-policy [flags]
組織のサービス利用ポリシー全体を更新します。設定はサービス操作に影響するため、変更前に read-service-policy
で現在の設定を確認してください。
iam-api project list [flags]
IAM プロジェクトを一覧表示します。
iam-api project create [flags]
IAM プロジェクトを作成します。既存のフォルダ内に作成する場合は --parent-folder-id を指定してください。
iam-api project read <id>
ID を指定して IAM プロジェクトを読み取ります。
iam-api project update --name=STRING --description=STRING <id>
IAM プロジェクトの名前と説明を更新します。両方の値を指定してください。
iam-api project move --ids=IDS,... --parent-folder-id=PARENT-FOLDER-ID
指定したプロジェクトをフォルダへ移動します。
iam-api project delete <id>
ID を指定して IAM プロジェクトを削除します。
iam-api project-api-key list [flags]
プロジェクト API キーを一覧表示します。
iam-api project-api-key create [flags]
プロジェクト API キーを作成します。レスポンスにアクセストークンとシークレットが含まれるため、出力を安全に保管してください。
iam-api project-api-key read <id>
ID を指定してプロジェクト API キーを読み取ります。
iam-api project-api-key update <id> [flags]
プロジェクト API キーを更新します。現在の設定を read で確認し、変更後の設定を JSON で指定してください。
iam-api project-api-key delete <id>
ID を指定してプロジェクト API キーを削除します。
iam-api scim list [flags]
ユーザープロビジョニング設定を一覧表示します。
iam-api scim create [flags]
ユーザープロビジョニング設定を作成します。
iam-api scim read <id>
ID を指定してユーザープロビジョニング設定を読み取ります。
iam-api scim update <id> [flags]
ユーザープロビジョニング設定を更新します。更新後の設定名を --name または --request JSON の name に指定してください。
iam-api scim delete <id>
ID を指定してユーザープロビジョニング設定を削除します。プロビジョニングされたユーザーとグループをすべて削除してから実行してください。
iam-api scim regenerate-token <id>
ユーザープロビジョニング設定の秘密トークンを再発行します。再発行後は古いトークンが使えなくなるため、連携先を更新できる場合にのみ実行してください。
iam-api service-policy enable
サービス利用ポリシーを有効化します。サービス操作の制限に影響するため、実行前に設定内容を確認してください。
iam-api service-policy disable
サービス利用ポリシーを無効化します。サービス操作の制限に影響するため、実行前に設定内容を確認してください。
iam-api service-policy is-enabled
サービス利用ポリシーが有効かどうかを確認します。
iam-api service-policy list-rule-templates [flags]
サービス利用ポリシーのルールテンプレートを一覧表示します。
iam-api service-principal list [flags]
サービスプリンシパルを一覧表示します。
iam-api service-principal create [flags]
サービスプリンシパルを作成します。
iam-api service-principal read <id>
ID を指定してサービスプリンシパルを読み取ります。
iam-api service-principal update <id> [flags]
サービスプリンシパルの名前と説明を更新します。名前と説明は必須です。
iam-api service-principal delete <id>
ID を指定してサービスプリンシパルを削除します。
iam-api service-principal list-keys <id> [flags]
サービスプリンシパルに登録されたキーを一覧表示します。
iam-api service-principal upload-key --public-key-file=STRING <id>
サービスプリンシパルに PEM 形式の RSA 公開鍵（2048～4096 ビット）を登録します。公開鍵は --public-key-file
で読み込みます。
iam-api service-principal enable-key <id> <key-id>
指定したサービスプリンシパルキーを有効化します。
iam-api service-principal disable-key <id> <key-id>
指定したサービスプリンシパルキーを無効化します。
iam-api service-principal delete-key <id> <key-id>
指定したサービスプリンシパルキーを削除します。
iam-api service-principal issue-token --assertion-file=STRING
登録済み公開鍵に対応する秘密鍵で署名した JWT アサーションからアクセストークンを発行します。アサーションは --assertion-file
で読み込み、発行されたトークンは秘密情報として扱います。
iam-api sso list [flags]
SSO プロファイルを一覧表示します。
iam-api sso create [flags]
SSO プロファイルを作成します。IdP の証明書など複数項目を JSON で指定してください。
iam-api sso read <id>
ID を指定して SSO プロファイルを読み取ります。
iam-api sso update <id> [flags]
SSO プロファイルを更新します。必要な IdP 設定一式を JSON で指定してください。
iam-api sso delete <id>
ID を指定して SSO プロファイルを削除します。
iam-api sso link <id>
SSO プロファイルを組織で有効にします。有効なプロファイルは一つで、ユーザーのログイン方法に影響するため、IdP
設定と対象ユーザーのメールアドレスを確認してください。
iam-api sso unlink <id>
SSO プロファイルと組織のリンクを解除します。ユーザーのログイン方法に影響するため、実行前に対象プロファイルを確認してください。
iam-api user-2fa deactivate-otp --user-id=INT
指定したユーザーの OTP を無効化します。ログイン方法に影響するため、--user-id で対象を確認してください。
iam-api user-2fa list-trusted-devices --user-id=INT
指定したユーザーの信頼済みデバイスを一覧表示します。
iam-api user-2fa delete-trusted-device --user-id=INT <trusted-device-id>
指定したユーザーの信頼済みデバイスを削除します。
iam-api user-2fa clear-trusted-devices --user-id=INT
指定したユーザーの信頼済みデバイスをすべて削除します。--user-id で対象を確認してください。
iam-api user-2fa list-security-keys --user-id=INT
指定したユーザーのセキュリティキーを一覧表示します。
iam-api user-2fa read-security-key --user-id=INT <security-key-id>
ID を指定してセキュリティキーを読み取ります。
iam-api user-2fa delete-security-key --user-id=INT <security-key-id>
指定したユーザーのセキュリティキーを削除します。
kms-api key list [flags]
KMS キーを一覧表示します。--count と --from でページングできます。
kms-api key read <id>
ID を指定して KMS キーを読み取ります。
kms-api key create [flags]
KMS キーを作成します。
kms-api key update <id> [flags]
KMS キーの名前、説明、タグを更新します。--name が必須です。Description は指定した場合だけリクエストに含まれます。Tags
は常にリクエストに含まれ、個別フラグのみでの更新では null (タグのクリア) として送信されます。タグを設定・維持する場合は --request
JSON で Tags を指定してください。
kms-api key delete <id>
ID を指定して KMS キーを削除します。削除前に対象 ID を確認してください。
kms-api key rotate <id>
KMS キーをローテーションします。有効 (active) なキーだけが対象で、BYOK モードでインポートしたキーはローテーションできません。
kms-api key change-status --status=STRING <id>
KMS キーの状態を変更します。
kms-api key schedule-destruction --pending-days=INT <id>
KMS キーの削除を予約します。削除予約中のキーは利用できませんが、状態変更で削除を取り消せます。
kms-api key encrypt --plain-file=STRING <id> [flags]
KMS キーで平文を暗号化します。
kms-api key decrypt --cipher-file=STRING <id>
KMS キーで暗号文を復号します。
secretmanager-api vault list [flags]
シークレット保管庫 (Vault) を一覧表示します。--count と --from でページングできます。
secretmanager-api vault read <id>
ID を指定してシークレット保管庫 (Vault) を読み取ります。
secretmanager-api vault create [flags]
シークレット保管庫 (Vault) を作成します。Vault 単位で課金が行われ、Vault
が作成されてから削除されるまでの間課金されます。--kms-key-id にはシークレットの暗号化に使う既存の KMS キー ID
を指定します。Tags は --request JSON でのみ指定できます。
secretmanager-api vault update <id> [flags]
シークレット保管庫 (Vault) の名前、説明、タグを更新します。--name が必須です。Description
は指定した場合だけリクエストに含まれます。Tags は常にリクエストに含まれ、個別フラグのみでの更新では null (タグのクリア)
として送信されます。タグを設定・維持する場合は --request JSON で Tags を指定してください。
secretmanager-api vault delete <id>
ID を指定してシークレット保管庫 (Vault) を削除します。削除前に対象 ID を確認してください。
secretmanager-api secret list <vault-id> [flags]
Vault 内のシークレットを一覧表示します。シークレットの値は含まれません。--count と --from でページングできます。
secretmanager-api secret create --name=NAME --value-file=VALUE-FILE <vault-id>
Vault にシークレットを作成または更新します (upsert)。同名シークレットが存在する場合は新しいバージョンとして登録され、最新を含む 50
世代まで保管されます。値は --value-file でのみ指定できます。
secretmanager-api secret delete <vault-id> <name>
Vault からシークレットを削除します。全バージョンが削除されます。削除前に対象 Vault ID とシークレット名を確認してください。
secretmanager-api secret unveil <vault-id> <name> [flags]
シークレットを復号して値を取得します。値はそのまま標準出力へ出力され、--query
は適用されません。出力に秘密情報が含まれるため、リダイレクト先とシェル履歴の取り扱いに注意してください。
service-endpoint-gateway-api appliance list
サービスエンドポイントゲートウェイを一覧表示します。
service-endpoint-gateway-api appliance read <id>
ID を指定してサービスエンドポイントゲートウェイを読み取ります。
service-endpoint-gateway-api appliance create [flags]
スイッチにサービスエンドポイントゲートウェイを作成します。サービスエンドポイントゲートウェイはスイッチ単体でのみ利用でき、ルータ＋スイッチでは作成できません。1
つのスイッチに対して複数のサービスエンドポイントゲートウェイを作成することはできません。作成には接続先スイッチ ID
とゲートウェイに割り当てるサブネットマスク長が必要です。--request は Appliance.Remark に
Switch.ID、Network.NetworkMaskLen、Servers[].IPAddress を指定する JSON を受け付け、Class
と Plan は自動設定されます。--request と個別フラグは併用できません。
service-endpoint-gateway-api appliance update <id> [flags]
サービスエンドポイントゲートウェイの接続先マネージドサービス設定を更新します。Settings は全体置換です。既存の設定を維持したい項目は
JSON に再指定してください。EnabledServices には接続先マネージドサービスを Type と Config で指定します (Type:
ObjectStorage、ContainerRegistry、MonitoringSuite、AppRunDedicatedControlPlane
など)。MonitoringSuite と DNSForwarding の Enabled は True または False です。設定の反映は
apply で行います。
service-endpoint-gateway-api appliance apply <id>
update
で変更した設定をサービスエンドポイントゲートウェイへ反映します。接続先マネージドサービスの変更時、ゲートウェイ経由の通信が一時的に中断することがあります。
service-endpoint-gateway-api appliance delete <id>
ID を指定してサービスエンドポイントゲートウェイを削除します。削除前に対象 ID を確認してください。
service-endpoint-gateway-api appliance read-interface <appliance-id> <interface-id>
サービスエンドポイントゲートウェイのインターフェース情報を取得します。ゲートウェイの IPv4 アドレスは、利用するサーバーの DNS 設定に使います。
service-endpoint-gateway-api appliance read-power-status <id>
サービスエンドポイントゲートウェイの電源状態を取得します。
service-endpoint-gateway-api appliance power-on <id>
サービスエンドポイントゲートウェイの電源を投入します。作成直後は起動処理が行われていることがあります。
service-endpoint-gateway-api appliance shutdown <id>
サービスエンドポイントゲートウェイの電源を停止します。ゲートウェイ経由の通信が停止します。
service-endpoint-gateway-api appliance reset <id>
サービスエンドポイントゲートウェイの電源を再起動します。ゲートウェイ経由の通信が一時的に中断します。
http <url> [flags]
SDK の認証情報を使って HTTPS URL に直接リクエストを送ります。指定したホストへアカウントの認証情報が送信されるため、信頼できる
API エンドポイントだけを指定してください。レスポンス本文は形式を変えずに出力し、--query による加工は行いません。例: skr http
'https://api.example.test/path' --method GET
Run "skr <command> --help" for more information on a command.
version
skr version
Usage: skr version [flags]
Print version information.
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
config
skr config
Usage: skr config <command> [flags]
Manage configuration profiles.
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
config current
Print the current profile name.
config list
List configuration profiles.
config show [<name>]
Show a configuration profile.
config create [<name>] [flags]
コントロールパネルで作成したサービスプリンシパルキーを含む profile を新規作成します。
config edit [<name>] [flags]
既存 profile のサービスプリンシパルキー認証情報を編集します。
config use [<name>]
Set the current configuration profile.
skr config current
Usage: skr config current
Print the current profile name.
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr config list
Usage: skr config list
List configuration profiles.
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr config show
Usage: skr config show [<name>]
Show a configuration profile.
Arguments:
[<name>] Profile name to show. Defaults to the current profile.
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr config create
Usage: skr config create [<name>] [flags]
コントロールパネルで作成したサービスプリンシパルキーを含む profile を新規作成します。
Arguments:
[<name>] Profile 名。省略時は default です。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--service-principal-id=STRING
サービスプリンシパル ID。
--service-principal-key-id=STRING
サービスプリンシパルキーの ID (KID)。
--private-key-file=STRING RSA 秘密鍵の PEM ファイルパス。
--use 作成した profile を現在の profile に設定します。
skr config edit
Usage: skr config edit [<name>] [flags]
既存 profile のサービスプリンシパルキー認証情報を編集します。
Arguments:
[<name>] Profile 名。省略時は現在の profile です。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--service-principal-id=STRING
サービスプリンシパル ID。
--service-principal-key-id=STRING
サービスプリンシパルキーの ID (KID)。
--private-key-file=STRING RSA 秘密鍵の PEM ファイルパス。
--use 編集した profile を現在の profile に設定します。
skr config use
Usage: skr config use [<name>]
Set the current configuration profile.
Arguments:
[<name>] Profile name to set as current. Defaults to the current profile.
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
iaas-api
skr iaas-api
Usage: skr iaas-api <command> [flags]
さくらのクラウド IaaS API を操作します。SDK のプロファイル、または SAKURA_ACCESS_TOKEN /
SAKURA_ACCESS_TOKEN_SECRET 環境変数で認証します。結果は JSON で出力します。--query で必要な項目を抽出できます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iaas-api archive find [flags]
アーカイブを指定したゾーンで検索して出力します。API の
ID、Name、Description、DiskPlanID、DiskPlanName、SizeMB、Tags を確認できます。OS
種別またはタグで絞り込めます。例: skr iaas-api archive find --zone is1b --os-type ubuntu2404
iaas-api archive read [flags]
指定したゾーンと ID のアーカイブを読み取って出力します。API の DiskPlanID、DiskPlanName、SizeMB、Tags
などを確認できます。例: skr iaas-api archive read --zone ZONE --id 123456789012
iaas-api database find [flags]
データベースアプライアンスを指定したゾーンで検索して出力します。例: skr iaas-api database find --zone tk1v
--name example
iaas-api database read [flags]
データベースアプライアンスを読み取って出力します。例: skr iaas-api database read --zone ZONE --id
123456789012
iaas-api database create [flags]
データベースアプライアンスを作成して出力します。基本項目はフラグ、複雑な値は --request JSON で指定します。例: skr iaas-api
database create --zone tk1v --name example --plan-id 10 --switch-id
123456789012 --ip-address 192.168.0.11 --network-mask-len 24 --database-type
mariadb --username dbuser --password @db-password.txt
iaas-api database update [flags]
データベースアプライアンスの設定を更新します。送信した内容で設定が置き換わるため、保持したい項目も含めて指定してください。ゾーンと ID
はフラグ、更新内容は --request JSON で指定します。例: skr iaas-api database update --zone tk1v
--id 123456789012 --request @db-update.json
iaas-api database delete [flags]
データベースアプライアンスを削除します。成功時は出力しません。例: skr iaas-api database delete --zone ZONE
--id 123456789012
iaas-api database boot [flags]
データベースアプライアンスを起動します。成功時は出力しません。例: skr iaas-api database boot --zone ZONE
--id 123456789012
iaas-api database shutdown [flags]
データベースアプライアンスをシャットダウンします。成功時は出力しません。例: skr iaas-api database shutdown --zone
ZONE --id 123456789012
iaas-api database reset [flags]
データベースアプライアンスを再起動します。成功時は出力しません。例: skr iaas-api database reset --zone ZONE
--id 123456789012
iaas-api database monitor-cpu [flags]
CPU 使用率のモニタリング値を指定した期間で取得して出力します。例: skr iaas-api database monitor-cpu
--zone ZONE --id 123456789012 --start 2025-01-01T00:00:00+09:00 --end
2025-01-02T00:00:00+09:00
iaas-api database monitor-disk [flags]
ディスク使用量のモニタリング値を指定した期間で取得して出力します。例: skr iaas-api database monitor-disk
--zone ZONE --id 123456789012
iaas-api database monitor-interface [flags]
ネットワーク送受信のモニタリング値を指定した期間で取得して出力します。例: skr iaas-api database
monitor-interface --zone ZONE --id 123456789012
iaas-api database monitor-database [flags]
メモリやレプリケーション遅延などデータベース固有のモニタリング値を指定した期間で取得して出力します。例: skr iaas-api database
monitor-database --zone ZONE --id 123456789012
iaas-api database list-parameter [flags]
データベースアプライアンスの設定パラメータ一覧を取得して出力します。パラメータは RDBMS 固有の設定値です。例: skr iaas-api
database list-parameter --zone ZONE --id 123456789012
iaas-api disk find [flags]
ディスクを指定したゾーンで検索して出力します。例: skr iaas-api disk find --zone is1b
iaas-api disk read [flags]
ディスクを読み取って出力します。例: skr iaas-api disk read --zone ZONE --id 123456789012
iaas-api disk create [flags]
ディスクを作成して出力します。基本項目はフラグ、複雑な値は --request JSON で指定します。例: skr iaas-api disk
create --zone is1b --name DISK-NAME --disk-plan-id 4 --connection virtio
--size-gb 20
iaas-api disk update [flags]
ディスクの指定項目を更新して出力します。省略した項目は変更しません。例: skr iaas-api disk update --zone ZONE
--id 123456789012 --name UPDATED-DISK-NAME
iaas-api disk delete [flags]
ディスクを削除します。サーバに接続中のディスクは削除できません。削除後は復旧できません。成功時は出力しません。例: skr iaas-api disk
delete --zone ZONE --id 123456789012 --fail-if-not-found
iaas-api icon find [flags]
アイコンを検索して出力します。Names、Tags、Scope、Sort は --request JSON
で指定できます。条件を省略すると一覧を取得します。例: skr iaas-api icon find --request @icon-find.json
iaas-api icon read [flags]
ID を指定してアイコンを読み取って出力します。例: skr iaas-api icon read --id 123456789012
iaas-api icon create [flags]
画像ファイルからアイコンを作成して出力します。例: skr iaas-api icon create --name example
--image-file ./icon.png
iaas-api icon update [flags]
アイコンの指定項目を更新して出力します。省略した項目は変更しません。例: skr iaas-api icon update --id
123456789012 --name updated
iaas-api icon delete [flags]
アイコンを削除します。成功時は出力しません。例: skr iaas-api icon delete --id 123456789012
iaas-api internet find [flags]
ルータ＋スイッチを指定したゾーンで検索して出力します。例: skr iaas-api internet find --zone is1b
iaas-api internet read [flags]
ルータ＋スイッチを読み取って出力します。
iaas-api internet create [flags]
ルータ＋スイッチを作成して出力します。課金対象になる場合があります。例: skr iaas-api internet create --zone
is1b --name ROUTER-SWITCH-NAME --network-mask-len 28 --band-width-mbps 100
iaas-api internet update [flags]
ルータ＋スイッチの設定を更新して出力します。例: skr iaas-api internet update --zone is1b --id
123456789012 --name UPDATED-NAME
iaas-api internet delete [flags]
ルータ＋スイッチを削除します。--force は IPv6 の無効化と NextHop が設定された追加サブネットの削除も行います。例:
skr iaas-api internet delete --zone is1b --id 123456789012
iaas-api internet list-subnet [flags]
ルータ＋スイッチに設定された IP アドレスブロックを一覧表示します。
iaas-api internet add-subnet [flags]
ルータ＋スイッチに IP アドレスブロックを追加します。ネクストホップとなるサーバを先に用意してください。
iaas-api internet update-subnet [flags]
追加した IP アドレスブロックのネクストホップを更新します。
iaas-api internet delete-subnet [flags]
ルータ＋スイッチに追加した IP アドレスブロックを削除します。
iaas-api internet read-ipv6 [flags]
ルータ＋スイッチに割り当てられた IPv6 ネットワークを読み取ります。
iaas-api internet enable-ipv6 [flags]
ルータ＋スイッチの IPv6 アドレス割り当てを有効にして、割り当て結果を出力します。
iaas-api internet disable-ipv6 [flags]
ルータ＋スイッチの IPv6 アドレス割り当てを無効にします。
iaas-api internet monitor-router [flags]
ルータ＋スイッチのトラフィックを指定期間で取得して出力します。例: skr iaas-api internet monitor-router
--zone is1b --id 123456789012 --start 2026-10-14T00:00:00Z --end
2026-10-15T00:00:00Z
iaas-api ipaddress list [flags]
グローバル IP アドレスを指定したゾーンで一覧表示します。例: skr iaas-api ipaddress list --zone is1b
iaas-api ipaddress read [flags]
指定したグローバル IP アドレスの情報を取得します。例: skr iaas-api ipaddress read --zone is1b
--ip-address 192.0.2.1
iaas-api ipaddress update-host-name [flags]
指定したグローバル IP アドレスの逆引きホスト名を変更します。成功時は出力しません。例: skr iaas-api ipaddress
update-host-name --zone is1b --ip-address 192.0.2.1 --host-name
www.example.com
iaas-api ipv6addr find [flags]
IPv6 アドレスを指定したゾーンで検索して出力します。例: skr iaas-api ipv6addr find --zone is1b
iaas-api ipv6addr create [flags]
IPv6 プレフィクス内のアドレスに逆引きホスト名を登録して出力します。例: skr iaas-api ipv6addr create --zone
is1b --ipv6-addr 2001:db8::1 --host-name www.example.com
iaas-api ipv6addr read [flags]
指定した IPv6 アドレスの情報を取得します。例: skr iaas-api ipv6addr read --zone is1b
--ipv6-addr 2001:db8::1
iaas-api ipv6addr update [flags]
指定した IPv6 アドレスの逆引きホスト名を変更して出力します。例: skr iaas-api ipv6addr update --zone is1b
--ipv6-addr 2001:db8::1 --host-name www.example.com
iaas-api ipv6addr delete [flags]
指定した IPv6 アドレスの逆引きホスト名の登録を解除します。成功時は出力しません。例: skr iaas-api ipv6addr delete
--zone is1b --ipv6-addr 2001:db8::1
iaas-api ipv6net find [flags]
IPv6 ネットワークを指定したゾーンで検索して出力します。例: skr iaas-api ipv6net find --zone is1b
iaas-api ipv6net read [flags]
指定した ID の IPv6 ネットワークを取得します。例: skr iaas-api ipv6net read --zone is1b --id
123456789012
iaas-api packetfilter find [flags]
パケットフィルタを指定したゾーンで検索して出力します。例: skr iaas-api packetfilter find --zone is1b
iaas-api packetfilter read [flags]
パケットフィルタを読み取って出力します。例: skr iaas-api packetfilter read --zone ZONE --id
123456789012
iaas-api packetfilter create [flags]
パケットフィルタを作成して出力します。基本項目はフラグ、ルールは --expressions JSON で指定できます。例:
skr iaas-api packetfilter create --zone is1b --name example --expressions
'[{"Protocol":"tcp","DestinationPort":"443","Action":"allow"}]'
iaas-api packetfilter update [flags]
パケットフィルタの指定項目を更新して出力します。ルール配列は --expressions JSON で指定できます。
iaas-api packetfilter delete [flags]
パケットフィルタを削除します。成功時は出力しません。例: skr iaas-api packetfilter delete --zone ZONE
--id 123456789012
iaas-api product disk find [flags]
指定したゾーンで利用できるディスクプランを検索します。API 応答の Total、From、Count、DiskPlans を含む JSON
を出力します。Availability と Size (サイズ、単位、利用可否) を確認できます。例: skr iaas-api product
disk find --zone is1b
iaas-api product disk read [flags]
指定したゾーンと ID のディスクプランを読み取って出力します。API の Availability と Size (サイズ、単位、利用可否)
を確認できます。例: skr iaas-api product disk read --zone ZONE --id 4
iaas-api product internet find [flags]
指定したゾーンのインターネットプランを検索します。API 応答の Total、From、Count、InternetPlans を含む JSON
を出力します。帯域幅と利用可否を確認できます。例: skr iaas-api product internet find --zone is1b
iaas-api product internet read [flags]
指定したゾーンと ID のインターネットプランを参照します。例: skr iaas-api product internet read --zone
ZONE --id INTERNET-PLAN-ID
iaas-api product license find [flags]
ライセンス情報を検索します。API 応答の Total、From、Count、LicenseInfo を含む JSON
を出力します。名称や利用条件を確認できます。
iaas-api product privatehost find [flags]
指定したゾーンの専有ホストプランを検索します。API 応答の Total、From、Count、PrivateHostPlans を含む JSON
を出力します。CPU、CPU モデル、メモリ、利用可否を確認できます。例: skr iaas-api product privatehost find
--zone is1b
iaas-api product privatehost read [flags]
指定したゾーンと ID の専有ホストプランを参照します。例: skr iaas-api product privatehost read --zone
ZONE --id PRIVATE-HOST-PLAN-ID
iaas-api product server find [flags]
指定したゾーンのサーバプランを検索します。API 応答の Total、From、Count、ServerPlans を含む JSON
を出力します。CPU、メモリ、GPU、CPUコミットメント、世代、利用可否を確認できます。例: skr iaas-api product server
find --zone is1b
iaas-api product server read [flags]
指定したゾーンと ID のサーバプランを参照します。例: skr iaas-api product server read --zone ZONE
--id SERVER-PLAN-ID
iaas-api region find [flags]
リージョン一覧を取得します。必要な項目だけを表示する例: skr iaas-api region find --query
'map({ID,Name,Description})'
iaas-api region read [flags]
指定した ID のリージョン情報を取得します。例: skr iaas-api region read --id REGION-ID
iaas-api switch find [flags]
スイッチを指定したゾーンで検索して出力します。例: skr iaas-api switch find --zone tk1v
iaas-api switch read [flags]
スイッチを読み取って出力します。例: skr iaas-api switch read --zone ZONE --id 123456789012
iaas-api switch create [flags]
スイッチを作成して出力します。例: skr iaas-api switch create --zone ZONE --name example
iaas-api switch update [flags]
指定項目だけを更新して出力します。例: skr iaas-api switch update --zone ZONE --id 123456789012
--name updated
iaas-api switch delete [flags]
スイッチを削除します。成功時は出力しません。例: skr iaas-api switch delete --zone ZONE --id
123456789012
iaas-api server find [flags]
サーバを指定したゾーンで検索して出力します。例: skr iaas-api server find --zone tk1v
iaas-api server read [flags]
サーバを読み取って出力します。例: skr iaas-api server read --zone ZONE --id 123456789012
iaas-api server create [flags]
サーバを作成して出力します。基本項目はフラグ、複雑な構成は --request JSON で指定します。ディスクと NIC
は --disk と --nic を繰り返して指定できます。例: skr iaas-api server create
--zone ZONE --name example --cpu 1 --memory-gb 1 --disk
'archive-id=ARCHIVE-ID,plan-id=DISK-PLAN-ID,size-gb=20' --nic
'upstream=shared'
iaas-api server boot --zone=STRING --id=INT-64 [flags]
サーバを起動します。cloud-init の user-data は任意で、--user-data @path.yaml または --user-data
- で指定します。例: skr iaas-api server boot --zone ZONE --id 123456789012
iaas-api server update [flags]
サーバの指定項目を更新して出力します。省略した項目は変更しません。CPU または MemoryGB の変更はプラン変更です。プラン変更後は新しいサーバ
ID を確認してください。例: skr iaas-api server update --zone ZONE --id 123456789012
--name updated
iaas-api server delete [flags]
サーバを削除します。成功時は出力しません。ディスクも削除する場合は --with-disks を指定します。例: skr iaas-api server
delete --zone ZONE --id 123456789012
iaas-api service-class find [flags]
指定したゾーンのサービスクラスを検索します。例: skr iaas-api service-class find --zone is1b
iaas-api zone find [flags]
ゾーン一覧を取得します。名前の抽出例: skr iaas-api zone find --query 'map(.Name)'
iaas-api zone read [flags]
指定した ID のゾーン情報を取得します。例: skr iaas-api zone read --id ZONE-ID
skr iaas-api archive
Usage: skr iaas-api archive <command>
さくらのクラウドのアーカイブを検索・参照します。検索では対象ゾーン、タグまたは OS 種別を指定できます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iaas-api archive find [flags]
アーカイブを指定したゾーンで検索して出力します。API の
ID、Name、Description、DiskPlanID、DiskPlanName、SizeMB、Tags を確認できます。OS
種別またはタグで絞り込めます。例: skr iaas-api archive find --zone is1b --os-type ubuntu2404
iaas-api archive read [flags]
指定したゾーンと ID のアーカイブを読み取って出力します。API の DiskPlanID、DiskPlanName、SizeMB、Tags
などを確認できます。例: skr iaas-api archive read --zone ZONE --id 123456789012
skr iaas-api archive find
Usage: skr iaas-api archive find [flags]
アーカイブを指定したゾーンで検索して出力します。API の
ID、Name、Description、DiskPlanID、DiskPlanName、SizeMB、Tags を確認できます。OS
種別またはタグで絞り込めます。例: skr iaas-api archive find --zone is1b --os-type ubuntu2404
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (単一ゾーン名)。任意: OSType は --os-type
で指定できます。Names (名前の文字列配列)、Tags (文字列配列)、Scope、Sort
は JSON で指定できます。OSType の検索条件は Names または Tags
の指定で対応する条件が上書きされます。Count と From は個別フラグです。例:
--request='{"Zone":"ZONE","Names":["ARCHIVE-NAME"]}'。ZONE
と名前は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。例: --zone is1b
--os-type=OS-TYPE 任意: 公開アーカイブの OS 種別。例:
ubuntu2404、debian12、almalinux9。Names または Tags
を併用すると対応する検索条件が上書きされます。
--tags=TAGS 任意: タグで検索します。カンマ区切りで指定します。API の Tags
フィールドに対応します。--os-type を併用すると OS 種別のタグ条件を上書きします。
--count=COUNT 任意: 取得件数 (整数)。
--from=FROM 任意: 取得開始位置 (整数)。
skr iaas-api archive read
Usage: skr iaas-api archive read [flags]
指定したゾーンと ID のアーカイブを読み取って出力します。API の DiskPlanID、DiskPlanName、SizeMB、Tags
などを確認できます。例: skr iaas-api archive read --zone ZONE --id 123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (数値)。例:
--request='{"Zone":"ZONE","ID":123456789012}'。ZONE と
ID は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: アーカイブ ID (数値)。
skr iaas-api database
Usage: skr iaas-api database <command>
さくらのクラウドのデータベースアプライアンスを検索、参照、作成、更新、削除します。作成は個別フラグまたは --request JSON、更新はゾーン・ID と
--request JSON を使用します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iaas-api database find [flags]
データベースアプライアンスを指定したゾーンで検索して出力します。例: skr iaas-api database find --zone tk1v
--name example
iaas-api database read [flags]
データベースアプライアンスを読み取って出力します。例: skr iaas-api database read --zone ZONE --id
123456789012
iaas-api database create [flags]
データベースアプライアンスを作成して出力します。基本項目はフラグ、複雑な値は --request JSON で指定します。例: skr iaas-api
database create --zone tk1v --name example --plan-id 10 --switch-id
123456789012 --ip-address 192.168.0.11 --network-mask-len 24 --database-type
mariadb --username dbuser --password @db-password.txt
iaas-api database update [flags]
データベースアプライアンスの設定を更新します。送信した内容で設定が置き換わるため、保持したい項目も含めて指定してください。ゾーンと ID
はフラグ、更新内容は --request JSON で指定します。例: skr iaas-api database update --zone tk1v
--id 123456789012 --request @db-update.json
iaas-api database delete [flags]
データベースアプライアンスを削除します。成功時は出力しません。例: skr iaas-api database delete --zone ZONE
--id 123456789012
iaas-api database boot [flags]
データベースアプライアンスを起動します。成功時は出力しません。例: skr iaas-api database boot --zone ZONE
--id 123456789012
iaas-api database shutdown [flags]
データベースアプライアンスをシャットダウンします。成功時は出力しません。例: skr iaas-api database shutdown --zone
ZONE --id 123456789012
iaas-api database reset [flags]
データベースアプライアンスを再起動します。成功時は出力しません。例: skr iaas-api database reset --zone ZONE
--id 123456789012
iaas-api database monitor-cpu [flags]
CPU 使用率のモニタリング値を指定した期間で取得して出力します。例: skr iaas-api database monitor-cpu
--zone ZONE --id 123456789012 --start 2025-01-01T00:00:00+09:00 --end
2025-01-02T00:00:00+09:00
iaas-api database monitor-disk [flags]
ディスク使用量のモニタリング値を指定した期間で取得して出力します。例: skr iaas-api database monitor-disk
--zone ZONE --id 123456789012
iaas-api database monitor-interface [flags]
ネットワーク送受信のモニタリング値を指定した期間で取得して出力します。例: skr iaas-api database
monitor-interface --zone ZONE --id 123456789012
iaas-api database monitor-database [flags]
メモリやレプリケーション遅延などデータベース固有のモニタリング値を指定した期間で取得して出力します。例: skr iaas-api database
monitor-database --zone ZONE --id 123456789012
iaas-api database list-parameter [flags]
データベースアプライアンスの設定パラメータ一覧を取得して出力します。パラメータは RDBMS 固有の設定値です。例: skr iaas-api
database list-parameter --zone ZONE --id 123456789012
skr iaas-api database find
Usage: skr iaas-api database find [flags]
データベースアプライアンスを指定したゾーンで検索して出力します。例: skr iaas-api database find --zone tk1v --name
example
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json で指定します。必須:
Zone (単一のゾーン名)。任意: 単一名の部分一致検索は --name、複数名の Names
と Sort (ソートキーの配列) は JSON で指定します。Tags は --tags
のカンマ区切りまたは JSON 配列、Count と From は個別フラグでも指定できます。例:
--request='{"Zone":"tk1v","Names":["example"]}'。フラグ例:
skr iaas-api database find --zone tk1v --name example
--zone=ZONE 必須: 対象ゾーン名。例: --zone tk1v
--name=NAME 任意: 部分一致で検索する単一の名前。カンマを含めて1つの名前として扱います。API
の名前検索条件に対応し、JSON では Names 配列で指定します。
--tags=TAGS 任意: タグの配列。カンマ区切りで指定します。API の Tags フィールドに対応します。
--count=COUNT 任意: 取得件数 (整数)。
--from=FROM 任意: 取得開始位置 (整数)。
skr iaas-api database read
Usage: skr iaas-api database read [flags]
データベースアプライアンスを読み取って出力します。例: skr iaas-api database read --zone ZONE --id
123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (作成結果にある数値)。例:
--request='{"Zone":"tk1v","ID":123456789012}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: 作成結果の ID (数値)。
skr iaas-api database create
Usage: skr iaas-api database create [flags]
データベースアプライアンスを作成して出力します。基本項目はフラグ、複雑な値は --request JSON で指定します。例: skr iaas-api
database create --zone tk1v --name example --plan-id 10 --switch-id 123456789012
--ip-address 192.168.0.11 --network-mask-len 24 --database-type mariadb
--username dbuser --password @db-password.txt
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST API リクエスト JSON を @path.json または - (標準入力)
で指定します。個別フラグと併用できません。パスワードを含むため、JSON
を直接書く方法は使えません。必須:
Zone、Name、PlanID、SwitchID、IPAddresses、NetworkMaskLen、DatabaseType、Username、Password。任意:
Description、Tags、IconID、DefaultRoute、Port、SourceNetwork、EnableReplication、ReplicaUserPassword、EnableWebUI、EnableBackup、BackupWeekdays、BackupStartTimeHour、BackupStartTimeMinute、EnableBackupv2、Backupv2Weekdays、Backupv2StartTimeHour、Backupv2StartTimeMinute、Backupv2Connect、EnableMonitoringSuite、DiskEncryptionAlgorithm、DiskEncryptionKMSKey。RDBMS
固有のパラメータは Parameters で指定します。起動の完了は待ちません。
--zone=STRING 必須: 作成先ゾーン名。例: --zone tk1v
--name=NAME 必須: データベースアプライアンスの名前。
--description=DESCRIPTION 任意: 説明 (最大512文字)。
--tags=TAGS,... 任意: タグの配列。カンマ区切りで指定します。API の Tags
フィールドに対応します。
--icon-id=ICON-ID 任意: アイコンの ID (数値)。
--plan-id=PLAN-ID 必須: データベースプランの ID (数値)。10: 10GB
(1core-2gb)、30: 30GB (2core-4gb)、90:
90GB (4core-8gb)、240: 240GB (8core-16gb)、500:
500GB、1000: 1TB。例: --plan-id 10
--switch-id=SWITCH-ID 必須: 接続先スイッチの ID
(数値)。スイッチ単体が対象で、ルータ＋スイッチでは利用できません。iaas-api
switch list で確認できます。
--ip-address=IP-ADDRESS,...
必須: データベースアプライアンスに割り当てる IPv4 アドレス。1個または2個
(レプリケーション時) 指定します。例: --ip-address
192.168.0.11
--network-mask-len=NETWORK-MASK-LEN
必須: ネットワークのサブネットマスク長。1 から 32 の整数。例: 24
--default-route=DEFAULT-ROUTE
任意: デフォルトルート (IPv4 アドレス)。
--port=PORT 任意: 接続用ポート番号。省略すると RDBMS の既定ポートを使います。1 から
65535 の整数。
--source-network=SOURCE-NETWORK,...
任意: 接続を許可する送信元ネットワーク (CIDR 形式の IPv4)。例:
--source-network 192.168.0.0/24
--database-type=DATABASE-TYPE
必須: RDBMS の種別。mariadb または postgres。
--database-version=DATABASE-VERSION
任意: RDBMS のバージョン。省略時は提供中の既定バージョンになります。
--username=USERNAME 必須: 既定ユーザーのユーザー名。
--password=PASSWORD 必須: 既定ユーザーのパスワード。@path でファイルから、-
で標準入力から読み込みます。インライン値は指定できません。
--enable-replication 任意: レプリケーションを有効にします。有効時は
--replica-user-password が必要で、--ip-address
を2個指定します。
--replica-user-password=REPLICA-USER-PASSWORD
レプリケーション有効時に必須: レプリケーションユーザーのパスワード。@path
でファイルから、- で標準入力から読み込みます。インライン値は指定できません。
--enable-web-ui 任意: Web UI (Admin UI) を有効にします。
--enable-backup 任意: バックアップを有効にします。有効時は --backup-weekday
の指定を推奨します。
--backup-weekday=BACKUP-WEEKDAY,...
任意: バックアップ取得日 (sun, mon, tue, wed, thu, fri,
sat)。カンマ区切りで指定します。例: --backup-weekday mon,tue
--backup-start-time-hour=BACKUP-START-TIME-HOUR
任意: バックアップ開始時刻の時 (0-23)。分は 15 分単位です。
--backup-start-time-minute=BACKUP-START-TIME-MINUTE
任意: バックアップ開始時刻の分 (0, 15, 30, 45)。
--enable-backup-v2 任意: Backup v2 を有効にします。有効時は
--backup-v2-weekday と --backup-v2-connect
が必要です。
--backup-v2-weekday=BACKUP-V2-WEEKDAY,...
Backup v2 有効時に必須: バックアップ取得日 (sun, mon, tue,
wed, thu, fri, sat)。カンマ区切りで指定します。
--backup-v2-start-time-hour=BACKUP-V2-START-TIME-HOUR
任意: Backup v2 開始時刻の時 (0-23)。
--backup-v2-start-time-minute=BACKUP-V2-START-TIME-MINUTE
任意: Backup v2 開始時刻の分 (0, 15, 30, 45)。
--backup-v2-connect=BACKUP-V2-CONNECT
Backup v2 有効時に必須: バックアップの接続方式。
--enable-monitoring-suite 任意: モニタリングスイート連携を有効にします (有償オプション)。
--disk-encryption-algorithm=DISK-ENCRYPTION-ALGORITHM
任意: ディスク暗号化のアルゴリズム。aes256_xts。KMS 鍵とともに指定します。
--disk-encryption-kms-key=DISK-ENCRYPTION-KMS-KEY
任意: 暗号化に使う KMS 鍵の ID
(数値)。--disk-encryption-algorithm とともに指定します。
skr iaas-api database update
Usage: skr iaas-api database update [flags]
データベースアプライアンスの設定を更新します。送信した内容で設定が置き換わるため、保持したい項目も含めて指定してください。ゾーンと ID はフラグ、更新内容は
--request JSON で指定します。例: skr iaas-api database update --zone tk1v --id
123456789012 --request @db-update.json
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST API リクエスト JSON を @path.json または - (標準入力)
で指定します。直接 JSON を書く方法は使えません。API の更新リクエストのフィールド:
Name、Description、Tags、IconID、CommonSetting
(WebUI、ServicePort、SourceNetwork、DefaultUser、UserPassword、ReplicaUser、ReplicaPassword)、BackupSetting
(Time、DayOfWeek、Connect、Rotate)、Backupv2Setting
(Time、DayOfWeek、Connect、Rotate)、ReplicationSetting
(Model、IPAddress、Port、User、Password)、InterfaceSettings、MonitoringSuite
(Enabled)。送信した内容で設定が置き換わるため、保持したい項目も含めて指定してください。read
の応答の UserPassword と ReplicaPassword
はマスク済みの値で返るため、実際のパスワードを指定してください。パスワードを含む JSON
は保護したファイルか標準入力から渡してください。例: --request @db-update.json
--zone=STRING 必須: 対象ゾーン名。例: --zone tk1v
--id=INT-64 必須: 更新するデータベースアプライアンスの ID (数値)。作成結果や find の出力にある ID
です。
skr iaas-api database delete
Usage: skr iaas-api database delete [flags]
データベースアプライアンスを削除します。成功時は出力しません。例: skr iaas-api database delete --zone ZONE --id
123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json で指定します。必須:
Zone (ゾーン名)、ID (数値)。任意: FailIfNotFound
(真偽値)、Force (真偽値。電源 OFF (強制終了) してから削除します)。例:
--request='{"Zone":"tk1v","ID":123456789012,"FailIfNotFound":true}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: 削除対象の ID (数値)。
--fail-if-not-found 任意: 対象が見つからない場合にエラーにします (真偽値)。
--force 任意: 電源 OFF (強制終了) してから削除します (真偽値)。
skr iaas-api database boot
Usage: skr iaas-api database boot [flags]
データベースアプライアンスを起動します。成功時は出力しません。例: skr iaas-api database boot --zone ZONE --id
123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (数値)。任意:
NoWait (真偽値。true で起動の完了を待ちません)。例:
--request='{"Zone":"tk1v","ID":123456789012}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: 起動対象の ID (数値)。
--no-wait 任意: 起動の完了を待たずに返ります (真偽値)。
skr iaas-api database shutdown
Usage: skr iaas-api database shutdown [flags]
データベースアプライアンスをシャットダウンします。成功時は出力しません。例: skr iaas-api database shutdown --zone
ZONE --id 123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (数値)。任意: NoWait
(真偽値。true でシャットダウンの完了を待ちません)、ForceShutdown
(真偽値。true で強制終了します)。例:
--request='{"Zone":"tk1v","ID":123456789012}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: シャットダウン対象の ID (数値)。
--no-wait 任意: シャットダウンの完了を待たずに返ります (真偽値)。
--force 任意: 強制終了します (真偽値)。
skr iaas-api database reset
Usage: skr iaas-api database reset [flags]
データベースアプライアンスを再起動します。成功時は出力しません。例: skr iaas-api database reset --zone ZONE --id
123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (数値)。例:
--request='{"Zone":"tk1v","ID":123456789012}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: 再起動対象の ID (数値)。
skr iaas-api database monitor-cpu
Usage: skr iaas-api database monitor-cpu [flags]
CPU 使用率のモニタリング値を指定した期間で取得して出力します。例: skr iaas-api database monitor-cpu
--zone ZONE --id 123456789012 --start 2025-01-01T00:00:00+09:00 --end
2025-01-02T00:00:00+09:00
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (数値)。任意:
Start と End (RFC3339 形式の取得期間)。例:
--request='{"Zone":"tk1v","ID":123456789012}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: 対象の ID (数値)。
--start=START 任意: 取得期間の開始 (RFC3339 形式)。例: --start
2025-01-01T00:00:00+09:00
--end=END 任意: 取得期間の終了 (RFC3339 形式)。
skr iaas-api database monitor-disk
Usage: skr iaas-api database monitor-disk [flags]
ディスク使用量のモニタリング値を指定した期間で取得して出力します。例: skr iaas-api database monitor-disk --zone
ZONE --id 123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (数値)。任意:
Start と End (RFC3339 形式の取得期間)。例:
--request='{"Zone":"tk1v","ID":123456789012}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: 対象の ID (数値)。
--start=START 任意: 取得期間の開始 (RFC3339 形式)。例: --start
2025-01-01T00:00:00+09:00
--end=END 任意: 取得期間の終了 (RFC3339 形式)。
skr iaas-api database monitor-interface
Usage: skr iaas-api database monitor-interface [flags]
ネットワーク送受信のモニタリング値を指定した期間で取得して出力します。例: skr iaas-api database monitor-interface
--zone ZONE --id 123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (数値)。任意:
Start と End (RFC3339 形式の取得期間)。例:
--request='{"Zone":"tk1v","ID":123456789012}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: 対象の ID (数値)。
--start=START 任意: 取得期間の開始 (RFC3339 形式)。例: --start
2025-01-01T00:00:00+09:00
--end=END 任意: 取得期間の終了 (RFC3339 形式)。
skr iaas-api database monitor-database
Usage: skr iaas-api database monitor-database [flags]
メモリやレプリケーション遅延などデータベース固有のモニタリング値を指定した期間で取得して出力します。例: skr iaas-api database
monitor-database --zone ZONE --id 123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (数値)。任意:
Start と End (RFC3339 形式の取得期間)。例:
--request='{"Zone":"tk1v","ID":123456789012}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: 対象の ID (数値)。
--start=START 任意: 取得期間の開始 (RFC3339 形式)。未指定時は End の 1 時間前を自動設定します。
--end=END 任意: 取得期間の終了 (RFC3339 形式)。未指定時は現在時刻を自動設定します。
skr iaas-api database list-parameter
Usage: skr iaas-api database list-parameter [flags]
データベースアプライアンスの設定パラメータ一覧を取得して出力します。パラメータは RDBMS 固有の設定値です。例: skr iaas-api database
list-parameter --zone ZONE --id 123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (数値)。例:
--request='{"Zone":"tk1v","ID":123456789012}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: 対象の ID (数値)。
skr iaas-api disk
Usage: skr iaas-api disk <command>
さくらのクラウドのディスクを検索、参照、作成、更新、削除します。作成と更新は --request JSON を使用します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iaas-api disk find [flags]
ディスクを指定したゾーンで検索して出力します。例: skr iaas-api disk find --zone is1b
iaas-api disk read [flags]
ディスクを読み取って出力します。例: skr iaas-api disk read --zone ZONE --id 123456789012
iaas-api disk create [flags]
ディスクを作成して出力します。基本項目はフラグ、複雑な値は --request JSON で指定します。例: skr iaas-api disk
create --zone is1b --name DISK-NAME --disk-plan-id 4 --connection virtio
--size-gb 20
iaas-api disk update [flags]
ディスクの指定項目を更新して出力します。省略した項目は変更しません。例: skr iaas-api disk update --zone ZONE
--id 123456789012 --name UPDATED-DISK-NAME
iaas-api disk delete [flags]
ディスクを削除します。サーバに接続中のディスクは削除できません。削除後は復旧できません。成功時は出力しません。例: skr iaas-api disk
delete --zone ZONE --id 123456789012 --fail-if-not-found
skr iaas-api disk find
Usage: skr iaas-api disk find [flags]
ディスクを指定したゾーンで検索して出力します。例: skr iaas-api disk find --zone is1b
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json で指定します。必須:
Zone (単一ゾーン名)。任意: 単一名の部分一致検索は --name、複数名の Names と
Sort は JSON で指定します。Tags は --tags のカンマ区切りまたは JSON
配列、Count と From は個別フラグでも指定できます。例: skr iaas-api disk
find --zone is1b --name example
--name=NAME 任意: 部分一致で検索する単一の名前。カンマを含めて1つの名前として扱います。API
の名前検索条件に対応し、JSON では Names 配列で指定します。
--zone=ZONE 必須: 対象ゾーン名。例: --zone is1b
--tags=TAGS 任意: タグの配列。カンマ区切りで指定します。API の Tags フィールドに対応します。
--count=COUNT 任意: 取得件数 (整数)。
--from=FROM 任意: 取得開始位置 (整数)。
skr iaas-api disk read
Usage: skr iaas-api disk read [flags]
ディスクを読み取って出力します。例: skr iaas-api disk read --zone ZONE --id 123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (数値)。例:
--request='{"Zone":"ZONE","ID":123456789012}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: ディスク ID (数値)。
skr iaas-api disk create
Usage: skr iaas-api disk create [flags]
ディスクを作成して出力します。基本項目はフラグ、複雑な値は --request JSON で指定します。例: skr iaas-api disk create
--zone is1b --name DISK-NAME --disk-plan-id 4 --connection virtio --size-gb 20
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または
@path.json で指定します。必須:
Zone、Name、DiskPlanID、Connection、SizeGB。個別フラグではこれらに加えて単純なスカラー値と
Tags を指定できます。DistantFrom (ID
配列)、EditParameter (複雑な設定)、OSType (SDK
の補助入力で、API フィールドではありません) は JSON で指定します。Tags は
JSON では文字列配列です。DiskPlanID、Connection、SizeGB
は対象ゾーンで利用できる値を指定してください。例:
--request @disk-create.json。JSON 例:
{"Zone":"ZONE","Name":"DISK-NAME","DiskPlanID":4,"Connection":"virtio","SizeGB":20,"Tags":["production","web"]}。
--zone=ZONE 必須: 作成先のゾーン名。
--name=NAME 必須: ディスク名。
--disk-plan-id=DISK-PLAN-ID
必須: 対象ゾーンで利用できるディスクプラン ID (数値)。
--connection=CONNECTION 必須: 接続インターフェース。virtio または ide を指定します。
--size-gb=SIZE-GB 必須: 対象ゾーンとディスクプランで利用できるサイズ (GB)。
--tags=TAGS 任意: タグの配列。カンマ区切りで指定します。API の Tags
フィールドに対応します。
--description=DESCRIPTION 任意: ディスクの説明 (最大512文字)。
--icon-id=ICON-ID 任意: アイコンの ID (数値)。
--encryption-algorithm=ENCRYPTION-ALGORITHM
任意: 暗号化アルゴリズム (none または aes256_xts)。
--kms-key-id=KMS-KEY-ID 任意: KMS キーの ID (数値)。
--dedicated-storage-contract-id=DEDICATED-STORAGE-CONTRACT-ID
任意: 専有ストレージ契約の ID (数値)。
--source-disk-id=SOURCE-DISK-ID
任意: コピー元ディスクの ID (数値)。
--source-archive-id=SOURCE-ARCHIVE-ID
任意: コピー元アーカイブの ID (数値)。
--server-id=SERVER-ID 任意: 接続先サーバの ID (数値)。
--no-wait 任意: ディスクの作成完了を待たずに戻ります。
skr iaas-api disk update
Usage: skr iaas-api disk update [flags]
ディスクの指定項目を更新して出力します。省略した項目は変更しません。例: skr iaas-api disk update --zone ZONE --id
123456789012 --name UPDATED-DISK-NAME
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または
@path.json で指定します。必須:
Zone、ID。Name、Description、Tags、IconID、Connection、NoWait
は個別フラグまたは JSON で指定できます。EditParameter
は JSON で指定します。省略した項目は変更しません。JSON 例:
--request='{"Zone":"ZONE","ID":123456789012,"Name":"UPDATED-DISK-NAME"}'。Zone
と ID は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: 更新対象のディスク ID (数値)。
--name=NAME 任意: 新しい名前。未指定なら変更しません。
--description=DESCRIPTION 任意: 新しい説明 (最大512文字)。空文字列も指定できます。未指定なら変更しません。
--tags=TAGS 任意: 更新後のタグ配列。カンマ区切りで指定します。未指定なら変更しません。
--icon-id=ICON-ID 任意: アイコンの ID (数値)。未指定なら変更しません。
--connection=CONNECTION 任意: 接続インターフェース。virtio または ide
を指定します。未指定なら変更しません。
--no-wait 任意: ディスクの更新完了を待たずに戻ります。
skr iaas-api disk delete
Usage: skr iaas-api disk delete [flags]
ディスクを削除します。サーバに接続中のディスクは削除できません。削除後は復旧できません。成功時は出力しません。例: skr iaas-api disk
delete --zone ZONE --id 123456789012 --fail-if-not-found
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (数値)。任意:
FailIfNotFound (対象がない場合にエラー)、WaitForRelease
(他リソースから参照されている間の削除待機)、WaitForReleaseTimeout
(秒)、WaitForReleaseTick
(秒)。サーバ接続中のディスクは削除できません。削除後は復旧できないため、対象
ID と接続状態を確認してください。例:
--request='{"Zone":"ZONE","ID":123456789012,"FailIfNotFound":true}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: 削除対象のディスク ID (数値)。
--fail-if-not-found 任意: 対象ディスクが見つからない場合にエラーにします。
--wait-for-release 任意: 他リソースから参照されている間は削除を待ちます。
--wait-for-release-timeout=WAIT-FOR-RELEASE-TIMEOUT
任意: 削除待機のタイムアウト (秒)。
--wait-for-release-tick=WAIT-FOR-RELEASE-TICK
任意: 削除待機中の確認間隔 (秒)。
skr iaas-api icon
Usage: skr iaas-api icon <command>
ユーザー作成アイコンを検索、参照、作成、更新、削除します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iaas-api icon find [flags]
アイコンを検索して出力します。Names、Tags、Scope、Sort は --request JSON
で指定できます。条件を省略すると一覧を取得します。例: skr iaas-api icon find --request @icon-find.json
iaas-api icon read [flags]
ID を指定してアイコンを読み取って出力します。例: skr iaas-api icon read --id 123456789012
iaas-api icon create [flags]
画像ファイルからアイコンを作成して出力します。例: skr iaas-api icon create --name example
--image-file ./icon.png
iaas-api icon update [flags]
アイコンの指定項目を更新して出力します。省略した項目は変更しません。例: skr iaas-api icon update --id
123456789012 --name updated
iaas-api icon delete [flags]
アイコンを削除します。成功時は出力しません。例: skr iaas-api icon delete --id 123456789012
skr iaas-api icon find
Usage: skr iaas-api icon find [flags]
アイコンを検索して出力します。Names、Tags、Scope、Sort は --request JSON
で指定できます。条件を省略すると一覧を取得します。例: skr iaas-api icon find --request @icon-find.json
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST FindRequest JSON を直接または @path.json
で指定します。Names、Tags、Scope、Sort は JSON
で指定します。--count、--from とは併用できません。
--count=COUNT 任意: 取得件数。
--from=FROM 任意: 取得開始位置。
skr iaas-api icon read
Usage: skr iaas-api icon read [flags]
ID を指定してアイコンを読み取って出力します。例: skr iaas-api icon read --id 123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json で指定します。必須:
ID (数値)。例: --request='{"ID":123456789012}'。ID
は実際の値に置き換えます。
--id=ID 必須: 読み取るアイコンの ID (数値)。
skr iaas-api icon create
Usage: skr iaas-api icon create [flags]
画像ファイルからアイコンを作成して出力します。例: skr iaas-api icon create --name example --image-file
./icon.png
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST CreateRequest JSON を直接または @path.json
で指定します。必須: Name、Base64 形式の Image。任意:
Tags 配列。個別フラグとは併用できません。例: --request
@icon-create.json
--name=NAME 必須: 作成するアイコンの名前。
--image-file=IMAGE-FILE 必須: PNG または JPEG の画像ファイル。API 用に Base64
形式へ変換します。画像データを引数に直接指定しないでください。
--tags=TAGS 任意: タグ。カンマ区切りで指定します。
skr iaas-api icon update
Usage: skr iaas-api icon update [flags]
アイコンの指定項目を更新して出力します。省略した項目は変更しません。例: skr iaas-api icon update --id 123456789012
--name updated
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST UpdateRequest JSON を直接または @path.json で指定します。必須:
ID。任意: Name、Tags。省略した項目は変更しません。個別フラグとは併用できません。例:
--request='{"ID":123456789012,"Name":"updated"}'
--id=ID 必須: 更新するアイコンの ID (数値)。
--name=NAME 任意: 新しい名前。未指定なら変更しません。
--tags=TAGS 任意: タグ。カンマ区切りで指定します。未指定なら変更しません。
skr iaas-api icon delete
Usage: skr iaas-api icon delete [flags]
アイコンを削除します。成功時は出力しません。例: skr iaas-api icon delete --id 123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: ID (数値)。FailIfNotFound は任意です。例:
--request='{"ID":123456789012,"FailIfNotFound":true}'。ID
は実際の値に置き換えます。
--id=ID 必須: 削除するアイコンの ID (数値)。
--fail-if-not-found 任意: 対象が見つからない場合にエラーにします。
skr iaas-api internet
Usage: skr iaas-api internet <command>
さくらのクラウドのルータ＋スイッチと、関連する IP アドレスブロックおよび IPv6 設定を操作します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iaas-api internet find [flags]
ルータ＋スイッチを指定したゾーンで検索して出力します。例: skr iaas-api internet find --zone is1b
iaas-api internet read [flags]
ルータ＋スイッチを読み取って出力します。
iaas-api internet create [flags]
ルータ＋スイッチを作成して出力します。課金対象になる場合があります。例: skr iaas-api internet create --zone
is1b --name ROUTER-SWITCH-NAME --network-mask-len 28 --band-width-mbps 100
iaas-api internet update [flags]
ルータ＋スイッチの設定を更新して出力します。例: skr iaas-api internet update --zone is1b --id
123456789012 --name UPDATED-NAME
iaas-api internet delete [flags]
ルータ＋スイッチを削除します。--force は IPv6 の無効化と NextHop が設定された追加サブネットの削除も行います。例:
skr iaas-api internet delete --zone is1b --id 123456789012
iaas-api internet list-subnet [flags]
ルータ＋スイッチに設定された IP アドレスブロックを一覧表示します。
iaas-api internet add-subnet [flags]
ルータ＋スイッチに IP アドレスブロックを追加します。ネクストホップとなるサーバを先に用意してください。
iaas-api internet update-subnet [flags]
追加した IP アドレスブロックのネクストホップを更新します。
iaas-api internet delete-subnet [flags]
ルータ＋スイッチに追加した IP アドレスブロックを削除します。
iaas-api internet read-ipv6 [flags]
ルータ＋スイッチに割り当てられた IPv6 ネットワークを読み取ります。
iaas-api internet enable-ipv6 [flags]
ルータ＋スイッチの IPv6 アドレス割り当てを有効にして、割り当て結果を出力します。
iaas-api internet disable-ipv6 [flags]
ルータ＋スイッチの IPv6 アドレス割り当てを無効にします。
iaas-api internet monitor-router [flags]
ルータ＋スイッチのトラフィックを指定期間で取得して出力します。例: skr iaas-api internet monitor-router
--zone is1b --id 123456789012 --start 2026-10-14T00:00:00Z --end
2026-10-15T00:00:00Z
skr iaas-api internet find
Usage: skr iaas-api internet find [flags]
ルータ＋スイッチを指定したゾーンで検索して出力します。例: skr iaas-api internet find --zone is1b
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json で指定します。必須:
Zone (単一ゾーン名)。任意: 単一名の部分一致検索は --name、複数名の
Names、SwitchIDs、SwitchNames、Sort は JSON で指定します。Tags
は --tags のカンマ区切りまたは JSON 配列、Count と From
は個別フラグでも指定できます。例: skr iaas-api internet find --zone
is1b --name ROUTER-SWITCH-NAME。名前は実際の値に置き換えます。
--name=NAME 任意: 部分一致で検索する単一の名前。カンマを含めて1つの名前として扱います。API
の名前検索条件に対応し、JSON では Names 配列で指定します。
--zone=ZONE 必須: 対象ゾーン名。例: --zone is1b
--tags=TAGS 任意: タグの配列。カンマ区切りで指定します。API の Tags フィールドに対応します。
--count=COUNT 任意: 取得件数 (整数)。
--from=FROM 任意: 取得開始位置 (整数)。
skr iaas-api internet read
Usage: skr iaas-api internet read [flags]
ルータ＋スイッチを読み取って出力します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (数値)。例:
--request='{"Zone":"is1b","ID":123456789012}'。ゾーンと ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: ルータ＋スイッチの ID (数値)。
skr iaas-api internet create
Usage: skr iaas-api internet create [flags]
ルータ＋スイッチを作成して出力します。課金対象になる場合があります。例: skr iaas-api internet create --zone is1b
--name ROUTER-SWITCH-NAME --network-mask-len 28 --band-width-mbps 100
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (作成先ゾーン)、Name
(名前)、NetworkMaskLen (プレフィクス長)、BandWidthMbps
(帯域幅)。任意: Description (最大512文字)、Tags
(文字列配列)、IconID (数値)。EnableIPv6 は作成時に IPv6
アドレス割り当てを有効にする設定です。料金と利用条件を確認してから実行してください。NoWait
と NotFoundRetry は JSON でのみ指定できます。フラグ例:
skr iaas-api internet create --zone is1b
--name ROUTER-SWITCH-NAME --network-mask-len
28 --band-width-mbps 100。ゾーンと名前は実際の値に置き換えます。
--zone=ZONE 必須: 作成先のゾーン名。
--name=NAME 必須: ルータ＋スイッチの名前。
--tags=TAGS 任意: タグの配列。カンマ区切りで指定します。API の Tags
フィールドに対応します。
--description=DESCRIPTION 任意: 説明 (最大512文字)。
--icon-id=ICON-ID 任意: アイコンの ID (数値)。
--network-mask-len=NETWORK-MASK-LEN
必須: 割り当てる IPv4 アドレスブロックのプレフィクス長。
--band-width-mbps=BAND-WIDTH-MBPS
必須: 接続帯域 (Mbps)。
skr iaas-api internet update
Usage: skr iaas-api internet update [flags]
ルータ＋スイッチの設定を更新して出力します。例: skr iaas-api internet update --zone is1b --id
123456789012 --name UPDATED-NAME
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または
@path.json で指定します。必須: Zone (ゾーン名)、ID
(数値)。Name、Description、Tags、IconID
は API フィールドです。BandWidthMbps と
EnableIPv6 は JSON のみで指定でき、帯域または IPv6
の設定も変更します。省略した項目は変更しません。帯域変更の制約と
IPv6 利用料を確認してください。例:
--request='{"Zone":"is1b","ID":123456789012,"Name":"UPDATED-NAME"}'。ゾーン、ID、名前は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: 更新対象の ID (数値)。
--tags=TAGS 任意: 更新後のタグ配列。カンマ区切りで指定します。未指定なら変更しません。
--name=NAME 任意: 新しい名前。未指定なら変更しません。
--description=DESCRIPTION 任意: 新しい説明。未指定なら変更しません。
--icon-id=ICON-ID 任意: アイコン ID (数値)。未指定なら変更しません。
skr iaas-api internet delete
Usage: skr iaas-api internet delete [flags]
ルータ＋スイッチを削除します。--force は IPv6 の無効化と NextHop が設定された追加サブネットの削除も行います。例: skr
iaas-api internet delete --zone is1b --id 123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (数値)。Force と
FailIfNotFound は --force と --fail-if-not-found
でも指定できます。これらは API 本文のフィールドではなく削除の動作オプションです。例:
--request='{"Zone":"is1b","ID":123456789012}'。ID
は実際の値に置き換えます。
--force 任意: IPv6 を無効化し、NextHop が設定された追加サブネットも削除します。既定は
false です。削除範囲を確認して指定してください。
--fail-if-not-found 任意: 対象が存在しない場合にエラーにします。既定は false で、不在でも成功として扱います。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: 削除対象の ID (数値)。
skr iaas-api internet list-subnet
Usage: skr iaas-api internet list-subnet [flags]
ルータ＋スイッチに設定された IP アドレスブロックを一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (ルータ＋スイッチの数値 ID)。例:
--request='{"Zone":"is1b","ID":123456789012}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: ルータ＋スイッチの ID (数値)。
skr iaas-api internet add-subnet
Usage: skr iaas-api internet add-subnet [flags]
ルータ＋スイッチに IP アドレスブロックを追加します。ネクストホップとなるサーバを先に用意してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json で指定します。必須:
Zone、ID、NetworkMaskLen、NextHop。NetworkMaskLen
はプレフィクス長、NextHop はネクストホップの IPv4 アドレスです。例:
skr iaas-api internet add-subnet --zone is1b --id
123456789012 --network-mask-len 28 --next-hop
192.0.2.1。ゾーン、ID、IP アドレスは実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: ルータ＋スイッチの ID (数値)。
--network-mask-len=NETWORK-MASK-LEN
必須: 追加する IP アドレスブロックのプレフィクス長。
--next-hop=NEXT-HOP 必須: ネクストホップの IPv4 アドレス。
skr iaas-api internet update-subnet
Usage: skr iaas-api internet update-subnet [flags]
追加した IP アドレスブロックのネクストホップを更新します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone、ID (ルータ＋スイッチ ID)、SubnetID、NextHop
(IPv4 アドレス)。例: skr iaas-api internet
update-subnet --zone is1b --id 123456789012
--subnet-id 234567890123 --next-hop 192.0.2.2。ID
とアドレスは実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: ルータ＋スイッチの ID (数値)。
--subnet-id=SUBNET-ID 必須: 更新する IP アドレスブロックの ID (数値)。
--next-hop=NEXT-HOP 必須: ネクストホップの IPv4 アドレス。
skr iaas-api internet delete-subnet
Usage: skr iaas-api internet delete-subnet [flags]
ルータ＋スイッチに追加した IP アドレスブロックを削除します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone、ID (ルータ＋スイッチ
ID)、SubnetID (削除するブロックの ID)。例:
--request='{"Zone":"is1b","ID":123456789012,"SubnetID":234567890123}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: ルータ＋スイッチの ID (数値)。
--subnet-id=SUBNET-ID 必須: 削除する IP アドレスブロックの ID (数値)。
skr iaas-api internet read-ipv6
Usage: skr iaas-api internet read-ipv6 [flags]
ルータ＋スイッチに割り当てられた IPv6 ネットワークを読み取ります。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (ルータ＋スイッチ
ID)。IPv6 が有効でない場合はエラーになります。例:
--request='{"Zone":"is1b","ID":123456789012}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: ルータ＋スイッチの ID (数値)。
skr iaas-api internet enable-ipv6
Usage: skr iaas-api internet enable-ipv6 [flags]
ルータ＋スイッチの IPv6 アドレス割り当てを有効にして、割り当て結果を出力します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (ルータ＋スイッチ
ID)。IPv6 の有効化は無償ですが、ルータ＋スイッチの利用料は別途必要です。例:
--request='{"Zone":"is1b","ID":123456789012}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: ルータ＋スイッチの ID (数値)。
skr iaas-api internet disable-ipv6
Usage: skr iaas-api internet disable-ipv6 [flags]
ルータ＋スイッチの IPv6 アドレス割り当てを無効にします。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json で指定します。必須:
Zone (ゾーン名)、ID (ルータ＋スイッチ ID)。割り当て済み IPv6
アドレスブロックを削除します。同じブロックを再度割り当てられるとは限らないため、無効化前に内容を確認してください。例:
--request='{"Zone":"is1b","ID":123456789012}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: ルータ＋スイッチの ID (数値)。
skr iaas-api internet monitor-router
Usage: skr iaas-api internet monitor-router [flags]
ルータ＋スイッチのトラフィックを指定期間で取得して出力します。例: skr iaas-api internet monitor-router --zone
is1b --id 123456789012 --start 2026-10-14T00:00:00Z --end 2026-10-15T00:00:00Z
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json で指定します。必須:
Zone (単一ゾーン名)、ID (ルータ＋スイッチ ID)。任意: Start、End
(RFC3339 形式の日時)。省略時は終了が現在時刻、開始がその1時間前。フラグ例:
skr iaas-api internet monitor-router --zone is1b
--id 123456789012 --start 2026-10-14T00:00:00Z --end
2026-10-15T00:00:00Z。ゾーン、ID、日時は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: 対象のルータ＋スイッチ ID (数値)。
--start=START 任意: 取得期間の開始日時 (RFC3339 形式)。省略時は終了日時の1時間前。
--end=END 任意: 取得期間の終了日時 (RFC3339 形式)。省略時は現在時刻。
skr iaas-api ipaddress
Usage: skr iaas-api ipaddress <command>
さくらのクラウドのグローバル IP アドレスを検索・参照し、逆引きホスト名を変更します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iaas-api ipaddress list [flags]
グローバル IP アドレスを指定したゾーンで一覧表示します。例: skr iaas-api ipaddress list --zone is1b
iaas-api ipaddress read [flags]
指定したグローバル IP アドレスの情報を取得します。例: skr iaas-api ipaddress read --zone is1b
--ip-address 192.0.2.1
iaas-api ipaddress update-host-name [flags]
指定したグローバル IP アドレスの逆引きホスト名を変更します。成功時は出力しません。例: skr iaas-api ipaddress
update-host-name --zone is1b --ip-address 192.0.2.1 --host-name
www.example.com
skr iaas-api ipaddress list
Usage: skr iaas-api ipaddress list [flags]
グローバル IP アドレスを指定したゾーンで一覧表示します。例: skr iaas-api ipaddress list --zone is1b
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 必須: Zone (ゾーン名)。--zone または ListRequest JSON
を直接／@path.json で指定します。--request と個別フラグは併用できません。
--zone=ZONE 必須: 一覧を取得するゾーン名です。例: --zone is1b
skr iaas-api ipaddress read
Usage: skr iaas-api ipaddress read [flags]
指定したグローバル IP アドレスの情報を取得します。例: skr iaas-api ipaddress read --zone is1b
--ip-address 192.0.2.1
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 必須: Zone (ゾーン名) と IPAddress (対象の IP
アドレス)。--zone と --ip-address、または ReadRequest
JSON を直接／@path.json で指定します。個別フラグと --request
は併用できません。
--zone=ZONE 必須: 対象のゾーン名です。
--ip-address=IP-ADDRESS 必須: 参照するグローバル IP アドレスです。
skr iaas-api ipaddress update-host-name
Usage: skr iaas-api ipaddress update-host-name [flags]
指定したグローバル IP アドレスの逆引きホスト名を変更します。成功時は出力しません。例: skr iaas-api ipaddress
update-host-name --zone is1b --ip-address 192.0.2.1 --host-name www.example.com
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、IPAddress
(対象の IP アドレス)。任意: HostName
(--host-name、省略時は逆引きホスト名を空にします)、RetryMax
と RetryInterval (JSON
のみ、一時的な失敗時のリトライ回数と間隔)。--request と個別フラグは併用できません。
--zone=ZONE 必須: 対象のゾーン名です。
--ip-address=IP-ADDRESS 必須: 逆引きホスト名を変更するグローバル IP アドレスです。
--host-name=HOST-NAME 任意: 変更後の逆引きホスト名です。省略時は空にします。
skr iaas-api ipv6addr
Usage: skr iaas-api ipv6addr <command>
さくらのクラウドの IPv6 アドレスを検索、参照、作成、更新、削除します。IPv6 プレフィクス内のアドレスに逆引きホスト名を登録します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iaas-api ipv6addr find [flags]
IPv6 アドレスを指定したゾーンで検索して出力します。例: skr iaas-api ipv6addr find --zone is1b
iaas-api ipv6addr create [flags]
IPv6 プレフィクス内のアドレスに逆引きホスト名を登録して出力します。例: skr iaas-api ipv6addr create --zone
is1b --ipv6-addr 2001:db8::1 --host-name www.example.com
iaas-api ipv6addr read [flags]
指定した IPv6 アドレスの情報を取得します。例: skr iaas-api ipv6addr read --zone is1b
--ipv6-addr 2001:db8::1
iaas-api ipv6addr update [flags]
指定した IPv6 アドレスの逆引きホスト名を変更して出力します。例: skr iaas-api ipv6addr update --zone is1b
--ipv6-addr 2001:db8::1 --host-name www.example.com
iaas-api ipv6addr delete [flags]
指定した IPv6 アドレスの逆引きホスト名の登録を解除します。成功時は出力しません。例: skr iaas-api ipv6addr delete
--zone is1b --ipv6-addr 2001:db8::1
skr iaas-api ipv6addr find
Usage: skr iaas-api ipv6addr find [flags]
IPv6 アドレスを指定したゾーンで検索して出力します。例: skr iaas-api ipv6addr find --zone is1b
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 任意: FindRequest JSON を直接または @path.json
で指定します。Sort、および接続先スイッチやホスト名での絞り込み
(SwitchIDs、HostNames、IPv6Addresses) は
JSON、Count と From は個別フラグで指定できます。省略時はゾーン内の IPv6
アドレスを一覧します。--request と個別フラグは併用できません。
--zone=ZONE 必須: 検索対象のゾーン名です。例: --zone is1b
--count=COUNT 任意: 取得件数です。
--from=FROM 任意: 取得開始位置です。
skr iaas-api ipv6addr create
Usage: skr iaas-api ipv6addr create [flags]
IPv6 プレフィクス内のアドレスに逆引きホスト名を登録して出力します。例: skr iaas-api ipv6addr create --zone is1b
--ipv6-addr 2001:db8::1 --host-name www.example.com
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、IPv6Addr (登録する
IPv6 アドレス)、HostName (逆引きホスト名)。--request
と個別フラグは併用できません。
--zone=ZONE 必須: 作成先のゾーン名です。
--ipv6-addr=IPV6-ADDR 必須: 登録する IPv6 アドレスです。有効化済みの IPv6
ネットワークのプレフィクス内を指定します。
--host-name=HOST-NAME 必須: 逆引きホスト名です。
skr iaas-api ipv6addr read
Usage: skr iaas-api ipv6addr read [flags]
指定した IPv6 アドレスの情報を取得します。例: skr iaas-api ipv6addr read --zone is1b --ipv6-addr
2001:db8::1
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 必須: Zone (ゾーン名) と IPv6Addr (対象の IPv6 アドレス)。--zone
と --ipv6-addr、または ReadRequest JSON を直接／@path.json
で指定します。個別フラグと --request は併用できません。
--zone=ZONE 必須: 対象のゾーン名です。
--ipv6-addr=IPV6-ADDR 必須: 参照する IPv6 アドレスです。
skr iaas-api ipv6addr update
Usage: skr iaas-api ipv6addr update [flags]
指定した IPv6 アドレスの逆引きホスト名を変更して出力します。例: skr iaas-api ipv6addr update --zone is1b
--ipv6-addr 2001:db8::1 --host-name www.example.com
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、IPv6Addr (対象の IPv6
アドレス)、HostName (変更後の逆引きホスト名)。--request
と個別フラグは併用できません。
--zone=ZONE 必須: 対象のゾーン名です。
--ipv6-addr=IPV6-ADDR 必須: 変更する IPv6 アドレスです。
--host-name=HOST-NAME 必須: 変更後の逆引きホスト名です。
skr iaas-api ipv6addr delete
Usage: skr iaas-api ipv6addr delete [flags]
指定した IPv6 アドレスの逆引きホスト名の登録を解除します。成功時は出力しません。例: skr iaas-api ipv6addr delete
--zone is1b --ipv6-addr 2001:db8::1
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、IPv6Addr
(解除する IPv6 アドレス)。任意: FailIfNotFound
(真偽値、対象が見つからない場合にエラーにします)。--request
と個別フラグは併用できません。
--zone=ZONE 必須: 対象のゾーン名です。
--ipv6-addr=IPV6-ADDR 必須: 解除する IPv6 アドレスです。
skr iaas-api ipv6net
Usage: skr iaas-api ipv6net <command>
さくらのクラウドの IPv6 ネットワーク (IPv6 アドレス割り当て) を検索・参照します。IPv6 の有効化と無効化は skr iaas-api
internet の enable-ipv6 と disable-ipv6 を使います。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iaas-api ipv6net find [flags]
IPv6 ネットワークを指定したゾーンで検索して出力します。例: skr iaas-api ipv6net find --zone is1b
iaas-api ipv6net read [flags]
指定した ID の IPv6 ネットワークを取得します。例: skr iaas-api ipv6net read --zone is1b --id
123456789012
skr iaas-api ipv6net find
Usage: skr iaas-api ipv6net find [flags]
IPv6 ネットワークを指定したゾーンで検索して出力します。例: skr iaas-api ipv6net find --zone is1b
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 任意: FindRequest JSON を直接または @path.json
で指定します。Sort、および接続先スイッチやルータ＋スイッチでの絞り込み
(SwitchIDs、SwitchNames、InternetIDs、InternetNames)
は JSON、Count と From は個別フラグで指定できます。省略時はゾーン内の IPv6
ネットワークを一覧します。--request と個別フラグは併用できません。
--zone=ZONE 必須: 検索対象のゾーン名です。例: --zone is1b
--count=COUNT 任意: 取得件数です。
--from=FROM 任意: 取得開始位置です。
skr iaas-api ipv6net read
Usage: skr iaas-api ipv6net read [flags]
指定した ID の IPv6 ネットワークを取得します。例: skr iaas-api ipv6net read --zone is1b --id
123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 必須: Zone (ゾーン名) と ID (数値)。--zone と --id、または
ReadRequest JSON を直接／@path.json で指定します。個別フラグと
--request は併用できません。
--zone=ZONE 必須: 対象のゾーン名です。
--id=ID 必須: 参照する IPv6 ネットワークの ID (数値) です。
skr iaas-api packetfilter
Usage: skr iaas-api packetfilter <command>
さくらのクラウドのパケットフィルタを検索、参照、作成、更新、削除します。ルール配列は --expressions JSON または --request JSON
で指定します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iaas-api packetfilter find [flags]
パケットフィルタを指定したゾーンで検索して出力します。例: skr iaas-api packetfilter find --zone is1b
iaas-api packetfilter read [flags]
パケットフィルタを読み取って出力します。例: skr iaas-api packetfilter read --zone ZONE --id
123456789012
iaas-api packetfilter create [flags]
パケットフィルタを作成して出力します。基本項目はフラグ、ルールは --expressions JSON で指定できます。例:
skr iaas-api packetfilter create --zone is1b --name example --expressions
'[{"Protocol":"tcp","DestinationPort":"443","Action":"allow"}]'
iaas-api packetfilter update [flags]
パケットフィルタの指定項目を更新して出力します。ルール配列は --expressions JSON で指定できます。
iaas-api packetfilter delete [flags]
パケットフィルタを削除します。成功時は出力しません。例: skr iaas-api packetfilter delete --zone ZONE
--id 123456789012
skr iaas-api packetfilter find
Usage: skr iaas-api packetfilter find [flags]
パケットフィルタを指定したゾーンで検索して出力します。例: skr iaas-api packetfilter find --zone is1b
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (単一のゾーン名)。任意: Names (名前の文字列配列)
は JSON、Count と From は個別フラグで指定します。例:
--request='{"Zone":"is1b","Names":["example"]}'。
--zone=ZONE 必須: 対象ゾーン名。
--count=COUNT 任意: 取得件数 (整数)。
--from=FROM 任意: 取得開始位置 (整数)。
skr iaas-api packetfilter read
Usage: skr iaas-api packetfilter read [flags]
パケットフィルタを読み取って出力します。例: skr iaas-api packetfilter read --zone ZONE --id
123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (数値)。例:
--request='{"Zone":"is1b","ID":123456789012}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: パケットフィルタの ID (数値)。
skr iaas-api packetfilter create
Usage: skr iaas-api packetfilter create [flags]
パケットフィルタを作成して出力します。基本項目はフラグ、ルールは --expressions JSON で指定できます。例:
skr iaas-api packetfilter create --zone is1b --name example --expressions
'[{"Protocol":"tcp","DestinationPort":"443","Action":"allow"}]'
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または
@path.json で指定します。必須: Zone、Name。任意:
Description (最大512文字)、Expression
(ルールの配列)。ルールは個別フラグ経路では --expressions に
JSON 配列を直接、または @path.json で指定できます。各要素は
Protocol、SourceNetwork、SourcePort、DestinationPort、Action、Description
を持ちます。Protocol は
http、https、tcp、udp、icmp、fragment、ip、Action
は allow または deny です。ポートは 0〜65535
の数値または範囲です。例: --expressions
'[{"Protocol":"tcp","SourceNetwork":"192.0.2.0/24","DestinationPort":"443","Action":"allow","Description":"Allow
HTTPS"}]'。
--zone=ZONE 必須: 作成先のゾーン名。
--name=NAME 必須: パケットフィルタの名前。
--description=DESCRIPTION 任意: 説明 (最大512文字)。
--expressions=EXPRESSIONS 任意: ルールの JSON 配列を直接、または @path.json
で指定します。1回だけ指定できます。
skr iaas-api packetfilter update
Usage: skr iaas-api packetfilter update [flags]
パケットフィルタの指定項目を更新して出力します。ルール配列は --expressions JSON で指定できます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone、ID。変更する項目は Name、Description
を個別フラグまたは JSON で指定できます。Expression
はルール配列で、個別フラグ経路では --expressions に JSON
配列を直接、または @path.json で指定できます。Expression
を更新する場合は OriginalExpressionHash (文字列) に
read で得た ExpressionHash を必ず指定してください。JSON
または --original-expression-hash で指定します。例:
--request='{"Zone":"is1b","ID":123456789012,"Name":"updated"}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: 更新対象の ID (数値)。
--name=NAME 任意: 新しい名前。未指定なら変更しません。
--description=DESCRIPTION 任意: 新しい説明 (最大512文字)。未指定なら変更しません。
--original-expression-hash=ORIGINAL-EXPRESSION-HASH
任意: ルール更新時に read で取得した ExpressionHash。
--expressions=EXPRESSIONS 任意: ルールの JSON 配列を直接、または @path.json
で指定します。1回だけ指定できます。
skr iaas-api packetfilter delete
Usage: skr iaas-api packetfilter delete [flags]
パケットフィルタを削除します。成功時は出力しません。例: skr iaas-api packetfilter delete --zone ZONE --id
123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (数値)。任意:
FailIfNotFound (対象がない場合にエラー)、WaitForRelease
(他リソースから参照されている間の削除待機)、WaitForReleaseTimeout
(秒)、WaitForReleaseTick (秒)。例:
--request='{"Zone":"is1b","ID":123456789012,"FailIfNotFound":true}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: 削除対象の ID (数値)。
--fail-if-not-found 任意: 対象が見つからない場合にエラーにします。
--wait-for-release 任意: 他リソースから参照されている間は削除を待ちます。
--wait-for-release-timeout=WAIT-FOR-RELEASE-TIMEOUT
任意: 削除待機のタイムアウト (秒)。
--wait-for-release-tick=WAIT-FOR-RELEASE-TICK
任意: 削除待機中の確認間隔 (秒)。
skr iaas-api product
Usage: skr iaas-api product <command>
商品 API のプラン情報を検索・参照します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iaas-api product disk find [flags]
指定したゾーンで利用できるディスクプランを検索します。API 応答の Total、From、Count、DiskPlans を含む JSON
を出力します。Availability と Size (サイズ、単位、利用可否) を確認できます。例: skr iaas-api product
disk find --zone is1b
iaas-api product disk read [flags]
指定したゾーンと ID のディスクプランを読み取って出力します。API の Availability と Size (サイズ、単位、利用可否)
を確認できます。例: skr iaas-api product disk read --zone ZONE --id 4
iaas-api product internet find [flags]
指定したゾーンのインターネットプランを検索します。API 応答の Total、From、Count、InternetPlans を含む JSON
を出力します。帯域幅と利用可否を確認できます。例: skr iaas-api product internet find --zone is1b
iaas-api product internet read [flags]
指定したゾーンと ID のインターネットプランを参照します。例: skr iaas-api product internet read --zone
ZONE --id INTERNET-PLAN-ID
iaas-api product license find [flags]
ライセンス情報を検索します。API 応答の Total、From、Count、LicenseInfo を含む JSON
を出力します。名称や利用条件を確認できます。
iaas-api product privatehost find [flags]
指定したゾーンの専有ホストプランを検索します。API 応答の Total、From、Count、PrivateHostPlans を含む JSON
を出力します。CPU、CPU モデル、メモリ、利用可否を確認できます。例: skr iaas-api product privatehost find
--zone is1b
iaas-api product privatehost read [flags]
指定したゾーンと ID の専有ホストプランを参照します。例: skr iaas-api product privatehost read --zone
ZONE --id PRIVATE-HOST-PLAN-ID
iaas-api product server find [flags]
指定したゾーンのサーバプランを検索します。API 応答の Total、From、Count、ServerPlans を含む JSON
を出力します。CPU、メモリ、GPU、CPUコミットメント、世代、利用可否を確認できます。例: skr iaas-api product server
find --zone is1b
iaas-api product server read [flags]
指定したゾーンと ID のサーバプランを参照します。例: skr iaas-api product server read --zone ZONE
--id SERVER-PLAN-ID
skr iaas-api product disk
Usage: skr iaas-api product disk <command>
ディスクプランを検索・参照します。プランの利用可否とサイズを確認できます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iaas-api product disk find [flags]
指定したゾーンで利用できるディスクプランを検索します。API 応答の Total、From、Count、DiskPlans を含む JSON
を出力します。Availability と Size (サイズ、単位、利用可否) を確認できます。例: skr iaas-api product
disk find --zone is1b
iaas-api product disk read [flags]
指定したゾーンと ID のディスクプランを読み取って出力します。API の Availability と Size (サイズ、単位、利用可否)
を確認できます。例: skr iaas-api product disk read --zone ZONE --id 4
skr iaas-api product disk find
Usage: skr iaas-api product disk find [flags]
指定したゾーンで利用できるディスクプランを検索します。API 応答の Total、From、Count、DiskPlans を含む JSON
を出力します。Availability と Size (サイズ、単位、利用可否) を確認できます。例: skr iaas-api product disk
find --zone is1b
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json で指定します。必須:
Zone (対象ゾーン名)。API の Filter、Sort、Include、Exclude
は JSON で指定します。Filter の文字列値は部分一致、配列値は
OR 条件です。Count と From は個別フラグです。例:
--request='{"Zone":"ZONE","Filter":{"Name":"PLAN-NAME"}}'。ZONE
と名前は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。例: --zone is1b
--count=COUNT 任意: 取得件数 (整数)。
--from=FROM 任意: 取得開始位置 (整数)。
skr iaas-api product disk read
Usage: skr iaas-api product disk read [flags]
指定したゾーンと ID のディスクプランを読み取って出力します。API の Availability と Size (サイズ、単位、利用可否)
を確認できます。例: skr iaas-api product disk read --zone ZONE --id 4
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (数値)。例:
--request='{"Zone":"ZONE","ID":4}'。ZONE と ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: ディスクプラン ID (数値)。
skr iaas-api product internet
Usage: skr iaas-api product internet <command>
インターネットプランを検索・参照します。帯域幅と利用可否を確認できます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iaas-api product internet find [flags]
指定したゾーンのインターネットプランを検索します。API 応答の Total、From、Count、InternetPlans を含む JSON
を出力します。帯域幅と利用可否を確認できます。例: skr iaas-api product internet find --zone is1b
iaas-api product internet read [flags]
指定したゾーンと ID のインターネットプランを参照します。例: skr iaas-api product internet read --zone
ZONE --id INTERNET-PLAN-ID
skr iaas-api product internet find
Usage: skr iaas-api product internet find [flags]
指定したゾーンのインターネットプランを検索します。API 応答の Total、From、Count、InternetPlans を含む JSON
を出力します。帯域幅と利用可否を確認できます。例: skr iaas-api product internet find --zone is1b
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 必須: Zone (対象ゾーン名)。API の Filter、Sort、Include、Exclude
は JSON で指定します。Filter の文字列値は部分一致、配列値は OR 条件です。Count と
From は個別フラグです。JSON は直接または @path.json で渡せます。--request
と個別フラグは併用できません。
--zone=ZONE 必須: 検索対象のゾーン名です。例: --zone is1b
--count=COUNT 任意: 取得件数です。
--from=FROM 任意: 取得開始位置です。
skr iaas-api product internet read
Usage: skr iaas-api product internet read [flags]
指定したゾーンと ID のインターネットプランを参照します。例: skr iaas-api product internet read --zone ZONE
--id INTERNET-PLAN-ID
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 必須: Zone (単一ゾーン名)、ID (数値)。JSON は直接または @path.json
で渡せます。--request と個別フラグは併用できません。
--zone=ZONE 必須: 対象ゾーン名です。
--id=ID 必須: インターネットプラン ID です。
skr iaas-api product license
Usage: skr iaas-api product license <command>
ライセンス情報を検索し、名称や利用条件を確認します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iaas-api product license find [flags]
ライセンス情報を検索します。API 応答の Total、From、Count、LicenseInfo を含む JSON
を出力します。名称や利用条件を確認できます。
skr iaas-api product license find
Usage: skr iaas-api product license find [flags]
ライセンス情報を検索します。API 応答の Total、From、Count、LicenseInfo を含む JSON
を出力します。名称や利用条件を確認できます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 任意: API リクエスト JSON を直接または @path.json
で指定します。Filter、Sort、Include、Exclude は JSON
で指定できます。Count と From は --count、--from
でも指定できます。省略時は一覧を取得します。--request と個別フラグは併用できません。
--count=COUNT 任意: 取得件数です。
--from=FROM 任意: 取得開始位置です。
skr iaas-api product privatehost
Usage: skr iaas-api product privatehost <command>
専有ホストプランを検索・参照します。CPU、メモリ、利用可否を確認できます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iaas-api product privatehost find [flags]
指定したゾーンの専有ホストプランを検索します。API 応答の Total、From、Count、PrivateHostPlans を含む JSON
を出力します。CPU、CPU モデル、メモリ、利用可否を確認できます。例: skr iaas-api product privatehost find
--zone is1b
iaas-api product privatehost read [flags]
指定したゾーンと ID の専有ホストプランを参照します。例: skr iaas-api product privatehost read --zone
ZONE --id PRIVATE-HOST-PLAN-ID
skr iaas-api product privatehost find
Usage: skr iaas-api product privatehost find [flags]
指定したゾーンの専有ホストプランを検索します。API 応答の Total、From、Count、PrivateHostPlans を含む JSON
を出力します。CPU、CPU モデル、メモリ、利用可否を確認できます。例: skr iaas-api product privatehost find
--zone is1b
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 必須: Zone (対象ゾーン名)。API の Filter、Sort、Include、Exclude
は JSON で指定します。Filter の文字列値は部分一致、配列値は OR 条件です。Count と
From は個別フラグです。JSON は直接または @path.json で渡せます。--request
と個別フラグは併用できません。
--zone=ZONE 必須: 検索対象のゾーン名です。例: --zone is1b
--count=COUNT 任意: 取得件数です。
--from=FROM 任意: 取得開始位置です。
skr iaas-api product privatehost read
Usage: skr iaas-api product privatehost read [flags]
指定したゾーンと ID の専有ホストプランを参照します。例: skr iaas-api product privatehost read --zone ZONE
--id PRIVATE-HOST-PLAN-ID
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 必須: Zone (単一ゾーン名)、ID (数値)。JSON は直接または @path.json
で渡せます。--request と個別フラグは併用できません。
--zone=ZONE 必須: 対象ゾーン名です。
--id=ID 必須: 専有ホストプラン ID です。
skr iaas-api product server
Usage: skr iaas-api product server <command>
サーバプランを検索・参照します。CPU、メモリ、GPU、利用可否を確認できます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iaas-api product server find [flags]
指定したゾーンのサーバプランを検索します。API 応答の Total、From、Count、ServerPlans を含む JSON
を出力します。CPU、メモリ、GPU、CPUコミットメント、世代、利用可否を確認できます。例: skr iaas-api product server
find --zone is1b
iaas-api product server read [flags]
指定したゾーンと ID のサーバプランを参照します。例: skr iaas-api product server read --zone ZONE
--id SERVER-PLAN-ID
skr iaas-api product server find
Usage: skr iaas-api product server find [flags]
指定したゾーンのサーバプランを検索します。API 応答の Total、From、Count、ServerPlans を含む JSON
を出力します。CPU、メモリ、GPU、CPUコミットメント、世代、利用可否を確認できます。例: skr iaas-api product server find
--zone is1b
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 必須: Zone (対象ゾーン名)。API の Filter、Sort、Include、Exclude
は JSON で指定します。Filter の文字列値は部分一致、配列値は OR 条件です。Count と
From は個別フラグです。JSON は直接または @path.json で渡せます。--request
と個別フラグは併用できません。
--zone=ZONE 必須: 検索対象のゾーン名です。例: --zone is1b
--count=COUNT 任意: 取得件数です。
--from=FROM 任意: 取得開始位置です。
skr iaas-api product server read
Usage: skr iaas-api product server read [flags]
指定したゾーンと ID のサーバプランを参照します。例: skr iaas-api product server read --zone ZONE --id
SERVER-PLAN-ID
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 必須: Zone (単一ゾーン名)、ID (数値)。JSON は直接または @path.json
で渡せます。--request と個別フラグは併用できません。
--zone=ZONE 必須: 対象ゾーン名です。
--id=ID 必須: サーバプラン ID です。
skr iaas-api region
Usage: skr iaas-api region <command>
リージョン情報を検索・参照します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iaas-api region find [flags]
リージョン一覧を取得します。必要な項目だけを表示する例: skr iaas-api region find --query
'map({ID,Name,Description})'
iaas-api region read [flags]
指定した ID のリージョン情報を取得します。例: skr iaas-api region read --id REGION-ID
skr iaas-api region find
Usage: skr iaas-api region find [flags]
リージョン一覧を取得します。必要な項目だけを表示する例: skr iaas-api region find --query
'map({ID,Name,Description})'
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 任意: FindRequest JSON を直接または @path.json で指定します。Names
と Sort は JSON、Count と From は --count、--from
で指定できます。省略時は一覧を取得します。--request と個別フラグは併用できません。
--count=COUNT 任意: 取得件数です。
--from=FROM 任意: 取得開始位置です。
skr iaas-api region read
Usage: skr iaas-api region read [flags]
指定した ID のリージョン情報を取得します。例: skr iaas-api region read --id REGION-ID
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 必須: ID (数値)。--id または ReadRequest JSON を直接／@path.json
で指定します。個別フラグと --request は併用できません。
--id=ID 必須: 参照するリージョン ID です。
skr iaas-api switch
Usage: skr iaas-api switch <command>
さくらのクラウドのスイッチを操作します。各操作で --zone などのフラグ、または --request JSON に Zone
を指定します。両経路は併用できません。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iaas-api switch find [flags]
スイッチを指定したゾーンで検索して出力します。例: skr iaas-api switch find --zone tk1v
iaas-api switch read [flags]
スイッチを読み取って出力します。例: skr iaas-api switch read --zone ZONE --id 123456789012
iaas-api switch create [flags]
スイッチを作成して出力します。例: skr iaas-api switch create --zone ZONE --name example
iaas-api switch update [flags]
指定項目だけを更新して出力します。例: skr iaas-api switch update --zone ZONE --id 123456789012
--name updated
iaas-api switch delete [flags]
スイッチを削除します。成功時は出力しません。例: skr iaas-api switch delete --zone ZONE --id
123456789012
skr iaas-api switch find
Usage: skr iaas-api switch find [flags]
スイッチを指定したゾーンで検索して出力します。例: skr iaas-api switch find --zone tk1v
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json で指定します。必須:
Zone (単一のゾーン名)。任意: Tags は --tags でカンマ区切り、または
JSON 配列で指定できます。Count と From は個別フラグ、Names
(名前の文字列配列) と Sort (ソートキーの配列) は JSON で指定します。Sort
の要素は Key (API のソート対象フィールド名) と Order (0: 昇順、1:
降順) を持つオブジェクトです。有効な Key は対象 API の仕様で確認してください。例:
--request='{"Zone":"tk1v","Names":["example"]}'。フラグ例:
skr iaas-api switch find --zone tk1v --tags
production,web
--zone=ZONE 必須: 対象ゾーン名。例: --zone tk1v
--tags=TAGS 任意: タグの配列。カンマ区切りで指定します。API の Tags フィールドに対応します。
--count=COUNT 任意: 取得件数 (整数)。
--from=FROM 任意: 取得開始位置 (整数)。
skr iaas-api switch read
Usage: skr iaas-api switch read [flags]
スイッチを読み取って出力します。例: skr iaas-api switch read --zone ZONE --id 123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (作成結果にある数値)。例:
--request='{"Zone":"tk1v","ID":123456789012}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: 作成結果の ID (数値)。
skr iaas-api switch create
Usage: skr iaas-api switch create [flags]
スイッチを作成して出力します。例: skr iaas-api switch create --zone ZONE --name example
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または
@path.json で指定します。必須: Zone
(ゾーン名)、Name (名前)。任意: Description
(説明、最大512文字)、Tags (--tags でカンマ区切り、JSON
経路では文字列配列)、IconID (数値)、NetworkMaskLen
(整数)、DefaultRoute (文字列)。JSON 例:
{"Zone":"tk1v","Name":"example","Tags":["test"]}。フラグ例:
skr iaas-api switch create --zone tk1v --name
example --tags production,web
--zone=ZONE 必須: 作成先のゾーン名。
--name=NAME 必須: スイッチの名前。
--tags=TAGS 任意: タグの配列。カンマ区切りで指定します。API の Tags
フィールドに対応します。
--description=DESCRIPTION 任意: 説明 (最大512文字)。
--icon-id=ICON-ID 任意: アイコンの ID (数値)。
--network-mask-len=NETWORK-MASK-LEN
任意: ネットワークマスク長 (整数)。
--default-route=DEFAULT-ROUTE
任意: デフォルトルート (文字列)。
skr iaas-api switch update
Usage: skr iaas-api switch update [flags]
指定項目だけを更新して出力します。例: skr iaas-api switch update --zone ZONE --id 123456789012
--name updated
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (数値)。任意:
Name (名前)、Description (説明、最大512文字)、Tags
(--tags でカンマ区切り、JSON 経路では文字列配列)、IconID
(数値)、NetworkMaskLen (整数)、DefaultRoute
(文字列)。省略した項目は変更しません。JSON 例:
{"Zone":"tk1v","ID":123456789012,"Tags":["test"]}。フラグ例:
skr iaas-api switch update --zone tk1v
--id 123456789012 --tags production,web。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: 更新対象の ID (数値)。
--tags=TAGS 任意: 更新後のタグ配列。カンマ区切りで指定します。未指定なら変更しません。
--name=NAME 任意: 新しい名前。未指定なら変更しません。
--description=DESCRIPTION 任意: 新しい説明 (最大512文字)。空文字列も指定できます。
--icon-id=ICON-ID 任意: アイコンの ID (数値)。
--network-mask-len=NETWORK-MASK-LEN
任意: ネットワークマスク長 (整数)。0 も明示できます。
--default-route=DEFAULT-ROUTE
任意: デフォルトルート (文字列)。空文字列も指定できます。
skr iaas-api switch delete
Usage: skr iaas-api switch delete [flags]
スイッチを削除します。成功時は出力しません。例: skr iaas-api switch delete --zone ZONE --id
123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json で指定します。必須:
Zone (ゾーン名)、ID (数値)。任意: FailIfNotFound
(真偽値)、WaitForRelease (真偽値)、WaitForReleaseTimeout
(秒の整数)、WaitForReleaseTick (秒の整数)。例:
--request='{"Zone":"tk1v","ID":123456789012,"FailIfNotFound":true}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: 削除対象の ID (数値)。
--fail-if-not-found 任意: 対象が見つからない場合にエラーにします (真偽値)。
--wait-for-release 任意: 他リソースから参照されている間は削除を待ちます (真偽値)。
--wait-for-release-timeout=WAIT-FOR-RELEASE-TIMEOUT
任意: 待機のタイムアウト (秒の整数、既定3600秒)。
--wait-for-release-tick=WAIT-FOR-RELEASE-TICK
任意: 待機時の確認間隔 (秒の整数、既定5秒)。
skr iaas-api server
Usage: skr iaas-api server <command>
さくらのクラウドのサーバを検索、参照、作成、更新、起動、削除します。作成時はcloud-init用ディスクやNICを個別フラグで指定できます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iaas-api server find [flags]
サーバを指定したゾーンで検索して出力します。例: skr iaas-api server find --zone tk1v
iaas-api server read [flags]
サーバを読み取って出力します。例: skr iaas-api server read --zone ZONE --id 123456789012
iaas-api server create [flags]
サーバを作成して出力します。基本項目はフラグ、複雑な構成は --request JSON で指定します。ディスクと NIC
は --disk と --nic を繰り返して指定できます。例: skr iaas-api server create
--zone ZONE --name example --cpu 1 --memory-gb 1 --disk
'archive-id=ARCHIVE-ID,plan-id=DISK-PLAN-ID,size-gb=20' --nic
'upstream=shared'
iaas-api server boot --zone=STRING --id=INT-64 [flags]
サーバを起動します。cloud-init の user-data は任意で、--user-data @path.yaml または --user-data
- で指定します。例: skr iaas-api server boot --zone ZONE --id 123456789012
iaas-api server update [flags]
サーバの指定項目を更新して出力します。省略した項目は変更しません。CPU または MemoryGB の変更はプラン変更です。プラン変更後は新しいサーバ
ID を確認してください。例: skr iaas-api server update --zone ZONE --id 123456789012
--name updated
iaas-api server delete [flags]
サーバを削除します。成功時は出力しません。ディスクも削除する場合は --with-disks を指定します。例: skr iaas-api server
delete --zone ZONE --id 123456789012
skr iaas-api server find
Usage: skr iaas-api server find [flags]
サーバを指定したゾーンで検索して出力します。例: skr iaas-api server find --zone tk1v
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json で指定します。必須:
Zone (単一ゾーン名)。任意: 単一名の部分一致検索は --name、複数名の Names と
Sort は JSON で指定します。Tags は --tags のカンマ区切りまたは JSON
配列、Count と From は個別フラグでも指定できます。例: skr iaas-api server
find --zone is1b --name example
--name=NAME 任意: 部分一致で検索する単一の名前。カンマを含めて1つの名前として扱います。API
の名前検索条件に対応し、JSON では Names 配列で指定します。
--zone=ZONE 必須: 対象ゾーン名。例: --zone tk1v
--tags=TAGS 任意: タグの配列。カンマ区切りで指定します。API の Tags フィールドに対応します。
--count=COUNT 任意: 取得件数 (整数)。
--from=FROM 任意: 取得開始位置 (整数)。
skr iaas-api server read
Usage: skr iaas-api server read [flags]
サーバを読み取って出力します。例: skr iaas-api server read --zone ZONE --id 123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (作成結果の数値)。例:
--request='{"Zone":"ZONE","ID":123456789012}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: サーバ ID (数値)。
skr iaas-api server create
Usage: skr iaas-api server create [flags]
サーバを作成して出力します。基本項目はフラグ、複雑な構成は --request JSON で指定します。ディスクと NIC は --disk と --nic
を繰り返して指定できます。例: skr iaas-api server create --zone ZONE --name example --cpu 1
--memory-gb 1 --disk 'archive-id=ARCHIVE-ID,plan-id=DISK-PLAN-ID,size-gb=20'
--nic 'upstream=shared'
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または
@path.json で指定します。必須: Zone
(単一ゾーン名)、Name、CPU、MemoryGB。CPU と
MemoryGB は対象ゾーンで利用可能なプランを指定します。Tags
は文字列配列です。Disks、NetworkInterfaces
などの複雑な構成や、その他の API フィールドも指定できます。NoWait=true
と BootAfterCreate=true は併用できません。NoWait=true
の場合は各ディスクも NoWait=true にします。例:
--request='{"Zone":"is1b","Name":"example","CPU":1,"MemoryGB":1,"Tags":["tutorial"]}'
--zone=ZONE 必須: 作成先のゾーン名。
--name=NAME 必須: サーバ名。
--cpu=CPU 必須: 仮想コア数。MemoryGB
と対象ゾーンで利用可能なプランの組み合わせを指定してください。
--memory-gb=MEMORY-GB 必須: メモリ容量 (GB)。CPU
と対象ゾーンで利用可能なプランの組み合わせを指定してください。
--tags=TAGS 任意: タグの配列。カンマ区切りで指定します。API の Tags
フィールドに対応します。
--description=DESCRIPTION 任意: サーバの説明 (最大512文字)。
--icon-id=ICON-ID 任意: アイコンの ID (数値)。
--gpu=GPU 任意: GPU 数。
--gpu-model=GPU-MODEL 任意: GPU モデル。
--cpu-model=CPU-MODEL 任意: CPU モデル。
--commitment=COMMITMENT 任意: CPU プランのコミットメント。standard または dedicatedcpu
を指定します。
--generation=GENERATION 任意: サーバプラン世代 (0: 既定、100、200)。
--confidential-vm 任意: Confidential VM
プランを有効にします。利用条件と提供ゾーンを確認してください。
--interface-driver=INTERFACE-DRIVER
任意: 仮想 NIC ドライバ。virtio または e1000 を指定します。
--boot-after-create 任意: true の場合、作成後にサーバを起動します。NoWait=true
とは併用できません。cloud-init user-data
を使う場合は省略してください。
--cdrom-id=CDROM-ID 任意: 作成時に挿入する CD-ROM イメージの ID (数値)。
--private-host-id=PRIVATE-HOST-ID
任意: 接続先の専有ホスト ID (数値)。
--disk=DISK 任意: ディスク1個を key=value のカンマ区切りで指定します。必須キー:
plan-id、size-gb (GB)。任意キー:
archive-id。すべて正の整数です。例: --disk
'archive-id=123,plan-id=4,size-gb=20'。繰り返し指定でき、指定順に
API の Disks 配列を組み立てます。接続は virtio
です。archive-id 省略時は空のディスクを作成します。
--nic=NIC 任意: NIC 1個を
upstream=shared、upstream=disconnected、または
upstream=SWITCH_ID
で指定します。共有セグメント、未接続、指定スイッチへの接続です。SWITCH_ID
は正の整数です。繰り返し指定でき、指定順に API の
NetworkInterfaces 配列を組み立てます。shared は先頭の
NIC にだけ指定できます。ルータ＋スイッチに接続する場合も先頭の NIC
を指定してください。OS の IP アドレスは設定しません。
skr iaas-api server boot
Usage: skr iaas-api server boot --zone=STRING --id=INT-64 [flags]
サーバを起動します。cloud-init の user-data は任意で、--user-data @path.yaml または --user-data -
で指定します。例: skr iaas-api server boot --zone ZONE --id 123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--zone=STRING 必須: 対象ゾーン名。
--id=INT-64 必須: 起動するサーバ ID。
--user-data=USER-DATA 任意: cloud-init user-data。省略すると
user-data なしで起動します。@path.yaml でファイルから、-
で標準入力から読み込みます。インライン値は指定できません。
skr iaas-api server update
Usage: skr iaas-api server update [flags]
サーバの指定項目を更新して出力します。省略した項目は変更しません。CPU または MemoryGB の変更はプラン変更です。プラン変更後は新しいサーバ ID
を確認してください。例: skr iaas-api server update --zone ZONE --id 123456789012 --name
updated
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (数値)。任意フラグは
Name、Description、Tags (--tags
でカンマ区切り)、CPU、MemoryGB、GPU、GPUModel、CPUModel
です。JSON 経路では Tags
を文字列配列で指定できます。IconID、Commitment、Generation、InterfaceDriver、CDROMID、PrivateHostID、Disks、NetworkInterfaces
など、フラグのない API フィールドや ID の設定・クリアには JSON
を使用します。省略した項目は変更しません。CPU または MemoryGB
を指定するとプランを変更します。例: skr iaas-api server
update --zone ZONE --id 123456789012 --tags
production,web。ID は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: 更新対象のサーバ ID (数値)。
--tags=TAGS 任意: 更新後のタグ配列。カンマ区切りで指定します。未指定なら変更しません。
--name=NAME 任意: 新しい名前。未指定なら変更しません。
--description=DESCRIPTION 任意: 新しい説明。未指定なら変更しません。
--cpu=CPU 任意: 仮想コア数。MemoryGB
と対象ゾーンで利用可能なプランの組み合わせを指定してください。変更時はプラン変更になります。
--memory-gb=MEMORY-GB 任意: メモリ容量 (GB)。CPU
と対象ゾーンで利用可能なプランの組み合わせを指定してください。変更時はプラン変更になります。
--gpu=GPU 任意: GPU 数。未指定なら変更しません。
--gpu-model=GPU-MODEL 任意: GPU モデル。未指定なら変更しません。
--cpu-model=CPU-MODEL 任意: CPU モデル。未指定なら変更しません。
skr iaas-api server delete
Usage: skr iaas-api server delete [flags]
サーバを削除します。成功時は出力しません。ディスクも削除する場合は --with-disks を指定します。例: skr iaas-api server
delete --zone ZONE --id 123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。JSON オブジェクトを直接または @path.json
で指定します。必須: Zone (ゾーン名)、ID (数値)。任意:
WithDisks (true の場合は接続中のディスクも削除)、FailIfNotFound
(true の場合は対象がないとエラー。省略時はエラーにしない)、Force
(起動中サーバを強制停止してから削除)。ディスクを残す場合は
WithDisks を省略または false にします。例:
--request='{"Zone":"ZONE","ID":123456789012,"FailIfNotFound":true}'。ID
は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。
--id=ID 必須: 削除対象のサーバ ID (数値)。
--with-disks 任意: true の場合、接続中のディスクも削除します。対象を確認してから指定してください。
--fail-if-not-found 任意: 対象サーバが見つからない場合にエラーにします。
--force 任意: 起動中の場合に強制停止してから削除します。
skr iaas-api service-class
Usage: skr iaas-api service-class <command>
指定したゾーンのサービスクラスを検索します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iaas-api service-class find [flags]
指定したゾーンのサービスクラスを検索します。例: skr iaas-api service-class find --zone is1b
skr iaas-api service-class find
Usage: skr iaas-api service-class find [flags]
指定したゾーンのサービスクラスを検索します。例: skr iaas-api service-class find --zone is1b
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 必須: Zone (単一ゾーン名)。Count と From は個別フラグ、Sort は JSON
で指定します。JSON は直接または @path.json で渡せます。--request
と個別フラグは併用できません。
--zone=ZONE 必須: 検索対象のゾーン名です。例: --zone is1b
--count=COUNT 任意: 取得件数です。
--from=FROM 任意: 取得開始位置です。
skr iaas-api zone
Usage: skr iaas-api zone <command>
さくらのクラウドのゾーン一覧を取得します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iaas-api zone find [flags]
ゾーン一覧を取得します。名前の抽出例: skr iaas-api zone find --query 'map(.Name)'
iaas-api zone read [flags]
指定した ID のゾーン情報を取得します。例: skr iaas-api zone read --id ZONE-ID
skr iaas-api zone find
Usage: skr iaas-api zone find [flags]
ゾーン一覧を取得します。名前の抽出例: skr iaas-api zone find --query 'map(.Name)'
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 任意: FindRequest JSON を直接または @path.json
で指定します。Names、Sort、Count、From
で検索条件を指定できます。省略時はゾーン一覧を取得します。
skr iaas-api zone read
Usage: skr iaas-api zone read [flags]
指定した ID のゾーン情報を取得します。例: skr iaas-api zone read --id ZONE-ID
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 必須: ID (数値)。--id または ReadRequest JSON を直接／@path.json
で指定します。個別フラグと --request は併用できません。
--id=ID 必須: 参照するゾーン ID です。
gslb-api
skr gslb-api
Usage: skr gslb-api <command> [flags]
さくらのクラウド GSLB を操作します。実サーバーへのヘルスチェックを行い、DNS 応答先を制御します。SDK のプロファイル、または
SAKURA_ACCESS_TOKEN / SAKURA_ACCESS_TOKEN_SECRET 環境変数で認証します。結果は JSON で出力します。詳細:
https://manual.sakura.ad.jp/cloud/appliance/gslb/index.html
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
gslb-api find [flags]
GSLB を検索します。Name は完全一致です。例: skr gslb-api find --name example
gslb-api read [flags]
指定した ID の GSLB を読み取ります。例: skr gslb-api read --id 123456789012
gslb-api create [flags]
GSLB を作成します。監視方法には --health-check-protocol を指定します。実サーバーは
--destination-server を繰り返して指定できます。複雑な設定には --request JSON を使います。
gslb-api update [flags]
GSLB
の指定項目を更新します。省略した設定は変更しません。ヘルスチェックのフラグを指定すると監視設定全体を置き換えるため、保持したい監視項目も再指定してください。実サーバーを指定すると一覧全体を置き換えます。
gslb-api delete [flags]
指定した ID の GSLB を削除します。
skr gslb-api find
Usage: skr gslb-api find [flags]
GSLB を検索します。Name は完全一致です。例: skr gslb-api find --name example
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用できません。FindRequest JSON を直接または @path.json
で指定します。Names と Tags は複数条件を JSON で指定できます。
--name=NAME 任意: 名前の完全一致検索。複数名は --request JSON の Names 配列で指定します。
--tags=TAGS 任意: タグによる絞り込み。カンマ区切りで指定します。
--count=COUNT 任意: 取得件数。
--from=FROM 任意: 取得開始位置。
skr gslb-api read
Usage: skr gslb-api read [flags]
指定した ID の GSLB を読み取ります。例: skr gslb-api read --id 123456789012
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用できません。ReadRequest JSON を直接または @path.json
で指定します。
--id=ID 必須: GSLB ID。
skr gslb-api create
Usage: skr gslb-api create [flags]
GSLB を作成します。監視方法には --health-check-protocol を指定します。実サーバーは --destination-server
を繰り返して指定できます。複雑な設定には --request JSON を使います。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用できません。CreateRequest JSON を直接または
@path.json で指定します。MonitoringSuiteLog
など、専用フラグのない API フィールドは JSON で指定します。
--name=NAME 必須: GSLB 名。
--description=DESCRIPTION 任意: GSLB の説明。
--tags=TAGS 任意: API の Tags 配列。カンマ区切りで指定します。
--icon-id=ICON-ID 任意: アイコン ID。
--delay-loop=DELAY-LOOP 任意: 実サーバーのチェック間隔 (秒)。10～60 の整数です。
--weighted 任意: 重み付け応答を有効にします。
--sorry-server=SORRY-SERVER
任意: 全実サーバーがダウンした場合の誘導先 IP アドレス。
--health-check-protocol=HEALTH-CHECK-PROTOCOL
必須: 監視プロトコル (http, https, tcp, ping)。
--health-check-host-header=HEALTH-CHECK-HOST-HEADER
任意: HealthCheck.HostHeader。
--health-check-path=HEALTH-CHECK-PATH
任意: HealthCheck.Path。
--health-check-response-code=HEALTH-CHECK-RESPONSE-CODE
任意: HealthCheck.ResponseCode。
--health-check-port=HEALTH-CHECK-PORT
任意: HealthCheck.Port。
--destination-server=DESTINATION-SERVER
任意: 実サーバーを追加します。形式:
ip-address=IP[,enabled=true|false][,weight=1..10000]。繰り返し指定できます。
skr gslb-api update
Usage: skr gslb-api update [flags]
GSLB
の指定項目を更新します。省略した設定は変更しません。ヘルスチェックのフラグを指定すると監視設定全体を置き換えるため、保持したい監視項目も再指定してください。実サーバーを指定すると一覧全体を置き換えます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用できません。UpdateRequest JSON を直接または
@path.json で指定します。MonitoringSuiteLog
など、専用フラグのない API フィールドは JSON で指定します。
--id=ID 必須: 更新する GSLB ID。
--name=NAME 任意: GSLB 名。
--description=DESCRIPTION 任意: GSLB の説明。空文字列を指定すると説明を空にします。
--tags=TAGS 任意: API の Tags 配列。カンマ区切りで指定します。
--icon-id=ICON-ID 任意: アイコン ID。
--delay-loop=DELAY-LOOP 任意: 実サーバーのチェック間隔 (秒)。10～60 の整数です。
--weighted 任意: 重み付け応答の有効／無効。
--sorry-server=SORRY-SERVER
任意: 全実サーバーがダウンした場合の誘導先 IP アドレス。
--health-check-protocol=HEALTH-CHECK-PROTOCOL
HealthCheck を指定する場合は必須。監視プロトコル (http, https,
tcp, ping)。
--health-check-host-header=HEALTH-CHECK-HOST-HEADER
任意: HealthCheck.HostHeader。
--health-check-path=HEALTH-CHECK-PATH
任意: HealthCheck.Path。
--health-check-response-code=HEALTH-CHECK-RESPONSE-CODE
任意: HealthCheck.ResponseCode。
--health-check-port=HEALTH-CHECK-PORT
任意: HealthCheck.Port。
--destination-server=DESTINATION-SERVER
任意: 実サーバー一覧全体を置き換えます。形式:
ip-address=IP[,enabled=true|false][,weight=1..10000]。繰り返し指定できます。
--monitoring-suite-log-enabled
任意: モニタリングスイートへのログ連携を有効／無効にします。
skr gslb-api delete
Usage: skr gslb-api delete [flags]
指定した ID の GSLB を削除します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用できません。DeleteRequest JSON を直接または @path.json
で指定します。
--id=ID 必須: 削除する GSLB ID。
--fail-if-not-found 対象が存在しない場合にエラーにします。
eventbus-api
skr eventbus-api
Usage: skr eventbus-api <command> [flags]
スケジュールまたはイベント検知をきっかけにジョブを実行する EventBus を操作します。実行先を process-configuration
で定義し、schedule または trigger から参照します。認証には SDK のプロファイル、または
SAKURA_ACCESS_TOKEN / SAKURA_ACCESS_TOKEN_SECRET 環境変数を使用します。結果は JSON
で出力します。--query で必要な項目を抽出できます。ジョブ実行はベストエフォート型で、厳密なリアルタイム性は保証されません。詳細:
https://manual.sakura.ad.jp/cloud/appliance/eventbus/about.html
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
eventbus-api process-configuration list
実行設定を一覧表示します。例: skr eventbus-api process-configuration list
eventbus-api process-configuration read <id>
ID を指定して実行設定を読み取ります。ID は list の出力で確認できます。
eventbus-api process-configuration create [flags]
実行設定を作成します。実行先サービス（simplenotification、simplemq、autoscale）は先に作成してください。例:
skr eventbus-api process-configuration create
--request='{"CommonServiceItem":{"Name":"notify","Settings":{"Destination":"simplenotification","Parameters":"{\"group_id\":\"GROUP-ID\",\"message\":\"hello\"}"}}}'
eventbus-api process-configuration update <id> [flags]
実行設定を部分更新します。未指定の項目は変更されません。Settings を指定する場合は Destination と Parameters
を含む設定全体を指定してください。
eventbus-api process-configuration delete <id>
ID を指定して実行設定を削除します。削除前に対象 ID を確認してください。
eventbus-api process-configuration update-secret --secret-file=STRING <id>
実行設定が実行先サービスを呼び出すためのシークレットを登録します。シークレットは --secret-file
でファイルまたは標準入力から読み込み、コマンドラインには記述しないでください。SimpleMQ の例:
{"APIKey":"SIMPLEMQ-API-KEY"}
eventbus-api schedule list
スケジュールを一覧表示します。
eventbus-api schedule read <id>
ID を指定してスケジュールを読み取ります。
eventbus-api schedule create [flags]
実行スケジュールを作成します。StartsAt は Unix epoch ミリ秒の整数です。RecurringStep
と RecurringUnit（min、hour、day）、または Crontab
を指定します。周期は最短 1 分です。例: skr eventbus-api schedule create
--request='{"CommonServiceItem":{"Name":"daily","Settings":{"ProcessConfigurationID":"PROCESS-CONFIGURATION-ID","StartsAt":1893456000000,"RecurringStep":1,"RecurringUnit":"day"}}}'
eventbus-api schedule update <id> [flags]
スケジュールを部分更新します。未指定項目は変更されません。Settings を更新する場合は ProcessConfigurationID と
StartsAt、および周期または Crontab を含めます。
eventbus-api schedule delete <id>
ID を指定してスケジュールを削除します。削除前に対象 ID を確認してください。
eventbus-api trigger list
トリガーを一覧表示します。
eventbus-api trigger read <id>
ID を指定してトリガーを読み取ります。
eventbus-api trigger create [flags]
イベントトリガーを作成します。Settings に Source、Types、ProcessConfigurationID を指定します。Source
と Types の例示値は実際のイベントソースに置き換えてください。例: skr eventbus-api trigger create
--request='{"CommonServiceItem":{"Name":"on-change","Settings":{"Source":"EVENT-SOURCE","Types":["EVENT-TYPE"],"ProcessConfigurationID":"PROCESS-CONFIGURATION-ID"}}}'
eventbus-api trigger update <id> [flags]
トリガーを部分更新します。未指定項目は変更されません。Settings を更新する場合は
Source、Types、ProcessConfigurationID を含めます。
eventbus-api trigger delete <id>
ID を指定してトリガーを削除します。削除前に対象 ID を確認してください。
skr eventbus-api process-configuration
Usage: skr eventbus-api process-configuration <command>
ジョブの実行先とパラメータを定義します。simple-notification、simplemq、autoscale
の実行先サービスを先に作成してから、この実行設定を作成してください。作成後、schedule または trigger からこの実行設定 ID を参照します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
eventbus-api process-configuration list
実行設定を一覧表示します。例: skr eventbus-api process-configuration list
eventbus-api process-configuration read <id>
ID を指定して実行設定を読み取ります。ID は list の出力で確認できます。
eventbus-api process-configuration create [flags]
実行設定を作成します。実行先サービス（simplenotification、simplemq、autoscale）は先に作成してください。例:
skr eventbus-api process-configuration create
--request='{"CommonServiceItem":{"Name":"notify","Settings":{"Destination":"simplenotification","Parameters":"{\"group_id\":\"GROUP-ID\",\"message\":\"hello\"}"}}}'
eventbus-api process-configuration update <id> [flags]
実行設定を部分更新します。未指定の項目は変更されません。Settings を指定する場合は Destination と Parameters
を含む設定全体を指定してください。
eventbus-api process-configuration delete <id>
ID を指定して実行設定を削除します。削除前に対象 ID を確認してください。
eventbus-api process-configuration update-secret --secret-file=STRING <id>
実行設定が実行先サービスを呼び出すためのシークレットを登録します。シークレットは --secret-file
でファイルまたは標準入力から読み込み、コマンドラインには記述しないでください。SimpleMQ の例:
{"APIKey":"SIMPLEMQ-API-KEY"}
skr eventbus-api process-configuration list
Usage: skr eventbus-api process-configuration list
実行設定を一覧表示します。例: skr eventbus-api process-configuration list
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr eventbus-api process-configuration read
Usage: skr eventbus-api process-configuration read <id>
ID を指定して実行設定を読み取ります。ID は list の出力で確認できます。
Arguments:
<id> list の出力で確認したリソース ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr eventbus-api process-configuration create
Usage: skr eventbus-api process-configuration create [flags]
実行設定を作成します。実行先サービス（simplenotification、simplemq、autoscale）は先に作成してください。例:
skr eventbus-api process-configuration create
--request='{"CommonServiceItem":{"Name":"notify","Settings":{"Destination":"simplenotification","Parameters":"{\"group_id\":\"GROUP-ID\",\"message\":\"hello\"}"}}}'
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST CommonServiceItem に Name と Settings を含む
JSON。直接指定するか @path.json でファイルを指定します。Provider は
eventbusprocessconfiguration に自動設定されます。
skr eventbus-api process-configuration update
Usage: skr eventbus-api process-configuration update <id> [flags]
実行設定を部分更新します。未指定の項目は変更されません。Settings を指定する場合は Destination と Parameters
を含む設定全体を指定してください。
Arguments:
<id> 更新する実行設定 ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 変更する項目を含む UpdateCommonServiceItemRequest
JSON。Settings は Destination と Parameters
を含む実行設定全体を指定します。直接 JSON または @path.json。Description を
null にすると説明を消去します。
skr eventbus-api process-configuration delete
Usage: skr eventbus-api process-configuration delete <id>
ID を指定して実行設定を削除します。削除前に対象 ID を確認してください。
Arguments:
<id> 削除するリソース ID。list の出力で確認できます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr eventbus-api process-configuration update-secret
Usage: skr eventbus-api process-configuration update-secret --secret-file=STRING <id>
実行設定が実行先サービスを呼び出すためのシークレットを登録します。シークレットは --secret-file
でファイルまたは標準入力から読み込み、コマンドラインには記述しないでください。SimpleMQ の例:
{"APIKey":"SIMPLEMQ-API-KEY"}
Arguments:
<id> シークレットを更新する実行設定 ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--secret-file=STRING Secret オブジェクトの JSON ファイル。-
の場合は標準入力から読み込みます。SimpleMQ:
{"APIKey":"..."}。API キー認証:
{"AccessToken":"...","AccessTokenSecret":"..."}。
skr eventbus-api schedule
Usage: skr eventbus-api schedule <command>
指定した時刻から定期的に実行設定を実行します。スケジュール周期は最短 1 分です。先に
process-configuration を作成し、その ID を指定してください。StartsAt は Unix
epoch のミリ秒を整数で指定します。例: skr eventbus-api schedule create
--request='{"CommonServiceItem":{"Name":"daily","Settings":{"ProcessConfigurationID":"PROCESS-CONFIGURATION-ID","StartsAt":1893456000000,"RecurringStep":1,"RecurringUnit":"day"}}}'
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
eventbus-api schedule list
スケジュールを一覧表示します。
eventbus-api schedule read <id>
ID を指定してスケジュールを読み取ります。
eventbus-api schedule create [flags]
実行スケジュールを作成します。StartsAt は Unix epoch ミリ秒の整数です。RecurringStep
と RecurringUnit（min、hour、day）、または Crontab
を指定します。周期は最短 1 分です。例: skr eventbus-api schedule create
--request='{"CommonServiceItem":{"Name":"daily","Settings":{"ProcessConfigurationID":"PROCESS-CONFIGURATION-ID","StartsAt":1893456000000,"RecurringStep":1,"RecurringUnit":"day"}}}'
eventbus-api schedule update <id> [flags]
スケジュールを部分更新します。未指定項目は変更されません。Settings を更新する場合は ProcessConfigurationID と
StartsAt、および周期または Crontab を含めます。
eventbus-api schedule delete <id>
ID を指定してスケジュールを削除します。削除前に対象 ID を確認してください。
skr eventbus-api schedule list
Usage: skr eventbus-api schedule list
スケジュールを一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr eventbus-api schedule read
Usage: skr eventbus-api schedule read <id>
ID を指定してスケジュールを読み取ります。
Arguments:
<id> list の出力で確認したリソース ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr eventbus-api schedule create
Usage: skr eventbus-api schedule create [flags]
実行スケジュールを作成します。StartsAt は Unix epoch ミリ秒の整数です。RecurringStep
と RecurringUnit（min、hour、day）、または Crontab
を指定します。周期は最短 1 分です。例: skr eventbus-api schedule create
--request='{"CommonServiceItem":{"Name":"daily","Settings":{"ProcessConfigurationID":"PROCESS-CONFIGURATION-ID","StartsAt":1893456000000,"RecurringStep":1,"RecurringUnit":"day"}}}'
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST Settings は ProcessConfigurationID、StartsAt（Unix
epoch ミリ秒の整数）、RecurringStep と
RecurringUnit（min、hour、day）で指定します。RecurringStep/RecurringUnit
の代わりに Crontab も指定できます。直接 JSON または @path.json。Provider
は eventbusschedule に自動設定されます。
skr eventbus-api schedule update
Usage: skr eventbus-api schedule update <id> [flags]
スケジュールを部分更新します。未指定項目は変更されません。Settings を更新する場合は ProcessConfigurationID と
StartsAt、および周期または Crontab を含めます。
Arguments:
<id> 更新するスケジュール ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 変更する項目を含む UpdateCommonServiceItemRequest
JSON。Settings は schedule 用の JSON オブジェクトです。直接 JSON または
@path.json。Description を null にすると説明を消去します。
skr eventbus-api schedule delete
Usage: skr eventbus-api schedule delete <id>
ID を指定してスケジュールを削除します。削除前に対象 ID を確認してください。
Arguments:
<id> 削除するリソース ID。list の出力で確認できます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr eventbus-api trigger
Usage: skr eventbus-api trigger <command>
イベントソースの変更を検知して実行設定を実行します。先に process-configuration を作成し、その ID
を指定してください。Settings には Source、Types、ProcessConfigurationID を指定します。Source
と Types の例示値は実際のイベントソースに置き換えてください。例: skr eventbus-api trigger create
--request='{"CommonServiceItem":{"Name":"on-change","Settings":{"Source":"EVENT-SOURCE","Types":["EVENT-TYPE"],"ProcessConfigurationID":"PROCESS-CONFIGURATION-ID"}}}'
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
eventbus-api trigger list
トリガーを一覧表示します。
eventbus-api trigger read <id>
ID を指定してトリガーを読み取ります。
eventbus-api trigger create [flags]
イベントトリガーを作成します。Settings に Source、Types、ProcessConfigurationID を指定します。Source
と Types の例示値は実際のイベントソースに置き換えてください。例: skr eventbus-api trigger create
--request='{"CommonServiceItem":{"Name":"on-change","Settings":{"Source":"EVENT-SOURCE","Types":["EVENT-TYPE"],"ProcessConfigurationID":"PROCESS-CONFIGURATION-ID"}}}'
eventbus-api trigger update <id> [flags]
トリガーを部分更新します。未指定項目は変更されません。Settings を更新する場合は
Source、Types、ProcessConfigurationID を含めます。
eventbus-api trigger delete <id>
ID を指定してトリガーを削除します。削除前に対象 ID を確認してください。
skr eventbus-api trigger list
Usage: skr eventbus-api trigger list
トリガーを一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr eventbus-api trigger read
Usage: skr eventbus-api trigger read <id>
ID を指定してトリガーを読み取ります。
Arguments:
<id> list の出力で確認したリソース ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr eventbus-api trigger create
Usage: skr eventbus-api trigger create [flags]
イベントトリガーを作成します。Settings に Source、Types、ProcessConfigurationID を指定します。Source
と Types の例示値は実際のイベントソースに置き換えてください。例: skr eventbus-api trigger create
--request='{"CommonServiceItem":{"Name":"on-change","Settings":{"Source":"EVENT-SOURCE","Types":["EVENT-TYPE"],"ProcessConfigurationID":"PROCESS-CONFIGURATION-ID"}}}'
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST Settings に Source、Types（文字列配列）、ProcessConfigurationID
を含む JSON。直接指定するか @path.json でファイルを指定します。Provider は
eventbustrigger に自動設定されます。
skr eventbus-api trigger update
Usage: skr eventbus-api trigger update <id> [flags]
トリガーを部分更新します。未指定項目は変更されません。Settings を更新する場合は Source、Types、ProcessConfigurationID
を含めます。
Arguments:
<id> 更新するトリガー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 変更する項目を含む UpdateCommonServiceItemRequest
JSON。Settings は Source、Types、ProcessConfigurationID
を含む trigger 用 JSON オブジェクトです。直接 JSON または
@path.json。Description を null にすると説明を消去します。
skr eventbus-api trigger delete
Usage: skr eventbus-api trigger delete <id>
ID を指定してトリガーを削除します。削除前に対象 ID を確認してください。
Arguments:
<id> 削除するリソース ID。list の出力で確認できます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
simplemq-api
skr simplemq-api
Usage: skr simplemq-api <command> [flags]
SimpleMQ のキュー管理 API とメッセージ API を操作します。キュー管理 API は SDK プロファイル、または
SAKURA_ACCESS_TOKEN / SAKURA_ACCESS_TOKEN_SECRET 環境変数で認証します。メッセージ API はキューの API
キーを --api-key-file から読み込みます。結果は JSON で出力します。--query で必要な項目を抽出できます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
simplemq-api queue list
キューを一覧表示します。
simplemq-api queue read <id>
ID を指定してキューを読み取ります。
simplemq-api queue create [flags]
キューを作成します。作成後、rotate-api-key でメッセージ API 用のキーを発行してください。
simplemq-api queue config <id> [flags]
キューの設定を更新します。--visibility-timeout-seconds と --expire-seconds
を指定するか、--request JSON を指定してください。
simplemq-api queue delete <id>
ID を指定してキューを削除します。
simplemq-api queue count-messages <id>
キュー内のメッセージ数を取得します。
simplemq-api queue rotate-api-key <id>
メッセージ API キーを発行または再発行し、結果を出力します。APIKey は認証情報として安全に扱ってください。
simplemq-api queue clear-messages <id>
キュー内のメッセージをすべて削除します。
simplemq-api message send --queue-name=STRING --api-key-file=STRING --content=STRING
キューへメッセージを送信します。
simplemq-api message receive --queue-name=STRING --api-key-file=STRING
キューからメッセージを受信します。
simplemq-api message extend-timeout --queue-name=STRING --api-key-file=STRING <message-id>
受信したメッセージの可視性タイムアウトを延長します。
simplemq-api message delete --queue-name=STRING --api-key-file=STRING <message-id>
受信したメッセージを削除します。
skr simplemq-api queue
Usage: skr simplemq-api queue <command>
キューを作成・管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
simplemq-api queue list
キューを一覧表示します。
simplemq-api queue read <id>
ID を指定してキューを読み取ります。
simplemq-api queue create [flags]
キューを作成します。作成後、rotate-api-key でメッセージ API 用のキーを発行してください。
simplemq-api queue config <id> [flags]
キューの設定を更新します。--visibility-timeout-seconds と --expire-seconds
を指定するか、--request JSON を指定してください。
simplemq-api queue delete <id>
ID を指定してキューを削除します。
simplemq-api queue count-messages <id>
キュー内のメッセージ数を取得します。
simplemq-api queue rotate-api-key <id>
メッセージ API キーを発行または再発行し、結果を出力します。APIKey は認証情報として安全に扱ってください。
simplemq-api queue clear-messages <id>
キュー内のメッセージをすべて削除します。
skr simplemq-api queue list
Usage: skr simplemq-api queue list
キューを一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr simplemq-api queue read
Usage: skr simplemq-api queue read <id>
ID を指定してキューを読み取ります。
Arguments:
<id> list の出力にあるキュー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr simplemq-api queue create
Usage: skr simplemq-api queue create [flags]
キューを作成します。作成後、rotate-api-key でメッセージ API 用のキーを発行してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。CreateQueueRequest JSON を直接または
@path.json で指定します。CommonServiceItem.Name
は5〜64文字の英数字またはハイフンです。Provider.Class は
simplemq に設定します。Tags と Icon は JSON で指定します。例:
--request='{"CommonServiceItem":{"Name":"sample-queue"}}'
--name=NAME 必須: キュー名 (5〜64文字の英数字またはハイフン)。例: sample-queue
--description=DESCRIPTION 任意: キューの説明。
skr simplemq-api queue config
Usage: skr simplemq-api queue config <id> [flags]
キューの設定を更新します。--visibility-timeout-seconds と --expire-seconds を指定するか、--request
JSON を指定してください。
Arguments:
<id> 設定を変更するキュー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。ConfigQueueRequest JSON を直接または @path.json
で指定します。Description、Tags、Icon など追加項目は JSON で指定します。例:
--request='{"CommonServiceItem":{"Settings":{"VisibilityTimeoutSeconds":30,"ExpireSeconds":345600}}}'
--visibility-timeout-seconds=VISIBILITY-TIMEOUT-SECONDS
必須: 可視性タイムアウト秒数 (5〜900)。API の
CommonServiceItem.Settings.VisibilityTimeoutSeconds
に対応します。--expire-seconds と併せて指定します。
--expire-seconds=EXPIRE-SECONDS
必須: メッセージ保存期間秒数 (60〜1209600)。API の
CommonServiceItem.Settings.ExpireSeconds
に対応します。--visibility-timeout-seconds と併せて指定します。
skr simplemq-api queue delete
Usage: skr simplemq-api queue delete <id>
ID を指定してキューを削除します。
Arguments:
<id> 削除するキュー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr simplemq-api queue count-messages
Usage: skr simplemq-api queue count-messages <id>
キュー内のメッセージ数を取得します。
Arguments:
<id> メッセージ数を取得するキュー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr simplemq-api queue rotate-api-key
Usage: skr simplemq-api queue rotate-api-key <id>
メッセージ API キーを発行または再発行し、結果を出力します。APIKey は認証情報として安全に扱ってください。
Arguments:
<id> キーを発行するキュー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr simplemq-api queue clear-messages
Usage: skr simplemq-api queue clear-messages <id>
キュー内のメッセージをすべて削除します。
Arguments:
<id> メッセージをすべて削除するキュー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr simplemq-api message
Usage: skr simplemq-api message <command>
キューの API キーを使ってメッセージを送受信します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
simplemq-api message send --queue-name=STRING --api-key-file=STRING --content=STRING
キューへメッセージを送信します。
simplemq-api message receive --queue-name=STRING --api-key-file=STRING
キューからメッセージを受信します。
simplemq-api message extend-timeout --queue-name=STRING --api-key-file=STRING <message-id>
受信したメッセージの可視性タイムアウトを延長します。
simplemq-api message delete --queue-name=STRING --api-key-file=STRING <message-id>
受信したメッセージを削除します。
skr simplemq-api message send
Usage: skr simplemq-api message send --queue-name=STRING --api-key-file=STRING --content=STRING
キューへメッセージを送信します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--queue-name=STRING 対象キュー名 (5〜64文字の英数字またはハイフン)。
--api-key-file=STRING キュー API キーのファイル。キーを直接引数に指定せず、- の場合は標準入力から読み込みます。
--content=STRING メッセージ本文。API 定義では英数字と + / = の文字で最大256000文字です。
skr simplemq-api message receive
Usage: skr simplemq-api message receive --queue-name=STRING --api-key-file=STRING
キューからメッセージを受信します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--queue-name=STRING 対象キュー名 (5〜64文字の英数字またはハイフン)。
--api-key-file=STRING キュー API キーのファイル。キーを直接引数に指定せず、- の場合は標準入力から読み込みます。
skr simplemq-api message extend-timeout
Usage: skr simplemq-api message extend-timeout --queue-name=STRING --api-key-file=STRING <message-id>
受信したメッセージの可視性タイムアウトを延長します。
Arguments:
<message-id> receive の出力にあるメッセージ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--queue-name=STRING 対象キュー名 (5〜64文字の英数字またはハイフン)。
--api-key-file=STRING キュー API キーのファイル。キーを直接引数に指定せず、- の場合は標準入力から読み込みます。
skr simplemq-api message delete
Usage: skr simplemq-api message delete --queue-name=STRING --api-key-file=STRING <message-id>
受信したメッセージを削除します。
Arguments:
<message-id> 削除するメッセージ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--queue-name=STRING 対象キュー名 (5〜64文字の英数字またはハイフン)。
--api-key-file=STRING キュー API キーのファイル。キーを直接引数に指定せず、- の場合は標準入力から読み込みます。
simple-notification-api
skr simple-notification-api
Usage: skr simple-notification-api <command> [flags]
さくらのクラウド
シンプル通知の通知先、通知先グループ、ルーティング設定、通知履歴を操作します。グループへの通知送信は実際の通知を発生させます。通知の到達は保証されず、結果は通知履歴でも確認してください。SDK
プロファイル、または SAKURA_ACCESS_TOKEN / SAKURA_ACCESS_TOKEN_SECRET
環境変数で認証します。結果は JSON で出力します。--query で必要な項目を抽出できます。詳細:
https://manual.sakura.ad.jp/cloud/appliance/simplenotification/about.html
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
simple-notification-api destination list
通知先を一覧表示します。
simple-notification-api destination read <id>
通知先の詳細を読み取ります。
simple-notification-api destination create [flags]
通知先を作成します。メールアドレスは確認が完了するまで送信先として利用できません。
simple-notification-api destination update <id> [flags]
通知先の名前、説明、タグ、Settings を更新します。通知先アドレスは変更できません。
simple-notification-api destination delete <id>
通知先を削除します。グループから参照されている通知先は先にグループ設定から外してください。
simple-notification-api destination read-status <id>
通知先の送信可否ステータスを取得します。
simple-notification-api group list
通知先グループを一覧表示します。
simple-notification-api group read <id>
通知先グループの詳細を読み取ります。
simple-notification-api group create [flags]
通知先グループを作成します。Settings.Destinations に通知先 ID を指定します。
simple-notification-api group update <id> [flags]
通知先グループの名前、説明、タグ、Settings を更新します。
simple-notification-api group delete <id>
通知先グループを削除します。
simple-notification-api group send-message <id> [flags]
通知先グループにメッセージを送信します。応答は受付結果であり、通知先への到達を保証しません。
simple-notification-api routing list
ルーティング設定を一覧表示します。
simple-notification-api routing read <id>
ルーティング設定を読み取ります。
simple-notification-api routing create [flags]
ルーティング設定を作成します。
simple-notification-api routing update <id> [flags]
ルーティング設定を更新します。
simple-notification-api routing delete <id>
ルーティング設定を削除します。
simple-notification-api routing reorder [flags]
ルーティング設定の順序を変更します。
simple-notification-api routing list-source
ルーティング設定に利用できる通知元を一覧表示します。
simple-notification-api history list
通知履歴を一覧表示します。
simple-notification-api history read <id>
通知履歴を読み取ります。
skr simple-notification-api destination
Usage: skr simple-notification-api destination <command>
メールアドレスまたは Webhook の通知先を管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
simple-notification-api destination list
通知先を一覧表示します。
simple-notification-api destination read <id>
通知先の詳細を読み取ります。
simple-notification-api destination create [flags]
通知先を作成します。メールアドレスは確認が完了するまで送信先として利用できません。
simple-notification-api destination update <id> [flags]
通知先の名前、説明、タグ、Settings を更新します。通知先アドレスは変更できません。
simple-notification-api destination delete <id>
通知先を削除します。グループから参照されている通知先は先にグループ設定から外してください。
simple-notification-api destination read-status <id>
通知先の送信可否ステータスを取得します。
skr simple-notification-api destination list
Usage: skr simple-notification-api destination list
通知先を一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr simple-notification-api destination read
Usage: skr simple-notification-api destination read <id>
通知先の詳細を読み取ります。
Arguments:
<id> 参照する通知先 ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr simple-notification-api destination create
Usage: skr simple-notification-api destination create [flags]
通知先を作成します。メールアドレスは確認が完了するまで送信先として利用できません。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 通知先の作成に使う JSON ファイルを @path.json で指定します。Settings
は Type (email または webhook)、Value、任意の
Disabled を持ちます。メールアドレスやWebhook
URLをコマンド引数に含めないでください。Provider.Class と ServiceClass
は自動設定します。
skr simple-notification-api destination update
Usage: skr simple-notification-api destination update <id> [flags]
通知先の名前、説明、タグ、Settings を更新します。通知先アドレスは変更できません。
Arguments:
<id> 更新する通知先 ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 通知先の更新に使う JSON を直接または @path.json
で指定します。Name、Description、Tags、Icon
は必須です。値を維持する項目は参照結果から再指定してください。Settings を指定する場合は
Type、Value、任意の Disabled を含む設定全体を指定し、Webhook URL
等を保護するため @path.json を使ってください。通知先アドレスは更新できません。
skr simple-notification-api destination delete
Usage: skr simple-notification-api destination delete <id>
通知先を削除します。グループから参照されている通知先は先にグループ設定から外してください。
Arguments:
<id> 削除する通知先 ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr simple-notification-api destination read-status
Usage: skr simple-notification-api destination read-status <id>
通知先の送信可否ステータスを取得します。
Arguments:
<id> ステータスを確認する通知先 ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr simple-notification-api group
Usage: skr simple-notification-api group <command>
通知先をまとめるグループと通知送信を管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
simple-notification-api group list
通知先グループを一覧表示します。
simple-notification-api group read <id>
通知先グループの詳細を読み取ります。
simple-notification-api group create [flags]
通知先グループを作成します。Settings.Destinations に通知先 ID を指定します。
simple-notification-api group update <id> [flags]
通知先グループの名前、説明、タグ、Settings を更新します。
simple-notification-api group delete <id>
通知先グループを削除します。
simple-notification-api group send-message <id> [flags]
通知先グループにメッセージを送信します。応答は受付結果であり、通知先への到達を保証しません。
skr simple-notification-api group list
Usage: skr simple-notification-api group list
通知先グループを一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr simple-notification-api group read
Usage: skr simple-notification-api group read <id>
通知先グループの詳細を読み取ります。
Arguments:
<id> 参照する通知先グループ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr simple-notification-api group create
Usage: skr simple-notification-api group create [flags]
通知先グループを作成します。Settings.Destinations に通知先 ID を指定します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 通知先グループの作成に使う JSON を直接または @path.json
で指定します。Settings.Destinations に通知先 ID
の配列を指定します。Provider.Class と ServiceClass は自動設定します。例:
--request='{"CommonServiceItem":{"Name":"mail-group","Settings":{"Destinations":["DESTINATION-ID"]}}}'
skr simple-notification-api group update
Usage: skr simple-notification-api group update <id> [flags]
通知先グループの名前、説明、タグ、Settings を更新します。
Arguments:
<id> 更新する通知先グループ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 通知先グループの更新に使う JSON を直接または @path.json
で指定します。Name、Description、Tags、Icon
は必須です。値を維持する項目は参照結果から再指定してください。Settings を指定する場合は
Destinations 配列と任意の Disabled を含む設定全体を指定します。
skr simple-notification-api group delete
Usage: skr simple-notification-api group delete <id>
通知先グループを削除します。
Arguments:
<id> 削除する通知先グループ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr simple-notification-api group send-message
Usage: skr simple-notification-api group send-message <id> [flags]
通知先グループにメッセージを送信します。応答は受付結果であり、通知先への到達を保証しません。
Arguments:
<id> 送信先の通知先グループ ID。通知先 ID ではありません。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST Message を含む JSON を直接または @path.json で指定するか、--message
を指定します。--request と個別フラグは併用できません。例: send-message
GROUP-ID --message 'テスト通知'
--message=MESSAGE 必須: 通知するメッセージ。API の Message フィールドに対応します。
skr simple-notification-api routing
Usage: skr simple-notification-api routing <command>
通知ルーティング設定を管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
simple-notification-api routing list
ルーティング設定を一覧表示します。
simple-notification-api routing read <id>
ルーティング設定を読み取ります。
simple-notification-api routing create [flags]
ルーティング設定を作成します。
simple-notification-api routing update <id> [flags]
ルーティング設定を更新します。
simple-notification-api routing delete <id>
ルーティング設定を削除します。
simple-notification-api routing reorder [flags]
ルーティング設定の順序を変更します。
simple-notification-api routing list-source
ルーティング設定に利用できる通知元を一覧表示します。
skr simple-notification-api routing list
Usage: skr simple-notification-api routing list
ルーティング設定を一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr simple-notification-api routing read
Usage: skr simple-notification-api routing read <id>
ルーティング設定を読み取ります。
Arguments:
<id> 参照するルーティング設定 ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr simple-notification-api routing create
Usage: skr simple-notification-api routing create [flags]
ルーティング設定を作成します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST ルーティング設定の作成に使う JSON を直接または @path.json で指定します。Settings
にルーティング API の設定を指定します。Provider.Class と ServiceClass
は自動設定します。
skr simple-notification-api routing update
Usage: skr simple-notification-api routing update <id> [flags]
ルーティング設定を更新します。
Arguments:
<id> 更新するルーティング設定 ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST ルーティング設定の更新に使う JSON を直接または @path.json
で指定します。Name、Description、Tags、Icon
は必須です。値を維持する項目は参照結果から再指定してください。Settings
を指定する場合はルーティング設定全体を指定します。
skr simple-notification-api routing delete
Usage: skr simple-notification-api routing delete <id>
ルーティング設定を削除します。
Arguments:
<id> 削除するルーティング設定 ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr simple-notification-api routing reorder
Usage: skr simple-notification-api routing reorder [flags]
ルーティング設定の順序を変更します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST ルーティング順序の変更に使う JSON を直接または @path.json で指定します。
skr simple-notification-api routing list-source
Usage: skr simple-notification-api routing list-source
ルーティング設定に利用できる通知元を一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr simple-notification-api history
Usage: skr simple-notification-api history <command>
通知履歴を参照します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
simple-notification-api history list
通知履歴を一覧表示します。
simple-notification-api history read <id>
通知履歴を読み取ります。
skr simple-notification-api history list
Usage: skr simple-notification-api history list
通知履歴を一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr simple-notification-api history read
Usage: skr simple-notification-api history read <id>
通知履歴を読み取ります。
Arguments:
<id> 参照する通知履歴 ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
networking-suite-api
skr networking-suite-api
Usage: skr networking-suite-api <command> [flags]
ネットワークスイートのサブネットグループ、サブネット、サーバ NIC 接続、IP アドレスを操作します。SDK プロファイル、または
SAKURA_ACCESS_TOKEN / SAKURA_ACCESS_TOKEN_SECRET 環境変数で認証します。API
エンドポイントは SDK の既定値を使います。対象ゾーンに合わせる場合は SAKURA_ENDPOINTS_NETWORKING_SUITE
を設定してください。Create/Update はフラグまたは --request JSON で入力します。SRN
はリソース一覧や参照結果から取得します。結果は JSON で出力します。--query で必要な項目を抽出できます。詳細:
https://manual.sakura.ad.jp/cloud/network/networking-suite/index.html
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
networking-suite-api subnet-group list
サブネットグループを一覧表示します。例: skr networking-suite-api subnet-group list
networking-suite-api subnet-group read <srn>
SRN を指定してサブネットグループを参照します。例: skr networking-suite-api subnet-group read
SUBNET-GROUP-SRN
networking-suite-api subnet-group create [flags]
リージョン単位のサブネットグループを作成します。例: skr networking-suite-api subnet-group create
--name NAME --description DESCRIPTION --ipv4-address-range-cidr 10.0.0.0/16
--region is1
networking-suite-api subnet-group update <srn> [flags]
サブネットグループの名前と説明を更新します。両方の値を指定してください。例: skr networking-suite-api subnet-group
update SUBNET-GROUP-SRN --name NAME --description DESCRIPTION
networking-suite-api subnet-group delete <srn>
サブネットグループを削除します。配下のサブネットを先に削除してください。例: skr networking-suite-api subnet-group
delete SUBNET-GROUP-SRN
networking-suite-api subnet list <subnet-group-srn>
サブネットグループの SRN を指定してサブネットを一覧表示します。例: skr networking-suite-api subnet list
SUBNET-GROUP-SRN
networking-suite-api subnet read <srn>
SRN を指定してサブネットを参照します。例: skr networking-suite-api subnet read SUBNET-SRN
networking-suite-api subnet create [flags]
サブネットグループにゾーン別サブネットを作成します。例: skr networking-suite-api subnet create --name
NAME --description DESCRIPTION --ipv4-address-range-cidr 10.0.1.0/24 --zone
is1b --subnet-group-srn SUBNET-GROUP-SRN
networking-suite-api subnet update <srn> [flags]
サブネットの名前と説明を更新します。両方の値を指定してください。例: skr networking-suite-api subnet update
SUBNET-SRN --name NAME --description DESCRIPTION
networking-suite-api subnet delete <srn>
サブネットを削除します。接続中の NIC がないことを確認してください。例: skr networking-suite-api subnet
delete SUBNET-SRN
networking-suite-api interface-connection create [flags]
指定したサーバ NIC をサブネットへ接続します。例: skr networking-suite-api interface-connection
create --interface-srn INTERFACE-SRN --subnet-srn SUBNET-SRN
networking-suite-api interface-connection delete <srn>
NIC とサブネットの接続を解除します。サーバは停止状態にしてください。例: skr networking-suite-api
interface-connection delete INTERFACE-CONNECTION-SRN
networking-suite-api address list <subnet-srn> [flags]
サブネットに割り当てられた IPv4 アドレスを一覧表示します。例: skr networking-suite-api address list
SUBNET-SRN
networking-suite-api address read <srn>
SRN を指定して IPv4 アドレスを参照します。例: skr networking-suite-api address read
ADDRESS-SRN
skr networking-suite-api subnet-group
Usage: skr networking-suite-api subnet-group <command>
リージョン内のネットワーク範囲を管理します。サブネットを作成する前に作成してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
networking-suite-api subnet-group list
サブネットグループを一覧表示します。例: skr networking-suite-api subnet-group list
networking-suite-api subnet-group read <srn>
SRN を指定してサブネットグループを参照します。例: skr networking-suite-api subnet-group read
SUBNET-GROUP-SRN
networking-suite-api subnet-group create [flags]
リージョン単位のサブネットグループを作成します。例: skr networking-suite-api subnet-group create
--name NAME --description DESCRIPTION --ipv4-address-range-cidr 10.0.0.0/16
--region is1
networking-suite-api subnet-group update <srn> [flags]
サブネットグループの名前と説明を更新します。両方の値を指定してください。例: skr networking-suite-api subnet-group
update SUBNET-GROUP-SRN --name NAME --description DESCRIPTION
networking-suite-api subnet-group delete <srn>
サブネットグループを削除します。配下のサブネットを先に削除してください。例: skr networking-suite-api subnet-group
delete SUBNET-GROUP-SRN
skr networking-suite-api subnet-group list
Usage: skr networking-suite-api subnet-group list
サブネットグループを一覧表示します。例: skr networking-suite-api subnet-group list
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr networking-suite-api subnet-group read
Usage: skr networking-suite-api subnet-group read <srn>
SRN を指定してサブネットグループを参照します。例: skr networking-suite-api subnet-group read
SUBNET-GROUP-SRN
Arguments:
<srn> 参照するサブネットグループの SRN。list の出力に含まれます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr networking-suite-api subnet-group create
Usage: skr networking-suite-api subnet-group create [flags]
リージョン単位のサブネットグループを作成します。例: skr networking-suite-api subnet-group create --name
NAME --description DESCRIPTION --ipv4-address-range-cidr 10.0.0.0/16 --region
is1
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用できません。CreateSubnetGroup
JSON を直接、@path.json、または - (標準入力)
で指定します。Name、Description、IPv4AddressRangeCIDR、Region.Code
が必要です。
--name=NAME 必須: サブネットグループ名。
--description=DESCRIPTION 必須: サブネットグループの説明。
--ipv4-address-range-cidr=IPV4-ADDRESS-RANGE-CIDR
必須: サブネットグループの IPv4
CIDR。10.0.0.0/8、172.16.0.0/12、192.168.0.0/16、100.64.0.0/10
の範囲内で /16 から /28 を指定します。
--region=REGION 必須: Region.Code に対応するリージョンコード (例: is1)。
skr networking-suite-api subnet-group update
Usage: skr networking-suite-api subnet-group update <srn> [flags]
サブネットグループの名前と説明を更新します。両方の値を指定してください。例: skr networking-suite-api subnet-group
update SUBNET-GROUP-SRN --name NAME --description DESCRIPTION
Arguments:
<srn> 更新するサブネットグループの SRN。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用できません。UpdateSubnetGroup JSON
を直接、@path.json、または - (標準入力) で指定します。Name と
Description が必要です。
--name=NAME 必須: 更新後の名前。
--description=DESCRIPTION 必須: 更新後の説明。
skr networking-suite-api subnet-group delete
Usage: skr networking-suite-api subnet-group delete <srn>
サブネットグループを削除します。配下のサブネットを先に削除してください。例: skr networking-suite-api subnet-group
delete SUBNET-GROUP-SRN
Arguments:
<srn> 削除するサブネットグループの SRN。配下のサブネットがないことを確認してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr networking-suite-api subnet
Usage: skr networking-suite-api subnet <command>
サブネットグループ内のゾーン別ネットワークを管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
networking-suite-api subnet list <subnet-group-srn>
サブネットグループの SRN を指定してサブネットを一覧表示します。例: skr networking-suite-api subnet list
SUBNET-GROUP-SRN
networking-suite-api subnet read <srn>
SRN を指定してサブネットを参照します。例: skr networking-suite-api subnet read SUBNET-SRN
networking-suite-api subnet create [flags]
サブネットグループにゾーン別サブネットを作成します。例: skr networking-suite-api subnet create --name
NAME --description DESCRIPTION --ipv4-address-range-cidr 10.0.1.0/24 --zone
is1b --subnet-group-srn SUBNET-GROUP-SRN
networking-suite-api subnet update <srn> [flags]
サブネットの名前と説明を更新します。両方の値を指定してください。例: skr networking-suite-api subnet update
SUBNET-SRN --name NAME --description DESCRIPTION
networking-suite-api subnet delete <srn>
サブネットを削除します。接続中の NIC がないことを確認してください。例: skr networking-suite-api subnet
delete SUBNET-SRN
skr networking-suite-api subnet list
Usage: skr networking-suite-api subnet list <subnet-group-srn>
サブネットグループの SRN を指定してサブネットを一覧表示します。例: skr networking-suite-api subnet list
SUBNET-GROUP-SRN
Arguments:
<subnet-group-srn> 一覧を取得する親サブネットグループの SRN。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr networking-suite-api subnet read
Usage: skr networking-suite-api subnet read <srn>
SRN を指定してサブネットを参照します。例: skr networking-suite-api subnet read SUBNET-SRN
Arguments:
<srn> 参照するサブネットの SRN。list の出力に含まれます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr networking-suite-api subnet create
Usage: skr networking-suite-api subnet create [flags]
サブネットグループにゾーン別サブネットを作成します。例: skr networking-suite-api subnet create --name NAME
--description DESCRIPTION --ipv4-address-range-cidr 10.0.1.0/24 --zone is1b
--subnet-group-srn SUBNET-GROUP-SRN
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用できません。CreateSubnet JSON
を直接、@path.json、または - (標準入力)
で指定します。Name、Description、IPv4AddressRangeCIDR、Zone.Code、SubnetGroup.SRN
が必要です。
--name=NAME 必須: サブネット名。
--description=DESCRIPTION 必須: サブネットの説明。
--ipv4-address-range-cidr=IPV4-ADDRESS-RANGE-CIDR
必須: 親範囲内で他のサブネットと重複しない IPv4 CIDR (/16 から
/28)。
--zone=ZONE 必須: Zone.Code に対応する配置先ゾーンコード (例: is1c)。
--subnet-group-srn=SUBNET-GROUP-SRN
必須: API の SubnetGroup.SRN に対応する親サブネットグループの
SRN。
skr networking-suite-api subnet update
Usage: skr networking-suite-api subnet update <srn> [flags]
サブネットの名前と説明を更新します。両方の値を指定してください。例: skr networking-suite-api subnet update
SUBNET-SRN --name NAME --description DESCRIPTION
Arguments:
<srn> 更新するサブネットの SRN。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用できません。UpdateSubnet JSON
を直接、@path.json、または - (標準入力) で指定します。Name と
Description が必要です。
--name=NAME 必須: 更新後の名前。
--description=DESCRIPTION 必須: 更新後の説明。
skr networking-suite-api subnet delete
Usage: skr networking-suite-api subnet delete <srn>
サブネットを削除します。接続中の NIC がないことを確認してください。例: skr networking-suite-api subnet delete
SUBNET-SRN
Arguments:
<srn> 削除するサブネットの SRN。接続中の NIC がないことを確認してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr networking-suite-api interface-connection
Usage: skr networking-suite-api interface-connection <command>
サーバの NIC とサブネットの接続を管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
networking-suite-api interface-connection create [flags]
指定したサーバ NIC をサブネットへ接続します。例: skr networking-suite-api interface-connection
create --interface-srn INTERFACE-SRN --subnet-srn SUBNET-SRN
networking-suite-api interface-connection delete <srn>
NIC とサブネットの接続を解除します。サーバは停止状態にしてください。例: skr networking-suite-api
interface-connection delete INTERFACE-CONNECTION-SRN
skr networking-suite-api interface-connection create
Usage: skr networking-suite-api interface-connection create [flags]
指定したサーバ NIC をサブネットへ接続します。例: skr networking-suite-api interface-connection create
--interface-srn INTERFACE-SRN --subnet-srn SUBNET-SRN
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--interface-srn=INTERFACE-SRN
必須: 接続するサーバ NIC の SRN。Server
read の NIC ID とゾーンから
srnv1:sakura-ZONE:sakura.iaas.interface:ID
の形式で構成します。
--subnet-srn=SUBNET-SRN 必須: 接続先サブネットの SRN。
--ephemeral-ipv4-address=EPHEMERAL-IPV4-ADDRESS
任意: API の EphemeralIPv4Address
に対応する、サブネット内で未使用の IPv4 アドレス。省略すると自動割り当てです。
skr networking-suite-api interface-connection delete
Usage: skr networking-suite-api interface-connection delete <srn>
NIC とサブネットの接続を解除します。サーバは停止状態にしてください。例: skr networking-suite-api
interface-connection delete INTERFACE-CONNECTION-SRN
Arguments:
<srn> 削除するインターフェースコネクションの SRN。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr networking-suite-api address
Usage: skr networking-suite-api address <command>
サブネットで使用中の IPv4 アドレスを参照します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
networking-suite-api address list <subnet-srn> [flags]
サブネットに割り当てられた IPv4 アドレスを一覧表示します。例: skr networking-suite-api address list
SUBNET-SRN
networking-suite-api address read <srn>
SRN を指定して IPv4 アドレスを参照します。例: skr networking-suite-api address read
ADDRESS-SRN
skr networking-suite-api address list
Usage: skr networking-suite-api address list <subnet-srn> [flags]
サブネットに割り当てられた IPv4 アドレスを一覧表示します。例: skr networking-suite-api address list
SUBNET-SRN
Arguments:
<subnet-srn> アドレス一覧を取得するサブネットの SRN。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--interface-connection-srn=INTERFACE-CONNECTION-SRN
任意: 対象のインターフェースコネクション SRN で結果を絞り込みます。
skr networking-suite-api address read
Usage: skr networking-suite-api address read <srn>
SRN を指定して IPv4 アドレスを参照します。例: skr networking-suite-api address read ADDRESS-SRN
Arguments:
<srn> 参照するアドレスの SRN。list の出力に含まれます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
apprun-dedicated-api
skr apprun-dedicated-api
Usage: skr apprun-dedicated-api <command> [flags]
専用ワーカノード上でコンテナを実行する AppRun 専有型のクラスタ、アプリケーションなどを操作します。SDK
プロファイル、または SAKURA_ACCESS_TOKEN / SAKURA_ACCESS_TOKEN_SECRET
環境変数で認証します。結果は JSON で出力します。--query で必要な項目を抽出できます。詳細:
https://manual.sakura.ad.jp/cloud/apprun-dedicated/about.html
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
apprun-dedicated-api cluster list [flags]
クラスタを一覧表示します。JSON 出力には items と nextCursor が含まれます。
apprun-dedicated-api cluster read <id>
クラスタ ID を指定して詳細を取得します。
apprun-dedicated-api cluster create --request=REQUEST
クラスタを作成します。サービスプリンシパル ID とポート設定を含む JSON を指定します。
apprun-dedicated-api cluster update --request=REQUEST <id>
クラスタの設定を更新します。更新対象の JSON を指定します。
apprun-dedicated-api cluster delete <id>
クラスタを削除します。関連リソースがないことを確認してください。
apprun-dedicated-api application list [flags]
アプリケーションを一覧表示します。
apprun-dedicated-api application create --name=STRING --cluster-id=STRING
アプリケーションをクラスタに登録します。
apprun-dedicated-api application read <id>
アプリケーション ID を指定して詳細を取得します。
apprun-dedicated-api application update <id> [flags]
アクティブバージョンを切り替えるか、--deactivate で停止します。
apprun-dedicated-api application delete <id>
アプリケーションを削除します。削除前に対象 ID を確認してください。
apprun-dedicated-api application containers <id>
アプリケーションのコンテナ配置と状態を取得します。
apprun-dedicated-api version list --application-id=STRING [flags]
アプリケーションのバージョンを一覧表示します。
apprun-dedicated-api version create --application-id=STRING --request=REQUEST
アプリケーションバージョンを作成します。
apprun-dedicated-api version read --application-id=STRING <version>
バージョンの詳細を取得します。
apprun-dedicated-api version delete --application-id=STRING <version>
バージョンを削除します。
apprun-dedicated-api auto-scaling-group list --cluster-id=STRING [flags]
クラスタ内のグループを一覧表示します。
apprun-dedicated-api auto-scaling-group create --cluster-id=STRING --request=REQUEST
クラスタにオートスケーリンググループを作成します。
apprun-dedicated-api auto-scaling-group read --cluster-id=STRING --auto-scaling-group-id=STRING
グループの詳細を取得します。
apprun-dedicated-api auto-scaling-group delete --cluster-id=STRING --auto-scaling-group-id=STRING
グループを削除します。
apprun-dedicated-api worker-node list --cluster-id=STRING --auto-scaling-group-id=STRING [flags]
グループ内のワーカノードを一覧表示します。
apprun-dedicated-api worker-node read --cluster-id=STRING --auto-scaling-group-id=STRING --worker-node-id=STRING
ワーカノードの詳細を取得します。
apprun-dedicated-api worker-node update --cluster-id=STRING --auto-scaling-group-id=STRING --worker-node-id=STRING --draining=STRING
ワーカノードの draining 状態を変更します。
apprun-dedicated-api load-balancer list --cluster-id=STRING --auto-scaling-group-id=STRING [flags]
グループ内のロードバランサを一覧表示します。
apprun-dedicated-api load-balancer create --cluster-id=STRING --auto-scaling-group-id=STRING --request=REQUEST
ロードバランサを作成します。
apprun-dedicated-api load-balancer read --cluster-id=STRING --auto-scaling-group-id=STRING --load-balancer-id=STRING
ロードバランサの詳細を取得します。
apprun-dedicated-api load-balancer delete --cluster-id=STRING --auto-scaling-group-id=STRING --load-balancer-id=STRING
ロードバランサを削除します。
apprun-dedicated-api load-balancer node list --cluster-id=STRING --auto-scaling-group-id=STRING --load-balancer-id=STRING [flags]
ロードバランサのノード一覧を取得します。
apprun-dedicated-api load-balancer node read --cluster-id=STRING --auto-scaling-group-id=STRING --load-balancer-id=STRING --node-id=STRING
ロードバランサノードの詳細を取得します。
apprun-dedicated-api certificate list --cluster-id=STRING [flags]
クラスタの証明書一覧を取得します。
apprun-dedicated-api certificate create --cluster-id=STRING --request=REQUEST
証明書を作成します。PEM を含む JSON は保護したファイルまたは標準入力から渡してください。
apprun-dedicated-api certificate read --cluster-id=STRING --certificate-id=STRING
証明書の詳細を取得します。
apprun-dedicated-api certificate update --cluster-id=STRING --certificate-id=STRING --request=REQUEST
証明書を更新します。PEM を含む JSON は保護したファイルまたは標準入力から渡してください。
apprun-dedicated-api certificate delete --cluster-id=STRING --certificate-id=STRING
証明書を削除します。
apprun-dedicated-api service-class list-lb
ロードバランサのサービスクラス一覧を取得します。
apprun-dedicated-api service-class list-worker
ワーカノードのサービスクラス一覧を取得します。
skr apprun-dedicated-api cluster
Usage: skr apprun-dedicated-api cluster <command>
クラスタを管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
apprun-dedicated-api cluster list [flags]
クラスタを一覧表示します。JSON 出力には items と nextCursor が含まれます。
apprun-dedicated-api cluster read <id>
クラスタ ID を指定して詳細を取得します。
apprun-dedicated-api cluster create --request=REQUEST
クラスタを作成します。サービスプリンシパル ID とポート設定を含む JSON を指定します。
apprun-dedicated-api cluster update --request=REQUEST <id>
クラスタの設定を更新します。更新対象の JSON を指定します。
apprun-dedicated-api cluster delete <id>
クラスタを削除します。関連リソースがないことを確認してください。
skr apprun-dedicated-api cluster list
Usage: skr apprun-dedicated-api cluster list [flags]
クラスタを一覧表示します。JSON 出力には items と nextCursor が含まれます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--max-items=100 1ページあたりの最大件数。
--cursor=CURSOR 前ページの nextCursor。
skr apprun-dedicated-api cluster read
Usage: skr apprun-dedicated-api cluster read <id>
クラスタ ID を指定して詳細を取得します。
Arguments:
<id> 参照するクラスタ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr apprun-dedicated-api cluster create
Usage: skr apprun-dedicated-api cluster create --request=REQUEST
クラスタを作成します。サービスプリンシパル ID とポート設定を含む JSON を指定します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST cluster.CreateParams JSON。直接 JSON または @path.json
で指定します。必須項目は name と servicePrincipalID です。ports
はロードバランサの待受ポート設定です。
skr apprun-dedicated-api cluster update
Usage: skr apprun-dedicated-api cluster update --request=REQUEST <id>
クラスタの設定を更新します。更新対象の JSON を指定します。
Arguments:
<id> 更新するクラスタ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST cluster.UpdateParams JSON。直接 JSON または @path.json
で指定します。
skr apprun-dedicated-api cluster delete
Usage: skr apprun-dedicated-api cluster delete <id>
クラスタを削除します。関連リソースがないことを確認してください。
Arguments:
<id> 削除するクラスタ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr apprun-dedicated-api application
Usage: skr apprun-dedicated-api application <command>
アプリケーションを管理します。クラスタ作成後に登録します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
apprun-dedicated-api application list [flags]
アプリケーションを一覧表示します。
apprun-dedicated-api application create --name=STRING --cluster-id=STRING
アプリケーションをクラスタに登録します。
apprun-dedicated-api application read <id>
アプリケーション ID を指定して詳細を取得します。
apprun-dedicated-api application update <id> [flags]
アクティブバージョンを切り替えるか、--deactivate で停止します。
apprun-dedicated-api application delete <id>
アプリケーションを削除します。削除前に対象 ID を確認してください。
apprun-dedicated-api application containers <id>
アプリケーションのコンテナ配置と状態を取得します。
skr apprun-dedicated-api application list
Usage: skr apprun-dedicated-api application list [flags]
アプリケーションを一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--max-items=100 1ページあたりの最大件数。
--cursor=CURSOR 前ページの nextCursor。
skr apprun-dedicated-api application create
Usage: skr apprun-dedicated-api application create --name=STRING --cluster-id=STRING
アプリケーションをクラスタに登録します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--name=STRING アプリケーション名。
--cluster-id=STRING 作成先クラスタの ID。
skr apprun-dedicated-api application read
Usage: skr apprun-dedicated-api application read <id>
アプリケーション ID を指定して詳細を取得します。
Arguments:
<id> 参照するアプリケーション ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr apprun-dedicated-api application update
Usage: skr apprun-dedicated-api application update <id> [flags]
アクティブバージョンを切り替えるか、--deactivate で停止します。
Arguments:
<id> 更新するアプリケーション ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--active-version=ACTIVE-VERSION
アクティブにするバージョン番号。
--deactivate アクティブバージョンを解除します。--active-version とは併用できません。
skr apprun-dedicated-api application delete
Usage: skr apprun-dedicated-api application delete <id>
アプリケーションを削除します。削除前に対象 ID を確認してください。
Arguments:
<id> 削除するアプリケーション ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr apprun-dedicated-api application containers
Usage: skr apprun-dedicated-api application containers <id>
アプリケーションのコンテナ配置と状態を取得します。
Arguments:
<id> 状態を取得するアプリケーション ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr apprun-dedicated-api version
Usage: skr apprun-dedicated-api version <command>
アプリケーションのバージョンを管理します。アプリケーション ID を指定します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
apprun-dedicated-api version list --application-id=STRING [flags]
アプリケーションのバージョンを一覧表示します。
apprun-dedicated-api version create --application-id=STRING --request=REQUEST
アプリケーションバージョンを作成します。
apprun-dedicated-api version read --application-id=STRING <version>
バージョンの詳細を取得します。
apprun-dedicated-api version delete --application-id=STRING <version>
バージョンを削除します。
skr apprun-dedicated-api version list
Usage: skr apprun-dedicated-api version list --application-id=STRING [flags]
アプリケーションのバージョンを一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--application-id=STRING 対象アプリケーション ID。
--max-items=100 1ページあたりの最大件数。
--cursor=CURSOR 前ページの nextCursor。
skr apprun-dedicated-api version create
Usage: skr apprun-dedicated-api version create --application-id=STRING --request=REQUEST
アプリケーションバージョンを作成します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--application-id=STRING 対象アプリケーション ID。
--request=REQUEST version.CreateParams
JSON。イメージ、CPU、メモリ、スケーリング設定を指定します。秘密情報が含まれる場合は
@path.json または - (標準入力) を使います。
skr apprun-dedicated-api version read
Usage: skr apprun-dedicated-api version read --application-id=STRING <version>
バージョンの詳細を取得します。
Arguments:
<version> 参照するバージョン番号。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--application-id=STRING 対象アプリケーション ID。
skr apprun-dedicated-api version delete
Usage: skr apprun-dedicated-api version delete --application-id=STRING <version>
バージョンを削除します。
Arguments:
<version> 削除するバージョン番号。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--application-id=STRING 対象アプリケーション ID。
skr apprun-dedicated-api auto-scaling-group
Usage: skr apprun-dedicated-api auto-scaling-group <command>
クラスタのワーカノードグループを管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
apprun-dedicated-api auto-scaling-group list --cluster-id=STRING [flags]
クラスタ内のグループを一覧表示します。
apprun-dedicated-api auto-scaling-group create --cluster-id=STRING --request=REQUEST
クラスタにオートスケーリンググループを作成します。
apprun-dedicated-api auto-scaling-group read --cluster-id=STRING --auto-scaling-group-id=STRING
グループの詳細を取得します。
apprun-dedicated-api auto-scaling-group delete --cluster-id=STRING --auto-scaling-group-id=STRING
グループを削除します。
skr apprun-dedicated-api auto-scaling-group list
Usage: skr apprun-dedicated-api auto-scaling-group list --cluster-id=STRING [flags]
クラスタ内のグループを一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--cluster-id=STRING 対象クラスタ ID。
--max-items=100 1ページあたりの最大件数。
--cursor=CURSOR 前ページの nextCursor。
skr apprun-dedicated-api auto-scaling-group create
Usage: skr apprun-dedicated-api auto-scaling-group create --cluster-id=STRING --request=REQUEST
クラスタにオートスケーリンググループを作成します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--cluster-id=STRING 作成先クラスタ ID。
--request=REQUEST autoscalinggroup.CreateParams
JSON。zone、workerServiceClassPath、ノード数、ネットワーク
interfaces を指定します。複雑な配列を含むため JSON で指定してください。
skr apprun-dedicated-api auto-scaling-group read
Usage: skr apprun-dedicated-api auto-scaling-group read --cluster-id=STRING --auto-scaling-group-id=STRING
グループの詳細を取得します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--cluster-id=STRING 対象クラスタ ID。
--auto-scaling-group-id=STRING
参照するグループ ID。
skr apprun-dedicated-api auto-scaling-group delete
Usage: skr apprun-dedicated-api auto-scaling-group delete --cluster-id=STRING --auto-scaling-group-id=STRING
グループを削除します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--cluster-id=STRING 対象クラスタ ID。
--auto-scaling-group-id=STRING
削除するグループ ID。
skr apprun-dedicated-api worker-node
Usage: skr apprun-dedicated-api worker-node <command>
オートスケーリンググループのワーカノードを参照・更新します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
apprun-dedicated-api worker-node list --cluster-id=STRING --auto-scaling-group-id=STRING [flags]
グループ内のワーカノードを一覧表示します。
apprun-dedicated-api worker-node read --cluster-id=STRING --auto-scaling-group-id=STRING --worker-node-id=STRING
ワーカノードの詳細を取得します。
apprun-dedicated-api worker-node update --cluster-id=STRING --auto-scaling-group-id=STRING --worker-node-id=STRING --draining=STRING
ワーカノードの draining 状態を変更します。
skr apprun-dedicated-api worker-node list
Usage: skr apprun-dedicated-api worker-node list --cluster-id=STRING --auto-scaling-group-id=STRING [flags]
グループ内のワーカノードを一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--cluster-id=STRING 対象クラスタ ID。
--auto-scaling-group-id=STRING
対象グループ ID。
--max-items=100 1ページあたりの最大件数。
--cursor=CURSOR 前ページの nextCursor。
skr apprun-dedicated-api worker-node read
Usage: skr apprun-dedicated-api worker-node read --cluster-id=STRING --auto-scaling-group-id=STRING --worker-node-id=STRING
ワーカノードの詳細を取得します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--cluster-id=STRING 対象クラスタ ID。
--auto-scaling-group-id=STRING
対象グループ ID。
--worker-node-id=STRING 参照するワーカノード ID。
skr apprun-dedicated-api worker-node update
Usage: skr apprun-dedicated-api worker-node update --cluster-id=STRING --auto-scaling-group-id=STRING --worker-node-id=STRING --draining=STRING
ワーカノードの draining 状態を変更します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--cluster-id=STRING 対象クラスタ ID。
--auto-scaling-group-id=STRING
対象グループ ID。
--worker-node-id=STRING 更新するワーカノード ID。
--draining=STRING draining 状態。true で draining、false で解除します。
skr apprun-dedicated-api load-balancer
Usage: skr apprun-dedicated-api load-balancer <command>
オートスケーリンググループのロードバランサを管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
apprun-dedicated-api load-balancer list --cluster-id=STRING --auto-scaling-group-id=STRING [flags]
グループ内のロードバランサを一覧表示します。
apprun-dedicated-api load-balancer create --cluster-id=STRING --auto-scaling-group-id=STRING --request=REQUEST
ロードバランサを作成します。
apprun-dedicated-api load-balancer read --cluster-id=STRING --auto-scaling-group-id=STRING --load-balancer-id=STRING
ロードバランサの詳細を取得します。
apprun-dedicated-api load-balancer delete --cluster-id=STRING --auto-scaling-group-id=STRING --load-balancer-id=STRING
ロードバランサを削除します。
apprun-dedicated-api load-balancer node list --cluster-id=STRING --auto-scaling-group-id=STRING --load-balancer-id=STRING [flags]
ロードバランサのノード一覧を取得します。
apprun-dedicated-api load-balancer node read --cluster-id=STRING --auto-scaling-group-id=STRING --load-balancer-id=STRING --node-id=STRING
ロードバランサノードの詳細を取得します。
skr apprun-dedicated-api load-balancer list
Usage: skr apprun-dedicated-api load-balancer list --cluster-id=STRING --auto-scaling-group-id=STRING [flags]
グループ内のロードバランサを一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--cluster-id=STRING 対象クラスタ ID。
--auto-scaling-group-id=STRING
対象グループ ID。
--max-items=100 1ページあたりの最大件数。
--cursor=CURSOR 前ページの nextCursor。
skr apprun-dedicated-api load-balancer create
Usage: skr apprun-dedicated-api load-balancer create --cluster-id=STRING --auto-scaling-group-id=STRING --request=REQUEST
ロードバランサを作成します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--cluster-id=STRING 対象クラスタ ID。
--auto-scaling-group-id=STRING
作成先グループ ID。
--request=REQUEST loadbalancer.CreateParams
JSON。name、serviceClassPath、interfaces 等を指定します。
skr apprun-dedicated-api load-balancer read
Usage: skr apprun-dedicated-api load-balancer read --cluster-id=STRING --auto-scaling-group-id=STRING --load-balancer-id=STRING
ロードバランサの詳細を取得します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--cluster-id=STRING 対象クラスタ ID。
--auto-scaling-group-id=STRING
対象グループ ID。
--load-balancer-id=STRING 参照するロードバランサ ID。
skr apprun-dedicated-api load-balancer delete
Usage: skr apprun-dedicated-api load-balancer delete --cluster-id=STRING --auto-scaling-group-id=STRING --load-balancer-id=STRING
ロードバランサを削除します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--cluster-id=STRING 対象クラスタ ID。
--auto-scaling-group-id=STRING
対象グループ ID。
--load-balancer-id=STRING 削除するロードバランサ ID。
skr apprun-dedicated-api load-balancer node
Usage: skr apprun-dedicated-api load-balancer node <command>
ロードバランサノードの状態を参照します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
apprun-dedicated-api load-balancer node list --cluster-id=STRING --auto-scaling-group-id=STRING --load-balancer-id=STRING [flags]
ロードバランサのノード一覧を取得します。
apprun-dedicated-api load-balancer node read --cluster-id=STRING --auto-scaling-group-id=STRING --load-balancer-id=STRING --node-id=STRING
ロードバランサノードの詳細を取得します。
skr apprun-dedicated-api load-balancer node list
Usage: skr apprun-dedicated-api load-balancer node list --cluster-id=STRING --auto-scaling-group-id=STRING --load-balancer-id=STRING [flags]
ロードバランサのノード一覧を取得します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--cluster-id=STRING 対象クラスタ ID。
--auto-scaling-group-id=STRING
対象グループ ID。
--load-balancer-id=STRING 対象ロードバランサ ID。
--max-items=100 1ページあたりの最大件数。
skr apprun-dedicated-api load-balancer node read
Usage: skr apprun-dedicated-api load-balancer node read --cluster-id=STRING --auto-scaling-group-id=STRING --load-balancer-id=STRING --node-id=STRING
ロードバランサノードの詳細を取得します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--cluster-id=STRING 対象クラスタ ID。
--auto-scaling-group-id=STRING
対象グループ ID。
--load-balancer-id=STRING 対象ロードバランサ ID。
--node-id=STRING 参照するロードバランサノード ID。
skr apprun-dedicated-api certificate
Usage: skr apprun-dedicated-api certificate <command>
クラスタの証明書を管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
apprun-dedicated-api certificate list --cluster-id=STRING [flags]
クラスタの証明書一覧を取得します。
apprun-dedicated-api certificate create --cluster-id=STRING --request=REQUEST
証明書を作成します。PEM を含む JSON は保護したファイルまたは標準入力から渡してください。
apprun-dedicated-api certificate read --cluster-id=STRING --certificate-id=STRING
証明書の詳細を取得します。
apprun-dedicated-api certificate update --cluster-id=STRING --certificate-id=STRING --request=REQUEST
証明書を更新します。PEM を含む JSON は保護したファイルまたは標準入力から渡してください。
apprun-dedicated-api certificate delete --cluster-id=STRING --certificate-id=STRING
証明書を削除します。
skr apprun-dedicated-api certificate list
Usage: skr apprun-dedicated-api certificate list --cluster-id=STRING [flags]
クラスタの証明書一覧を取得します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--cluster-id=STRING 対象クラスタ ID。
--max-items=100 1ページあたりの最大件数。
--cursor=CURSOR 前ページの nextCursor。
skr apprun-dedicated-api certificate create
Usage: skr apprun-dedicated-api certificate create --cluster-id=STRING --request=REQUEST
証明書を作成します。PEM を含む JSON は保護したファイルまたは標準入力から渡してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--cluster-id=STRING 対象クラスタ ID。
--request=REQUEST certificate.CreateParams
JSON。name、certificatePem、privatekeyPem
を指定します。リクエストは @path.json または - (標準入力) で渡してください。
skr apprun-dedicated-api certificate read
Usage: skr apprun-dedicated-api certificate read --cluster-id=STRING --certificate-id=STRING
証明書の詳細を取得します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--cluster-id=STRING 対象クラスタ ID。
--certificate-id=STRING 参照する証明書 ID。
skr apprun-dedicated-api certificate update
Usage: skr apprun-dedicated-api certificate update --cluster-id=STRING --certificate-id=STRING --request=REQUEST
証明書を更新します。PEM を含む JSON は保護したファイルまたは標準入力から渡してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--cluster-id=STRING 対象クラスタ ID。
--certificate-id=STRING 更新する証明書 ID。
--request=REQUEST certificate.UpdateParams JSON。リクエストは @path.json
または - (標準入力) で渡してください。
skr apprun-dedicated-api certificate delete
Usage: skr apprun-dedicated-api certificate delete --cluster-id=STRING --certificate-id=STRING
証明書を削除します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--cluster-id=STRING 対象クラスタ ID。
--certificate-id=STRING 削除する証明書 ID。
skr apprun-dedicated-api service-class
Usage: skr apprun-dedicated-api service-class <command>
利用可能なワーカ／ロードバランサのサービスクラスを取得します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
apprun-dedicated-api service-class list-lb
ロードバランサのサービスクラス一覧を取得します。
apprun-dedicated-api service-class list-worker
ワーカノードのサービスクラス一覧を取得します。
skr apprun-dedicated-api service-class list-lb
Usage: skr apprun-dedicated-api service-class list-lb
ロードバランサのサービスクラス一覧を取得します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr apprun-dedicated-api service-class list-worker
Usage: skr apprun-dedicated-api service-class list-worker
ワーカノードのサービスクラス一覧を取得します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
apprun-api
skr apprun-api
Usage: skr apprun-api <command> [flags]
AppRun
共用型のアプリケーション、バージョン、トラフィック分散などを操作します。アプリケーションはコンテナイメージからデプロイされ、負荷に応じてスケーリングします。料金は実行リソース、スケール数、時間に応じて発生します。SDK
プロファイル、または SAKURA_ACCESS_TOKEN / SAKURA_ACCESS_TOKEN_SECRET
環境変数で認証します。認証情報を含む作成・更新リクエストは保護したファイルまたは標準入力から読み込みます。結果は JSON で出力します。詳細:
https://manual.sakura.ad.jp/cloud/apprun/about.html
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
apprun-api application list [flags]
アプリケーション一覧を取得します。ページングと並び順はフラグで指定できます。
apprun-api application read <id>
アプリケーションの設定と公開 URL を取得します。
apprun-api application create [flags]
コンテナイメージからアプリケーションを作成します。コンテナイメージの設定にはコンポーネント名、CPU、メモリ、レジストリ設定が必要です。認証情報を含む可能性があるためリクエストは保護したファイルまたは標準入力から読み込みます。例:
skr apprun-api application create --request @application.json
apprun-api application update <id> [flags]
アプリケーションを部分更新します。リソース構成の変更により新しいバージョンが作成されます。認証情報を含む JSON
は保護したファイルまたは標準入力から渡してください。
apprun-api application delete <id>
アプリケーションを削除します。削除前に対象 ID を確認してください。
apprun-api application status <id>
アプリケーションのステータスを取得します。
apprun-api version list --application-id=STRING [flags]
アプリケーションのバージョン一覧を取得します。
apprun-api version read --application-id=STRING --version-id=STRING
アプリケーションのバージョン詳細を取得します。
apprun-api version delete --application-id=STRING --version-id=STRING
アプリケーションのバージョンを削除します。最新バージョン、トラフィックの宛先に指定したバージョン、最後の1件は削除できません。
apprun-api version status --application-id=STRING --version-id=STRING
アプリケーションのバージョンステータスを取得します。
apprun-api packet-filter read <application-id>
アプリケーションのパケットフィルターを取得します。
apprun-api packet-filter update <application-id> [flags]
パケットフィルターの有効状態と IPv4 アドレス設定を更新します。
apprun-api traffic list <application-id>
アプリケーションのトラフィック分散設定を取得します。
apprun-api traffic update <application-id> [flags]
最大4バージョンへのトラフィック分散割合を更新します。最新バージョンを対象にする場合は is_latest_version を指定します。
apprun-api user read
ログイン中の AppRun ユーザー情報を取得します。
apprun-api user create
AppRun にサインアップします。
skr apprun-api application
Usage: skr apprun-api application <command>
AppRun アプリケーションを管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
apprun-api application list [flags]
アプリケーション一覧を取得します。ページングと並び順はフラグで指定できます。
apprun-api application read <id>
アプリケーションの設定と公開 URL を取得します。
apprun-api application create [flags]
コンテナイメージからアプリケーションを作成します。コンテナイメージの設定にはコンポーネント名、CPU、メモリ、レジストリ設定が必要です。認証情報を含む可能性があるためリクエストは保護したファイルまたは標準入力から読み込みます。例:
skr apprun-api application create --request @application.json
apprun-api application update <id> [flags]
アプリケーションを部分更新します。リソース構成の変更により新しいバージョンが作成されます。認証情報を含む JSON
は保護したファイルまたは標準入力から渡してください。
apprun-api application delete <id>
アプリケーションを削除します。削除前に対象 ID を確認してください。
apprun-api application status <id>
アプリケーションのステータスを取得します。
skr apprun-api application list
Usage: skr apprun-api application list [flags]
アプリケーション一覧を取得します。ページングと並び順はフラグで指定できます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST ListApplicationsParams
JSON。フラグと併用できません。直接指定、@path.json、または
-（標準入力）に対応します。
--page-num=PAGE-NUM 取得するページ番号。
--page-size=PAGE-SIZE 1ページあたりの項目数。
--sort-field=SORT-FIELD 並び替えに使うフィールド名。
--sort-order=SORT-ORDER 並び順。asc または desc。
skr apprun-api application read
Usage: skr apprun-api application read <id>
アプリケーションの設定と公開 URL を取得します。
Arguments:
<id> 取得するアプリケーション ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr apprun-api application create
Usage: skr apprun-api application create [flags]
コンテナイメージからアプリケーションを作成します。コンテナイメージの設定にはコンポーネント名、CPU、メモリ、レジストリ設定が必要です。認証情報を含む可能性があるためリクエストは保護したファイルまたは標準入力から読み込みます。例:
skr apprun-api application create --request @application.json
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST CreateApplicationBody
JSON。name、timeout_seconds、port、min_scale、max_scale、components
を指定します。components には
name、max_cpu、max_memory、deploy_source.container_registry.image
が必要です。認証情報を含む場合があるため @path.json または -（標準入力）だけを受け付けます。
skr apprun-api application update
Usage: skr apprun-api application update <id> [flags]
アプリケーションを部分更新します。リソース構成の変更により新しいバージョンが作成されます。認証情報を含む JSON
は保護したファイルまたは標準入力から渡してください。
Arguments:
<id> 更新するアプリケーション ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST PatchApplicationBody JSON。変更する
API フィールドを指定します。components
を指定するときはコンポーネントの設定を含めてください。認証情報を含む場合があるため @path.json
または -（標準入力）だけを受け付けます。
skr apprun-api application delete
Usage: skr apprun-api application delete <id>
アプリケーションを削除します。削除前に対象 ID を確認してください。
Arguments:
<id> 削除するアプリケーション ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr apprun-api application status
Usage: skr apprun-api application status <id>
アプリケーションのステータスを取得します。
Arguments:
<id> ステータスを取得するアプリケーション ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr apprun-api version
Usage: skr apprun-api version <command>
アプリケーションのバージョンを確認・削除します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
apprun-api version list --application-id=STRING [flags]
アプリケーションのバージョン一覧を取得します。
apprun-api version read --application-id=STRING --version-id=STRING
アプリケーションのバージョン詳細を取得します。
apprun-api version delete --application-id=STRING --version-id=STRING
アプリケーションのバージョンを削除します。最新バージョン、トラフィックの宛先に指定したバージョン、最後の1件は削除できません。
apprun-api version status --application-id=STRING --version-id=STRING
アプリケーションのバージョンステータスを取得します。
skr apprun-api version list
Usage: skr apprun-api version list --application-id=STRING [flags]
アプリケーションのバージョン一覧を取得します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--application-id=STRING 対象アプリケーション ID。
--request=REQUEST ListApplicationVersionsParams
JSON。フラグと併用できません。直接指定、@path.json、または
-（標準入力）に対応します。
--page-num=PAGE-NUM 取得するページ番号。
--page-size=PAGE-SIZE 1ページあたりの項目数。
--sort-field=SORT-FIELD 並び替えに使うフィールド名。
--sort-order=SORT-ORDER 並び順。asc または desc。
skr apprun-api version read
Usage: skr apprun-api version read --application-id=STRING --version-id=STRING
アプリケーションのバージョン詳細を取得します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--application-id=STRING 対象アプリケーション ID。
--version-id=STRING 取得するバージョン ID。
skr apprun-api version delete
Usage: skr apprun-api version delete --application-id=STRING --version-id=STRING
アプリケーションのバージョンを削除します。最新バージョン、トラフィックの宛先に指定したバージョン、最後の1件は削除できません。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--application-id=STRING 対象アプリケーション ID。
--version-id=STRING 削除するバージョン ID。
skr apprun-api version status
Usage: skr apprun-api version status --application-id=STRING --version-id=STRING
アプリケーションのバージョンステータスを取得します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--application-id=STRING 対象アプリケーション ID。
--version-id=STRING 対象バージョン ID。
skr apprun-api packet-filter
Usage: skr apprun-api packet-filter <command>
アプリケーションのパケットフィルターを確認・変更します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
apprun-api packet-filter read <application-id>
アプリケーションのパケットフィルターを取得します。
apprun-api packet-filter update <application-id> [flags]
パケットフィルターの有効状態と IPv4 アドレス設定を更新します。
skr apprun-api packet-filter read
Usage: skr apprun-api packet-filter read <application-id>
アプリケーションのパケットフィルターを取得します。
Arguments:
<application-id> 対象アプリケーション ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr apprun-api packet-filter update
Usage: skr apprun-api packet-filter update <application-id> [flags]
パケットフィルターの有効状態と IPv4 アドレス設定を更新します。
Arguments:
<application-id> 対象アプリケーション ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST PatchPacketFilterBody JSON。is_enabled と
settings（from_ip、from_ip_prefix_length）の形式です。直接指定、@path.json、または
-（標準入力）に対応します。
skr apprun-api traffic
Usage: skr apprun-api traffic <command>
アプリケーションのバージョン間でトラフィックを分散します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
apprun-api traffic list <application-id>
アプリケーションのトラフィック分散設定を取得します。
apprun-api traffic update <application-id> [flags]
最大4バージョンへのトラフィック分散割合を更新します。最新バージョンを対象にする場合は is_latest_version を指定します。
skr apprun-api traffic list
Usage: skr apprun-api traffic list <application-id>
アプリケーションのトラフィック分散設定を取得します。
Arguments:
<application-id> 対象アプリケーション ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr apprun-api traffic update
Usage: skr apprun-api traffic update <application-id> [flags]
最大4バージョンへのトラフィック分散割合を更新します。最新バージョンを対象にする場合は is_latest_version を指定します。
Arguments:
<application-id> 対象アプリケーション ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST UpdateTrafficBody JSON 配列。各要素は is_latest_version
と percent、または version_name と percent の組です。percent
はトラフィック分散割合です。最新バージョンに分散する場合は is_latest_version
を指定します。直接指定、@path.json、または -（標準入力）に対応します。
skr apprun-api user
Usage: skr apprun-api user <command>
AppRun のユーザー情報を確認します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
apprun-api user read
ログイン中の AppRun ユーザー情報を取得します。
apprun-api user create
AppRun にサインアップします。
skr apprun-api user read
Usage: skr apprun-api user read
ログイン中の AppRun ユーザー情報を取得します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr apprun-api user create
Usage: skr apprun-api user create
AppRun にサインアップします。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
container-registry-api
skr container-registry-api
Usage: skr container-registry-api <command> [flags]
さくらのクラウドのコンテナレジストリと認証ユーザーを管理します。2026年6月25日以降の新規レジストリは非公開です。SDK
プロファイル、または SAKURA_ACCESS_TOKEN / SAKURA_ACCESS_TOKEN_SECRET
環境変数で認証します。ユーザーのパスワードは保護されたファイルまたは標準入力から読み込みます。結果は JSON で出力します。詳細:
https://manual.sakura.ad.jp/cloud/appliance/container-registry/index.html
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
container-registry-api registry list [flags]
コンテナレジストリを検索します。
container-registry-api registry create [flags]
コンテナレジストリを作成します。
container-registry-api registry read <id>
ID を指定してコンテナレジストリを読み取ります。
container-registry-api registry update --request=STRING <id>
コンテナレジストリの説明、タグ、アイコン、独自ドメインを更新します。
container-registry-api registry delete <id>
ID を指定してコンテナレジストリを削除します。
container-registry-api registry user list <registry-id>
コンテナレジストリのユーザーを一覧表示します。
container-registry-api registry user add --user-name=STRING --password-file=STRING --permission=STRING <registry-id>
認証ユーザーを追加します。パスワードは保護されたファイルまたは標準入力から読み込みます。
container-registry-api registry user update <registry-id> <user-name> [flags]
認証ユーザーのパスワードまたは権限を更新します。
container-registry-api registry user delete <registry-id> <user-name>
認証ユーザーを削除します。
skr container-registry-api registry
Usage: skr container-registry-api registry <command>
コンテナレジストリと、その認証に使うユーザーを管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
container-registry-api registry list [flags]
コンテナレジストリを検索します。
container-registry-api registry create [flags]
コンテナレジストリを作成します。
container-registry-api registry read <id>
ID を指定してコンテナレジストリを読み取ります。
container-registry-api registry update --request=STRING <id>
コンテナレジストリの説明、タグ、アイコン、独自ドメインを更新します。
container-registry-api registry delete <id>
ID を指定してコンテナレジストリを削除します。
container-registry-api registry user list <registry-id>
コンテナレジストリのユーザーを一覧表示します。
container-registry-api registry user add --user-name=STRING --password-file=STRING --permission=STRING <registry-id>
認証ユーザーを追加します。パスワードは保護されたファイルまたは標準入力から読み込みます。
container-registry-api registry user update <registry-id> <user-name> [flags]
認証ユーザーのパスワードまたは権限を更新します。
container-registry-api registry user delete <registry-id> <user-name>
認証ユーザーを削除します。
skr container-registry-api registry list
Usage: skr container-registry-api registry list [flags]
コンテナレジストリを検索します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 任意: 検索条件の JSON を直接または @path.json
で指定します。Names、Tags、Sort、Count、From で検索条件を指定できます。例:
--request='{"Names":["example-registry"]}'
skr container-registry-api registry create
Usage: skr container-registry-api registry create [flags]
コンテナレジストリを作成します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST JSON を直接または @path.json
で指定します。個別フラグとは相互排他です。Name
は必須で、レジストリ接続名にも使われます。Description、Tags、IconID、VirtualDomain
を指定できます。Tags は JSON
専用です。Users、パスワード、廃止された公開設定は指定できません。例:
--request @registry.json
--name=NAME フラグ入力では必須: API の Name
とレジストリ接続名です。小文字英字から始まり英数字で終わる小文字英数字・ハイフンの名前です。他ユーザーと重複できず、作成後は変更できません。例:
--name example-registry
--description=DESCRIPTION 任意: API の Description。最大512文字です。--request
とは相互排他です。
--icon-id=ICON-ID 任意: API の IconID。--request とは相互排他です。
--virtual-domain=VIRTUAL-DOMAIN
任意: API の VirtualDomain。対応する CNAME
を設定してください。--request とは相互排他です。
skr container-registry-api registry read
Usage: skr container-registry-api registry read <id>
ID を指定してコンテナレジストリを読み取ります。
Arguments:
<id> 読み取るコンテナレジストリ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr container-registry-api registry update
Usage: skr container-registry-api registry update --request=STRING <id>
コンテナレジストリの説明、タグ、アイコン、独自ドメインを更新します。
Arguments:
<id> 更新するコンテナレジストリ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=STRING 必須: JSON を直接または @path.json
で指定します。Description、Tags、IconID、VirtualDomain
を指定できます。指定したフィールドだけを更新し、省略したフィールドは変更しません。Name
は作成後に変更できません。独自ドメインを使う場合は対応する CNAME も設定します。例:
--request @registry-update.json
skr container-registry-api registry delete
Usage: skr container-registry-api registry delete <id>
ID を指定してコンテナレジストリを削除します。
Arguments:
<id> 削除するコンテナレジストリ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr container-registry-api registry user
Usage: skr container-registry-api registry user <command>
コンテナレジストリの認証ユーザーを管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
container-registry-api registry user list <registry-id>
コンテナレジストリのユーザーを一覧表示します。
container-registry-api registry user add --user-name=STRING --password-file=STRING --permission=STRING <registry-id>
認証ユーザーを追加します。パスワードは保護されたファイルまたは標準入力から読み込みます。
container-registry-api registry user update <registry-id> <user-name> [flags]
認証ユーザーのパスワードまたは権限を更新します。
container-registry-api registry user delete <registry-id> <user-name>
認証ユーザーを削除します。
skr container-registry-api registry user list
Usage: skr container-registry-api registry user list <registry-id>
コンテナレジストリのユーザーを一覧表示します。
Arguments:
<registry-id> ユーザーを一覧表示するコンテナレジストリ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr container-registry-api registry user add
Usage: skr container-registry-api registry user add --user-name=STRING --password-file=STRING --permission=STRING <registry-id>
認証ユーザーを追加します。パスワードは保護されたファイルまたは標準入力から読み込みます。
Arguments:
<registry-id> ユーザーを追加するコンテナレジストリ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--user-name=STRING 必須: 1〜63文字。英数字と - + . @ _ を指定できます。
--password-file=STRING 必須: 1〜63文字のパスワードが入った保護されたファイル。-
を指定すると標準入力から読み込みます。秘密情報を引数に直接指定しないでください。
--permission=STRING 必須: all、readwrite、readonly のいずれか。
skr container-registry-api registry user update
Usage: skr container-registry-api registry user update <registry-id> <user-name> [flags]
認証ユーザーのパスワードまたは権限を更新します。
Arguments:
<registry-id> ユーザーを更新するコンテナレジストリ ID。
<user-name> 更新するユーザー名。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--password-file=PASSWORD-FILE
任意: 新しい1〜63文字のパスワードが入った保護されたファイル。-
を指定すると標準入力から読み込みます。秘密情報を引数に直接指定しないでください。
--permission=PERMISSION 任意: 変更後の権限 all、readwrite、readonly。
skr container-registry-api registry user delete
Usage: skr container-registry-api registry user delete <registry-id> <user-name>
認証ユーザーを削除します。
Arguments:
<registry-id> ユーザーを削除するコンテナレジストリ ID。
<user-name> 削除するユーザー名。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
object-storage-api
skr object-storage-api
Usage: skr object-storage-api <command> [flags]
さくらのオブジェクトストレージ管理 API でサイト、バケット、サイトアカウント、パーミッションを操作します。S3
互換 API のオブジェクト本体の転送ではなく、管理操作を行います。認証には SDK のプロファイル、または
SAKURA_ACCESS_TOKEN / SAKURA_ACCESS_TOKEN_SECRET
環境変数を使用します。バケット作成は課金対象です。アクセスキーのシークレットは発行時の応答にのみ含まれます。結果は JSON で出力します。詳細:
https://manual.sakura.ad.jp/cloud/objectstorage/api.html
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
object-storage-api site list
利用可能なサイトを一覧表示します。
object-storage-api site read <site-id>
サイトの情報を取得します。
object-storage-api site plans <site-id>
サイトで選択できるバケットプランを一覧表示します。
object-storage-api site status read <site-id>
サイトの状態を取得します。
object-storage-api site status quota <site-id>
サイトのクォータを取得します。
object-storage-api site status bucket-metering --from=STRING --to=STRING <site-id> <bucket-name>
期間を指定してバケットの利用量を取得します。
object-storage-api account create <site-id>
サイトアカウントを作成します。
object-storage-api account read <site-id>
サイトアカウントを取得します。
object-storage-api account delete <site-id>
サイトアカウントを削除します。
object-storage-api account access-key list <site-id>
サイトアカウントのアクセスキーを一覧表示します。
object-storage-api account access-key create <site-id>
アクセスキーを発行します。シークレットは作成時の応答にのみ含まれます。
object-storage-api account access-key read <site-id> <key-id>
アクセスキーの情報を取得します。
object-storage-api account access-key delete <site-id> <key-id>
アクセスキーを削除します。
object-storage-api bucket list <site-id>
サイト内のバケットを一覧表示します。
object-storage-api bucket create <site-id> <bucket-name> [flags]
バケットを作成します。現在利用できるサイトは isk01、tky01、arc02 です。arc02 では --plan
を指定します。作成完了後からバケットの基本料金が発生します。
object-storage-api bucket delete <site-id> <bucket-name>
指定サイトに所属するバケットを削除します。所属を確認できない場合は拒否します。バケット内のオブジェクトを事前に削除してください。
object-storage-api bucket encryption read <site-id> <bucket-name>
暗号化設定を取得します。
object-storage-api bucket encryption enable --kms-key-id=STRING <site-id> <bucket-name>
KMS キーを指定して暗号化を有効にします。
object-storage-api bucket encryption disable <site-id> <bucket-name>
バケット暗号化を無効にします。
object-storage-api bucket replication read <site-id> <bucket-name>
レプリケーション設定を取得します。
object-storage-api bucket replication enable --target-bucket=STRING <site-id> <bucket-name>
別サイトのバケットを宛先にしてレプリケーションを有効にします。
object-storage-api bucket replication disable <site-id> <bucket-name>
レプリケーションを無効にします。
object-storage-api bucket penalty <site-id> <bucket-name>
バケットのペナルティ情報を取得します。
object-storage-api bucket usage <site-id> <bucket-name>
バケットの利用量を取得します。
object-storage-api bucket quota <site-id> <bucket-name>
バケットのクォータを取得します。
object-storage-api permission list <site-id>
サイトのパーミッションを一覧表示します。
object-storage-api permission create --request=STRING <site-id>
バケット制御を指定してパーミッションを作成します。
object-storage-api permission read <site-id> <permission-id>
パーミッションを取得します。
object-storage-api permission update --request=STRING <site-id> <permission-id>
パーミッション名とバケット制御を更新します。
object-storage-api permission delete <site-id> <permission-id>
パーミッションを削除します。
object-storage-api permission access-key list <site-id> <permission-id>
アクセスキーを一覧表示します。
object-storage-api permission access-key create <site-id> <permission-id>
アクセスキーを発行します。シークレットは作成時の応答にのみ含まれます。
object-storage-api permission access-key read <site-id> <permission-id> <key-id>
アクセスキーの情報を取得します。
object-storage-api permission access-key delete <site-id> <permission-id> <key-id>
アクセスキーを削除します。
skr object-storage-api site
Usage: skr object-storage-api site <command>
オブジェクトストレージのサイト、プラン、状態を確認します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
object-storage-api site list
利用可能なサイトを一覧表示します。
object-storage-api site read <site-id>
サイトの情報を取得します。
object-storage-api site plans <site-id>
サイトで選択できるバケットプランを一覧表示します。
object-storage-api site status read <site-id>
サイトの状態を取得します。
object-storage-api site status quota <site-id>
サイトのクォータを取得します。
object-storage-api site status bucket-metering --from=STRING --to=STRING <site-id> <bucket-name>
期間を指定してバケットの利用量を取得します。
skr object-storage-api site list
Usage: skr object-storage-api site list
利用可能なサイトを一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api site read
Usage: skr object-storage-api site read <site-id>
サイトの情報を取得します。
Arguments:
<site-id> 情報を取得するサイト ID。サイト ID は site list の結果から確認します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api site plans
Usage: skr object-storage-api site plans <site-id>
サイトで選択できるバケットプランを一覧表示します。
Arguments:
<site-id> プランを確認するサイト ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api site status
Usage: skr object-storage-api site status <command>
サイトの状態、クォータ、バケット利用量を確認します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
object-storage-api site status read <site-id>
サイトの状態を取得します。
object-storage-api site status quota <site-id>
サイトのクォータを取得します。
object-storage-api site status bucket-metering --from=STRING --to=STRING <site-id> <bucket-name>
期間を指定してバケットの利用量を取得します。
skr object-storage-api site status read
Usage: skr object-storage-api site status read <site-id>
サイトの状態を取得します。
Arguments:
<site-id> 状態を取得するサイト ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api site status quota
Usage: skr object-storage-api site status quota <site-id>
サイトのクォータを取得します。
Arguments:
<site-id> クォータを取得するサイト ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api site status bucket-metering
Usage: skr object-storage-api site status bucket-metering --from=STRING --to=STRING <site-id> <bucket-name>
期間を指定してバケットの利用量を取得します。
Arguments:
<site-id> 利用量を確認するサイト ID。
<bucket-name> 利用量を確認するバケット名。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--from=STRING 必須: RFC3339 形式の開始時刻。
--to=STRING 必須: RFC3339 形式の終了時刻。
skr object-storage-api account
Usage: skr object-storage-api account <command>
サイトアカウントとアカウントアクセスキーを管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
object-storage-api account create <site-id>
サイトアカウントを作成します。
object-storage-api account read <site-id>
サイトアカウントを取得します。
object-storage-api account delete <site-id>
サイトアカウントを削除します。
object-storage-api account access-key list <site-id>
サイトアカウントのアクセスキーを一覧表示します。
object-storage-api account access-key create <site-id>
アクセスキーを発行します。シークレットは作成時の応答にのみ含まれます。
object-storage-api account access-key read <site-id> <key-id>
アクセスキーの情報を取得します。
object-storage-api account access-key delete <site-id> <key-id>
アクセスキーを削除します。
skr object-storage-api account create
Usage: skr object-storage-api account create <site-id>
サイトアカウントを作成します。
Arguments:
<site-id> サイトアカウントを作成するサイト ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api account read
Usage: skr object-storage-api account read <site-id>
サイトアカウントを取得します。
Arguments:
<site-id> サイトアカウントを取得するサイト ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api account delete
Usage: skr object-storage-api account delete <site-id>
サイトアカウントを削除します。
Arguments:
<site-id> サイトアカウントを削除するサイト ID。サイト内のバケットなどを先に削除してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api account access-key
Usage: skr object-storage-api account access-key <command>
サイトアカウントのアクセスキーを管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
object-storage-api account access-key list <site-id>
サイトアカウントのアクセスキーを一覧表示します。
object-storage-api account access-key create <site-id>
アクセスキーを発行します。シークレットは作成時の応答にのみ含まれます。
object-storage-api account access-key read <site-id> <key-id>
アクセスキーの情報を取得します。
object-storage-api account access-key delete <site-id> <key-id>
アクセスキーを削除します。
skr object-storage-api account access-key list
Usage: skr object-storage-api account access-key list <site-id>
サイトアカウントのアクセスキーを一覧表示します。
Arguments:
<site-id> アクセスキーを一覧表示するサイト ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api account access-key create
Usage: skr object-storage-api account access-key create <site-id>
アクセスキーを発行します。シークレットは作成時の応答にのみ含まれます。
Arguments:
<site-id> アクセスキーを発行するサイト ID。シークレットは作成時に一度だけ返されます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api account access-key read
Usage: skr object-storage-api account access-key read <site-id> <key-id>
アクセスキーの情報を取得します。
Arguments:
<site-id> アクセスキーが属するサイト ID。
<key-id> 情報を取得するアクセスキー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api account access-key delete
Usage: skr object-storage-api account access-key delete <site-id> <key-id>
アクセスキーを削除します。
Arguments:
<site-id> アクセスキーが属するサイト ID。
<key-id> 削除するアクセスキー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api bucket
Usage: skr object-storage-api bucket <command>
バケットを作成・一覧・削除し、暗号化やレプリケーションを管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
object-storage-api bucket list <site-id>
サイト内のバケットを一覧表示します。
object-storage-api bucket create <site-id> <bucket-name> [flags]
バケットを作成します。現在利用できるサイトは isk01、tky01、arc02 です。arc02 では --plan
を指定します。作成完了後からバケットの基本料金が発生します。
object-storage-api bucket delete <site-id> <bucket-name>
指定サイトに所属するバケットを削除します。所属を確認できない場合は拒否します。バケット内のオブジェクトを事前に削除してください。
object-storage-api bucket encryption read <site-id> <bucket-name>
暗号化設定を取得します。
object-storage-api bucket encryption enable --kms-key-id=STRING <site-id> <bucket-name>
KMS キーを指定して暗号化を有効にします。
object-storage-api bucket encryption disable <site-id> <bucket-name>
バケット暗号化を無効にします。
object-storage-api bucket replication read <site-id> <bucket-name>
レプリケーション設定を取得します。
object-storage-api bucket replication enable --target-bucket=STRING <site-id> <bucket-name>
別サイトのバケットを宛先にしてレプリケーションを有効にします。
object-storage-api bucket replication disable <site-id> <bucket-name>
レプリケーションを無効にします。
object-storage-api bucket penalty <site-id> <bucket-name>
バケットのペナルティ情報を取得します。
object-storage-api bucket usage <site-id> <bucket-name>
バケットの利用量を取得します。
object-storage-api bucket quota <site-id> <bucket-name>
バケットのクォータを取得します。
skr object-storage-api bucket list
Usage: skr object-storage-api bucket list <site-id>
サイト内のバケットを一覧表示します。
Arguments:
<site-id> 一覧を取得するサイト ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api bucket create
Usage: skr object-storage-api bucket create <site-id> <bucket-name> [flags]
バケットを作成します。現在利用できるサイトは isk01、tky01、arc02 です。arc02 では --plan
を指定します。作成完了後からバケットの基本料金が発生します。
Arguments:
<site-id> バケットを作成するサイト ID。
<bucket-name> 作成する一意のバケット名。半角小文字英字・数字・ハイフンを使用できます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--plan=PLAN アーカイブプラン用サイト arc02 で必須です。site plans の service_class_path
の末尾にあるプラン値を指定します。
skr object-storage-api bucket delete
Usage: skr object-storage-api bucket delete <site-id> <bucket-name>
指定サイトに所属するバケットを削除します。所属を確認できない場合は拒否します。バケット内のオブジェクトを事前に削除してください。
Arguments:
<site-id> バケットが属するサイト ID。
<bucket-name> 削除するバケット名。バケット内のオブジェクトを先に削除してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api bucket encryption
Usage: skr object-storage-api bucket encryption <command>
バケット暗号化を管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
object-storage-api bucket encryption read <site-id> <bucket-name>
暗号化設定を取得します。
object-storage-api bucket encryption enable --kms-key-id=STRING <site-id> <bucket-name>
KMS キーを指定して暗号化を有効にします。
object-storage-api bucket encryption disable <site-id> <bucket-name>
バケット暗号化を無効にします。
skr object-storage-api bucket encryption read
Usage: skr object-storage-api bucket encryption read <site-id> <bucket-name>
暗号化設定を取得します。
Arguments:
<site-id> バケットが属するサイト ID。
<bucket-name> 設定を取得するバケット名。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api bucket encryption enable
Usage: skr object-storage-api bucket encryption enable --kms-key-id=STRING <site-id> <bucket-name>
KMS キーを指定して暗号化を有効にします。
Arguments:
<site-id> バケットが属するサイト ID。
<bucket-name> 暗号化するバケット名。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--kms-key-id=STRING 必須: 暗号化に使用する KMS キー ID。
skr object-storage-api bucket encryption disable
Usage: skr object-storage-api bucket encryption disable <site-id> <bucket-name>
バケット暗号化を無効にします。
Arguments:
<site-id> バケットが属するサイト ID。
<bucket-name> 暗号化を無効にするバケット名。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api bucket replication
Usage: skr object-storage-api bucket replication <command>
バケットのリージョン間レプリケーションを管理します。送信元バケットの指定サイトへの所属を確認できない場合は拒否します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
object-storage-api bucket replication read <site-id> <bucket-name>
レプリケーション設定を取得します。
object-storage-api bucket replication enable --target-bucket=STRING <site-id> <bucket-name>
別サイトのバケットを宛先にしてレプリケーションを有効にします。
object-storage-api bucket replication disable <site-id> <bucket-name>
レプリケーションを無効にします。
skr object-storage-api bucket replication read
Usage: skr object-storage-api bucket replication read <site-id> <bucket-name>
レプリケーション設定を取得します。
Arguments:
<site-id> バケットが属するサイト ID。
<bucket-name> 設定を取得するバケット名。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api bucket replication enable
Usage: skr object-storage-api bucket replication enable --target-bucket=STRING <site-id> <bucket-name>
別サイトのバケットを宛先にしてレプリケーションを有効にします。
Arguments:
<site-id> レプリケーション元バケットのサイト ID。
<bucket-name> レプリケーション元バケット名。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--target-bucket=STRING 必須: レプリケーション先バケット名。
skr object-storage-api bucket replication disable
Usage: skr object-storage-api bucket replication disable <site-id> <bucket-name>
レプリケーションを無効にします。
Arguments:
<site-id> バケットが属するサイト ID。
<bucket-name> レプリケーションを無効にするバケット名。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api bucket penalty
Usage: skr object-storage-api bucket penalty <site-id> <bucket-name>
バケットのペナルティ情報を取得します。
Arguments:
<site-id> バケットが属するサイト ID。
<bucket-name> ペナルティ情報を取得するバケット名。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api bucket usage
Usage: skr object-storage-api bucket usage <site-id> <bucket-name>
バケットの利用量を取得します。
Arguments:
<site-id> バケットが属するサイト ID。
<bucket-name> 利用量を取得するバケット名。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api bucket quota
Usage: skr object-storage-api bucket quota <site-id> <bucket-name>
バケットのクォータを取得します。
Arguments:
<site-id> バケットが属するサイト ID。
<bucket-name> クォータを取得するバケット名。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api permission
Usage: skr object-storage-api permission <command>
バケットごとのアクセス権限とアクセスキーを管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
object-storage-api permission list <site-id>
サイトのパーミッションを一覧表示します。
object-storage-api permission create --request=STRING <site-id>
バケット制御を指定してパーミッションを作成します。
object-storage-api permission read <site-id> <permission-id>
パーミッションを取得します。
object-storage-api permission update --request=STRING <site-id> <permission-id>
パーミッション名とバケット制御を更新します。
object-storage-api permission delete <site-id> <permission-id>
パーミッションを削除します。
object-storage-api permission access-key list <site-id> <permission-id>
アクセスキーを一覧表示します。
object-storage-api permission access-key create <site-id> <permission-id>
アクセスキーを発行します。シークレットは作成時の応答にのみ含まれます。
object-storage-api permission access-key read <site-id> <permission-id> <key-id>
アクセスキーの情報を取得します。
object-storage-api permission access-key delete <site-id> <permission-id> <key-id>
アクセスキーを削除します。
skr object-storage-api permission list
Usage: skr object-storage-api permission list <site-id>
サイトのパーミッションを一覧表示します。
Arguments:
<site-id> 一覧を取得するサイト ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api permission create
Usage: skr object-storage-api permission create --request=STRING <site-id>
バケット制御を指定してパーミッションを作成します。
Arguments:
<site-id> パーミッションを作成するサイト ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=STRING 必須: PermissionBucketControlsBody JSON を直接または
@path.json で指定します。display_name と bucket_controls
を指定してください。例: --request @permission.json
skr object-storage-api permission read
Usage: skr object-storage-api permission read <site-id> <permission-id>
パーミッションを取得します。
Arguments:
<site-id> パーミッションが属するサイト ID。
<permission-id> 参照するパーミッション ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api permission update
Usage: skr object-storage-api permission update --request=STRING <site-id> <permission-id>
パーミッション名とバケット制御を更新します。
Arguments:
<site-id> パーミッションが属するサイト ID。
<permission-id> 更新するパーミッション ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=STRING 必須: PermissionBucketControlsBody JSON を直接または
@path.json で指定します。display_name と bucket_controls
を指定してください。省略したバケット制御を維持するかは指定した全項目で確認してください。例:
--request @permission-update.json
skr object-storage-api permission delete
Usage: skr object-storage-api permission delete <site-id> <permission-id>
パーミッションを削除します。
Arguments:
<site-id> パーミッションが属するサイト ID。
<permission-id> 削除するパーミッション ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api permission access-key
Usage: skr object-storage-api permission access-key <command>
パーミッションのアクセスキーを管理します。シークレットは作成時の応答にのみ含まれます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
object-storage-api permission access-key list <site-id> <permission-id>
アクセスキーを一覧表示します。
object-storage-api permission access-key create <site-id> <permission-id>
アクセスキーを発行します。シークレットは作成時の応答にのみ含まれます。
object-storage-api permission access-key read <site-id> <permission-id> <key-id>
アクセスキーの情報を取得します。
object-storage-api permission access-key delete <site-id> <permission-id> <key-id>
アクセスキーを削除します。
skr object-storage-api permission access-key list
Usage: skr object-storage-api permission access-key list <site-id> <permission-id>
アクセスキーを一覧表示します。
Arguments:
<site-id> パーミッションが属するサイト ID。
<permission-id> アクセスキーを一覧表示するパーミッション ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api permission access-key create
Usage: skr object-storage-api permission access-key create <site-id> <permission-id>
アクセスキーを発行します。シークレットは作成時の応答にのみ含まれます。
Arguments:
<site-id> パーミッションが属するサイト ID。
<permission-id> アクセスキーを発行するパーミッション ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api permission access-key read
Usage: skr object-storage-api permission access-key read <site-id> <permission-id> <key-id>
アクセスキーの情報を取得します。
Arguments:
<site-id> パーミッションが属するサイト ID。
<permission-id> アクセスキーが属するパーミッション ID。
<key-id> 情報を取得するアクセスキー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr object-storage-api permission access-key delete
Usage: skr object-storage-api permission access-key delete <site-id> <permission-id> <key-id>
アクセスキーを削除します。
Arguments:
<site-id> パーミッションが属するサイト ID。
<permission-id> アクセスキーが属するパーミッション ID。
<key-id> 削除するアクセスキー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
iam-api
skr iam-api
Usage: skr iam-api <command> [flags]
さくらのクラウド IAM のユーザー、グループ、組織、プロジェクト、フォルダ、ポリシーなどを操作します。SDK
プロファイル、または SAKURA_ACCESS_TOKEN / SAKURA_ACCESS_TOKEN_SECRET
環境変数で認証します。各機能を利用するには、対象機能の権限を付与したサービスプリンシパルが必要です。詳細:
https://manual.sakura.ad.jp/cloud/controlpanel/iam-policy.html
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iam-api user list [flags]
IAM ユーザーを一覧表示します。--page、--per-page、--ordering で取得範囲と並び順を指定できます。
iam-api user create [flags]
IAM ユーザーを作成します。パスワードは --password-file でファイルまたは標準入力から指定します。
iam-api user read <id>
ID を指定して IAM ユーザーを読み取ります。
iam-api user update <id> [flags]
IAM ユーザーの名前、説明、パスワードを更新します。名前と説明は必須です。パスワードは --password-file を指定した場合のみ変更します。
iam-api user delete <id>
ID を指定して IAM ユーザーを削除します。
iam-api user register-email --email=STRING <user-id>
ユーザーのメールアドレスを登録します。作成時の --email は SSO の外部 IdP ログインで使うメールアドレスで、この操作とは別の項目です。
iam-api user unregister-email <user-id>
ユーザーのメールアドレスの登録を解除します。
iam-api group list [flags]
IAM グループを一覧表示します。--user-id で指定したユーザーが所属するグループに絞り込めます。
iam-api group create --name=STRING --description=STRING
IAM グループを作成します。作成後、update-memberships でユーザーを所属させてください。
iam-api group read <id>
ID を指定して IAM グループを読み取ります。
iam-api group update --name=STRING --description=STRING <id>
IAM グループの名前と説明を更新します。どちらも必須で、指定しない項目は空で上書きされます。
iam-api group delete <id>
ID を指定して IAM グループを削除します。
iam-api group read-memberships <group-id>
グループに所属するユーザーを一覧表示します。
iam-api group update-memberships <group-id> [flags]
グループの所属ユーザーを置き換えます。現在の所属は保持されず、指定した配列で上書きされます。read-memberships
で現在の所属を確認できます。
iam-api policy read-organization
組織の IAM ポリシーバインディング（ロールとプリンシパルの割り当て）を一覧表示します。
iam-api policy update-organization [flags]
組織の IAM ポリシーバインディングを置き換えます。現在の割り当て全体を --request に JSON
配列で指定します。read-organization の出力を基に編集してください。
iam-api policy read-project <project-id>
指定したプロジェクトの IAM ポリシーバインディング（ロールとプリンシパルの割り当て）を一覧表示します。
iam-api policy update-project <project-id> [flags]
指定したプロジェクトの IAM ポリシーバインディングを置き換えます。現在の割り当て全体を --request に JSON
配列で指定します。read-project の出力を基に編集してください。
iam-api policy read-folder <folder-id>
指定したフォルダの IAM ポリシーバインディング（ロールとプリンシパルの割り当て）を一覧表示します。
iam-api policy update-folder <folder-id> [flags]
指定したフォルダの IAM ポリシーバインディングを置き換えます。現在の割り当て全体を --request に JSON
配列で指定します。read-folder の出力を基に編集してください。
iam-api auth read-password-policy
組織のパスワードポリシーを参照します。
iam-api auth update-password-policy [flags]
組織のパスワードポリシーを更新します。--request ではすべての項目を含む JSON
を指定します。フラグを使う場合も4項目すべてを指定してください。
iam-api auth read-auth-conditions
組織の認証条件を参照します。
iam-api auth update-auth-conditions [flags]
組織の認証条件を更新します。現在の設定を read-auth-conditions で確認し、すべての項目を含む JSON を指定してください。
iam-api auth read-auth-context
現在の認証情報に対応する IAM 認証コンテキストを参照します。
iam-api folder list [flags]
IAM フォルダを一覧表示します。ページングや絞り込みには --request または対応する個別フラグを指定します。
iam-api folder create [flags]
IAM フォルダを作成します。親フォルダを指定する場合は --parent-id を指定してください。
iam-api folder read <id>
ID を指定して IAM フォルダを読み取ります。
iam-api folder update --name=STRING <id> [flags]
IAM フォルダの名前と説明を更新します。説明を変更しない場合は --description を省略します。
iam-api folder move --ids=IDS,... --parent-id=PARENT-ID
指定したフォルダを親フォルダへ移動します。移動先が有効な階層になることを確認してください。
iam-api folder delete <id>
ID を指定して IAM フォルダを削除します。
iam-api iam-role list [flags]
利用可能な IAM ロールを一覧表示します。
iam-api iam-role read <id>
ID を指定して IAM ロールを読み取ります。
iam-api id-policy read-organization
組織の ID ポリシーを参照します。
iam-api id-policy update-organization [flags]
組織の ID ポリシー全体を置き換えます。変更前に read-organization で現在の設定を保存してください。
iam-api id-role list [flags]
利用可能な ID ロールを一覧表示します。
iam-api id-role read <id>
ID を指定して ID ロールを読み取ります。
iam-api organization read
IAM 組織の情報を参照します。
iam-api organization update --name=STRING
IAM 組織名を更新します。
iam-api organization read-service-policy [flags]
組織のサービス利用ポリシーを参照します。
iam-api organization update-service-policy [flags]
組織のサービス利用ポリシー全体を更新します。設定はサービス操作に影響するため、変更前に read-service-policy
で現在の設定を確認してください。
iam-api project list [flags]
IAM プロジェクトを一覧表示します。
iam-api project create [flags]
IAM プロジェクトを作成します。既存のフォルダ内に作成する場合は --parent-folder-id を指定してください。
iam-api project read <id>
ID を指定して IAM プロジェクトを読み取ります。
iam-api project update --name=STRING --description=STRING <id>
IAM プロジェクトの名前と説明を更新します。両方の値を指定してください。
iam-api project move --ids=IDS,... --parent-folder-id=PARENT-FOLDER-ID
指定したプロジェクトをフォルダへ移動します。
iam-api project delete <id>
ID を指定して IAM プロジェクトを削除します。
iam-api project-api-key list [flags]
プロジェクト API キーを一覧表示します。
iam-api project-api-key create [flags]
プロジェクト API キーを作成します。レスポンスにアクセストークンとシークレットが含まれるため、出力を安全に保管してください。
iam-api project-api-key read <id>
ID を指定してプロジェクト API キーを読み取ります。
iam-api project-api-key update <id> [flags]
プロジェクト API キーを更新します。現在の設定を read で確認し、変更後の設定を JSON で指定してください。
iam-api project-api-key delete <id>
ID を指定してプロジェクト API キーを削除します。
iam-api scim list [flags]
ユーザープロビジョニング設定を一覧表示します。
iam-api scim create [flags]
ユーザープロビジョニング設定を作成します。
iam-api scim read <id>
ID を指定してユーザープロビジョニング設定を読み取ります。
iam-api scim update <id> [flags]
ユーザープロビジョニング設定を更新します。更新後の設定名を --name または --request JSON の name に指定してください。
iam-api scim delete <id>
ID を指定してユーザープロビジョニング設定を削除します。プロビジョニングされたユーザーとグループをすべて削除してから実行してください。
iam-api scim regenerate-token <id>
ユーザープロビジョニング設定の秘密トークンを再発行します。再発行後は古いトークンが使えなくなるため、連携先を更新できる場合にのみ実行してください。
iam-api service-policy enable
サービス利用ポリシーを有効化します。サービス操作の制限に影響するため、実行前に設定内容を確認してください。
iam-api service-policy disable
サービス利用ポリシーを無効化します。サービス操作の制限に影響するため、実行前に設定内容を確認してください。
iam-api service-policy is-enabled
サービス利用ポリシーが有効かどうかを確認します。
iam-api service-policy list-rule-templates [flags]
サービス利用ポリシーのルールテンプレートを一覧表示します。
iam-api service-principal list [flags]
サービスプリンシパルを一覧表示します。
iam-api service-principal create [flags]
サービスプリンシパルを作成します。
iam-api service-principal read <id>
ID を指定してサービスプリンシパルを読み取ります。
iam-api service-principal update <id> [flags]
サービスプリンシパルの名前と説明を更新します。名前と説明は必須です。
iam-api service-principal delete <id>
ID を指定してサービスプリンシパルを削除します。
iam-api service-principal list-keys <id> [flags]
サービスプリンシパルに登録されたキーを一覧表示します。
iam-api service-principal upload-key --public-key-file=STRING <id>
サービスプリンシパルに PEM 形式の RSA 公開鍵（2048～4096 ビット）を登録します。公開鍵は --public-key-file
で読み込みます。
iam-api service-principal enable-key <id> <key-id>
指定したサービスプリンシパルキーを有効化します。
iam-api service-principal disable-key <id> <key-id>
指定したサービスプリンシパルキーを無効化します。
iam-api service-principal delete-key <id> <key-id>
指定したサービスプリンシパルキーを削除します。
iam-api service-principal issue-token --assertion-file=STRING
登録済み公開鍵に対応する秘密鍵で署名した JWT アサーションからアクセストークンを発行します。アサーションは --assertion-file
で読み込み、発行されたトークンは秘密情報として扱います。
iam-api sso list [flags]
SSO プロファイルを一覧表示します。
iam-api sso create [flags]
SSO プロファイルを作成します。IdP の証明書など複数項目を JSON で指定してください。
iam-api sso read <id>
ID を指定して SSO プロファイルを読み取ります。
iam-api sso update <id> [flags]
SSO プロファイルを更新します。必要な IdP 設定一式を JSON で指定してください。
iam-api sso delete <id>
ID を指定して SSO プロファイルを削除します。
iam-api sso link <id>
SSO プロファイルを組織で有効にします。有効なプロファイルは一つで、ユーザーのログイン方法に影響するため、IdP
設定と対象ユーザーのメールアドレスを確認してください。
iam-api sso unlink <id>
SSO プロファイルと組織のリンクを解除します。ユーザーのログイン方法に影響するため、実行前に対象プロファイルを確認してください。
iam-api user-2fa deactivate-otp --user-id=INT
指定したユーザーの OTP を無効化します。ログイン方法に影響するため、--user-id で対象を確認してください。
iam-api user-2fa list-trusted-devices --user-id=INT
指定したユーザーの信頼済みデバイスを一覧表示します。
iam-api user-2fa delete-trusted-device --user-id=INT <trusted-device-id>
指定したユーザーの信頼済みデバイスを削除します。
iam-api user-2fa clear-trusted-devices --user-id=INT
指定したユーザーの信頼済みデバイスをすべて削除します。--user-id で対象を確認してください。
iam-api user-2fa list-security-keys --user-id=INT
指定したユーザーのセキュリティキーを一覧表示します。
iam-api user-2fa read-security-key --user-id=INT <security-key-id>
ID を指定してセキュリティキーを読み取ります。
iam-api user-2fa delete-security-key --user-id=INT <security-key-id>
指定したユーザーのセキュリティキーを削除します。
skr iam-api user
Usage: skr iam-api user <command>
IAM ユーザーを作成・管理します。ユーザー ID は list で確認できます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iam-api user list [flags]
IAM ユーザーを一覧表示します。--page、--per-page、--ordering で取得範囲と並び順を指定できます。
iam-api user create [flags]
IAM ユーザーを作成します。パスワードは --password-file でファイルまたは標準入力から指定します。
iam-api user read <id>
ID を指定して IAM ユーザーを読み取ります。
iam-api user update <id> [flags]
IAM ユーザーの名前、説明、パスワードを更新します。名前と説明は必須です。パスワードは --password-file を指定した場合のみ変更します。
iam-api user delete <id>
ID を指定して IAM ユーザーを削除します。
iam-api user register-email --email=STRING <user-id>
ユーザーのメールアドレスを登録します。作成時の --email は SSO の外部 IdP ログインで使うメールアドレスで、この操作とは別の項目です。
iam-api user unregister-email <user-id>
ユーザーのメールアドレスの登録を解除します。
skr iam-api user list
Usage: skr iam-api user list [flags]
IAM ユーザーを一覧表示します。--page、--per-page、--ordering で取得範囲と並び順を指定できます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--page=PAGE 任意: 取得するページ番号（1 開始）。
--per-page=PER-PAGE 任意: 1 ページあたりの取得件数。
--ordering=ORDERING 任意: 並び順。code または -code を指定します。
skr iam-api user create
Usage: skr iam-api user create [flags]
IAM ユーザーを作成します。パスワードは --password-file でファイルまたは標準入力から指定します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--name=NAME 必須: ユーザー名。
--code=CODE 必須: ユーザーコード。
--description=DESCRIPTION 必須: ユーザーの説明。空文字列も指定できます。
--email=EMAIL 任意: SSO プロファイル有効時に外部 IdP
のログインで利用するメールアドレス。ユーザーの通知用メールアドレスは
register-email で登録します。
--password-file=STRING 必須: パスワードを記載したファイル。-
の場合は標準入力から読み込みます。パスワードは英数字と ASCII
記号のみで、英字と数字を必ず含めます。組織のパスワードポリシーに従います。
skr iam-api user read
Usage: skr iam-api user read <id>
ID を指定して IAM ユーザーを読み取ります。
Arguments:
<id> list の出力にあるユーザー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api user update
Usage: skr iam-api user update <id> [flags]
IAM ユーザーの名前、説明、パスワードを更新します。名前と説明は必須です。パスワードは --password-file を指定した場合のみ変更します。
Arguments:
<id> 更新するユーザー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--name=NAME 必須: ユーザー名。
--description=DESCRIPTION 必須: ユーザーの説明。空文字列も指定できます。
--password-file=PASSWORD-FILE
任意: 変更後のパスワードを記載したファイル。-
の場合は標準入力から読み込みます。未指定のときはパスワードを変更しません。
skr iam-api user delete
Usage: skr iam-api user delete <id>
ID を指定して IAM ユーザーを削除します。
Arguments:
<id> 削除するユーザー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api user register-email
Usage: skr iam-api user register-email --email=STRING <user-id>
ユーザーのメールアドレスを登録します。作成時の --email は SSO の外部 IdP ログインで使うメールアドレスで、この操作とは別の項目です。
Arguments:
<user-id> メールアドレスを登録するユーザー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--email=STRING 必須: 登録するメールアドレス。例: user@example.com
skr iam-api user unregister-email
Usage: skr iam-api user unregister-email <user-id>
ユーザーのメールアドレスの登録を解除します。
Arguments:
<user-id> メールアドレスの登録を解除するユーザー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api group
Usage: skr iam-api group <command>
IAM グループを作成・管理します。グループへの所属は update-memberships で行います。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iam-api group list [flags]
IAM グループを一覧表示します。--user-id で指定したユーザーが所属するグループに絞り込めます。
iam-api group create --name=STRING --description=STRING
IAM グループを作成します。作成後、update-memberships でユーザーを所属させてください。
iam-api group read <id>
ID を指定して IAM グループを読み取ります。
iam-api group update --name=STRING --description=STRING <id>
IAM グループの名前と説明を更新します。どちらも必須で、指定しない項目は空で上書きされます。
iam-api group delete <id>
ID を指定して IAM グループを削除します。
iam-api group read-memberships <group-id>
グループに所属するユーザーを一覧表示します。
iam-api group update-memberships <group-id> [flags]
グループの所属ユーザーを置き換えます。現在の所属は保持されず、指定した配列で上書きされます。read-memberships
で現在の所属を確認できます。
skr iam-api group list
Usage: skr iam-api group list [flags]
IAM グループを一覧表示します。--user-id で指定したユーザーが所属するグループに絞り込めます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--page=PAGE 任意: 取得するページ番号（1 開始）。
--per-page=PER-PAGE 任意: 1 ページあたりの取得件数。
--ordering=ORDERING 任意: 並び順。name または -name を指定します。
--user-id=USER-ID 任意: 指定したユーザーが所属するグループに絞り込みます。
skr iam-api group create
Usage: skr iam-api group create --name=STRING --description=STRING
IAM グループを作成します。作成後、update-memberships でユーザーを所属させてください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--name=STRING 必須: グループ名。
--description=STRING 必須: グループの説明。空文字列も指定できます。
skr iam-api group read
Usage: skr iam-api group read <id>
ID を指定して IAM グループを読み取ります。
Arguments:
<id> list の出力にあるグループ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api group update
Usage: skr iam-api group update --name=STRING --description=STRING <id>
IAM グループの名前と説明を更新します。どちらも必須で、指定しない項目は空で上書きされます。
Arguments:
<id> 更新するグループ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--name=STRING 必須: グループ名。
--description=STRING 必須: グループの説明。空文字列も指定できます。
skr iam-api group delete
Usage: skr iam-api group delete <id>
ID を指定して IAM グループを削除します。
Arguments:
<id> 削除するグループ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api group read-memberships
Usage: skr iam-api group read-memberships <group-id>
グループに所属するユーザーを一覧表示します。
Arguments:
<group-id> 所属ユーザーを確認するグループ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api group update-memberships
Usage: skr iam-api group update-memberships <group-id> [flags]
グループの所属ユーザーを置き換えます。現在の所属は保持されず、指定した配列で上書きされます。read-memberships で現在の所属を確認できます。
Arguments:
<group-id> 所属ユーザーを更新するグループ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST ユーザー ID の JSON 配列を直接または @path.json で指定します。例:
--request '[1,2,3]'
skr iam-api policy
Usage: skr iam-api policy <command>
IAM ポリシーバインディング（ロールとプリンシパルの割り当て）を参照・更新します。更新は現在の割り当て全体を置き換えます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iam-api policy read-organization
組織の IAM ポリシーバインディング（ロールとプリンシパルの割り当て）を一覧表示します。
iam-api policy update-organization [flags]
組織の IAM ポリシーバインディングを置き換えます。現在の割り当て全体を --request に JSON
配列で指定します。read-organization の出力を基に編集してください。
iam-api policy read-project <project-id>
指定したプロジェクトの IAM ポリシーバインディング（ロールとプリンシパルの割り当て）を一覧表示します。
iam-api policy update-project <project-id> [flags]
指定したプロジェクトの IAM ポリシーバインディングを置き換えます。現在の割り当て全体を --request に JSON
配列で指定します。read-project の出力を基に編集してください。
iam-api policy read-folder <folder-id>
指定したフォルダの IAM ポリシーバインディング（ロールとプリンシパルの割り当て）を一覧表示します。
iam-api policy update-folder <folder-id> [flags]
指定したフォルダの IAM ポリシーバインディングを置き換えます。現在の割り当て全体を --request に JSON
配列で指定します。read-folder の出力を基に編集してください。
skr iam-api policy read-organization
Usage: skr iam-api policy read-organization
組織の IAM ポリシーバインディング（ロールとプリンシパルの割り当て）を一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api policy update-organization
Usage: skr iam-api policy update-organization [flags]
組織の IAM ポリシーバインディングを置き換えます。現在の割り当て全体を --request に JSON
配列で指定します。read-organization の出力を基に編集してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 現在の割り当ての JSON 配列を直接または @path.json
で指定します。各要素は role と principals を持ち、role は
type（preset）と id（IAM ロール ID）、principals は
type（user など）と id（数値）を指定します。例: --request
'[{"role":{"type":"preset","id":"IAM-ROLE-ID"},"principals":[{"type":"user","id":123}]}]'
skr iam-api policy read-project
Usage: skr iam-api policy read-project <project-id>
指定したプロジェクトの IAM ポリシーバインディング（ロールとプリンシパルの割り当て）を一覧表示します。
Arguments:
<project-id> 対象のプロジェクト ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api policy update-project
Usage: skr iam-api policy update-project <project-id> [flags]
指定したプロジェクトの IAM ポリシーバインディングを置き換えます。現在の割り当て全体を --request に JSON
配列で指定します。read-project の出力を基に編集してください。
Arguments:
<project-id> 対象のプロジェクト ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 現在の割り当ての JSON 配列を直接または @path.json
で指定します。各要素は role と principals を持ち、role は
type（preset）と id（IAM ロール ID）、principals は
type（user など）と id（数値）を指定します。例: --request
'[{"role":{"type":"preset","id":"IAM-ROLE-ID"},"principals":[{"type":"user","id":123}]}]'
skr iam-api policy read-folder
Usage: skr iam-api policy read-folder <folder-id>
指定したフォルダの IAM ポリシーバインディング（ロールとプリンシパルの割り当て）を一覧表示します。
Arguments:
<folder-id> 対象のフォルダ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api policy update-folder
Usage: skr iam-api policy update-folder <folder-id> [flags]
指定したフォルダの IAM ポリシーバインディングを置き換えます。現在の割り当て全体を --request に JSON
配列で指定します。read-folder の出力を基に編集してください。
Arguments:
<folder-id> 対象のフォルダ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 現在の割り当ての JSON 配列を直接または @path.json
で指定します。各要素は role と principals を持ち、role は
type（preset）と id（IAM ロール ID）、principals は
type（user など）と id（数値）を指定します。例: --request
'[{"role":{"type":"preset","id":"IAM-ROLE-ID"},"principals":[{"type":"user","id":123}]}]'
skr iam-api auth
Usage: skr iam-api auth <command>
組織の認証条件とパスワードポリシーを参照・更新します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iam-api auth read-password-policy
組織のパスワードポリシーを参照します。
iam-api auth update-password-policy [flags]
組織のパスワードポリシーを更新します。--request ではすべての項目を含む JSON
を指定します。フラグを使う場合も4項目すべてを指定してください。
iam-api auth read-auth-conditions
組織の認証条件を参照します。
iam-api auth update-auth-conditions [flags]
組織の認証条件を更新します。現在の設定を read-auth-conditions で確認し、すべての項目を含む JSON を指定してください。
iam-api auth read-auth-context
現在の認証情報に対応する IAM 認証コンテキストを参照します。
skr iam-api auth read-password-policy
Usage: skr iam-api auth read-password-policy
組織のパスワードポリシーを参照します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api auth update-password-policy
Usage: skr iam-api auth update-password-policy [flags]
組織のパスワードポリシーを更新します。--request ではすべての項目を含む JSON を指定します。フラグを使う場合も4項目すべてを指定してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST パスワードポリシー全体の JSON。直接指定するか @path.json
で読み込みます。組織全体の設定を変更するため、更新前に
read-password-policy で確認してください。--request
と個別フラグは併用できません。
--min-length=MIN-LENGTH 必須: パスワードの最小文字数。
--require-uppercase 必須: 大文字を必須にします。
--require-lowercase 必須: 小文字を必須にします。
--require-symbols 必須: 記号を必須にします。
skr iam-api auth read-auth-conditions
Usage: skr iam-api auth read-auth-conditions
組織の認証条件を参照します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api auth update-auth-conditions
Usage: skr iam-api auth update-auth-conditions [flags]
組織の認証条件を更新します。現在の設定を read-auth-conditions で確認し、すべての項目を含む JSON を指定してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 認証条件全体の JSON。直接指定するか @path.json
で読み込みます。組織全体のログイン条件を変更するため、更新前に read-auth-conditions
で確認してください。
skr iam-api auth read-auth-context
Usage: skr iam-api auth read-auth-context
現在の認証情報に対応する IAM 認証コンテキストを参照します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api folder
Usage: skr iam-api folder <command>
IAM フォルダを管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iam-api folder list [flags]
IAM フォルダを一覧表示します。ページングや絞り込みには --request または対応する個別フラグを指定します。
iam-api folder create [flags]
IAM フォルダを作成します。親フォルダを指定する場合は --parent-id を指定してください。
iam-api folder read <id>
ID を指定して IAM フォルダを読み取ります。
iam-api folder update --name=STRING <id> [flags]
IAM フォルダの名前と説明を更新します。説明を変更しない場合は --description を省略します。
iam-api folder move --ids=IDS,... --parent-id=PARENT-ID
指定したフォルダを親フォルダへ移動します。移動先が有効な階層になることを確認してください。
iam-api folder delete <id>
ID を指定して IAM フォルダを削除します。
skr iam-api folder list
Usage: skr iam-api folder list [flags]
IAM フォルダを一覧表示します。ページングや絞り込みには --request または対応する個別フラグを指定します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST フォルダ一覧のページング・絞り込み条件を含む JSON。直接指定するか @path.json
で読み込みます。個別フラグと併用できません。
--page=PAGE 任意: 取得するページ番号。
--per-page=PER-PAGE 任意: 1 ページあたりの取得件数。
--name=NAME 任意: 名前で絞り込みます。
--parent-id=PARENT-ID 任意: 親フォルダ ID で絞り込みます。
skr iam-api folder create
Usage: skr iam-api folder create [flags]
IAM フォルダを作成します。親フォルダを指定する場合は --parent-id を指定してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST フォルダ名、説明、任意の親フォルダ ID を含む JSON。直接指定するか
@path.json で読み込みます。
--name=NAME 必須: フォルダ名。
--description=DESCRIPTION 任意: フォルダの説明。
--parent-id=PARENT-ID 任意: 親フォルダ ID。
skr iam-api folder read
Usage: skr iam-api folder read <id>
ID を指定して IAM フォルダを読み取ります。
Arguments:
<id> 読み取るフォルダ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api folder update
Usage: skr iam-api folder update --name=STRING <id> [flags]
IAM フォルダの名前と説明を更新します。説明を変更しない場合は --description を省略します。
Arguments:
<id> 更新するフォルダ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--name=STRING 必須: 更新後のフォルダ名。
--description=DESCRIPTION 任意: 更新後の説明。
skr iam-api folder move
Usage: skr iam-api folder move --ids=IDS,... --parent-id=PARENT-ID
指定したフォルダを親フォルダへ移動します。移動先が有効な階層になることを確認してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--ids=IDS,... 移動するフォルダ ID をカンマ区切りで指定します。
--parent-id=PARENT-ID 必須: 移動先の親フォルダ ID。
skr iam-api folder delete
Usage: skr iam-api folder delete <id>
ID を指定して IAM フォルダを削除します。
Arguments:
<id> 削除するフォルダ ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api iam-role
Usage: skr iam-api iam-role <command>
利用可能な IAM ロールを参照します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iam-api iam-role list [flags]
利用可能な IAM ロールを一覧表示します。
iam-api iam-role read <id>
ID を指定して IAM ロールを読み取ります。
skr iam-api iam-role list
Usage: skr iam-api iam-role list [flags]
利用可能な IAM ロールを一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--page=PAGE 任意: 取得するページ番号。
--per-page=PER-PAGE 任意: 1 ページあたりの取得件数。
skr iam-api iam-role read
Usage: skr iam-api iam-role read <id>
ID を指定して IAM ロールを読み取ります。
Arguments:
<id> 読み取る IAM ロール ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api id-policy
Usage: skr iam-api id-policy <command>
組織の ID ポリシーを参照・更新します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iam-api id-policy read-organization
組織の ID ポリシーを参照します。
iam-api id-policy update-organization [flags]
組織の ID ポリシー全体を置き換えます。変更前に read-organization で現在の設定を保存してください。
skr iam-api id-policy read-organization
Usage: skr iam-api id-policy read-organization
組織の ID ポリシーを参照します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api id-policy update-organization
Usage: skr iam-api id-policy update-organization [flags]
組織の ID ポリシー全体を置き換えます。変更前に read-organization で現在の設定を保存してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 組織の ID ポリシー全体を表す JSON 配列。直接指定するか @path.json
で読み込みます。既存設定全体を置き換えるため、更新前に read-organization
で確認してください。
skr iam-api id-role
Usage: skr iam-api id-role <command>
利用可能な ID ロールを参照します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iam-api id-role list [flags]
利用可能な ID ロールを一覧表示します。
iam-api id-role read <id>
ID を指定して ID ロールを読み取ります。
skr iam-api id-role list
Usage: skr iam-api id-role list [flags]
利用可能な ID ロールを一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--page=PAGE 任意: 取得するページ番号。
--per-page=PER-PAGE 任意: 1 ページあたりの取得件数。
skr iam-api id-role read
Usage: skr iam-api id-role read <id>
ID を指定して ID ロールを読み取ります。
Arguments:
<id> 読み取る ID ロール ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api organization
Usage: skr iam-api organization <command>
IAM 組織とサービス利用ポリシーを参照・管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iam-api organization read
IAM 組織の情報を参照します。
iam-api organization update --name=STRING
IAM 組織名を更新します。
iam-api organization read-service-policy [flags]
組織のサービス利用ポリシーを参照します。
iam-api organization update-service-policy [flags]
組織のサービス利用ポリシー全体を更新します。設定はサービス操作に影響するため、変更前に read-service-policy
で現在の設定を確認してください。
skr iam-api organization read
Usage: skr iam-api organization read
IAM 組織の情報を参照します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api organization update
Usage: skr iam-api organization update --name=STRING
IAM 組織名を更新します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--name=STRING 更新後の組織名。
skr iam-api organization read-service-policy
Usage: skr iam-api organization read-service-policy [flags]
組織のサービス利用ポリシーを参照します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST サービス利用ポリシーの絞り込み条件 JSON。省略すると既定の条件で取得します。直接指定するか
@path.json で読み込みます。--request と個別フラグは併用できません。
--is-active 任意: 有効状態で絞り込みます。
--is-dry-run 任意: ドライラン状態で絞り込みます。
--name=NAME 任意: サービス名で絞り込みます。
--code=CODE 任意: サービスコードで絞り込みます。
--type=TYPE 任意: サービスポリシーの型で絞り込みます。
skr iam-api organization update-service-policy
Usage: skr iam-api organization update-service-policy [flags]
組織のサービス利用ポリシー全体を更新します。設定はサービス操作に影響するため、変更前に read-service-policy で現在の設定を確認してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST サービス利用ポリシーのルール全体を表す JSON 配列。直接指定するか @path.json
で読み込みます。
skr iam-api project
Usage: skr iam-api project <command>
IAM プロジェクトを管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iam-api project list [flags]
IAM プロジェクトを一覧表示します。
iam-api project create [flags]
IAM プロジェクトを作成します。既存のフォルダ内に作成する場合は --parent-folder-id を指定してください。
iam-api project read <id>
ID を指定して IAM プロジェクトを読み取ります。
iam-api project update --name=STRING --description=STRING <id>
IAM プロジェクトの名前と説明を更新します。両方の値を指定してください。
iam-api project move --ids=IDS,... --parent-folder-id=PARENT-FOLDER-ID
指定したプロジェクトをフォルダへ移動します。
iam-api project delete <id>
ID を指定して IAM プロジェクトを削除します。
skr iam-api project list
Usage: skr iam-api project list [flags]
IAM プロジェクトを一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST プロジェクト一覧のページング・絞り込み条件を含む JSON。直接指定するか @path.json
で読み込みます。個別フラグと併用できません。
--page=PAGE 任意: 取得するページ番号。
--per-page=PER-PAGE 任意: 1 ページあたりの取得件数。
--ordering=ORDERING 任意: 並び順を API の ordering 値で指定します。
--iam-role=IAM-ROLE 任意: IAM ロール ID で絞り込みます。
--parent-folder-id=PARENT-FOLDER-ID
任意: 親フォルダ ID で絞り込みます。
skr iam-api project create
Usage: skr iam-api project create [flags]
IAM プロジェクトを作成します。既存のフォルダ内に作成する場合は --parent-folder-id を指定してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST プロジェクトコード、名前、説明を含む JSON。直接指定するか @path.json
で読み込みます。コード、名前、説明は必須です。
--code=CODE 必須: プロジェクトコード。
--name=NAME 必須: プロジェクト名。
--description=DESCRIPTION 必須: プロジェクトの説明。
--parent-folder-id=PARENT-FOLDER-ID
任意: 親フォルダ ID。
skr iam-api project read
Usage: skr iam-api project read <id>
ID を指定して IAM プロジェクトを読み取ります。
Arguments:
<id> 読み取るプロジェクト ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api project update
Usage: skr iam-api project update --name=STRING --description=STRING <id>
IAM プロジェクトの名前と説明を更新します。両方の値を指定してください。
Arguments:
<id> 更新するプロジェクト ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--name=STRING 更新後のプロジェクト名。
--description=STRING 更新後の説明。
skr iam-api project move
Usage: skr iam-api project move --ids=IDS,... --parent-folder-id=PARENT-FOLDER-ID
指定したプロジェクトをフォルダへ移動します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--ids=IDS,... 移動するプロジェクト ID をカンマ区切りで指定します。
--parent-folder-id=PARENT-FOLDER-ID
必須: 移動先フォルダ ID。
skr iam-api project delete
Usage: skr iam-api project delete <id>
ID を指定して IAM プロジェクトを削除します。
Arguments:
<id> 削除するプロジェクト ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api project-api-key
Usage: skr iam-api project-api-key <command>
プロジェクト API キーを管理します。作成時の秘密情報を安全に扱ってください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iam-api project-api-key list [flags]
プロジェクト API キーを一覧表示します。
iam-api project-api-key create [flags]
プロジェクト API キーを作成します。レスポンスにアクセストークンとシークレットが含まれるため、出力を安全に保管してください。
iam-api project-api-key read <id>
ID を指定してプロジェクト API キーを読み取ります。
iam-api project-api-key update <id> [flags]
プロジェクト API キーを更新します。現在の設定を read で確認し、変更後の設定を JSON で指定してください。
iam-api project-api-key delete <id>
ID を指定してプロジェクト API キーを削除します。
skr iam-api project-api-key list
Usage: skr iam-api project-api-key list [flags]
プロジェクト API キーを一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST API キー一覧のページング・並び順条件を含む JSON。直接指定するか @path.json
で読み込みます。
--page=PAGE 任意: 取得するページ番号。
--per-page=PER-PAGE 任意: 1 ページあたりの取得件数。
--ordering=ORDERING 任意: 並び順を API の ordering 値で指定します。
skr iam-api project-api-key create
Usage: skr iam-api project-api-key create [flags]
プロジェクト API キーを作成します。レスポンスにアクセストークンとシークレットが含まれるため、出力を安全に保管してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST API キー作成リクエスト全体を JSON で指定します。必須の
project_id、name、description、IAM ロール配列
iam_roles を含めてください。シングルサーバコントロールパネルで使うキーは
server_resource_id と zone_id
も指定します（https://manual.sakura.ad.jp/cloud/api/apikey.html）。直接指定するか
@path.json
で読み込みます。レスポンスには秘密情報（アクセストークンとシークレット）が含まれるため、出力を安全に保管してください。
skr iam-api project-api-key read
Usage: skr iam-api project-api-key read <id>
ID を指定してプロジェクト API キーを読み取ります。
Arguments:
<id> 読み取る API キー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api project-api-key update
Usage: skr iam-api project-api-key update <id> [flags]
プロジェクト API キーを更新します。現在の設定を read で確認し、変更後の設定を JSON で指定してください。
Arguments:
<id> 更新する API キー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 変更後の API キー設定全体を含む JSON。直接指定するか @path.json で読み込みます。
skr iam-api project-api-key delete
Usage: skr iam-api project-api-key delete <id>
ID を指定してプロジェクト API キーを削除します。
Arguments:
<id> 削除する API キー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api scim
Usage: skr iam-api scim <command>
ユーザープロビジョニング設定を管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iam-api scim list [flags]
ユーザープロビジョニング設定を一覧表示します。
iam-api scim create [flags]
ユーザープロビジョニング設定を作成します。
iam-api scim read <id>
ID を指定してユーザープロビジョニング設定を読み取ります。
iam-api scim update <id> [flags]
ユーザープロビジョニング設定を更新します。更新後の設定名を --name または --request JSON の name に指定してください。
iam-api scim delete <id>
ID を指定してユーザープロビジョニング設定を削除します。プロビジョニングされたユーザーとグループをすべて削除してから実行してください。
iam-api scim regenerate-token <id>
ユーザープロビジョニング設定の秘密トークンを再発行します。再発行後は古いトークンが使えなくなるため、連携先を更新できる場合にのみ実行してください。
skr iam-api scim list
Usage: skr iam-api scim list [flags]
ユーザープロビジョニング設定を一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST ユーザープロビジョニング設定一覧のページング条件を含む JSON。直接指定するか @path.json
で読み込みます。
--page=PAGE 任意: 取得するページ番号。
--per-page=PER-PAGE 任意: 1 ページあたりの取得件数。
skr iam-api scim create
Usage: skr iam-api scim create [flags]
ユーザープロビジョニング設定を作成します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST ユーザープロビジョニング設定の JSON。name を指定し、直接または @path.json
で読み込みます。
--name=NAME 必須: 設定名。
skr iam-api scim read
Usage: skr iam-api scim read <id>
ID を指定してユーザープロビジョニング設定を読み取ります。
Arguments:
<id> 読み取る設定 ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api scim update
Usage: skr iam-api scim update <id> [flags]
ユーザープロビジョニング設定を更新します。更新後の設定名を --name または --request JSON の name に指定してください。
Arguments:
<id> 更新する設定 ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST 更新後の設定名を含む JSON。name は必須です。直接指定するか @path.json
で読み込みます。--request と --name は併用できません。
--name=NAME 必須: 更新後の設定名。
skr iam-api scim delete
Usage: skr iam-api scim delete <id>
ID を指定してユーザープロビジョニング設定を削除します。プロビジョニングされたユーザーとグループをすべて削除してから実行してください。
Arguments:
<id> 削除する設定 ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api scim regenerate-token
Usage: skr iam-api scim regenerate-token <id>
ユーザープロビジョニング設定の秘密トークンを再発行します。再発行後は古いトークンが使えなくなるため、連携先を更新できる場合にのみ実行してください。
Arguments:
<id> トークンを再発行する設定 ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api service-policy
Usage: skr iam-api service-policy <command>
サービス利用ポリシーの有効状態とルールテンプレートを管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iam-api service-policy enable
サービス利用ポリシーを有効化します。サービス操作の制限に影響するため、実行前に設定内容を確認してください。
iam-api service-policy disable
サービス利用ポリシーを無効化します。サービス操作の制限に影響するため、実行前に設定内容を確認してください。
iam-api service-policy is-enabled
サービス利用ポリシーが有効かどうかを確認します。
iam-api service-policy list-rule-templates [flags]
サービス利用ポリシーのルールテンプレートを一覧表示します。
skr iam-api service-policy enable
Usage: skr iam-api service-policy enable
サービス利用ポリシーを有効化します。サービス操作の制限に影響するため、実行前に設定内容を確認してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api service-policy disable
Usage: skr iam-api service-policy disable
サービス利用ポリシーを無効化します。サービス操作の制限に影響するため、実行前に設定内容を確認してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api service-policy is-enabled
Usage: skr iam-api service-policy is-enabled
サービス利用ポリシーが有効かどうかを確認します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api service-policy list-rule-templates
Usage: skr iam-api service-policy list-rule-templates [flags]
サービス利用ポリシーのルールテンプレートを一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST ルールテンプレートの絞り込み条件 JSON。直接指定するか @path.json で読み込みます。
--page=PAGE 任意: 取得するページ番号。
--per-page=PER-PAGE 任意: 1 ページあたりの取得件数。
--name=NAME 任意: 名前で絞り込みます。
--code=CODE 任意: コードで絞り込みます。
--type=TYPE 任意: 種別で絞り込みます。
skr iam-api service-principal
Usage: skr iam-api service-principal <command>
サービスプリンシパルと公開鍵を管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iam-api service-principal list [flags]
サービスプリンシパルを一覧表示します。
iam-api service-principal create [flags]
サービスプリンシパルを作成します。
iam-api service-principal read <id>
ID を指定してサービスプリンシパルを読み取ります。
iam-api service-principal update <id> [flags]
サービスプリンシパルの名前と説明を更新します。名前と説明は必須です。
iam-api service-principal delete <id>
ID を指定してサービスプリンシパルを削除します。
iam-api service-principal list-keys <id> [flags]
サービスプリンシパルに登録されたキーを一覧表示します。
iam-api service-principal upload-key --public-key-file=STRING <id>
サービスプリンシパルに PEM 形式の RSA 公開鍵（2048～4096 ビット）を登録します。公開鍵は --public-key-file
で読み込みます。
iam-api service-principal enable-key <id> <key-id>
指定したサービスプリンシパルキーを有効化します。
iam-api service-principal disable-key <id> <key-id>
指定したサービスプリンシパルキーを無効化します。
iam-api service-principal delete-key <id> <key-id>
指定したサービスプリンシパルキーを削除します。
iam-api service-principal issue-token --assertion-file=STRING
登録済み公開鍵に対応する秘密鍵で署名した JWT アサーションからアクセストークンを発行します。アサーションは --assertion-file
で読み込み、発行されたトークンは秘密情報として扱います。
skr iam-api service-principal list
Usage: skr iam-api service-principal list [flags]
サービスプリンシパルを一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST サービスプリンシパル一覧のページング・絞り込み条件を含む JSON。直接指定するか
@path.json で読み込みます。
--page=PAGE 任意: 取得するページ番号。
--per-page=PER-PAGE 任意: 1 ページあたりの取得件数。
--project-id=PROJECT-ID 任意: プロジェクト ID で絞り込みます。
--ordering=ORDERING 任意: 並び順を API の ordering 値で指定します。
skr iam-api service-principal create
Usage: skr iam-api service-principal create [flags]
サービスプリンシパルを作成します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST サービスプリンシパル作成 JSON。直接指定するか @path.json で読み込みます。
--project-id=PROJECT-ID 必須: 対象プロジェクト ID。
--name=NAME 必須: サービスプリンシパル名。
--description=DESCRIPTION 必須: サービスプリンシパルの説明。
skr iam-api service-principal read
Usage: skr iam-api service-principal read <id>
ID を指定してサービスプリンシパルを読み取ります。
Arguments:
<id> 読み取るサービスプリンシパル ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api service-principal update
Usage: skr iam-api service-principal update <id> [flags]
サービスプリンシパルの名前と説明を更新します。名前と説明は必須です。
Arguments:
<id> 更新するサービスプリンシパル ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 更新後のサービスプリンシパル設定を含む JSON。name と description
は必須です。直接指定するか @path.json で読み込みます。--request と
--name は併用できません。
--name=NAME 必須: 更新後のサービスプリンシパル名。
--description=DESCRIPTION 必須: 更新後のサービスプリンシパルの説明。
skr iam-api service-principal delete
Usage: skr iam-api service-principal delete <id>
ID を指定してサービスプリンシパルを削除します。
Arguments:
<id> 削除するサービスプリンシパル ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api service-principal list-keys
Usage: skr iam-api service-principal list-keys <id> [flags]
サービスプリンシパルに登録されたキーを一覧表示します。
Arguments:
<id> キーを一覧表示するサービスプリンシパル ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST キー一覧のページング・並び順条件 JSON。直接指定するか @path.json
で読み込みます。--request と個別フラグは併用できません。
--page=PAGE 任意: 取得するページ番号。
--per-page=PER-PAGE 任意: 1 ページあたりの取得件数。
--ordering=ORDERING 任意: 並び順を API の ordering 値で指定します。
skr iam-api service-principal upload-key
Usage: skr iam-api service-principal upload-key --public-key-file=STRING <id>
サービスプリンシパルに PEM 形式の RSA 公開鍵（2048～4096 ビット）を登録します。公開鍵は --public-key-file で読み込みます。
Arguments:
<id> 公開鍵を登録するサービスプリンシパル ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--public-key-file=STRING 必須: 公開鍵ファイル。- の場合は標準入力から読み込みます。
skr iam-api service-principal enable-key
Usage: skr iam-api service-principal enable-key <id> <key-id>
指定したサービスプリンシパルキーを有効化します。
Arguments:
<id> サービスプリンシパル ID。
<key-id> 有効化するキー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api service-principal disable-key
Usage: skr iam-api service-principal disable-key <id> <key-id>
指定したサービスプリンシパルキーを無効化します。
Arguments:
<id> サービスプリンシパル ID。
<key-id> 無効化するキー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api service-principal delete-key
Usage: skr iam-api service-principal delete-key <id> <key-id>
指定したサービスプリンシパルキーを削除します。
Arguments:
<id> サービスプリンシパル ID。
<key-id> 削除するキー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api service-principal issue-token
Usage: skr iam-api service-principal issue-token --assertion-file=STRING
登録済み公開鍵に対応する秘密鍵で署名した JWT アサーションからアクセストークンを発行します。アサーションは --assertion-file
で読み込み、発行されたトークンは秘密情報として扱います。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--assertion-file=STRING 必須: アサーションを記載したファイル。- の場合は標準入力から読み込みます。
skr iam-api sso
Usage: skr iam-api sso <command>
SSO プロファイルを管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iam-api sso list [flags]
SSO プロファイルを一覧表示します。
iam-api sso create [flags]
SSO プロファイルを作成します。IdP の証明書など複数項目を JSON で指定してください。
iam-api sso read <id>
ID を指定して SSO プロファイルを読み取ります。
iam-api sso update <id> [flags]
SSO プロファイルを更新します。必要な IdP 設定一式を JSON で指定してください。
iam-api sso delete <id>
ID を指定して SSO プロファイルを削除します。
iam-api sso link <id>
SSO プロファイルを組織で有効にします。有効なプロファイルは一つで、ユーザーのログイン方法に影響するため、IdP
設定と対象ユーザーのメールアドレスを確認してください。
iam-api sso unlink <id>
SSO プロファイルと組織のリンクを解除します。ユーザーのログイン方法に影響するため、実行前に対象プロファイルを確認してください。
skr iam-api sso list
Usage: skr iam-api sso list [flags]
SSO プロファイルを一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--page=PAGE 任意: 取得するページ番号。
--per-page=PER-PAGE 任意: 1 ページあたりの取得件数。
skr iam-api sso create
Usage: skr iam-api sso create [flags]
SSO プロファイルを作成します。IdP の証明書など複数項目を JSON で指定してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST SSO プロファイル作成 JSON（name、description、IdP の entity
ID、login/logout URL、X.509 certificate）。直接指定するか
@path.json で読み込みます。
skr iam-api sso read
Usage: skr iam-api sso read <id>
ID を指定して SSO プロファイルを読み取ります。
Arguments:
<id> 読み取る SSO プロファイル ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api sso update
Usage: skr iam-api sso update <id> [flags]
SSO プロファイルを更新します。必要な IdP 設定一式を JSON で指定してください。
Arguments:
<id> 更新する SSO プロファイル ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST SSO プロファイルの更新 JSON。直接指定するか @path.json で読み込みます。
skr iam-api sso delete
Usage: skr iam-api sso delete <id>
ID を指定して SSO プロファイルを削除します。
Arguments:
<id> 削除する SSO プロファイル ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api sso link
Usage: skr iam-api sso link <id>
SSO プロファイルを組織で有効にします。有効なプロファイルは一つで、ユーザーのログイン方法に影響するため、IdP
設定と対象ユーザーのメールアドレスを確認してください。
Arguments:
<id> リンクする SSO プロファイル ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api sso unlink
Usage: skr iam-api sso unlink <id>
SSO プロファイルと組織のリンクを解除します。ユーザーのログイン方法に影響するため、実行前に対象プロファイルを確認してください。
Arguments:
<id> リンクを解除する SSO プロファイル ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr iam-api user-2fa
Usage: skr iam-api user-2fa <command>
ユーザーの OTP、信頼済みデバイス、セキュリティキーを管理します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
iam-api user-2fa deactivate-otp --user-id=INT
指定したユーザーの OTP を無効化します。ログイン方法に影響するため、--user-id で対象を確認してください。
iam-api user-2fa list-trusted-devices --user-id=INT
指定したユーザーの信頼済みデバイスを一覧表示します。
iam-api user-2fa delete-trusted-device --user-id=INT <trusted-device-id>
指定したユーザーの信頼済みデバイスを削除します。
iam-api user-2fa clear-trusted-devices --user-id=INT
指定したユーザーの信頼済みデバイスをすべて削除します。--user-id で対象を確認してください。
iam-api user-2fa list-security-keys --user-id=INT
指定したユーザーのセキュリティキーを一覧表示します。
iam-api user-2fa read-security-key --user-id=INT <security-key-id>
ID を指定してセキュリティキーを読み取ります。
iam-api user-2fa delete-security-key --user-id=INT <security-key-id>
指定したユーザーのセキュリティキーを削除します。
skr iam-api user-2fa deactivate-otp
Usage: skr iam-api user-2fa deactivate-otp --user-id=INT
指定したユーザーの OTP を無効化します。ログイン方法に影響するため、--user-id で対象を確認してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--user-id=INT 対象ユーザー ID。操作対象を確認して指定してください。
skr iam-api user-2fa list-trusted-devices
Usage: skr iam-api user-2fa list-trusted-devices --user-id=INT
指定したユーザーの信頼済みデバイスを一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--user-id=INT 対象ユーザー ID。操作対象を確認して指定してください。
skr iam-api user-2fa delete-trusted-device
Usage: skr iam-api user-2fa delete-trusted-device --user-id=INT <trusted-device-id>
指定したユーザーの信頼済みデバイスを削除します。
Arguments:
<trusted-device-id> 削除する信頼済みデバイス ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--user-id=INT 対象ユーザー ID。操作対象を確認して指定してください。
skr iam-api user-2fa clear-trusted-devices
Usage: skr iam-api user-2fa clear-trusted-devices --user-id=INT
指定したユーザーの信頼済みデバイスをすべて削除します。--user-id で対象を確認してください。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--user-id=INT 対象ユーザー ID。操作対象を確認して指定してください。
skr iam-api user-2fa list-security-keys
Usage: skr iam-api user-2fa list-security-keys --user-id=INT
指定したユーザーのセキュリティキーを一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--user-id=INT 対象ユーザー ID。操作対象を確認して指定してください。
skr iam-api user-2fa read-security-key
Usage: skr iam-api user-2fa read-security-key --user-id=INT <security-key-id>
ID を指定してセキュリティキーを読み取ります。
Arguments:
<security-key-id> 読み取るセキュリティキー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--user-id=INT 対象ユーザー ID。操作対象を確認して指定してください。
skr iam-api user-2fa delete-security-key
Usage: skr iam-api user-2fa delete-security-key --user-id=INT <security-key-id>
指定したユーザーのセキュリティキーを削除します。
Arguments:
<security-key-id> 削除するセキュリティキー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--user-id=INT 対象ユーザー ID。操作対象を確認して指定してください。
kms-api
skr kms-api
Usage: skr kms-api <command> [flags]
さくらのクラウド KMS (Key Management Service) で暗号鍵を操作します。FIPS 140-3 level 3 認証の
HSM と連携し、対称鍵 AES-256 bit の暗号化・復号を提供します。キーの削除は猶予期間 7〜90 日の削除予約制です。SDK
プロファイル、または SAKURA_ACCESS_TOKEN / SAKURA_ACCESS_TOKEN_SECRET 環境変数で認証します。API
エンドポイントのゾーンは SDK の既定値 (tk1a) を使い、SAKURA_ENDPOINTS_KMS で変更できます。平文や暗号文、BYOK
の秘密鍵はファイルまたは標準入力から読み込みます。結果は JSON で出力しますが、decrypt の平文はバイト列のまま出力します。--query
で必要な項目を抽出できます。詳細: https://manual.sakura.ad.jp/cloud/appliance/kms/index.html
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
kms-api key list [flags]
KMS キーを一覧表示します。--count と --from でページングできます。
kms-api key read <id>
ID を指定して KMS キーを読み取ります。
kms-api key create [flags]
KMS キーを作成します。
kms-api key update <id> [flags]
KMS キーの名前、説明、タグを更新します。--name が必須です。Description は指定した場合だけリクエストに含まれます。Tags
は常にリクエストに含まれ、個別フラグのみでの更新では null (タグのクリア) として送信されます。タグを設定・維持する場合は --request
JSON で Tags を指定してください。
kms-api key delete <id>
ID を指定して KMS キーを削除します。削除前に対象 ID を確認してください。
kms-api key rotate <id>
KMS キーをローテーションします。有効 (active) なキーだけが対象で、BYOK モードでインポートしたキーはローテーションできません。
kms-api key change-status --status=STRING <id>
KMS キーの状態を変更します。
kms-api key schedule-destruction --pending-days=INT <id>
KMS キーの削除を予約します。削除予約中のキーは利用できませんが、状態変更で削除を取り消せます。
kms-api key encrypt --plain-file=STRING <id> [flags]
KMS キーで平文を暗号化します。
kms-api key decrypt --cipher-file=STRING <id>
KMS キーで暗号文を復号します。
skr kms-api key
Usage: skr kms-api key <command>
KMS キーを作成・管理します。キーはプロジェクト単位で最大 100 個まで作成でき、削除は猶予期間 7〜90 日の削除予約制です。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
kms-api key list [flags]
KMS キーを一覧表示します。--count と --from でページングできます。
kms-api key read <id>
ID を指定して KMS キーを読み取ります。
kms-api key create [flags]
KMS キーを作成します。
kms-api key update <id> [flags]
KMS キーの名前、説明、タグを更新します。--name が必須です。Description は指定した場合だけリクエストに含まれます。Tags
は常にリクエストに含まれ、個別フラグのみでの更新では null (タグのクリア) として送信されます。タグを設定・維持する場合は --request
JSON で Tags を指定してください。
kms-api key delete <id>
ID を指定して KMS キーを削除します。削除前に対象 ID を確認してください。
kms-api key rotate <id>
KMS キーをローテーションします。有効 (active) なキーだけが対象で、BYOK モードでインポートしたキーはローテーションできません。
kms-api key change-status --status=STRING <id>
KMS キーの状態を変更します。
kms-api key schedule-destruction --pending-days=INT <id>
KMS キーの削除を予約します。削除予約中のキーは利用できませんが、状態変更で削除を取り消せます。
kms-api key encrypt --plain-file=STRING <id> [flags]
KMS キーで平文を暗号化します。
kms-api key decrypt --cipher-file=STRING <id>
KMS キーで暗号文を復号します。
skr kms-api key list
Usage: skr kms-api key list [flags]
KMS キーを一覧表示します。--count と --from でページングできます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--count=COUNT 任意: 1 ページの取得件数。
--from=FROM 任意: 取得開始位置 (0 開始)。
skr kms-api key read
Usage: skr kms-api key read <id>
ID を指定して KMS キーを読み取ります。
Arguments:
<id> list の出力にある KMS キー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr kms-api key create
Usage: skr kms-api key create [flags]
KMS キーを作成します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST 個別フラグと併用不可。作成リクエスト JSON を @path.json
または -（標準入力）で指定します。PlainKey (BYOK
の秘密鍵) を含む可能性があるため、インライン JSON
は受け付けません。Name、Description、Tags、PlainKey
を指定できます。
--name=NAME 必須: キー名 (1〜255 文字)。例: my-key
--description=DESCRIPTION 任意: キーの説明。
--plain-key-file=PLAIN-KEY-FILE
任意: BYOK モードでインポートする秘密鍵。256 bit の対称鍵を base64
エンコードした内容のファイルを指定し、- の場合は標準入力から読み込みます。
skr kms-api key update
Usage: skr kms-api key update <id> [flags]
KMS キーの名前、説明、タグを更新します。--name が必須です。Description は指定した場合だけリクエストに含まれます。Tags
は常にリクエストに含まれ、個別フラグのみでの更新では null (タグのクリア) として送信されます。タグを設定・維持する場合は --request JSON
で Tags を指定してください。
Arguments:
<id> 更新する KMS キー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST API リクエスト JSON を直接または @path.json
で指定します。個別フラグと併用できません。
--name=NAME 必須: 更新後のキー名 (1〜255 文字)。例: my-key
--description=DESCRIPTION 任意: 更新後のキーの説明。省略するとリクエスト本文に含まれません。
skr kms-api key delete
Usage: skr kms-api key delete <id>
ID を指定して KMS キーを削除します。削除前に対象 ID を確認してください。
Arguments:
<id> 削除する KMS キー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr kms-api key rotate
Usage: skr kms-api key rotate <id>
KMS キーをローテーションします。有効 (active) なキーだけが対象で、BYOK モードでインポートしたキーはローテーションできません。
Arguments:
<id> ローテーションする KMS キー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr kms-api key change-status
Usage: skr kms-api key change-status --status=STRING <id>
KMS キーの状態を変更します。
Arguments:
<id> 状態を変更する KMS キー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--status=STRING 必須: 設定する状態。active (有効: 暗号化・復号可)、restricted (制限中:
復号のみ可)、suspended (一時停止中: 操作不可) のいずれか。
skr kms-api key schedule-destruction
Usage: skr kms-api key schedule-destruction --pending-days=INT <id>
KMS キーの削除を予約します。削除予約中のキーは利用できませんが、状態変更で削除を取り消せます。
Arguments:
<id> 削除を予約する KMS キー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--pending-days=INT 必須: 削除までの猶予日数 (7〜90)。
skr kms-api key encrypt
Usage: skr kms-api key encrypt --plain-file=STRING <id> [flags]
KMS キーで平文を暗号化します。
Arguments:
<id> 暗号化に使う KMS キー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--plain-file=STRING 必須: 暗号化する平文のファイル。- の場合は標準入力から読み込みます。平文は API 向けに
base64 エンコードされて送信されます。
--algo=STRING 任意: 暗号化アルゴリズム。aes-256-gcm
(既定)、aes-256-cbc、aes-256-kw のいずれか。
skr kms-api key decrypt
Usage: skr kms-api key decrypt --cipher-file=STRING <id>
KMS キーで暗号文を復号します。
Arguments:
<id> 復号に使う KMS キー ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--cipher-file=STRING 必須: encrypt が出力した暗号文 (base64 テキスト)
のファイル。- の場合は標準入力から読み込みます。encrypt の JSON
出力をリダイレクトしたファイルもそのまま使えます。復号した平文はバイト列のまま標準出力に出力され、--query
は適用されません。
secretmanager-api
skr secretmanager-api
Usage: skr secretmanager-api <command> [flags]
さくらのクラウド シークレットマネージャーでシークレット保管庫 (Vault) とシークレットを操作します。シークレットは Vault
単位で暗号化され、最新を含む 50 世代まで保管されます。Vault 作成には既存の KMS キー ID が必要です。SDK プロファイル、または
SAKURA_ACCESS_TOKEN / SAKURA_ACCESS_TOKEN_SECRET 環境変数で認証します。シークレットの値は
--value-file で指定したファイルまたは標準入力から読み込み、unveil は値をそのまま標準出力へ出力します。結果は
JSON で出力しますが、unveil は値のみを出力します。--query で必要な項目を抽出できます。詳細:
https://manual.sakura.ad.jp/cloud/appliance/secretsmanager/index.html
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
secretmanager-api vault list [flags]
シークレット保管庫 (Vault) を一覧表示します。--count と --from でページングできます。
secretmanager-api vault read <id>
ID を指定してシークレット保管庫 (Vault) を読み取ります。
secretmanager-api vault create [flags]
シークレット保管庫 (Vault) を作成します。Vault 単位で課金が行われ、Vault
が作成されてから削除されるまでの間課金されます。--kms-key-id にはシークレットの暗号化に使う既存の KMS キー ID
を指定します。Tags は --request JSON でのみ指定できます。
secretmanager-api vault update <id> [flags]
シークレット保管庫 (Vault) の名前、説明、タグを更新します。--name が必須です。Description
は指定した場合だけリクエストに含まれます。Tags は常にリクエストに含まれ、個別フラグのみでの更新では null (タグのクリア)
として送信されます。タグを設定・維持する場合は --request JSON で Tags を指定してください。
secretmanager-api vault delete <id>
ID を指定してシークレット保管庫 (Vault) を削除します。削除前に対象 ID を確認してください。
secretmanager-api secret list <vault-id> [flags]
Vault 内のシークレットを一覧表示します。シークレットの値は含まれません。--count と --from でページングできます。
secretmanager-api secret create --name=NAME --value-file=VALUE-FILE <vault-id>
Vault にシークレットを作成または更新します (upsert)。同名シークレットが存在する場合は新しいバージョンとして登録され、最新を含む 50
世代まで保管されます。値は --value-file でのみ指定できます。
secretmanager-api secret delete <vault-id> <name>
Vault からシークレットを削除します。全バージョンが削除されます。削除前に対象 Vault ID とシークレット名を確認してください。
secretmanager-api secret unveil <vault-id> <name> [flags]
シークレットを復号して値を取得します。値はそのまま標準出力へ出力され、--query
は適用されません。出力に秘密情報が含まれるため、リダイレクト先とシェル履歴の取り扱いに注意してください。
skr secretmanager-api vault
Usage: skr secretmanager-api vault <command>
シークレット保管庫 (Vault) を作成・管理します。Vault 単位で課金が行われ、シークレットは Vault に最新を含む 50 世代まで保管されます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
secretmanager-api vault list [flags]
シークレット保管庫 (Vault) を一覧表示します。--count と --from でページングできます。
secretmanager-api vault read <id>
ID を指定してシークレット保管庫 (Vault) を読み取ります。
secretmanager-api vault create [flags]
シークレット保管庫 (Vault) を作成します。Vault 単位で課金が行われ、Vault
が作成されてから削除されるまでの間課金されます。--kms-key-id にはシークレットの暗号化に使う既存の KMS キー ID
を指定します。Tags は --request JSON でのみ指定できます。
secretmanager-api vault update <id> [flags]
シークレット保管庫 (Vault) の名前、説明、タグを更新します。--name が必須です。Description
は指定した場合だけリクエストに含まれます。Tags は常にリクエストに含まれ、個別フラグのみでの更新では null (タグのクリア)
として送信されます。タグを設定・維持する場合は --request JSON で Tags を指定してください。
secretmanager-api vault delete <id>
ID を指定してシークレット保管庫 (Vault) を削除します。削除前に対象 ID を確認してください。
skr secretmanager-api vault list
Usage: skr secretmanager-api vault list [flags]
シークレット保管庫 (Vault) を一覧表示します。--count と --from でページングできます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--count=COUNT 任意: 1 ページの取得件数。
--from=FROM 任意: 取得開始位置 (0 開始)。
skr secretmanager-api vault read
Usage: skr secretmanager-api vault read <id>
ID を指定してシークレット保管庫 (Vault) を読み取ります。
Arguments:
<id> list の出力にある Vault のリソース ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr secretmanager-api vault create
Usage: skr secretmanager-api vault create [flags]
シークレット保管庫 (Vault) を作成します。Vault 単位で課金が行われ、Vault
が作成されてから削除されるまでの間課金されます。--kms-key-id にはシークレットの暗号化に使う既存の KMS キー ID を指定します。Tags は
--request JSON でのみ指定できます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST API リクエスト JSON を直接または @path.json
で指定します。個別フラグと併用できません。
--name=NAME 必須: Vault 名 (1〜255 文字)。例: app1-vault
--description=DESCRIPTION 任意: Vault の説明。省略するとリクエスト本文に含まれません。
--kms-key-id=KMS-KEY-ID 必須: シークレットの暗号化に使う KMS キー ID (1〜255
文字)。kms-api key list で確認できます。
skr secretmanager-api vault update
Usage: skr secretmanager-api vault update <id> [flags]
シークレット保管庫 (Vault) の名前、説明、タグを更新します。--name が必須です。Description
は指定した場合だけリクエストに含まれます。Tags は常にリクエストに含まれ、個別フラグのみでの更新では null (タグのクリア)
として送信されます。タグを設定・維持する場合は --request JSON で Tags を指定してください。
Arguments:
<id> 更新する Vault のリソース ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST API リクエスト JSON を直接または @path.json
で指定します。個別フラグと併用できません。
--name=NAME 必須: 更新後の Vault 名 (1〜255 文字)。例: app1-vault
--description=DESCRIPTION 任意: 更新後の Vault の説明。省略するとリクエスト本文に含まれません。
skr secretmanager-api vault delete
Usage: skr secretmanager-api vault delete <id>
ID を指定してシークレット保管庫 (Vault) を削除します。削除前に対象 ID を確認してください。
Arguments:
<id> 削除する Vault のリソース ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr secretmanager-api secret
Usage: skr secretmanager-api secret <command>
Vault 内のシークレットを操作します。値の入出力はファイルまたは標準入出力経由で行い、コマンド引数に含めません。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
secretmanager-api secret list <vault-id> [flags]
Vault 内のシークレットを一覧表示します。シークレットの値は含まれません。--count と --from でページングできます。
secretmanager-api secret create --name=NAME --value-file=VALUE-FILE <vault-id>
Vault にシークレットを作成または更新します (upsert)。同名シークレットが存在する場合は新しいバージョンとして登録され、最新を含む 50
世代まで保管されます。値は --value-file でのみ指定できます。
secretmanager-api secret delete <vault-id> <name>
Vault からシークレットを削除します。全バージョンが削除されます。削除前に対象 Vault ID とシークレット名を確認してください。
secretmanager-api secret unveil <vault-id> <name> [flags]
シークレットを復号して値を取得します。値はそのまま標準出力へ出力され、--query
は適用されません。出力に秘密情報が含まれるため、リダイレクト先とシェル履歴の取り扱いに注意してください。
skr secretmanager-api secret list
Usage: skr secretmanager-api secret list <vault-id> [flags]
Vault 内のシークレットを一覧表示します。シークレットの値は含まれません。--count と --from でページングできます。
Arguments:
<vault-id> シークレットを一覧表示する Vault のリソース ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--count=COUNT 任意: 1 ページの取得件数。
--from=FROM 任意: 取得開始位置 (0 開始)。
skr secretmanager-api secret create
Usage: skr secretmanager-api secret create --name=NAME --value-file=VALUE-FILE <vault-id>
Vault にシークレットを作成または更新します (upsert)。同名シークレットが存在する場合は新しいバージョンとして登録され、最新を含む 50
世代まで保管されます。値は --value-file でのみ指定できます。
Arguments:
<vault-id> シークレットを作成する Vault のリソース ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--name=NAME 必須: シークレット名 (1〜255 文字)。例: db-password
--value-file=VALUE-FILE 必須: シークレットの値のファイル。-
の場合は標準入力から読み込みます。前後の空白は除去されます。値を直接引数に指定することはできません。
skr secretmanager-api secret delete
Usage: skr secretmanager-api secret delete <vault-id> <name>
Vault からシークレットを削除します。全バージョンが削除されます。削除前に対象 Vault ID とシークレット名を確認してください。
Arguments:
<vault-id> シークレットが属する Vault のリソース ID。
<name> 削除するシークレット名。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr secretmanager-api secret unveil
Usage: skr secretmanager-api secret unveil <vault-id> <name> [flags]
シークレットを復号して値を取得します。値はそのまま標準出力へ出力され、--query
は適用されません。出力に秘密情報が含まれるため、リダイレクト先とシェル履歴の取り扱いに注意してください。
Arguments:
<vault-id> シークレットが属する Vault のリソース ID。
<name> 取得するシークレット名。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--secret-version=SECRET-VERSION
任意: 取得するバージョン番号。省略すると最新バージョンを取得します。
service-endpoint-gateway-api
skr service-endpoint-gateway-api
Usage: skr service-endpoint-gateway-api <command> [flags]
さくらのクラウドのサービスエンドポイントゲートウェイを操作します。サービスエンドポイントゲートウェイはスイッチの拡張機能で、プライベートネットワーク内からオブジェクトストレージやコンテナレジストリなどのマネージドサービスへ閉域接続します。スイッチ単体が対象で、ルータ＋スイッチでは利用できません。SDK
プロファイル、または SAKURA_ACCESS_TOKEN / SAKURA_ACCESS_TOKEN_SECRET 環境変数で認証します。Create
はフラグまたは --request JSON で入力します。結果は JSON で出力します。--query で必要な項目を抽出できます。詳細:
https://manual.sakura.ad.jp/cloud/network/switch/seg.html
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
service-endpoint-gateway-api appliance list
サービスエンドポイントゲートウェイを一覧表示します。
service-endpoint-gateway-api appliance read <id>
ID を指定してサービスエンドポイントゲートウェイを読み取ります。
service-endpoint-gateway-api appliance create [flags]
スイッチにサービスエンドポイントゲートウェイを作成します。サービスエンドポイントゲートウェイはスイッチ単体でのみ利用でき、ルータ＋スイッチでは作成できません。1
つのスイッチに対して複数のサービスエンドポイントゲートウェイを作成することはできません。作成には接続先スイッチ ID
とゲートウェイに割り当てるサブネットマスク長が必要です。--request は Appliance.Remark に
Switch.ID、Network.NetworkMaskLen、Servers[].IPAddress を指定する JSON を受け付け、Class
と Plan は自動設定されます。--request と個別フラグは併用できません。
service-endpoint-gateway-api appliance update <id> [flags]
サービスエンドポイントゲートウェイの接続先マネージドサービス設定を更新します。Settings は全体置換です。既存の設定を維持したい項目は
JSON に再指定してください。EnabledServices には接続先マネージドサービスを Type と Config で指定します (Type:
ObjectStorage、ContainerRegistry、MonitoringSuite、AppRunDedicatedControlPlane
など)。MonitoringSuite と DNSForwarding の Enabled は True または False です。設定の反映は
apply で行います。
service-endpoint-gateway-api appliance apply <id>
update
で変更した設定をサービスエンドポイントゲートウェイへ反映します。接続先マネージドサービスの変更時、ゲートウェイ経由の通信が一時的に中断することがあります。
service-endpoint-gateway-api appliance delete <id>
ID を指定してサービスエンドポイントゲートウェイを削除します。削除前に対象 ID を確認してください。
service-endpoint-gateway-api appliance read-interface <appliance-id> <interface-id>
サービスエンドポイントゲートウェイのインターフェース情報を取得します。ゲートウェイの IPv4 アドレスは、利用するサーバーの DNS 設定に使います。
service-endpoint-gateway-api appliance read-power-status <id>
サービスエンドポイントゲートウェイの電源状態を取得します。
service-endpoint-gateway-api appliance power-on <id>
サービスエンドポイントゲートウェイの電源を投入します。作成直後は起動処理が行われていることがあります。
service-endpoint-gateway-api appliance shutdown <id>
サービスエンドポイントゲートウェイの電源を停止します。ゲートウェイ経由の通信が停止します。
service-endpoint-gateway-api appliance reset <id>
サービスエンドポイントゲートウェイの電源を再起動します。ゲートウェイ経由の通信が一時的に中断します。
skr service-endpoint-gateway-api appliance
Usage: skr service-endpoint-gateway-api appliance <command>
サービスエンドポイントゲートウェイの作成・削除、接続先マネージドサービスの設定、設定反映、電源操作を行います。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
Commands:
service-endpoint-gateway-api appliance list
サービスエンドポイントゲートウェイを一覧表示します。
service-endpoint-gateway-api appliance read <id>
ID を指定してサービスエンドポイントゲートウェイを読み取ります。
service-endpoint-gateway-api appliance create [flags]
スイッチにサービスエンドポイントゲートウェイを作成します。サービスエンドポイントゲートウェイはスイッチ単体でのみ利用でき、ルータ＋スイッチでは作成できません。1
つのスイッチに対して複数のサービスエンドポイントゲートウェイを作成することはできません。作成には接続先スイッチ ID
とゲートウェイに割り当てるサブネットマスク長が必要です。--request は Appliance.Remark に
Switch.ID、Network.NetworkMaskLen、Servers[].IPAddress を指定する JSON を受け付け、Class
と Plan は自動設定されます。--request と個別フラグは併用できません。
service-endpoint-gateway-api appliance update <id> [flags]
サービスエンドポイントゲートウェイの接続先マネージドサービス設定を更新します。Settings は全体置換です。既存の設定を維持したい項目は
JSON に再指定してください。EnabledServices には接続先マネージドサービスを Type と Config で指定します (Type:
ObjectStorage、ContainerRegistry、MonitoringSuite、AppRunDedicatedControlPlane
など)。MonitoringSuite と DNSForwarding の Enabled は True または False です。設定の反映は
apply で行います。
service-endpoint-gateway-api appliance apply <id>
update
で変更した設定をサービスエンドポイントゲートウェイへ反映します。接続先マネージドサービスの変更時、ゲートウェイ経由の通信が一時的に中断することがあります。
service-endpoint-gateway-api appliance delete <id>
ID を指定してサービスエンドポイントゲートウェイを削除します。削除前に対象 ID を確認してください。
service-endpoint-gateway-api appliance read-interface <appliance-id> <interface-id>
サービスエンドポイントゲートウェイのインターフェース情報を取得します。ゲートウェイの IPv4 アドレスは、利用するサーバーの DNS 設定に使います。
service-endpoint-gateway-api appliance read-power-status <id>
サービスエンドポイントゲートウェイの電源状態を取得します。
service-endpoint-gateway-api appliance power-on <id>
サービスエンドポイントゲートウェイの電源を投入します。作成直後は起動処理が行われていることがあります。
service-endpoint-gateway-api appliance shutdown <id>
サービスエンドポイントゲートウェイの電源を停止します。ゲートウェイ経由の通信が停止します。
service-endpoint-gateway-api appliance reset <id>
サービスエンドポイントゲートウェイの電源を再起動します。ゲートウェイ経由の通信が一時的に中断します。
skr service-endpoint-gateway-api appliance list
Usage: skr service-endpoint-gateway-api appliance list
サービスエンドポイントゲートウェイを一覧表示します。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr service-endpoint-gateway-api appliance read
Usage: skr service-endpoint-gateway-api appliance read <id>
ID を指定してサービスエンドポイントゲートウェイを読み取ります。
Arguments:
<id> list の出力にあるサービスエンドポイントゲートウェイのリソース ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr service-endpoint-gateway-api appliance create
Usage: skr service-endpoint-gateway-api appliance create [flags]
スイッチにサービスエンドポイントゲートウェイを作成します。サービスエンドポイントゲートウェイはスイッチ単体でのみ利用でき、ルータ＋スイッチでは作成できません。1
つのスイッチに対して複数のサービスエンドポイントゲートウェイを作成することはできません。作成には接続先スイッチ ID
とゲートウェイに割り当てるサブネットマスク長が必要です。--request は Appliance.Remark に
Switch.ID、Network.NetworkMaskLen、Servers[].IPAddress を指定する JSON を受け付け、Class と
Plan は自動設定されます。--request と個別フラグは併用できません。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP
リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
--request=REQUEST API リクエスト JSON を直接または @path.json
で指定します。個別フラグと併用できません。Appliance.Remark に
Switch.ID、Network.NetworkMaskLen、Servers[].IPAddress
を指定します。Class と Plan は自動的に設定されます。
--switch-id=SWITCH-ID 必須: 接続先スイッチの
ID。スイッチ単体が対象で、ルータ＋スイッチでは利用できません。iaas-api
switch list で確認できます。
--network-mask-len=NETWORK-MASK-LEN
必須: サービスエンドポイントゲートウェイに割り当てるサブネットマスク長。例: 24
--server-ip=SERVER-IP,... 任意: サービスエンドポイントゲートウェイに割り当てる IPv4 アドレス
(ゲートウェイアドレス)。ネットマスク長とともにゲートウェイのサブネットを構成します。例:
--server-ip 192.168.2.110
skr service-endpoint-gateway-api appliance update
Usage: skr service-endpoint-gateway-api appliance update <id> [flags]
サービスエンドポイントゲートウェイの接続先マネージドサービス設定を更新します。Settings は全体置換です。既存の設定を維持したい項目は
JSON に再指定してください。EnabledServices には接続先マネージドサービスを Type と Config で指定します (Type:
ObjectStorage、ContainerRegistry、MonitoringSuite、AppRunDedicatedControlPlane
など)。MonitoringSuite と DNSForwarding の Enabled は True または False です。設定の反映は apply
で行います。
Arguments:
<id> 更新するサービスエンドポイントゲートウェイのリソース ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
--request=REQUEST Appliance.Settings を含むリクエスト
JSON。ServiceEndpointGateway 配下に EnabledServices
(Type と Config.Endpoints)、MonitoringSuite
(Enabled)、DNSForwarding
(Enabled、PrivateHostedZone、UpstreamDNS1、UpstreamDNS2)
を指定します。Settings は全体置換です。直接 JSON または
@path.json。例: skr service-endpoint-gateway-api
appliance update ID --request
'{"Appliance":{"Settings":{"ServiceEndpointGateway":{"EnabledServices":[{"Type":"ObjectStorage","Config":{"Endpoints":["s3.isk01.sakurastorage.jp"]}]}}}}}'
skr service-endpoint-gateway-api appliance apply
Usage: skr service-endpoint-gateway-api appliance apply <id>
update
で変更した設定をサービスエンドポイントゲートウェイへ反映します。接続先マネージドサービスの変更時、ゲートウェイ経由の通信が一時的に中断することがあります。
Arguments:
<id> 設定を反映するサービスエンドポイントゲートウェイのリソース ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr service-endpoint-gateway-api appliance delete
Usage: skr service-endpoint-gateway-api appliance delete <id>
ID を指定してサービスエンドポイントゲートウェイを削除します。削除前に対象 ID を確認してください。
Arguments:
<id> 削除するサービスエンドポイントゲートウェイのリソース ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr service-endpoint-gateway-api appliance read-interface
Usage: skr service-endpoint-gateway-api appliance read-interface <appliance-id> <interface-id>
サービスエンドポイントゲートウェイのインターフェース情報を取得します。ゲートウェイの IPv4 アドレスは、利用するサーバーの DNS 設定に使います。
Arguments:
<appliance-id> サービスエンドポイントゲートウェイのリソース ID。
<interface-id> 参照するインターフェースのスイッチ ID。read の Interfaces にある Switch で確認できます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr service-endpoint-gateway-api appliance read-power-status
Usage: skr service-endpoint-gateway-api appliance read-power-status <id>
サービスエンドポイントゲートウェイの電源状態を取得します。
Arguments:
<id> サービスエンドポイントゲートウェイのリソース ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr service-endpoint-gateway-api appliance power-on
Usage: skr service-endpoint-gateway-api appliance power-on <id>
サービスエンドポイントゲートウェイの電源を投入します。作成直後は起動処理が行われていることがあります。
Arguments:
<id> 電源を投入するサービスエンドポイントゲートウェイのリソース ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr service-endpoint-gateway-api appliance shutdown
Usage: skr service-endpoint-gateway-api appliance shutdown <id>
サービスエンドポイントゲートウェイの電源を停止します。ゲートウェイ経由の通信が停止します。
Arguments:
<id> 電源を停止するサービスエンドポイントゲートウェイのリソース ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
skr service-endpoint-gateway-api appliance reset
Usage: skr service-endpoint-gateway-api appliance reset <id>
サービスエンドポイントゲートウェイの電源を再起動します。ゲートウェイ経由の通信が一時的に中断します。
Arguments:
<id> 再起動するサービスエンドポイントゲートウェイのリソース ID。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query 'map({ID,Name})'
http
skr http
Usage: skr http <url> [flags]
SDK の認証情報を使って HTTPS URL に直接リクエストを送ります。指定したホストへアカウントの認証情報が送信されるため、信頼できる
API エンドポイントだけを指定してください。レスポンス本文は形式を変えずに出力し、--query による加工は行いません。例: skr http
'https://api.example.test/path' --method GET
Arguments:
<url> 呼び出す HTTPS URL。指定したホストへ SDK の認証情報が送信されます。
Flags:
-h, --help Show context-sensitive help.
--trace SDK の HTTP リクエストとレスポンスをトレースします。認証情報などが出力される場合があります。
--version Print version information and quit.
--query=QUERY jq 式で API の JSON 出力を加工します。例: --query
'map({ID,Name})'
-X, --method="GET" HTTP メソッド。省略時は GET です。例: PATCH
-d, --data=DATA リクエスト本文。文字列、@ファイルパス、または
-（標準入力）を指定します。秘密情報を含む本文はファイルまたは標準入力で渡してください。
-H, --header=HEADER,... 追加する HTTP ヘッダー。'名前: 値' の形式で複数指定できます。