XServer CLI リファレンス — VPSクラウド管理
XServer CLI で、XServer VPS クラウドのVPS・DBサーバー・L4ロードバランサー・NFS・追加IPの申し込みと、電源・ネットワーク・パケットフィルター・SSH Key・OS再インストールなどを操作するコマンドのリファレンスです。
xserver vps-cloud 配下のコマンドを掲載しています。対象サービスは XServer VPS クラウド です。XServer VPS（xserver vps）とは別のサービスです。
各コマンドは XServer VPS クラウド API の1操作に対応します。コマンドの説明は API リファレンスと同じ内容で、CLI 固有の確認・出力の扱いをあわせて記載しています。申込後の自動更新の切り替えと解約はXServerアカウントで行ってください。
インストール
Node.js（v18 以上）がインストールされた環境で、npm からグローバルインストールしてください。
npm install -g xserver-cliインストールせずに即時実行することもできます。
npx xserver-cli vps-cloud vps listバージョン確認
xserver --version認証設定
認証に使用する秘密値はAPIキーのみです。XServerアカウントの「APIキー管理」で、XServer VPS クラウドの権限を設定して発行してください。権限は機能の分類ごとに「すべての操作 / 読み取り専用 / 操作不可」を設定し、新規お申し込みとカタログ（プラン・料金・リージョン・OSイメージ）の参照には、別に新規お申し込みの許可が必要です。読み取り専用のキーは、新規お申し込みの許可があっても申し込めません（カタログの参照だけ利用できます）。操作対象のリソースは個別に指定せず、アカウントの XServer VPS クラウド全体が対象です。
権限がない操作は API が 403 で拒否します。CLI 側で追加の権限チェックは行いません。分類と対象操作は API リファレンスの「認証・権限」 を参照してください。
APIキーの発行手順については、下記マニュアルをご参照ください。
xserver auth login
対話形式でAPIキーを設定します。ログイン時に利用可能なサービス・権限・新規お申し込みの可否・APIキー有効期限を表示してから、名前付きプロファイルに保存します。
xserver auth login
# ✔ APIキーを入力: ****
# 認証情報を検証中...
# ✓ 認証に成功しました
#
# 利用可能なサービス:
# XServer VPS クラウド
# 権限: カスタム
# 対象リソース: すべて
# 新規お申し込み: 許可されていません
#
# APIキー有効期限: 2026-12-31 00:00:00
#
# ✓ プロファイル "default" を保存しました
# 設定ファイル: ~/.config/xserver-cli/config.jsonカスタムのキーでは、分類ごとの権限を xserver me の services.vps_cloud.permissions で確認できます。
--api-keyによる非対話設定もできますが、値がプロセス一覧やシェル履歴へ残る可能性があります。CI/CDでは実行環境のシークレット機能を使用してください。
環境変数
| 環境変数 | 説明 |
|---|---|
XSERVER_API_KEY | APIキー |
※--profile <name>を指定した場合は、環境変数より指定したプロファイルを優先します。
操作対象の指定
VPS・DBサーバー・L4ロードバランサー・NFS・追加IPを操作するコマンドでは、位置引数 <uuid> にAPI用のUUIDを指定します。各 list コマンドの uuid で確認し、service_code で画面のサービスコードと照合してください。VPS・DBサーバー・L4ロードバランサー・NFSの詳細画面に表示される「UUID」は resource_uuid で、<uuid> には使用できません。追加IPは画面にUUIDが表示されないため、address（IPアドレス）または service_code で照合してください。
xserver vps-cloud vps info a1b2c3d4-5678-40ab-8def-1234567890abNIC・プライベートネットワーク・パケットフィルター・振り分け先サーバーはそれぞれのUUID、データベース・DBユーザー・SSH Key は名前で指定します。L4ロードバランサーのリスナーは受信ポート番号で指定します。
一覧の続きを取得
件数が増える一覧は --limit（1〜500、省略時50）と --cursor で取得します。応答の has_more が true の場合は、同じ検索条件・--limit のまま next_cursor を --cursor に指定してください。CLI は自動で続きを取得しません。
xserver --format json vps-cloud vps list --limit 100 --cursor NEXT_CURSORグローバルオプション
| オプション | 説明 | デフォルト |
|---|---|---|
--format <format> | 出力形式（table または json） | table |
--profile <name> | 使用するプロファイル名 | default |
-y, --yes | 破壊的操作の確認プロンプトを承認して実行 | — |
--debug | トラブルシューティング情報を標準エラー出力へ表示 | — |
-V, --version | バージョン番号を表示 | — |
-h, --help | ヘルプを表示 | — |
vps os-reinstall run では --yes 単独では実行できません。新規お申し込みの実申請でも --yes では確認を省略できません。
出力形式
既定では人が読みやすいテーブル形式で出力します。自動処理では --format json を使用できます。確認が必要な操作では、確認メッセージを標準エラー出力へ、最終結果を標準出力へ表示します。
| 操作 | HTTP | CLI の出力 |
|---|---|---|
| 新規お申し込み（VPS・DBサーバー・L4ロードバランサー・NFS） | 202 Accepted | 応答本文の uuid・status（provisioning）と、確認先の location |
| 追加IPの新規お申し込み | 201 Created | 応答本文の uuid・status（active）と location |
| 電源操作・OS再インストール | 202 Accepted（本文なし） | accepted: true と確認先の location |
| 変更・削除 | 200 OK | 処理結果の message。変更後の内容は各取得コマンドで確認します |
| 作成・追加（データベース・DBユーザー・パケットフィルター・ルール・プライベートネットワーク・VPS接続・振り分け先・SSH Key） | 201 Created | 作成されたものの識別子など、サービス側で決まる値と message |
| IPv6の有効化・無効化 | 200 OK | 変更後の ipv6 の設定と message |
location は API が返した Location ヘッダーの値です。CLI は受付時点で終了し、完了までのポーリングは行いません。
新規お申し込みの安全確認
signup はプリペイド残高から料金が支払われる本契約の申込です。新規お申し込みが許可されたAPIキーと十分なプリペイド残高が必要です。1回のコマンドで1商品を申し込みます。
vps-cloud catalog regionsと各商品のcatalog *-plansで、リージョン、プラン、契約期間（periods[].months）と支払総額（periods[].total_price）を確認します。VPSはcatalog vps-imagesでイメージコードも確認します。- 支払総額を
--expected-total-priceに指定し、--agree-to-terms --dry-runを付けて実行して、課金・契約作成を行わずに実行可否と支払額を確認します。料金が変わっていれば dry-run でも 422PRICE_MISMATCHになります。 - 実申請では、同じ
--expected-total-priceに--agree-to-terms --confirm-purchaseを付けて実行します。 - 表示されるサービス利用規約、個人情報の取り扱い、申込内容、税込のお支払い金額を確認し、対話端末へ指定された確認文字列を入力します。
CLI は実申請の直前にも dry-run を行い、金額が --expected-total-price と一致しない場合は申込を中止します。課金を伴う実申請は対話端末でのみ実行でき、--yes では確認を省略できません。CI/CDなどの非対話環境では --dry-run のみ利用してください。
--period はプランの periods[].months から指定してください。CLI は月数を固定せず、そのまま API へ送ります。--auto-renew は省略すると有効（API既定）になります。無効にする場合は --auto-renew false を指定してください。
実申請の冪等性キーは省略するとCLIが自動生成し、標準エラー出力へ表示します。入力不備・残高不足・価格不一致などで却下された応答も、そのキーの結果として記録されます。同じキーで内容を変えて送ると 422 VALIDATION_ERROR になるため、内容を修正して再実行するときは新しいキーを使ってください（省略すれば自動生成されます）。応答を受け取れなかった場合やサーバーエラーの場合は、まず同じキー・同じ内容で再実行してください。処理中、またはサービスへの実行を開始した後に5xxとなり結果が確定していない場合は、48時間 409 DUPLICATE_REQUEST を返し続けることがあります。その場合は再送を続けないでください。各 list コマンドとXServerアカウントの契約・支払状況を確認し、未実行と確認できた場合のみ新しいキーで再申請してください。
非同期処理の確認
| 操作 | 完了の確認先 |
|---|---|
| VPS・DBサーバー・L4ロードバランサー・NFS の新規お申し込み | 各 info <uuid> の status が active になれば利用可能です。構築完了まで10分程度が目安です。error の場合は再申込せずサポートへお問い合わせください。 |
| 電源操作（start / stop / reboot） | 各 power status <uuid>。L4ロードバランサーは can_start / can_stop もあわせて確認します。DBサーバーは status だけで確認し、起動中は processing です（processing_action は常に null）。processing が10分以上続く場合はサポートへお問い合わせください。 |
| OS再インストール | vps os-reinstall status <uuid> の status が completed で完了、error は失敗です。 |
状態の確認は10秒以上空けて行ってください。同じ状態への電源操作は 409 INVALID_POWER_STATE になります。電源操作・作成系コマンドは --idempotency-key を指定でき、通信断からの再送時に重複を防げます。
OS再インストール
OS再インストールを実行すると、サーバー内のデータは削除されます。必要なデータは、あらかじめバックアップを取ったうえで実行してください。
--confirm-reinstallが必須です。--yes単独では実行できません。対話時は「<uuid> のOS再インストールを承認」を正確に入力します。非対話では--yesと--confirm-reinstallの両方が必要です。- VPSを停止してから実行してください。稼働中の場合は
409 INVALID_POWER_STATE（VPSを停止してからOS再インストールを実行してください）で拒否されます。停止はvps-cloud vps power stopで行えます。 - 処理中の受付がある場合は
409 OPERATION_IN_PROGRESSになります。 - 前回の処理が失敗したまま残っている場合は
409 FEATURE_UNAVAILABLEになります。サポートへお問い合わせください。 - 冪等性キーは必須で、
--idempotency-keyを省略するとCLIが自動生成し、標準エラー出力へ表示します。
操作保護
vps-cloud vps protection set <uuid> --os-reinstall true にしたVPSは、どのAPIキーからの再インストールも 409 PROTECTED で拒否されます。再インストールするときだけ false に戻してください。現在の設定は vps-cloud vps protection get <uuid> で確認できます。画面からの操作には影響しません。
再インストールの流れ
vps-cloud vps os-images <uuid>でイメージコードとセットアップスクリプトコードを取得します。- 操作保護を有効にしているVPSでは
vps-cloud vps protection set <uuid> --os-reinstall falseにします。 vps-cloud vps power stop <uuid>→vps-cloud vps power status <uuid>でstoppedを確認します。vps-cloud vps os-reinstall run ... --confirm-reinstallを実行します。vps-cloud vps os-reinstall status <uuid>でcompletedを確認します。
破壊的操作の安全確認
削除（データベース・DBユーザー・振り分け先サーバー・プライベートネットワーク・パケットフィルターとルール・SSH Key）と、割り当て・接続の解除（追加IP・パケットフィルター・接続先データベース・ネットワーク接続）では、CLIが対象を表示して確認します。既定の回答は No です。自動実行で確認を省略する場合のみ --yes を指定してください。
OS再インストールは上記と別の確認です。--yes では省略できません。
秘密値の取り扱い
- rootパスワードやDBユーザーのパスワードをコマンドへ直接指定すると、プロセス一覧やシェル履歴へ残る可能性があります。共有端末での実行を避け、履歴・CIログ・実行権限を適切に管理してください。
--debugではリクエスト本文のパスワードとセットアップスクリプトの指定を伏せ字にして表示します。それ以外の内容は出力されるため、共有前に必ず確認してください。
レート制限エラー
APIの利用上限を超えた場合、CLIは RATE_LIMIT_EXCEEDED エラーを表示して終了します。HTTPレスポンスに Retry-After ヘッダーが含まれる場合は、その秒数を目安に待ってから再実行してください。
| 対象 | リクエスト/分 | リクエスト/日 | 同時接続数 |
|---|---|---|---|
| VPSクラウドAPI全体（1アカウントあたり） | 60 | 10,000 | 5 |
キーを増やしても上限は増えません。再送・状態確認も件数に含みます。
APIキー情報
xserver me
現在認証に使用しているAPIキーの情報を取得します。VPSクラウドの権限は services.vps_cloud に、権限の種類（すべての操作 / 読み取り専用 / カスタム）、分類ごとの権限（permissions、カスタムのときだけ）、新規お申し込みの可否（allow_signup）として含まれます。auth login でも同じ内容を表示します。
使用例
xserver mexserver --format json meカタログ
xserver vps-cloud catalog regions
リージョンと、そのリージョンで利用できるサービス種別を返します。返されたリージョンIDを申込・カタログ取得に指定してください。参照には、APIキーの新規お申し込みの許可（allow_signup）が必要です。
API: GET /v1/vps-cloud/catalog/regions
使用例
xserver vps-cloud catalog regionsxserver vps-cloud catalog vps-plans [options]
現在利用可能な組み合わせと税込料金を返します。固定値を埋め込まず、申込直前に本APIとdry_runで最新値を確認してください。参照には、APIキーの新規お申し込みの許可（allow_signup）が必要です。
API: GET /v1/vps-cloud/catalog/linux-vps-plans
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--region <region> | 任意 | 利用リージョン。未指定時は全リージョンで利用可能な組み合わせ |
--plan-id <ids> | 任意 | 公開プランID（カンマ区切りで複数指定可） |
使用例
xserver vps-cloud catalog vps-plansxserver vps-cloud catalog database-plans [options]
現在利用可能な組み合わせと税込料金を返します。固定値を埋め込まず、申込直前に本APIとdry_runで最新値を確認してください。参照には、APIキーの新規お申し込みの許可（allow_signup）が必要です。
API: GET /v1/vps-cloud/catalog/database-plans
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--region <region> | 任意 | 利用リージョン。未指定時は全リージョンで利用可能な組み合わせ |
--plan-id <ids> | 任意 | 公開プランID（カンマ区切りで複数指定可） |
使用例
xserver vps-cloud catalog database-plansxserver vps-cloud catalog load-balancer-plans [options]
現在利用可能な組み合わせと税込料金を返します。固定値を埋め込まず、申込直前に本APIとdry_runで最新値を確認してください。参照には、APIキーの新規お申し込みの許可（allow_signup）が必要です。
API: GET /v1/vps-cloud/catalog/load-balancer-plans
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--region <region> | 任意 | 利用リージョン。未指定時は全リージョンで利用可能な組み合わせ |
--plan-id <ids> | 任意 | 公開プランID（カンマ区切りで複数指定可） |
使用例
xserver vps-cloud catalog load-balancer-plansxserver vps-cloud catalog nfs-plans [options]
現在利用可能な組み合わせと税込料金を返します。固定値を埋め込まず、申込直前に本APIとdry_runで最新値を確認してください。参照には、APIキーの新規お申し込みの許可（allow_signup）が必要です。
API: GET /v1/vps-cloud/catalog/nfs-plans
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--region <region> | 任意 | 利用リージョン。未指定時は全リージョンで利用可能な組み合わせ |
--plan-id <ids> | 任意 | 公開プランID（カンマ区切りで複数指定可） |
使用例
xserver vps-cloud catalog nfs-plansxserver vps-cloud catalog ip-address-plans [options]
現在利用可能な組み合わせと税込料金を返します。固定値を埋め込まず、申込直前に本APIとdry_runで最新値を確認してください。参照には、APIキーの新規お申し込みの許可（allow_signup）が必要です。
API: GET /v1/vps-cloud/catalog/ip-address-plans
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--region <region> | 任意 | 利用リージョン。未指定時は全リージョンで利用可能な組み合わせ |
--plan-id <ids> | 任意 | 公開プランID（カンマ区切りで複数指定可） |
使用例
xserver vps-cloud catalog ip-address-plansxserver vps-cloud catalog vps-images --region <region>
指定リージョンのOSイメージとセットアップスクリプトを返します。プランによる絞り込みは行いません。申込時の利用可否はdry_runで確認してください。参照には、APIキーの新規お申し込みの許可（allow_signup）が必要です。name・family・versionは表示用で、OS再インストール用の一覧（/linux-vps/{uuid}/os-images）と申込用の一覧（/catalog/linux-vps-images）で表記が異なることがあります。指定にはcodeを使ってください。
API: GET /v1/vps-cloud/catalog/linux-vps-images
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--region <region> | 必須 | 公開リージョンID |
使用例
xserver vps-cloud catalog vps-images --region tokyo01VPS
xserver vps-cloud vps list [options]
認証したアカウントのVPSを返します。状態・名前で絞り込めます。続きはnext_cursorで取得します。
API: GET /v1/vps-cloud/linux-vps
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--status <status> | 任意 | 提供状態の完全一致（provisioning / active / suspended / error） |
--name <name> | 任意 | 表示名の部分一致 |
--limit <n> | 任意 | 取得件数（1〜500、省略時50） |
--cursor <cursor> | 任意 | 前回応答の next_cursor（--limit を含め、他の検索条件は変更しない） |
使用例
xserver vps-cloud vps listxserver vps-cloud vps info <uuid>
指定したAPI用UUIDのVPS詳細を返します。存在しない、または別アカウントのUUIDは404を返します。
API: GET /v1/vps-cloud/linux-vps/{uuid}
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
使用例
xserver vps-cloud vps info a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud vps signup --image-code <code> --root-password <password> --region <region> --plan-id <id> --period <months> --name <name> --expected-total-price <yen> --agree-to-terms [options]
VPSをプリペイド残高で申し込みます。カタログ（プラン一覧）で確認したperiods[].total_priceをexpected_total_priceへ指定し、実申込の前に同じリクエスト本文でdry_run=trueを実行して、支払総額を確認してください。実申込は202 Acceptedと作成対象のUUID、status=provisioningを返します。構築完了まで10分程度が目安で、状況により前後します。Locationのリソース詳細を10秒以上空けて取得し、statusがactiveになれば利用可能です。errorの場合は構築に失敗しているため、再申込せずXServerアカウントの契約・支払状況を確認してサポートへお問い合わせください。読み取り専用（read）のキーは、allow_signupが有効でも申し込めません。詳細取得には対象商品の参照権限も必要です。
catalog vps-plans で支払総額（periods[].total_price）を確認して --expected-total-price に指定し、実申込前に --agree-to-terms --dry-run で実行可否と支払額を確認してください。料金が変わっていれば --dry-run でも 422 PRICE_MISMATCH になり、実申込を中止します。実申込には --confirm-purchase と対話端末での確認文字列の入力が必要で、--yes では省略できません（ページ上部の「新規お申し込みの安全確認」を参照）。
受付は 202 Accepted で、CLI は構築完了を待ちません。応答の uuid で info を実行し、status が active になったことを確認してください。
API: POST /v1/vps-cloud/linux-vps
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--image-code <code> | 必須 | VPSイメージ一覧（catalog vps-images）が返したイメージコード |
--setup-script-code <code> | 任意 | 選択イメージの setup_scripts[].code |
--root-password <password> | 必須 | rootパスワード（9〜70文字の半角英数・記号。英字・数字・記号のうち2種以上。空白・バッククォート・山括弧は不可） |
--ssh-key-name <name> | 任意 | 登録済み、または同時登録するSSHキー名 |
--ssh-public-key <key> | 任意 | 同時登録するOpenSSH公開鍵（--ssh-key-name と併用）。同じ名前で同じ鍵が登録済みなら、登録済みのキーをそのまま使用。コメントに制御文字・絵文字など4バイトの文字は使えません |
--region <region> | 必須 | リージョン一覧が返した公開リージョンID |
--plan-id <id> | 必須 | catalog vps-plans が返した公開プランID |
--period <months> | 必須 | 契約期間（月）。catalog vps-plans の periods[].months から指定 |
--name <name> | 必須 | リソースの表示名（1〜50文字の英小文字・数字・ハイフン・アンダースコア。コントロールパネルの申込と同じ） |
--memo <memo> | 任意 | メモ（最大500文字。絵文字・韓国語・€ など、一部の文字は使えません。〜・−・¥ などの記号は、見た目が同じ全角の文字に置き換えて保存します） |
--expected-total-price <yen> | 必須 | catalog vps-plans が返した periods[].total_price（税込支払総額） |
--auto-renew <bool> | 任意 | 自動更新（true / false。省略時は true） |
--partner-code <code> | 任意 | お取次店コード（半角英数字50文字以内）。存在しないコードでもエラーにならず、お申し込みは成立します |
--dry-run | 任意 | 課金・契約作成を行わず実行可否と料金だけを検証 |
--confirm-purchase | 任意 | 課金を伴う申請を明示的に確認 |
--agree-to-terms | 必須 | 利用規約・個人情報の取り扱いに同意 |
--idempotency-key <key> | 任意 | 実申込の冪等性キー（英数字・_・-の8～64文字。省略時は自動生成） |
使用例
xserver vps-cloud vps signup --image-code IMAGE_CODE --root-password "MyPassw0rd-2026" --region tokyo01 --plan-id PLAN_ID --period 1 --name web-01 --expected-total-price TOTAL_PRICE --agree-to-terms --dry-runxserver vps-cloud vps signup --image-code IMAGE_CODE --root-password "MyPassw0rd-2026" --region tokyo01 --plan-id PLAN_ID --period 1 --name web-01 --expected-total-price TOTAL_PRICE --agree-to-terms --confirm-purchasexserver vps-cloud vps name update <uuid> --name <name>
表示名を変更します。1〜64文字の英数字・ハイフン・アンダースコアを指定できます（申込時より使える文字が広い）。変更後の内容は詳細APIで確認できます。前回の処理が失敗したまま残っている場合は409 FEATURE_UNAVAILABLEを返します。サポートへお問い合わせください。
API: PUT /v1/vps-cloud/linux-vps/{uuid}/name
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--name <name> | 必須 | 新しい表示名（1〜64文字の英数字・ハイフン・アンダースコア） |
使用例
xserver vps-cloud vps name update a1b2c3d4-5678-40ab-8def-1234567890ab --name web-01xserver vps-cloud vps memo update <uuid> --memo <memo>
メモを変更します。空文字はメモ削除として扱います。
API: PUT /v1/vps-cloud/linux-vps/{uuid}/memo
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--memo <memo> | 必須 | メモ（最大500文字。絵文字・韓国語・€ など、一部の文字は使えません。〜・−・¥ などの記号は、見た目が同じ全角の文字に置き換えて保存します）。空文字で削除 |
使用例
xserver vps-cloud vps memo update a1b2c3d4-5678-40ab-8def-1234567890ab --memo "本番環境"xserver vps-cloud vps power status <uuid>
電源状態と現在実行可能な操作を返します。
API: GET /v1/vps-cloud/linux-vps/{uuid}/power
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
使用例
xserver vps-cloud vps power status a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud vps power start <uuid> [options]
電源操作を受け付けます。レスポンスボディは返さず、Locationの電源状態の取得APIを10秒以上空けて確認してください。すでに起動している場合は409 INVALID_POWER_STATE、電源の処理中（電源状態のstatusがprocessing）は409 OPERATION_IN_PROGRESSです。操作できるかは電源状態のcan_start / can_stop / can_rebootで確認できます。前回の処理が失敗したまま残っている場合は409 FEATURE_UNAVAILABLEを返します。サポートへお問い合わせください。
CLI は受付時点で終了し、完了は待ちません。進捗は power status で確認してください（ページ上部の「非同期処理の確認」を参照）。
API: POST /v1/vps-cloud/linux-vps/{uuid}/power/start
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--idempotency-key <key> | 任意 | 再送時の重複を防ぐキー（英数字・_・-の8～64文字） |
使用例
xserver vps-cloud vps power start a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud vps power reboot <uuid> [options]
電源操作を受け付けます。レスポンスボディは返さず、Locationの電源状態の取得APIを10秒以上空けて確認してください。停止中の場合は409 INVALID_POWER_STATE、電源の処理中（電源状態のstatusがprocessing）は409 OPERATION_IN_PROGRESSです。操作できるかは電源状態のcan_start / can_stop / can_rebootで確認できます。前回の処理が失敗したまま残っている場合は409 FEATURE_UNAVAILABLEを返します。サポートへお問い合わせください。
CLI は受付時点で終了し、完了は待ちません。進捗は power status で確認してください（ページ上部の「非同期処理の確認」を参照）。
API: POST /v1/vps-cloud/linux-vps/{uuid}/power/reboot
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--idempotency-key <key> | 任意 | 再送時の重複を防ぐキー（英数字・_・-の8～64文字） |
使用例
xserver vps-cloud vps power reboot a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud vps power stop <uuid> [options]
電源操作を受け付けます。レスポンスボディは返さず、Locationの電源状態の取得APIを10秒以上空けて確認してください。すでに停止している場合は409 INVALID_POWER_STATE、電源の処理中（電源状態のstatusがprocessing）は409 OPERATION_IN_PROGRESSです。操作できるかは電源状態のcan_start / can_stop / can_rebootで確認できます。前回の処理が失敗したまま残っている場合は409 FEATURE_UNAVAILABLEを返します。サポートへお問い合わせください。
CLI は受付時点で終了し、完了は待ちません。進捗は power status で確認してください（ページ上部の「非同期処理の確認」を参照）。
API: POST /v1/vps-cloud/linux-vps/{uuid}/power/stop
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--idempotency-key <key> | 任意 | 再送時の重複を防ぐキー（英数字・_・-の8～64文字） |
使用例
xserver vps-cloud vps power stop a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud vps metrics <uuid> --metrics <list> --from <datetime> --to <datetime> [options]
指定期間[from,to)の時系列を昇順で返します。cpuは%、disk_read/writeはMB/s、network_in/outは各区間の転送量MBです（10進単位）。データは5分間隔で記録され、granularity=3600は1時間ごとに1点（CPU・ディスクI/Oは1時間の平均、転送量は1時間の合計）として返します。from/toはデータ点の境界に揃えます。欠測はnull、実測0は0。指定系列を入力順で返し、重複・未知metricは422。期間は最大30日かつ1系列1,000点で、granularity=300（省略時）では約3.4日までです。10秒以上空けて取得してください。
API: GET /v1/vps-cloud/linux-vps/{uuid}/metrics
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--metrics <list> | 必須 | 取得する metric のカンマ区切り（cpu / disk_read / disk_write / network_in / network_out） |
--from <datetime> | 必須 | 取得期間の開始日時（例 2026-09-06T00:00:00+09:00）。秒・タイムゾーンは省略可（タイムゾーンを省略すると日本時間）。日付だけは不可 |
--to <datetime> | 必須 | 取得期間の終了日時（--from と同じ書き方）。from より後 |
--granularity <seconds> | 任意 | データ点の間隔（秒）。300 または 3600、省略時 300。指定できる期間は 300 で約3.4日、3600 で30日まで |
使用例
xserver vps-cloud vps metrics a1b2c3d4-5678-40ab-8def-1234567890ab --metrics cpu,network_in --from 2026-10-01T00:00:00+09:00 --to 2026-10-02T00:00:00+09:00xserver vps-cloud vps os-images <uuid>
対象VPSのプラン・リージョンでOS再インストールに指定できるOSイメージとセットアップスクリプトを返します。name・family・versionは表示用で、OS再インストール用の一覧（/linux-vps/{uuid}/os-images）と申込用の一覧（/catalog/linux-vps-images）で表記が異なることがあります。指定にはcodeを使ってください。
API: GET /v1/vps-cloud/linux-vps/{uuid}/os-images
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
使用例
xserver vps-cloud vps os-images a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud vps os-reinstall run <uuid> --image-code <code> --root-password <password> --confirm-reinstall [options]
対象VPSを指定したOSイメージで再インストールします。サーバー内のデータは削除されるため、必要なデータは事前にバックアップしてください。rootパスワードは応答・ログへ返しません。VPSを停止してから実行してください。稼働中の場合は409 INVALID_POWER_STATE（VPSを停止してからOS再インストールを実行してください）を返し、実行しません。処理中の受付がある場合は409 OPERATION_IN_PROGRESSになります。前回の処理が失敗したまま残っている場合は409 FEATURE_UNAVAILABLEを返します。サポートへお問い合わせください。操作保護（protection.os_reinstall）がtrueの場合は409 PROTECTEDを返し、実行しません。202は受付を表し、Locationの再インストール状態を10秒以上空けて取得して完了を確認します。
--confirm-reinstall は必須です。--yes だけでは実行できません。対話端末では uuid を含む確認フレーズの入力が必要で、vps-cloud vps os-images 相当でイメージ名を取得して --image-code を照合します。非対話では --yes と --confirm-reinstall の両方が必要です。
誤操作防止には操作保護（vps-cloud vps protection get / set）を使えます。os_reinstall が true のVPSは 409 PROTECTED で拒否されます。前回の処理が失敗したまま残っている場合は 409 FEATURE_UNAVAILABLE になるため、サポートへお問い合わせください。冪等性キーは省略時に自動生成し、標準エラー出力へ表示します。受付後の進捗は vps-cloud vps os-reinstall status で確認してください。
API: POST /v1/vps-cloud/linux-vps/{uuid}/os-reinstall
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--image-code <code> | 必須 | 対象VPSのOSイメージ一覧（vps os-images）が返したイメージコード |
--setup-script-code <code> | 任意 | 選択イメージで利用可能なセットアップスクリプトコード |
--root-password <password> | 必須 | rootパスワード（9〜70文字の半角英数・記号。英字・数字・記号のうち2種以上。空白・バッククォート・山括弧は不可） |
--ssh-key-name <name> | 任意 | 登録済み、または同時登録するSSHキー名 |
--ssh-public-key <key> | 任意 | 同時登録するOpenSSH公開鍵（--ssh-key-name と併用）。同じ名前で同じ鍵が登録済みなら、登録済みのキーをそのまま使用。コメントに制御文字・絵文字など4バイトの文字は使えません |
--idempotency-key <key> | 任意 | 冪等性キー（英数字・_・-の8～64文字。省略時は自動生成） |
--confirm-reinstall | 必須 | データ全消去を承認（必須。--yes では省略不可） |
-y, --yes | 任意 | 非対話実行時に、--confirm-reinstall と併用して確認を承認 |
使用例
xserver vps-cloud vps os-reinstall run a1b2c3d4-5678-40ab-8def-1234567890ab --image-code IMAGE_CODE --root-password "MyPassw0rd-2026" --confirm-reinstallxserver --yes vps-cloud vps os-reinstall run a1b2c3d4-5678-40ab-8def-1234567890ab --image-code IMAGE_CODE --root-password "MyPassw0rd-2026" --confirm-reinstallxserver vps-cloud vps os-reinstall status <uuid>
対象VPSの直近の再インストール状態を返します。not_startedは実行履歴なし、processingは受付済み・再インストール中、completedは利用可能な状態まで完了、errorは失敗です。画面で実行した処理も同じVPSの状態として扱います。失敗時は新しい申込を行わず、サポートへお問い合わせください。
API: GET /v1/vps-cloud/linux-vps/{uuid}/os-reinstall
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
使用例
xserver vps-cloud vps os-reinstall status a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud vps protection get <uuid>
API経由のOS再インストールの誤操作を防ぐための保護設定を返します。設定はVPS単位で、操作するAPIキーにかかわらず適用されます。初期値はfalseです。画面からの操作には影響しません。
OS再インストール（vps-cloud vps os-reinstall run）の誤操作防止に使います。
API: GET /v1/vps-cloud/linux-vps/{uuid}/protection
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
使用例
xserver vps-cloud vps protection get a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud vps protection set <uuid> --os-reinstall <bool>
API経由のOS再インストールの保護設定を完全置換します。trueの場合、どのAPIキーからの再インストールも409 PROTECTEDで拒否します。再インストールするには先にfalseへ変更してください。画面からの操作には影響しません。
OS再インストール（vps-cloud vps os-reinstall run）の誤操作防止に使います。
API: PUT /v1/vps-cloud/linux-vps/{uuid}/protection
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--os-reinstall <bool> | 必須 | true でAPI経由のOS再インストールを禁止 / false で解除 |
使用例
xserver vps-cloud vps protection set a1b2c3d4-5678-40ab-8def-1234567890ab --os-reinstall truexserver vps-cloud vps port list <uuid> [options]
メインNICとプライベートネットワークのNICを返します。IPv6用のポートは含まず、IPv6設定APIで参照します。続きはnext_cursorで取得します。
API: GET /v1/vps-cloud/linux-vps/{uuid}/ports
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--limit <n> | 任意 | 取得件数（1〜500、省略時50） |
--cursor <cursor> | 任意 | 前回応答の next_cursor（--limit を含め、他の検索条件は変更しない） |
使用例
xserver vps-cloud vps port list a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud vps port info <uuid> <portUuid>
指定したNICのネットワーク・IP・帯域・パケットフィルターを返します。
API: GET /v1/vps-cloud/linux-vps/{uuid}/ports/{port_uuid}
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
<portUuid> | NICのUUID。vps-cloud vps port list の port_uuid |
使用例
xserver vps-cloud vps port info a1b2c3d4-5678-40ab-8def-1234567890ab 5f0c7d2e-1a2b-4c3d-8e4f-5a6b7c8d9e0fxserver vps-cloud vps port assign-ip <uuid> <portUuid> --ip-address <ip>
同一アカウントの追加IP契約のうち、どのNICにも割り当てていないIPv4アドレスを指定し、プライベートネットワークのNICへ割り当てます。割当状況は追加IP詳細APIのassignmentで確認します（追加IP一覧APIには含まれません）。自アカウントの追加IP契約にないIPアドレスは422 VALIDATION_ERROR、他のNICで使用中のIPは409 RESOURCE_IN_USEです。同じIPがすでに割り当てられている場合は、何もせず成功（200）を返します。別のグローバルIPが割当済みの場合は409 ALREADY_EXISTSで、先に解除してから割り当ててください。メインNICには割り当てできません。OS側では、追加IP詳細APIのsubnet_maskを使ってアドレスを設定してください。
API: PUT /v1/vps-cloud/linux-vps/{uuid}/ports/{port_uuid}/additional-ip
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
<portUuid> | NICのUUID。vps-cloud vps port list の port_uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--ip-address <ip> | 必須 | 割り当てる追加IPv4アドレス。vps-cloud ip-address list の address のうち、vps-cloud ip-address info の assignment が null（未割当）のもの |
使用例
xserver vps-cloud vps port assign-ip a1b2c3d4-5678-40ab-8def-1234567890ab 5f0c7d2e-1a2b-4c3d-8e4f-5a6b7c8d9e0f --ip-address 203.0.113.30xserver vps-cloud vps port unassign-ip <uuid> <portUuid> [options]
NICに割り当てられた追加IPv4を解除します。メインNICのグローバルIPは解除できず409 FEATURE_UNAVAILABLEです。未割当のNICは変更せず200を返します。追加IP契約自体は削除しません。
確認プロンプトが出ます（-y / --yes で省略可）。
API: DELETE /v1/vps-cloud/linux-vps/{uuid}/ports/{port_uuid}/additional-ip
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
<portUuid> | NICのUUID。vps-cloud vps port list の port_uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver vps-cloud vps port unassign-ip a1b2c3d4-5678-40ab-8def-1234567890ab 5f0c7d2e-1a2b-4c3d-8e4f-5a6b7c8d9e0fxserver vps-cloud vps port apply-filter <uuid> <portUuid> <filterUuid>
URLで指定したパケットフィルターをNICへ適用します。メインNIC・追加NICのどちらにも適用できます。リクエスト本文はありません。同じパケットフィルターの再PUTは成功扱いです。
API: PUT /v1/vps-cloud/linux-vps/{uuid}/ports/{port_uuid}/packet-filters/{filter_uuid}
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
<portUuid> | NICのUUID。vps-cloud vps port list の port_uuid |
<filterUuid> | パケットフィルターのUUID。vps-cloud packet-filter list の filter_uuid |
使用例
xserver vps-cloud vps port apply-filter a1b2c3d4-5678-40ab-8def-1234567890ab 5f0c7d2e-1a2b-4c3d-8e4f-5a6b7c8d9e0f 8d6cdf93-7e63-4e0f-8268-6dde7f1c12acxserver vps-cloud vps port remove-filter <uuid> <portUuid> <filterUuid> [options]
指定したパケットフィルターをNICから解除します。最後のパケットフィルターを解除すると、未適用となりすべての受信通信が拒否されます。既に解除済みの同じ関連への再DELETEは成功です。
確認プロンプトが出ます（-y / --yes で省略可）。
API: DELETE /v1/vps-cloud/linux-vps/{uuid}/ports/{port_uuid}/packet-filters/{filter_uuid}
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
<portUuid> | NICのUUID。vps-cloud vps port list の port_uuid |
<filterUuid> | パケットフィルターのUUID。vps-cloud packet-filter list の filter_uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver vps-cloud vps port remove-filter a1b2c3d4-5678-40ab-8def-1234567890ab 5f0c7d2e-1a2b-4c3d-8e4f-5a6b7c8d9e0f 8d6cdf93-7e63-4e0f-8268-6dde7f1c12acxserver vps-cloud vps ipv6 get <uuid>
画面の「IPv6」と同じ、IPv6の有効・無効とIPv6用ポートの情報を返します。IPv6は1ポートで提供し、追加IPの割り当て先には指定できません。有効化後のOS側のアドレス設定は利用者が行います（公式マニュアル https://vpscloud.xserver.ne.jp/support/manual/man_server_vps_ipv6.php ）。
API: GET /v1/vps-cloud/linux-vps/{uuid}/ipv6
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
使用例
xserver vps-cloud vps ipv6 get a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud vps ipv6 set <uuid> --enabled <bool>
IPv6の有効・無効を変更し、変更後の設定を返します（割り当てられるアドレスなどはサービス側で決まるため、変更系でも返します）。有効化するとIPv6用ポートとアドレスを割り当て、無効化するとポートを削除して通信できなくなります（enabled=false、addresses=[]、packet_filters=[]、その他の項目はnull）。再有効化時に同じIPv6アドレスが割り当てられる保証はありません。利用者が任意のアドレスを指定することもできません。無効化前にOS側の設定を削除してください。同じ状態への変更は成功として現在の設定を返します。処理中の受付がある場合は409 OPERATION_IN_PROGRESSです。有効化後のOS側のアドレス設定は利用者が行います（公式マニュアル https://vpscloud.xserver.ne.jp/support/manual/man_server_vps_ipv6.php ）。
API: PUT /v1/vps-cloud/linux-vps/{uuid}/ipv6
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--enabled <bool> | 必須 | true で有効 / false で無効 |
使用例
xserver vps-cloud vps ipv6 set a1b2c3d4-5678-40ab-8def-1234567890ab --enabled truexserver vps-cloud vps ipv6 apply-filter <uuid> <filterUuid>
URLで指定したパケットフィルターをIPv6用ポートへ適用します。リクエスト本文はありません。同じパケットフィルターの再PUTは成功扱いです。IPv6が無効の場合は409 FEATURE_UNAVAILABLEです。
API: PUT /v1/vps-cloud/linux-vps/{uuid}/ipv6/packet-filters/{filter_uuid}
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
<filterUuid> | パケットフィルターのUUID。vps-cloud packet-filter list の filter_uuid |
使用例
xserver vps-cloud vps ipv6 apply-filter a1b2c3d4-5678-40ab-8def-1234567890ab 8d6cdf93-7e63-4e0f-8268-6dde7f1c12acxserver vps-cloud vps ipv6 remove-filter <uuid> <filterUuid> [options]
指定したパケットフィルターをIPv6用ポートから解除します。最後のパケットフィルターを解除すると、未適用となりすべての受信通信が拒否されます。既に解除済みの同じ関連への再DELETEは成功です。IPv6が無効の場合は409 FEATURE_UNAVAILABLEです。
確認プロンプトが出ます（-y / --yes で省略可）。
API: DELETE /v1/vps-cloud/linux-vps/{uuid}/ipv6/packet-filters/{filter_uuid}
引数
| 引数 | 説明 |
|---|---|
<uuid> | VPSのAPI用UUID。vps-cloud vps list の uuid（詳細画面の「UUID」＝resource_uuid とは異なります） |
<filterUuid> | パケットフィルターのUUID。vps-cloud packet-filter list の filter_uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver vps-cloud vps ipv6 remove-filter a1b2c3d4-5678-40ab-8def-1234567890ab 8d6cdf93-7e63-4e0f-8268-6dde7f1c12acDBサーバー
xserver vps-cloud database-server list [options]
認証したアカウントのDBサーバーを返します。状態・名前で絞り込めます。続きはnext_cursorで取得します。
API: GET /v1/vps-cloud/database-servers
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--status <status> | 任意 | 提供状態の完全一致（provisioning / active / suspended / error） |
--name <name> | 任意 | 表示名の部分一致 |
--limit <n> | 任意 | 取得件数（1〜500、省略時50） |
--cursor <cursor> | 任意 | 前回応答の next_cursor（--limit を含め、他の検索条件は変更しない） |
使用例
xserver vps-cloud database-server listxserver vps-cloud database-server info <uuid>
指定したAPI用UUIDのDBサーバー詳細を返します。存在しない、または別アカウントのUUIDは404を返します。
API: GET /v1/vps-cloud/database-servers/{uuid}
引数
| 引数 | 説明 |
|---|---|
<uuid> | DBサーバーのAPI用UUID。vps-cloud database-server list の uuid |
使用例
xserver vps-cloud database-server info a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud database-server signup --engine <engine> --engine-version <version> --region <region> --plan-id <id> --period <months> --name <name> --expected-total-price <yen> --agree-to-terms [options]
DBサーバーをプリペイド残高で申し込みます。カタログ（プラン一覧）で確認したperiods[].total_priceをexpected_total_priceへ指定し、実申込の前に同じリクエスト本文でdry_run=trueを実行して、支払総額を確認してください。実申込は202 Acceptedと作成対象のUUID、status=provisioningを返します。構築完了まで10分程度が目安で、状況により前後します。Locationのリソース詳細を10秒以上空けて取得し、statusがactiveになれば利用可能です。errorの場合は構築に失敗しているため、再申込せずXServerアカウントの契約・支払状況を確認してサポートへお問い合わせください。読み取り専用（read）のキーは、allow_signupが有効でも申し込めません。詳細取得には対象商品の参照権限も必要です。
catalog database-plans で支払総額（periods[].total_price）を確認して --expected-total-price に指定し、実申込前に --agree-to-terms --dry-run で実行可否と支払額を確認してください。料金が変わっていれば --dry-run でも 422 PRICE_MISMATCH になり、実申込を中止します。実申込には --confirm-purchase と対話端末での確認文字列の入力が必要で、--yes では省略できません（ページ上部の「新規お申し込みの安全確認」を参照）。
受付は 202 Accepted で、CLI は構築完了を待ちません。応答の uuid で info を実行し、status が active になったことを確認してください。
API: POST /v1/vps-cloud/database-servers
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--engine <engine> | 必須 | データベースエンジン（mariadb / postgresql） |
--engine-version <version> | 必須 | 選択プランの engines[].versions に含まれる値 |
--region <region> | 必須 | リージョン一覧が返した公開リージョンID |
--plan-id <id> | 必須 | catalog database-plans が返した公開プランID |
--period <months> | 必須 | 契約期間（月）。catalog database-plans の periods[].months から指定 |
--name <name> | 必須 | リソースの表示名（1〜50文字の英小文字・数字・ハイフン・アンダースコア。コントロールパネルの申込と同じ） |
--memo <memo> | 任意 | メモ（最大500文字。絵文字・韓国語・€ など、一部の文字は使えません。〜・−・¥ などの記号は、見た目が同じ全角の文字に置き換えて保存します） |
--expected-total-price <yen> | 必須 | catalog database-plans が返した periods[].total_price（税込支払総額） |
--auto-renew <bool> | 任意 | 自動更新（true / false。省略時は true） |
--partner-code <code> | 任意 | お取次店コード（半角英数字50文字以内）。存在しないコードでもエラーにならず、お申し込みは成立します |
--dry-run | 任意 | 課金・契約作成を行わず実行可否と料金だけを検証 |
--confirm-purchase | 任意 | 課金を伴う申請を明示的に確認 |
--agree-to-terms | 必須 | 利用規約・個人情報の取り扱いに同意 |
--idempotency-key <key> | 任意 | 実申込の冪等性キー（英数字・_・-の8～64文字。省略時は自動生成） |
使用例
xserver vps-cloud database-server signup --engine mariadb --engine-version ENGINE_VERSION --region tokyo01 --plan-id PLAN_ID --period 1 --name db-01 --expected-total-price TOTAL_PRICE --agree-to-terms --dry-runxserver vps-cloud database-server signup --engine mariadb --engine-version ENGINE_VERSION --region tokyo01 --plan-id PLAN_ID --period 1 --name db-01 --expected-total-price TOTAL_PRICE --agree-to-terms --confirm-purchasexserver vps-cloud database-server memo update <uuid> --memo <memo>
メモを変更します。空文字はメモ削除として扱います。
API: PUT /v1/vps-cloud/database-servers/{uuid}/memo
引数
| 引数 | 説明 |
|---|---|
<uuid> | DBサーバーのAPI用UUID。vps-cloud database-server list の uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--memo <memo> | 必須 | メモ（最大500文字。絵文字・韓国語・€ など、一部の文字は使えません。〜・−・¥ などの記号は、見た目が同じ全角の文字に置き換えて保存します）。空文字で削除 |
使用例
xserver vps-cloud database-server memo update a1b2c3d4-5678-40ab-8def-1234567890ab --memo "本番環境"xserver vps-cloud database-server power status <uuid>
電源状態と現在実行可能な操作を返します。DBサーバーは起動中にprocessingを返します。異常が起きている場合もprocessingのまま変わらないことがあるため、processingが10分以上続く場合はサポートへお問い合わせください。
API: GET /v1/vps-cloud/database-servers/{uuid}/power
引数
| 引数 | 説明 |
|---|---|
<uuid> | DBサーバーのAPI用UUID。vps-cloud database-server list の uuid |
使用例
xserver vps-cloud database-server power status a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud database-server power start <uuid> [options]
電源操作を受け付けます。レスポンスボディは返さず、Locationの電源状態の取得APIを10秒以上空けて確認してください。すでに起動している場合は409 INVALID_POWER_STATE、電源の処理中（電源状態のstatusがprocessing）は409 OPERATION_IN_PROGRESSです。操作できるかは電源状態のcan_start / can_stop / can_rebootで確認できます。
CLI は受付時点で終了し、完了は待ちません。進捗は power status で確認してください（ページ上部の「非同期処理の確認」を参照）。
API: POST /v1/vps-cloud/database-servers/{uuid}/power/start
引数
| 引数 | 説明 |
|---|---|
<uuid> | DBサーバーのAPI用UUID。vps-cloud database-server list の uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--idempotency-key <key> | 任意 | 再送時の重複を防ぐキー（英数字・_・-の8～64文字） |
使用例
xserver vps-cloud database-server power start a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud database-server power stop <uuid> [options]
電源操作を受け付けます。レスポンスボディは返さず、Locationの電源状態の取得APIを10秒以上空けて確認してください。すでに停止している場合は409 INVALID_POWER_STATE、電源の処理中（電源状態のstatusがprocessing）は409 OPERATION_IN_PROGRESSです。操作できるかは電源状態のcan_start / can_stop / can_rebootで確認できます。
CLI は受付時点で終了し、完了は待ちません。進捗は power status で確認してください（ページ上部の「非同期処理の確認」を参照）。
API: POST /v1/vps-cloud/database-servers/{uuid}/power/stop
引数
| 引数 | 説明 |
|---|---|
<uuid> | DBサーバーのAPI用UUID。vps-cloud database-server list の uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--idempotency-key <key> | 任意 | 再送時の重複を防ぐキー（英数字・_・-の8～64文字） |
使用例
xserver vps-cloud database-server power stop a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud database-server metrics <uuid> --metrics <list> --from <datetime> --to <datetime> [options]
指定期間[from,to)の時系列を昇順で返します。cpuは%、disk_read/writeはMB/s、network_in/outは各区間の転送量MBです（10進単位）。データは5分間隔で記録され、granularity=3600は1時間ごとに1点（CPU・ディスクI/Oは1時間の平均、転送量は1時間の合計）として返します。from/toはデータ点の境界に揃えます。欠測はnull、実測0は0。指定系列を入力順で返し、重複・未知metricは422。期間は最大30日かつ1系列1,000点で、granularity=300（省略時）では約3.4日までです。10秒以上空けて取得してください。
API: GET /v1/vps-cloud/database-servers/{uuid}/metrics
引数
| 引数 | 説明 |
|---|---|
<uuid> | DBサーバーのAPI用UUID。vps-cloud database-server list の uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--metrics <list> | 必須 | 取得する metric のカンマ区切り（cpu / disk_read / disk_write / network_in / network_out） |
--from <datetime> | 必須 | 取得期間の開始日時（例 2026-09-06T00:00:00+09:00）。秒・タイムゾーンは省略可（タイムゾーンを省略すると日本時間）。日付だけは不可 |
--to <datetime> | 必須 | 取得期間の終了日時（--from と同じ書き方）。from より後 |
--granularity <seconds> | 任意 | データ点の間隔（秒）。300 または 3600、省略時 300。指定できる期間は 300 で約3.4日、3600 で30日まで |
使用例
xserver vps-cloud database-server metrics a1b2c3d4-5678-40ab-8def-1234567890ab --metrics cpu,network_in --from 2026-10-01T00:00:00+09:00 --to 2026-10-02T00:00:00+09:00xserver vps-cloud database-server storage <uuid>
画面と同じ利用者データの使用量と契約容量を数値で返します。システム利用領域は使用量に含めません。計測できない場合はused_gb・usage_percentをnullにし、0と区別します。DBサーバーの電源状態が起動や停止の処理中の場合は409 OPERATION_IN_PROGRESS（完了後に再実行してください）、停止中・異常時の場合は409 INVALID_POWER_STATEを返します。
API: GET /v1/vps-cloud/database-servers/{uuid}/storage
引数
| 引数 | 説明 |
|---|---|
<uuid> | DBサーバーのAPI用UUID。vps-cloud database-server list の uuid |
使用例
xserver vps-cloud database-server storage a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud database-server database list <uuid> [options]
DBサーバーに作成済みのデータベースを返します。データベース名を識別子として使用します。DBサーバーの電源状態が起動や停止の処理中の場合は409 OPERATION_IN_PROGRESS（完了後に再実行してください）、停止中・異常時の場合は409 INVALID_POWER_STATEを返します。続きはnext_cursorで取得します。
API: GET /v1/vps-cloud/database-servers/{uuid}/databases
引数
| 引数 | 説明 |
|---|---|
<uuid> | DBサーバーのAPI用UUID。vps-cloud database-server list の uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--limit <n> | 任意 | 取得件数（1〜500、省略時50） |
--cursor <cursor> | 任意 | 前回応答の next_cursor（--limit を含め、他の検索条件は変更しない） |
使用例
xserver vps-cloud database-server database list a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud database-server database create <uuid> --name <name> --charset <charset> [options]
指定したデータベース名と文字コードでデータベースを作成します。同名データベースが存在する場合は409 ALREADY_EXISTSを返します。DBサーバーの電源状態が起動や停止の処理中の場合は409 OPERATION_IN_PROGRESS（完了後に再実行してください）、停止中・異常時の場合は409 INVALID_POWER_STATEを返します。
API: POST /v1/vps-cloud/database-servers/{uuid}/databases
引数
| 引数 | 説明 |
|---|---|
<uuid> | DBサーバーのAPI用UUID。vps-cloud database-server list の uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--name <name> | 必須 | データベース名（英字で始まる1〜30文字の英数字・アンダースコア）。システムデータベース名（MariaDBのmysql・information_schema・performance_schema・sys、PostgreSQLのpostgres・template0・template1。大文字・小文字を区別しない）とSQLの予約語は使えません |
--charset <charset> | 必須 | 文字コード。MariaDB: utf8mb4 / utf8 / latin1 / sjis / binary、PostgreSQL: UTF8 |
--idempotency-key <key> | 任意 | 再送時の重複を防ぐキー（英数字・_・-の8～64文字） |
使用例
xserver vps-cloud database-server database create a1b2c3d4-5678-40ab-8def-1234567890ab --name app_db --charset utf8mb4xserver vps-cloud database-server database delete <uuid> <databaseName> [options]
URLで指定したデータベースを削除します。MariaDBでは、DBユーザーの接続先（grants）に指定されている間は削除せず、409 RESOURCE_IN_USEを返します。DBユーザーの接続先を解除してから削除してください。MariaDBはデータベースを削除しても権限が残り、同じ名前のデータベースを作り直すと、前に接続先にしていたDBユーザーが使えてしまうためです。コントロールパネルでの削除などで、削除済みのデータベース名が接続先に残っている場合、その接続先は解除APIで解除できません（404）。同じ名前のデータベースを作る前に、そのDBユーザーを削除してください。PostgreSQLは削除時に権限も消えるため、接続先に指定されていても削除します。保存されているデータはすべて削除され、元に戻せません。必要なデータは事前にバックアップしてください。DBサーバーの電源状態が起動や停止の処理中の場合は409 OPERATION_IN_PROGRESS（完了後に再実行してください）、停止中・異常時の場合は409 INVALID_POWER_STATEを返します。
確認プロンプトが出ます（-y / --yes で省略可）。
API: DELETE /v1/vps-cloud/database-servers/{uuid}/databases/{database_name}
引数
| 引数 | 説明 |
|---|---|
<uuid> | DBサーバーのAPI用UUID。vps-cloud database-server list の uuid |
<databaseName> | データベース名。vps-cloud database-server database list の name |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver vps-cloud database-server database delete a1b2c3d4-5678-40ab-8def-1234567890ab app_dbxserver vps-cloud database-server user list <uuid> [options]
DBサーバーに作成済みのDBユーザーと接続先データベースを返します。passwordは返しません。DBサーバーの電源状態が起動や停止の処理中の場合は409 OPERATION_IN_PROGRESS（完了後に再実行してください）、停止中・異常時の場合は409 INVALID_POWER_STATEを返します。続きはnext_cursorで取得します。
API: GET /v1/vps-cloud/database-servers/{uuid}/users
引数
| 引数 | 説明 |
|---|---|
<uuid> | DBサーバーのAPI用UUID。vps-cloud database-server list の uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--limit <n> | 任意 | 取得件数（1〜500、省略時50） |
--cursor <cursor> | 任意 | 前回応答の next_cursor（--limit を含め、他の検索条件は変更しない） |
使用例
xserver vps-cloud database-server user list a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud database-server user create <uuid> --name <name> --password <password> [options]
指定したユーザー名とパスワードでDBユーザーを作成します。パスワードはレスポンス・実行ログ・アプリケーションログへ返しません。DBサーバーの電源状態が起動や停止の処理中の場合は409 OPERATION_IN_PROGRESS（完了後に再実行してください）、停止中・異常時の場合は409 INVALID_POWER_STATEを返します。
API: POST /v1/vps-cloud/database-servers/{uuid}/users
引数
| 引数 | 説明 |
|---|---|
<uuid> | DBサーバーのAPI用UUID。vps-cloud database-server list の uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--name <name> | 必須 | DBユーザー名（MariaDB 1〜16文字 / PostgreSQL 1〜63文字。英数字を1文字以上含めます。スラッシュ・バックスラッシュ、日本語など ASCII 以外の文字は使えません）。DBサーバーが管理に使う名前（rootなど）、SQLの予約語、PostgreSQLのpostgres・public・noneとpg_で始まる名前は使えません |
--password <password> | 必須 | パスワード（8〜32文字の半角英数字と _-!*^&） |
--idempotency-key <key> | 任意 | 再送時の重複を防ぐキー（英数字・_・-の8～64文字） |
使用例
xserver vps-cloud database-server user create a1b2c3d4-5678-40ab-8def-1234567890ab --name app_user --password "Passw0rd_2026"xserver vps-cloud database-server user password <uuid> <userName> --password <password>
指定DBユーザーのパスワードを変更します。秘密情報はレスポンスやログへ返しません。DBサーバーの電源状態が起動や停止の処理中の場合は409 OPERATION_IN_PROGRESS（完了後に再実行してください）、停止中・異常時の場合は409 INVALID_POWER_STATEを返します。
API: PUT /v1/vps-cloud/database-servers/{uuid}/users/{user_name}/password
引数
| 引数 | 説明 |
|---|---|
<uuid> | DBサーバーのAPI用UUID。vps-cloud database-server list の uuid |
<userName> | DBユーザー名。vps-cloud database-server user list の name。- で始まる名前は、名前の前に -- を書く。スラッシュを含む名前は指定できない |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--password <password> | 必須 | 新しいパスワード（8〜32文字の半角英数字と _-!*^&） |
使用例
xserver vps-cloud database-server user password a1b2c3d4-5678-40ab-8def-1234567890ab app_user --password "Passw0rd_2026"xserver vps-cloud database-server user delete <uuid> <userName> [options]
指定DBユーザーを削除します。データベース自体は削除しません。接続先（grants）が残っていても削除し、そのユーザーでのデータベース接続はすべてできなくなります。DBサーバーの電源状態が起動や停止の処理中の場合は409 OPERATION_IN_PROGRESS（完了後に再実行してください）、停止中・異常時の場合は409 INVALID_POWER_STATEを返します。
確認プロンプトが出ます（-y / --yes で省略可）。
API: DELETE /v1/vps-cloud/database-servers/{uuid}/users/{user_name}
引数
| 引数 | 説明 |
|---|---|
<uuid> | DBサーバーのAPI用UUID。vps-cloud database-server list の uuid |
<userName> | DBユーザー名。vps-cloud database-server user list の name。- で始まる名前は、名前の前に -- を書く。スラッシュを含む名前は指定できない |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver vps-cloud database-server user delete a1b2c3d4-5678-40ab-8def-1234567890ab app_userxserver vps-cloud database-server user grant <uuid> <userName> <databaseName>
URLで指定したDBユーザーにデータベースの利用権限を適用します。リクエスト本文はありません。同じ権限の再PUTは成功扱いです。DBサーバーの電源状態が起動や停止の処理中の場合は409 OPERATION_IN_PROGRESS（完了後に再実行してください）、停止中・異常時の場合は409 INVALID_POWER_STATEを返します。
API: PUT /v1/vps-cloud/database-servers/{uuid}/users/{user_name}/grants/{database_name}
引数
| 引数 | 説明 |
|---|---|
<uuid> | DBサーバーのAPI用UUID。vps-cloud database-server list の uuid |
<userName> | DBユーザー名。vps-cloud database-server user list の name。- で始まる名前は、名前の前に -- を書く。スラッシュを含む名前は指定できない |
<databaseName> | データベース名。vps-cloud database-server database list の name |
使用例
xserver vps-cloud database-server user grant a1b2c3d4-5678-40ab-8def-1234567890ab app_user app_dbxserver vps-cloud database-server user revoke <uuid> <userName> <databaseName> [options]
URLで指定したDBユーザーからデータベースの利用権限を解除します。リクエスト本文はありません。同じ権限の再DELETEは成功扱いです。DBサーバーの電源状態が起動や停止の処理中の場合は409 OPERATION_IN_PROGRESS（完了後に再実行してください）、停止中・異常時の場合は409 INVALID_POWER_STATEを返します。
確認プロンプトが出ます（-y / --yes で省略可）。
API: DELETE /v1/vps-cloud/database-servers/{uuid}/users/{user_name}/grants/{database_name}
引数
| 引数 | 説明 |
|---|---|
<uuid> | DBサーバーのAPI用UUID。vps-cloud database-server list の uuid |
<userName> | DBユーザー名。vps-cloud database-server user list の name。- で始まる名前は、名前の前に -- を書く。スラッシュを含む名前は指定できない |
<databaseName> | データベース名。vps-cloud database-server database list の name |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver vps-cloud database-server user revoke a1b2c3d4-5678-40ab-8def-1234567890ab app_user app_dbL4ロードバランサー
xserver vps-cloud load-balancer list [options]
認証したアカウントのL4ロードバランサーを返します。状態・名前で絞り込めます。続きはnext_cursorで取得します。
API: GET /v1/vps-cloud/load-balancers
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--status <status> | 任意 | 提供状態の完全一致（provisioning / active / suspended / error） |
--name <name> | 任意 | 表示名の部分一致 |
--limit <n> | 任意 | 取得件数（1〜500、省略時50） |
--cursor <cursor> | 任意 | 前回応答の next_cursor（--limit を含め、他の検索条件は変更しない） |
使用例
xserver vps-cloud load-balancer listxserver vps-cloud load-balancer info <uuid>
指定したAPI用UUIDのL4ロードバランサー詳細を返します。存在しない、または別アカウントのUUIDは404を返します。
API: GET /v1/vps-cloud/load-balancers/{uuid}
引数
| 引数 | 説明 |
|---|---|
<uuid> | L4ロードバランサーのAPI用UUID。vps-cloud load-balancer list の uuid |
使用例
xserver vps-cloud load-balancer info a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud load-balancer signup --region <region> --plan-id <id> --period <months> --name <name> --expected-total-price <yen> --agree-to-terms [options]
L4ロードバランサーをプリペイド残高で申し込みます。カタログ（プラン一覧）で確認したperiods[].total_priceをexpected_total_priceへ指定し、実申込の前に同じリクエスト本文でdry_run=trueを実行して、支払総額を確認してください。実申込は202 Acceptedと作成対象のUUID、status=provisioningを返します。構築完了まで10分程度が目安で、状況により前後します。Locationのリソース詳細を10秒以上空けて取得し、statusがactiveになれば利用可能です。errorの場合は構築に失敗しているため、再申込せずXServerアカウントの契約・支払状況を確認してサポートへお問い合わせください。読み取り専用（read）のキーは、allow_signupが有効でも申し込めません。詳細取得には対象商品の参照権限も必要です。
catalog load-balancer-plans で支払総額（periods[].total_price）を確認して --expected-total-price に指定し、実申込前に --agree-to-terms --dry-run で実行可否と支払額を確認してください。料金が変わっていれば --dry-run でも 422 PRICE_MISMATCH になり、実申込を中止します。実申込には --confirm-purchase と対話端末での確認文字列の入力が必要で、--yes では省略できません（ページ上部の「新規お申し込みの安全確認」を参照）。
受付は 202 Accepted で、CLI は構築完了を待ちません。応答の uuid で info を実行し、status が active になったことを確認してください。
API: POST /v1/vps-cloud/load-balancers
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--region <region> | 必須 | リージョン一覧が返した公開リージョンID |
--plan-id <id> | 必須 | catalog load-balancer-plans が返した公開プランID |
--period <months> | 必須 | 契約期間（月）。catalog load-balancer-plans の periods[].months から指定 |
--name <name> | 必須 | リソースの表示名（1〜50文字の英小文字・数字・ハイフン・アンダースコア。コントロールパネルの申込と同じ） |
--memo <memo> | 任意 | メモ（最大500文字。絵文字・韓国語・€ など、一部の文字は使えません。〜・−・¥ などの記号は、見た目が同じ全角の文字に置き換えて保存します） |
--expected-total-price <yen> | 必須 | catalog load-balancer-plans が返した periods[].total_price（税込支払総額） |
--auto-renew <bool> | 任意 | 自動更新（true / false。省略時は true） |
--partner-code <code> | 任意 | お取次店コード（半角英数字50文字以内）。存在しないコードでもエラーにならず、お申し込みは成立します |
--dry-run | 任意 | 課金・契約作成を行わず実行可否と料金だけを検証 |
--confirm-purchase | 任意 | 課金を伴う申請を明示的に確認 |
--agree-to-terms | 必須 | 利用規約・個人情報の取り扱いに同意 |
--idempotency-key <key> | 任意 | 実申込の冪等性キー（英数字・_・-の8～64文字。省略時は自動生成） |
使用例
xserver vps-cloud load-balancer signup --region tokyo01 --plan-id PLAN_ID --period 1 --name lb-01 --expected-total-price TOTAL_PRICE --agree-to-terms --dry-runxserver vps-cloud load-balancer signup --region tokyo01 --plan-id PLAN_ID --period 1 --name lb-01 --expected-total-price TOTAL_PRICE --agree-to-terms --confirm-purchasexserver vps-cloud load-balancer name update <uuid> --name <name>
表示名を変更します。1〜64文字の英数字・ハイフン・アンダースコアを指定できます（申込時より使える文字が広い）。変更後の内容は詳細APIで確認できます。
API: PUT /v1/vps-cloud/load-balancers/{uuid}/name
引数
| 引数 | 説明 |
|---|---|
<uuid> | L4ロードバランサーのAPI用UUID。vps-cloud load-balancer list の uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--name <name> | 必須 | 新しい表示名（1〜64文字の英数字・ハイフン・アンダースコア） |
使用例
xserver vps-cloud load-balancer name update a1b2c3d4-5678-40ab-8def-1234567890ab --name lb-01xserver vps-cloud load-balancer memo update <uuid> --memo <memo>
メモを変更します。空文字はメモ削除として扱います。
API: PUT /v1/vps-cloud/load-balancers/{uuid}/memo
引数
| 引数 | 説明 |
|---|---|
<uuid> | L4ロードバランサーのAPI用UUID。vps-cloud load-balancer list の uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--memo <memo> | 必須 | メモ（最大500文字。絵文字・韓国語・€ など、一部の文字は使えません。〜・−・¥ などの記号は、見た目が同じ全角の文字に置き換えて保存します）。空文字で削除 |
使用例
xserver vps-cloud load-balancer memo update a1b2c3d4-5678-40ab-8def-1234567890ab --memo "本番環境"xserver vps-cloud load-balancer power status <uuid>
電源状態と現在実行可能な操作を返します。構築後は、L4ロードバランサーの電源の有効・無効をrunning / stoppedで表します。設定反映中・異常時はcan_start / can_stopがfalseです。
API: GET /v1/vps-cloud/load-balancers/{uuid}/power
引数
| 引数 | 説明 |
|---|---|
<uuid> | L4ロードバランサーのAPI用UUID。vps-cloud load-balancer list の uuid |
使用例
xserver vps-cloud load-balancer power status a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud load-balancer power start <uuid> [options]
電源操作を受け付けます。レスポンスボディは返さず、Locationの電源状態の取得APIを10秒以上空けて確認してください。すでに起動している場合は409 INVALID_POWER_STATE、設定の反映中は409 OPERATION_IN_PROGRESSです。操作できるかは電源状態のcan_start / can_stopで確認できます。
CLI は受付時点で終了し、完了は待ちません。進捗は power status で確認してください（ページ上部の「非同期処理の確認」を参照）。
API: POST /v1/vps-cloud/load-balancers/{uuid}/power/start
引数
| 引数 | 説明 |
|---|---|
<uuid> | L4ロードバランサーのAPI用UUID。vps-cloud load-balancer list の uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--idempotency-key <key> | 任意 | 再送時の重複を防ぐキー（英数字・_・-の8～64文字） |
使用例
xserver vps-cloud load-balancer power start a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud load-balancer power stop <uuid> [options]
電源操作を受け付けます。レスポンスボディは返さず、Locationの電源状態の取得APIを10秒以上空けて確認してください。すでに停止している場合は409 INVALID_POWER_STATE、設定の反映中は409 OPERATION_IN_PROGRESSです。操作できるかは電源状態のcan_start / can_stopで確認できます。
CLI は受付時点で終了し、完了は待ちません。進捗は power status で確認してください（ページ上部の「非同期処理の確認」を参照）。
API: POST /v1/vps-cloud/load-balancers/{uuid}/power/stop
引数
| 引数 | 説明 |
|---|---|
<uuid> | L4ロードバランサーのAPI用UUID。vps-cloud load-balancer list の uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--idempotency-key <key> | 任意 | 再送時の重複を防ぐキー（英数字・_・-の8～64文字） |
使用例
xserver vps-cloud load-balancer power stop a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud load-balancer listener get <uuid> <listenerPort>
受信ポートでリスナーを指定します。画面の「設定対象のポート」と同じポート番号を指定してください。受信ポートは20 / 21 / 25 / 80 / 443 / 587 / 8080 / 8443の固定8種で、リスナーの追加や任意のポートへの変更、一覧取得は提供しません。
API: GET /v1/vps-cloud/load-balancers/{uuid}/listeners/{listener_port}
引数
| 引数 | 説明 |
|---|---|
<uuid> | L4ロードバランサーのAPI用UUID。vps-cloud load-balancer list の uuid |
<listenerPort> | L4ロードバランサーの受信ポート（20 / 21 / 25 / 80 / 443 / 587 / 8080 / 8443） |
使用例
xserver vps-cloud load-balancer listener get a1b2c3d4-5678-40ab-8def-1234567890ab 443xserver vps-cloud load-balancer listener set-enabled <uuid> <listenerPort> --enabled <bool>
この属性だけを変更します。同一値は成功（設定の反映中は、同じ値でも409 OPERATION_IN_PROGRESS）。200は設定受付を表します。リスナー設定取得APIで現在値を確認してください。設定反映は非同期で、現在値の一致だけでは通信への反映完了を保証しません。処理中の409を受けた場合は10秒以上空けて現在値を確認してから再実行してください。
API: PUT /v1/vps-cloud/load-balancers/{uuid}/listeners/{listener_port}/enabled
引数
| 引数 | 説明 |
|---|---|
<uuid> | L4ロードバランサーのAPI用UUID。vps-cloud load-balancer list の uuid |
<listenerPort> | L4ロードバランサーの受信ポート（20 / 21 / 25 / 80 / 443 / 587 / 8080 / 8443） |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--enabled <bool> | 必須 | true で有効 / false で無効 |
使用例
xserver vps-cloud load-balancer listener set-enabled a1b2c3d4-5678-40ab-8def-1234567890ab 443 --enabled truexserver vps-cloud load-balancer listener set-algorithm <uuid> <listenerPort> --algorithm <algorithm>
この属性だけを変更します。同一値は成功（設定の反映中は、同じ値でも409 OPERATION_IN_PROGRESS）。200は設定受付を表します。リスナー設定取得APIで現在値を確認してください。設定反映は非同期で、現在値の一致だけでは通信への反映完了を保証しません。処理中の409を受けた場合は10秒以上空けて現在値を確認してから再実行してください。
API: PUT /v1/vps-cloud/load-balancers/{uuid}/listeners/{listener_port}/algorithm
引数
| 引数 | 説明 |
|---|---|
<uuid> | L4ロードバランサーのAPI用UUID。vps-cloud load-balancer list の uuid |
<listenerPort> | L4ロードバランサーの受信ポート（20 / 21 / 25 / 80 / 443 / 587 / 8080 / 8443） |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--algorithm <algorithm> | 必須 | round_robin（ラウンドロビン）/ least_connections（リーストコネクション） |
使用例
xserver vps-cloud load-balancer listener set-algorithm a1b2c3d4-5678-40ab-8def-1234567890ab 443 --algorithm least_connectionsxserver vps-cloud load-balancer member list <uuid> <listenerPort> [options]
指定リスナーに登録された転送先VPSを返します。続きはnext_cursorで取得します。
API: GET /v1/vps-cloud/load-balancers/{uuid}/listeners/{listener_port}/members
引数
| 引数 | 説明 |
|---|---|
<uuid> | L4ロードバランサーのAPI用UUID。vps-cloud load-balancer list の uuid |
<listenerPort> | L4ロードバランサーの受信ポート（20 / 21 / 25 / 80 / 443 / 587 / 8080 / 8443） |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--limit <n> | 任意 | 取得件数（1〜500、省略時50） |
--cursor <cursor> | 任意 | 前回応答の next_cursor（--limit を含め、他の検索条件は変更しない） |
使用例
xserver vps-cloud load-balancer member list a1b2c3d4-5678-40ab-8def-1234567890ab 443xserver vps-cloud load-balancer member add <uuid> <listenerPort> --vps-uuid <uuid> [options]
同一アカウント・リージョン内の利用可能なVPSを指定します。メインNIC（is_main=true）のプライベートIPを自動的に使用します。転送先ポートはURLのlistener_portと同じ値になり、任意指定はできません。同一リスナー内の同じVPS・転送先ポートの重複は409。
API: POST /v1/vps-cloud/load-balancers/{uuid}/listeners/{listener_port}/members
引数
| 引数 | 説明 |
|---|---|
<uuid> | L4ロードバランサーのAPI用UUID。vps-cloud load-balancer list の uuid |
<listenerPort> | L4ロードバランサーの受信ポート（20 / 21 / 25 / 80 / 443 / 587 / 8080 / 8443） |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--vps-uuid <uuid> | 必須 | 同一アカウントのVPSの uuid |
--idempotency-key <key> | 任意 | 再送時の重複を防ぐキー（英数字・_・-の8～64文字） |
使用例
xserver vps-cloud load-balancer member add a1b2c3d4-5678-40ab-8def-1234567890ab 443 --vps-uuid b2c3d4e5-6789-40ab-8def-234567890abcxserver vps-cloud load-balancer member delete <uuid> <listenerPort> <memberUuid> [options]
指定リスナーから振り分け先サーバーを削除します。VPSやNIC自体は削除しません。
確認プロンプトが出ます（-y / --yes で省略可）。
API: DELETE /v1/vps-cloud/load-balancers/{uuid}/listeners/{listener_port}/members/{member_uuid}
引数
| 引数 | 説明 |
|---|---|
<uuid> | L4ロードバランサーのAPI用UUID。vps-cloud load-balancer list の uuid |
<listenerPort> | L4ロードバランサーの受信ポート（20 / 21 / 25 / 80 / 443 / 587 / 8080 / 8443） |
<memberUuid> | 振り分け先サーバーのUUID。vps-cloud load-balancer member list の member_uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver vps-cloud load-balancer member delete a1b2c3d4-5678-40ab-8def-1234567890ab 443 9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6dNFS
xserver vps-cloud nfs list [options]
認証したアカウントのNFSを返します。状態・名前で絞り込めます。続きはnext_cursorで取得します。
API: GET /v1/vps-cloud/nfs
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--status <status> | 任意 | 提供状態の完全一致（provisioning / active / suspended / error） |
--name <name> | 任意 | 表示名の部分一致 |
--limit <n> | 任意 | 取得件数（1〜500、省略時50） |
--cursor <cursor> | 任意 | 前回応答の next_cursor（--limit を含め、他の検索条件は変更しない） |
使用例
xserver vps-cloud nfs listxserver vps-cloud nfs info <uuid>
指定したAPI用UUIDのNFS詳細を返します。存在しない、または別アカウントのUUIDは404を返します。
API: GET /v1/vps-cloud/nfs/{uuid}
引数
| 引数 | 説明 |
|---|---|
<uuid> | NFSのAPI用UUID。vps-cloud nfs list の uuid |
使用例
xserver vps-cloud nfs info a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud nfs signup --region <region> --plan-id <id> --period <months> --name <name> --expected-total-price <yen> --agree-to-terms [options]
NFSをプリペイド残高で申し込みます。カタログ（プラン一覧）で確認したperiods[].total_priceをexpected_total_priceへ指定し、実申込の前に同じリクエスト本文でdry_run=trueを実行して、支払総額を確認してください。実申込は202 Acceptedと作成対象のUUID、status=provisioningを返します。構築完了まで10分程度が目安で、状況により前後します。Locationのリソース詳細を10秒以上空けて取得し、statusがactiveになれば利用可能です。errorの場合は構築に失敗しているため、再申込せずXServerアカウントの契約・支払状況を確認してサポートへお問い合わせください。読み取り専用（read）のキーは、allow_signupが有効でも申し込めません。詳細取得には対象商品の参照権限も必要です。
catalog nfs-plans で支払総額（periods[].total_price）を確認して --expected-total-price に指定し、実申込前に --agree-to-terms --dry-run で実行可否と支払額を確認してください。料金が変わっていれば --dry-run でも 422 PRICE_MISMATCH になり、実申込を中止します。実申込には --confirm-purchase と対話端末での確認文字列の入力が必要で、--yes では省略できません（ページ上部の「新規お申し込みの安全確認」を参照）。
受付は 202 Accepted で、CLI は構築完了を待ちません。応答の uuid で info を実行し、status が active になったことを確認してください。
API: POST /v1/vps-cloud/nfs
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--region <region> | 必須 | リージョン一覧が返した公開リージョンID |
--plan-id <id> | 必須 | catalog nfs-plans が返した公開プランID |
--period <months> | 必須 | 契約期間（月）。catalog nfs-plans の periods[].months から指定 |
--name <name> | 必須 | リソースの表示名（1〜50文字の英小文字・数字・ハイフン・アンダースコア。コントロールパネルの申込と同じ） |
--memo <memo> | 任意 | メモ（最大500文字。絵文字・韓国語・€ など、一部の文字は使えません。〜・−・¥ などの記号は、見た目が同じ全角の文字に置き換えて保存します） |
--expected-total-price <yen> | 必須 | catalog nfs-plans が返した periods[].total_price（税込支払総額） |
--auto-renew <bool> | 任意 | 自動更新（true / false。省略時は true） |
--partner-code <code> | 任意 | お取次店コード（半角英数字50文字以内）。存在しないコードでもエラーにならず、お申し込みは成立します |
--dry-run | 任意 | 課金・契約作成を行わず実行可否と料金だけを検証 |
--confirm-purchase | 任意 | 課金を伴う申請を明示的に確認 |
--agree-to-terms | 必須 | 利用規約・個人情報の取り扱いに同意 |
--idempotency-key <key> | 任意 | 実申込の冪等性キー（英数字・_・-の8～64文字。省略時は自動生成） |
使用例
xserver vps-cloud nfs signup --region tokyo01 --plan-id PLAN_ID --period 1 --name nfs-01 --expected-total-price TOTAL_PRICE --agree-to-terms --dry-runxserver vps-cloud nfs signup --region tokyo01 --plan-id PLAN_ID --period 1 --name nfs-01 --expected-total-price TOTAL_PRICE --agree-to-terms --confirm-purchasexserver vps-cloud nfs name update <uuid> --name <name>
表示名を変更します。1〜64文字の英数字・ハイフン・アンダースコアを指定できます（申込時より使える文字が広い）。変更後の内容は詳細APIで確認できます。
API: PUT /v1/vps-cloud/nfs/{uuid}/name
引数
| 引数 | 説明 |
|---|---|
<uuid> | NFSのAPI用UUID。vps-cloud nfs list の uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--name <name> | 必須 | 新しい表示名（1〜64文字の英数字・ハイフン・アンダースコア） |
使用例
xserver vps-cloud nfs name update a1b2c3d4-5678-40ab-8def-1234567890ab --name nfs-01xserver vps-cloud nfs memo update <uuid> --memo <memo>
メモを変更します。空文字はメモ削除として扱います。
API: PUT /v1/vps-cloud/nfs/{uuid}/memo
引数
| 引数 | 説明 |
|---|---|
<uuid> | NFSのAPI用UUID。vps-cloud nfs list の uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--memo <memo> | 必須 | メモ（最大500文字。絵文字・韓国語・€ など、一部の文字は使えません。〜・−・¥ などの記号は、見た目が同じ全角の文字に置き換えて保存します）。空文字で削除 |
使用例
xserver vps-cloud nfs memo update a1b2c3d4-5678-40ab-8def-1234567890ab --memo "本番環境"xserver vps-cloud nfs power status <uuid>
電源状態と現在実行可能な操作を返します。
API: GET /v1/vps-cloud/nfs/{uuid}/power
引数
| 引数 | 説明 |
|---|---|
<uuid> | NFSのAPI用UUID。vps-cloud nfs list の uuid |
使用例
xserver vps-cloud nfs power status a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud nfs power start <uuid> [options]
電源操作を受け付けます。レスポンスボディは返さず、Locationの電源状態の取得APIを10秒以上空けて確認してください。すでに起動している場合は409 INVALID_POWER_STATE、電源の処理中（電源状態のstatusがprocessing）は409 OPERATION_IN_PROGRESSです。操作できるかは電源状態のcan_start / can_stop / can_rebootで確認できます。
CLI は受付時点で終了し、完了は待ちません。進捗は power status で確認してください（ページ上部の「非同期処理の確認」を参照）。
API: POST /v1/vps-cloud/nfs/{uuid}/power/start
引数
| 引数 | 説明 |
|---|---|
<uuid> | NFSのAPI用UUID。vps-cloud nfs list の uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--idempotency-key <key> | 任意 | 再送時の重複を防ぐキー（英数字・_・-の8～64文字） |
使用例
xserver vps-cloud nfs power start a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud nfs power stop <uuid> [options]
電源操作を受け付けます。レスポンスボディは返さず、Locationの電源状態の取得APIを10秒以上空けて確認してください。すでに停止している場合は409 INVALID_POWER_STATE、電源の処理中（電源状態のstatusがprocessing）は409 OPERATION_IN_PROGRESSです。操作できるかは電源状態のcan_start / can_stop / can_rebootで確認できます。
CLI は受付時点で終了し、完了は待ちません。進捗は power status で確認してください（ページ上部の「非同期処理の確認」を参照）。
API: POST /v1/vps-cloud/nfs/{uuid}/power/stop
引数
| 引数 | 説明 |
|---|---|
<uuid> | NFSのAPI用UUID。vps-cloud nfs list の uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--idempotency-key <key> | 任意 | 再送時の重複を防ぐキー（英数字・_・-の8～64文字） |
使用例
xserver vps-cloud nfs power stop a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud nfs metrics <uuid> --metrics <list> --from <datetime> --to <datetime> [options]
指定期間[from,to)の時系列を昇順で返します。cpuは%、disk_read/writeはMB/s、network_in/outは各区間の転送量MBです（10進単位）。データは5分間隔で記録され、granularity=3600は1時間ごとに1点（CPU・ディスクI/Oは1時間の平均、転送量は1時間の合計）として返します。from/toはデータ点の境界に揃えます。欠測はnull、実測0は0。指定系列を入力順で返し、重複・未知metricは422。期間は最大30日かつ1系列1,000点で、granularity=300（省略時）では約3.4日までです。10秒以上空けて取得してください。
API: GET /v1/vps-cloud/nfs/{uuid}/metrics
引数
| 引数 | 説明 |
|---|---|
<uuid> | NFSのAPI用UUID。vps-cloud nfs list の uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--metrics <list> | 必須 | 取得する metric のカンマ区切り（cpu / disk_read / disk_write / network_in / network_out） |
--from <datetime> | 必須 | 取得期間の開始日時（例 2026-09-06T00:00:00+09:00）。秒・タイムゾーンは省略可（タイムゾーンを省略すると日本時間）。日付だけは不可 |
--to <datetime> | 必須 | 取得期間の終了日時（--from と同じ書き方）。from より後 |
--granularity <seconds> | 任意 | データ点の間隔（秒）。300 または 3600、省略時 300。指定できる期間は 300 で約3.4日、3600 で30日まで |
使用例
xserver vps-cloud nfs metrics a1b2c3d4-5678-40ab-8def-1234567890ab --metrics cpu,network_in --from 2026-10-01T00:00:00+09:00 --to 2026-10-02T00:00:00+09:00プライベートネットワーク
xserver vps-cloud private-network list [options]
main-networkと利用者作成ネットワークを返します。main-networkはVPS・DB・NFSの作成時に自動接続される既定ネットワークで、名前変更・削除・任意接続変更はできません。続きはnext_cursorで取得します。
API: GET /v1/vps-cloud/private-networks
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--name <name> | 任意 | ネットワーク名の部分一致 |
--limit <n> | 任意 | 取得件数（1〜500、省略時50） |
--cursor <cursor> | 任意 | 前回応答の next_cursor（--limit を含め、他の検索条件は変更しない） |
使用例
xserver vps-cloud private-network listxserver vps-cloud private-network info <networkUuid>
指定ネットワークのCIDRと割当範囲を返します。
API: GET /v1/vps-cloud/private-networks/{network_uuid}
引数
| 引数 | 説明 |
|---|---|
<networkUuid> | プライベートネットワークのUUID。vps-cloud private-network list の network_uuid |
使用例
xserver vps-cloud private-network info 3e4f5a6b-7c8d-4e9f-8a0b-1c2d3e4f5a6bxserver vps-cloud private-network create --name <name> --cidr <cidr> [options]
192.168.0.0/16内のCIDRでプライベートネットワークを作成します。/16〜/28で、ホスト部は0で指定します。10.0.0.0/8と172.16.0.0/12は対象外で422。既存ネットワーク・予約範囲との包含を含む重複は409です。192.168.0.0/16を指定すると利用可能な範囲全体を使うため、他のネットワークを追加できません。既存ネットワークがある場合も/16での作成は重複となります。
API: POST /v1/vps-cloud/private-networks
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--name <name> | 必須 | 1〜64文字の英数字・ハイフン・アンダースコア。既存のネットワークと同じ名前も指定できます |
--cidr <cidr> | 必須 | 192.168.0.0/16 内のIPv4 CIDR（prefix length 16〜28、ホスト部は0） |
--idempotency-key <key> | 任意 | 再送時の重複を防ぐキー（英数字・_・-の8～64文字） |
使用例
xserver vps-cloud private-network create --name app-network --cidr 192.168.10.0/24xserver vps-cloud private-network delete <networkUuid> [options]
ユーザー作成ネットワークを削除します。NIC（接続中のVPS）が残る場合は409 RESOURCE_IN_USEを返します。
確認プロンプトが出ます（-y / --yes で省略可）。
API: DELETE /v1/vps-cloud/private-networks/{network_uuid}
引数
| 引数 | 説明 |
|---|---|
<networkUuid> | プライベートネットワークのUUID。vps-cloud private-network list の network_uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver vps-cloud private-network delete 3e4f5a6b-7c8d-4e9f-8a0b-1c2d3e4f5a6bxserver vps-cloud private-network name update <networkUuid> --name <name>
ユーザー作成ネットワークの表示名を変更します。
API: PUT /v1/vps-cloud/private-networks/{network_uuid}/name
引数
| 引数 | 説明 |
|---|---|
<networkUuid> | プライベートネットワークのUUID。vps-cloud private-network list の network_uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--name <name> | 必須 | 新しいネットワーク名 |
使用例
xserver vps-cloud private-network name update 3e4f5a6b-7c8d-4e9f-8a0b-1c2d3e4f5a6b --name app-networkxserver vps-cloud private-network attachment list <networkUuid> [options]
接続中のリソースをresource.typeで区別して返します。DBサーバー・NFSの接続が含まれるのはmain-networkのみです。利用者作成ネットワークに接続できるのはVPSだけで、接続変更もこのVPSに限ります。続きはnext_cursorで取得します。
API: GET /v1/vps-cloud/private-networks/{network_uuid}/attachments
引数
| 引数 | 説明 |
|---|---|
<networkUuid> | プライベートネットワークのUUID。vps-cloud private-network list の network_uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--limit <n> | 任意 | 取得件数（1〜500、省略時50） |
--cursor <cursor> | 任意 | 前回応答の next_cursor（--limit を含め、他の検索条件は変更しない） |
使用例
xserver vps-cloud private-network attachment list 3e4f5a6b-7c8d-4e9f-8a0b-1c2d3e4f5a6bxserver vps-cloud private-network attachment attach <networkUuid> --vps-uuid <uuid> --private-ip-address <ip> [options]
同一アカウントのVPSを、利用者作成のプライベートネットワークへ接続します。
API: POST /v1/vps-cloud/private-networks/{network_uuid}/attachments
引数
| 引数 | 説明 |
|---|---|
<networkUuid> | プライベートネットワークのUUID。vps-cloud private-network list の network_uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--vps-uuid <uuid> | 必須 | 同一アカウントのVPSの uuid。すでにこのネットワークに接続しているVPSは指定できません（409） |
--private-ip-address <ip> | 必須 | allocation_pool 内の未使用IPv4（自動割当は行いません） |
--idempotency-key <key> | 任意 | 再送時の重複を防ぐキー（英数字・_・-の8～64文字） |
使用例
xserver vps-cloud private-network attachment attach 3e4f5a6b-7c8d-4e9f-8a0b-1c2d3e4f5a6b --vps-uuid a1b2c3d4-5678-40ab-8def-1234567890ab --private-ip-address 192.168.10.11xserver vps-cloud private-network attachment detach <networkUuid> <portUuid> [options]
利用者作成ネットワークからVPSを切断します。このNICに追加IPが割り当てられている場合は、その割り当ても解除され、通信できなくなります。main-network・メインNIC・DBサーバー・NFSの接続は解除できず409になります。VPSや追加IPの契約は終了しません。
確認プロンプトが出ます（-y / --yes で省略可）。
API: DELETE /v1/vps-cloud/private-networks/{network_uuid}/attachments/{port_uuid}
引数
| 引数 | 説明 |
|---|---|
<networkUuid> | プライベートネットワークのUUID。vps-cloud private-network list の network_uuid |
<portUuid> | NICのUUID。vps-cloud vps port list の port_uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver vps-cloud private-network attachment detach 3e4f5a6b-7c8d-4e9f-8a0b-1c2d3e4f5a6b 5f0c7d2e-1a2b-4c3d-8e4f-5a6b7c8d9e0f追加IP
xserver vps-cloud ip-address list [options]
認証したアカウントの追加IPv4契約を返します。割当先（assignment）とサブネットマスクは含まず、割り当て済みかどうかに関係なく同じ形で返します。割当先とサブネットマスクは追加IP詳細APIで取得できます。続きはnext_cursorで取得します。
API: GET /v1/vps-cloud/ip-addresses
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--limit <n> | 任意 | 取得件数（1〜500、省略時50） |
--cursor <cursor> | 任意 | 前回応答の next_cursor（--limit を含め、他の検索条件は変更しない） |
使用例
xserver vps-cloud ip-address listxserver vps-cloud ip-address info <uuid>
指定した追加IP契約と現在の割当先を返します。未割当の場合はassignmentの各値がnullです。利用者が払い出しIPを選ぶことはできません。
API: GET /v1/vps-cloud/ip-addresses/{uuid}
引数
| 引数 | 説明 |
|---|---|
<uuid> | 追加IPのAPI用UUID。vps-cloud ip-address list の uuid（画面にはUUIDが表示されないため、address または service_code で照合） |
使用例
xserver vps-cloud ip-address info a1b2c3d4-5678-40ab-8def-1234567890abxserver vps-cloud ip-address signup --region <region> --plan-id <id> --period <months> --expected-total-price <yen> --agree-to-terms [options]
追加IPをプリペイド残高で申し込みます。カタログ（プラン一覧）で確認したperiods[].total_priceをexpected_total_priceへ指定し、実申込の前に同じリクエスト本文でdry_run=trueを実行して、支払総額を確認してください。1回の申込で追加IPv4を1個契約します。XServerアカウント全体の有効契約数は32個までです。上限に達している場合はdry_runでも409 CONTRACT_LIMIT_EXCEEDEDを返します。支払完了後、201 CreatedとUUID、status=activeを返します。構築待ちはなく、NICへ割り当てて利用できます。Locationから契約したIPの詳細を取得できます。読み取り専用（read）のキーは、allow_signupが有効でも申し込めません。詳細取得には対象商品の参照権限も必要です。
catalog ip-address-plans で支払総額（periods[].total_price）を確認して --expected-total-price に指定し、実申込前に --agree-to-terms --dry-run で実行可否と支払額を確認してください。料金が変わっていれば --dry-run でも 422 PRICE_MISMATCH になり、実申込を中止します。実申込には --confirm-purchase と対話端末での確認文字列の入力が必要で、--yes では省略できません（ページ上部の「新規お申し込みの安全確認」を参照）。
受付は 201 Created で、構築待ちはありません。
API: POST /v1/vps-cloud/ip-addresses
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--region <region> | 必須 | リージョン一覧が返した公開リージョンID |
--plan-id <id> | 必須 | catalog ip-address-plans が返した公開プランID |
--period <months> | 必須 | 契約期間（月）。catalog ip-address-plans の periods[].months から指定 |
--memo <memo> | 任意 | メモ（最大500文字。絵文字・韓国語・€ など、一部の文字は使えません。〜・−・¥ などの記号は、見た目が同じ全角の文字に置き換えて保存します） |
--expected-total-price <yen> | 必須 | catalog ip-address-plans が返した periods[].total_price（税込支払総額） |
--auto-renew <bool> | 任意 | 自動更新（true / false。省略時は true） |
--dry-run | 任意 | 課金・契約作成を行わず実行可否と料金だけを検証 |
--confirm-purchase | 任意 | 課金を伴う申請を明示的に確認 |
--agree-to-terms | 必須 | 利用規約・個人情報の取り扱いに同意 |
--idempotency-key <key> | 任意 | 実申込の冪等性キー（英数字・_・-の8～64文字。省略時は自動生成） |
使用例
xserver vps-cloud ip-address signup --region tokyo01 --plan-id PLAN_ID --period 1 --expected-total-price TOTAL_PRICE --agree-to-terms --dry-runxserver vps-cloud ip-address signup --region tokyo01 --plan-id PLAN_ID --period 1 --expected-total-price TOTAL_PRICE --agree-to-terms --confirm-purchasexserver vps-cloud ip-address memo update <uuid> --memo <memo>
追加IP契約のメモを変更します。割当操作はVPSのNIC設定APIを利用します。
API: PUT /v1/vps-cloud/ip-addresses/{uuid}/memo
引数
| 引数 | 説明 |
|---|---|
<uuid> | 追加IPのAPI用UUID。vps-cloud ip-address list の uuid（画面にはUUIDが表示されないため、address または service_code で照合） |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--memo <memo> | 必須 | メモ（最大500文字。絵文字・韓国語・€ など、一部の文字は使えません。〜・−・¥ などの記号は、見た目が同じ全角の文字に置き換えて保存します）。空文字で削除 |
使用例
xserver vps-cloud ip-address memo update a1b2c3d4-5678-40ab-8def-1234567890ab --memo "本番環境"パケットフィルター
xserver vps-cloud packet-filter list [options]
利用者が作成したパケットフィルターだけを返します。続きはnext_cursorで取得します。
API: GET /v1/vps-cloud/packet-filters
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--name <name> | 任意 | パケットフィルター名の部分一致 |
--limit <n> | 任意 | 取得件数（1〜500、省略時50） |
--cursor <cursor> | 任意 | 前回応答の next_cursor（--limit を含め、他の検索条件は変更しない） |
使用例
xserver vps-cloud packet-filter listxserver vps-cloud packet-filter info <filterUuid>
指定パケットフィルターとルール一覧を返します。適用先のNICはVPSのNIC一覧・IPv6設定で確認します。
API: GET /v1/vps-cloud/packet-filters/{filter_uuid}
引数
| 引数 | 説明 |
|---|---|
<filterUuid> | パケットフィルターのUUID。vps-cloud packet-filter list の filter_uuid |
使用例
xserver vps-cloud packet-filter info 8d6cdf93-7e63-4e0f-8268-6dde7f1c12acxserver vps-cloud packet-filter create --name <name> [options]
許可ルール0件のパケットフィルターを作成します。適用前に必要な許可ルールを追加してください。許可ルールがないフィルターだけを適用したNICは、すべての受信通信を拒否します。名前変更は提供しません。
API: POST /v1/vps-cloud/packet-filters
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--name <name> | 必須 | 3〜64文字。英字で始まり、英数字・ハイフン・アンダースコア。同じ名前のフィルターは作成できません（409）。大文字・小文字は区別します（web-filter と WEB-FILTER は別の名前） |
--idempotency-key <key> | 任意 | 再送時の重複を防ぐキー（英数字・_・-の8～64文字） |
使用例
xserver vps-cloud packet-filter create --name web-filterxserver vps-cloud packet-filter delete <filterUuid> [options]
NICに適用中のパケットフィルターは削除せず、409 RESOURCE_IN_USEを返します。
確認プロンプトが出ます（-y / --yes で省略可）。
API: DELETE /v1/vps-cloud/packet-filters/{filter_uuid}
引数
| 引数 | 説明 |
|---|---|
<filterUuid> | パケットフィルターのUUID。vps-cloud packet-filter list の filter_uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver vps-cloud packet-filter delete 8d6cdf93-7e63-4e0f-8268-6dde7f1c12acxserver vps-cloud packet-filter add-rule <filterUuid> --ethertype <ethertype> --protocol <protocol> --remote-ip-prefix <cidr> [options]
受信許可ルールを追加します。TCP/UDPはport_range_min/maxの両方を1〜65535（min<=max）で指定するか、両方を省略またはnullにしてすべてのポートを許可します。片方だけの指定は422です。ICMPでは両ポート番号を省略またはnullにし、数値指定は422。remote_ip_prefixは必須で、nullは全送信元を明示的に許可します。CIDRのIPバージョンはethertypeと一致させ、ホスト部が0のネットワークアドレスで指定します（例: 192.0.2.0/24。192.0.2.5/24のようなホスト部付きは422）。1台だけ許可する場合はIPv4は/32、IPv6は/128を指定します。未知の項目や条件に合わない値を指定すると422を返します。
--remote-ip-prefix に null を指定すると、全送信元を明示的に許可します。
API: POST /v1/vps-cloud/packet-filters/{filter_uuid}/rules
引数
| 引数 | 説明 |
|---|---|
<filterUuid> | パケットフィルターのUUID。vps-cloud packet-filter list の filter_uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--ethertype <ethertype> | 必須 | ipv4 / ipv6 |
--protocol <protocol> | 必須 | tcp / udp / icmp |
--port-range-min <port> | 任意 | 開始ポート（1〜65535）。TCP/UDPで開始・終了の両方を省略すると全ポート。片方だけの指定は不可。ICMPでは指定しない |
--port-range-max <port> | 任意 | 終了ポート（1〜65535）。TCP/UDPで開始・終了の両方を省略すると全ポート。片方だけの指定は不可。ICMPでは指定しない |
--remote-ip-prefix <cidr> | 必須 | ethertype と一致するCIDR。ホスト部を0にしたネットワークアドレスで指定（例 203.0.113.0/24。1台だけなら /32、IPv6 は /128）。null で全送信元（0.0.0.0/0、IPv6 は ::/0 として返ります）。IPv4 射影アドレス（::ffff:… の形）は指定できない（IPv4 は --ethertype ipv4 で指定） |
--idempotency-key <key> | 任意 | 再送時の重複を防ぐキー（英数字・_・-の8～64文字） |
使用例
xserver vps-cloud packet-filter add-rule 8d6cdf93-7e63-4e0f-8268-6dde7f1c12ac --ethertype ipv4 --protocol tcp --port-range-min 443 --port-range-max 443 --remote-ip-prefix 203.0.113.0/24xserver vps-cloud packet-filter add-rule 8d6cdf93-7e63-4e0f-8268-6dde7f1c12ac --ethertype ipv4 --protocol icmp --remote-ip-prefix nullxserver vps-cloud packet-filter delete-rule <filterUuid> <ruleUuid> [options]
指定ルールを削除します。パケットフィルター自体は削除しません。存在しない・削除済みのルールは404です（NICからの適用解除と違い、再DELETEは成功扱いにしません）。
確認プロンプトが出ます（-y / --yes で省略可）。
API: DELETE /v1/vps-cloud/packet-filters/{filter_uuid}/rules/{rule_uuid}
引数
| 引数 | 説明 |
|---|---|
<filterUuid> | パケットフィルターのUUID。vps-cloud packet-filter list の filter_uuid |
<ruleUuid> | パケットフィルタールールのUUID。vps-cloud packet-filter info の rules[].rule_uuid |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver vps-cloud packet-filter delete-rule 8d6cdf93-7e63-4e0f-8268-6dde7f1c12ac 7cbb2835-7f5c-4b36-a445-a5522a774791SSH Key（公開鍵）
xserver vps-cloud ssh-key list [options]
登録済みSSHキーの名前と登録日時を返します。公開鍵本文とフィンガープリントはSSH Key詳細APIで取得できます。秘密鍵は保持・返却しません。続きはnext_cursorで取得します。
API: GET /v1/vps-cloud/ssh-keys
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--name <name> | 任意 | SSHキー名の部分一致 |
--limit <n> | 任意 | 取得件数（1〜500、省略時50） |
--cursor <cursor> | 任意 | 前回応答の next_cursor（--limit を含め、他の検索条件は変更しない） |
使用例
xserver vps-cloud ssh-key listxserver vps-cloud ssh-key info <name>
SSHキー名で登録内容とフィンガープリントを取得します。
API: GET /v1/vps-cloud/ssh-keys/{name}
引数
| 引数 | 説明 |
|---|---|
<name> | SSHキー名。vps-cloud ssh-key list の name。- で始まる名前は、名前の前に -- を書く（例: -- -key） |
使用例
xserver vps-cloud ssh-key info my-keyxserver vps-cloud ssh-key add --name <name> --public-key <key> [options]
利用者が用意したOpenSSH形式の公開鍵を登録します。APIで秘密鍵を生成・返却しません。削除済みのSSHキー名は再登録できず、409 ALREADY_EXISTSを返します。
API: POST /v1/vps-cloud/ssh-keys
オプション
| オプション | 必須 | 説明 |
|---|---|---|
--name <name> | 必須 | 1〜50文字。英数字・ハイフン・アンダースコア。名前の重複は大文字・小文字を区別せずに判定します（deploy-key があると DEPLOY-KEY は409） |
--public-key <key> | 必須 | 1行のOpenSSH公開鍵（秘密鍵・authorized_keys オプションは不可）。コメントに制御文字・絵文字など4バイトの文字は使えません |
--idempotency-key <key> | 任意 | 再送時の重複を防ぐキー（英数字・_・-の8～64文字） |
使用例
xserver vps-cloud ssh-key add --name my-key --public-key "ssh-ed25519 AAAAC3Nza... user@example"xserver vps-cloud ssh-key delete <name> [options]
登録済みのSSH Key（公開鍵）を削除します。既存VPS内のauthorized_keysは変更しません。存在しない・削除済みのキーは404です（再DELETEは成功扱いにしません）。削除した名前は再登録できません。
確認プロンプトが出ます（-y / --yes で省略可）。
API: DELETE /v1/vps-cloud/ssh-keys/{name}
引数
| 引数 | 説明 |
|---|---|
<name> | SSHキー名。vps-cloud ssh-key list の name。- で始まる名前は、名前の前に -- を書く（例: -- -key） |
オプション
| オプション | 必須 | 説明 |
|---|---|---|
-y, --yes | 任意 | 確認プロンプトをスキップ |
使用例
xserver vps-cloud ssh-key delete my-key