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 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 disk-plan find [flags]
指定したゾーンで利用できるディスクプランを検索して出力します。API の Availability と Size (サイズ、単位、利用可否)
を確認できます。例: skr iaas-api disk-plan find --zone is1b
iaas-api disk-plan read [flags]
指定したゾーンと ID のディスクプランを読み取って出力します。API の Availability と Size (サイズ、単位、利用可否)
を確認できます。例: skr iaas-api disk-plan read --zone ZONE --id 4
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 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 zone find [flags]
ゾーン一覧を取得します。名前の抽出例: skr iaas-api zone find --query 'map(.Name)'
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>
受信したメッセージを削除します。
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
ワーカノードのサービスクラス一覧を取得します。
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>
認証ユーザーを削除します。
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]
サービスプリンシパルを更新します。更新後の名前は --name または --request JSON の name に指定してください。
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>
指定したユーザーのセキュリティキーを削除します。
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 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 disk-plan find [flags]
指定したゾーンで利用できるディスクプランを検索して出力します。API の Availability と Size (サイズ、単位、利用可否)
を確認できます。例: skr iaas-api disk-plan find --zone is1b
iaas-api disk-plan read [flags]
指定したゾーンと ID のディスクプランを読み取って出力します。API の Availability と Size (サイズ、単位、利用可否)
を確認できます。例: skr iaas-api disk-plan read --zone ZONE --id 4
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 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 zone find [flags]
ゾーン一覧を取得します。名前の抽出例: skr iaas-api zone find --query 'map(.Name)'
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 とは併用できません。
--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 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 (単一ゾーン名)。任意: Tags は --tags でカンマ区切り、または JSON
配列で指定できます。Count と From は個別フラグ、Names (名前の文字列配列)
と Sort (ソートキーの配列) は JSON で指定します。JSON 例:
--request='{"Zone":"ZONE","Names":["example"]}'。タグのフラグ例:
skr iaas-api disk find --zone ZONE --tags
production,web
--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、変更する項目を1つ以上。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 disk-plan
Usage: skr iaas-api disk-plan <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 disk-plan find [flags]
指定したゾーンで利用できるディスクプランを検索して出力します。API の Availability と Size (サイズ、単位、利用可否)
を確認できます。例: skr iaas-api disk-plan find --zone is1b
iaas-api disk-plan read [flags]
指定したゾーンと ID のディスクプランを読み取って出力します。API の Availability と Size (サイズ、単位、利用可否)
を確認できます。例: skr iaas-api disk-plan read --zone ZONE --id 4
skr iaas-api disk-plan find
Usage: skr iaas-api disk-plan find [flags]
指定したゾーンで利用できるディスクプランを検索して出力します。API の Availability と Size (サイズ、単位、利用可否)
を確認できます。例: skr iaas-api disk-plan 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 (名前の文字列配列) と
Sort は JSON で指定します。Count と From は個別フラグです。例:
--request='{"Zone":"ZONE","Names":["PLAN-NAME"]}'。ZONE
と名前は実際の値に置き換えます。
--zone=ZONE 必須: 対象ゾーン名。例: --zone is1b
--count=COUNT 任意: 取得件数 (整数)。
--from=FROM 任意: 取得開始位置 (整数)。
skr iaas-api disk-plan read
Usage: skr iaas-api disk-plan read [flags]
指定したゾーンと ID のディスクプランを読み取って出力します。API の Availability と Size (サイズ、単位、利用可否)
を確認できます。例: skr iaas-api disk-plan 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 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、変更する項目を1つ以上。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 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 (単一ゾーン名)。任意: Tags は --tags でカンマ区切り、または
JSON 配列で指定できます。Count と From は個別フラグ、Names
(名前の文字列配列) と Sort (ソートキーの配列) は JSON で指定します。例:
--request='{"Zone":"tk1v","Names":["example"]}'。フラグ例:
skr iaas-api server find --zone tk1v --tags
production,web
--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
で指定します。共有セグメントまたは未接続です。繰り返し指定でき、指定順に API の
NetworkInterfaces 配列を組み立てます。shared は先頭の NIC
にだけ指定できます。
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
(数値)、変更するフィールドを1つ以上。任意フラグは
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 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)'
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
で検索条件を指定できます。省略時はゾーン一覧を取得します。
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 キーのファイル。キーを直接引数に指定せず、- の場合は標準入力から読み込みます。
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})'
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})'
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]
サービスプリンシパルを更新します。更新後の名前は --name または --request JSON の name に指定してください。
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]
サービスプリンシパルを更新します。更新後の名前は --name または --request JSON の name に指定してください。
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]
サービスプリンシパルを更新します。更新後の名前は --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 は必須です。任意の description は JSON
で指定できます。直接指定するか @path.json で読み込みます。--request と --name
は併用できません。
--name=NAME 必須: 更新後のサービスプリンシパル名。
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。操作対象を確認して指定してください。
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 ヘッダー。'名前: 値' の形式で複数指定できます。