API情報
API種別 |
メソッド |
URI |
対象 |
名称 |
実行 |
設定 |
POST |
/:GisServiceCode/system-storages/:StorageServiceCode/publickeys.json |
システムストレージ |
公開鍵追加 |
非同期 |
- 指定したシステムストレージにSSHログインのための公開鍵を追加します
- これはOS種別がLinuxのシステムストレージを使って仮想サーバを起動し、SSHでリモートログインするために必要です
- OS種別がWindowsのシステムストレージを指定することはできません
- 指定された公開鍵はrootアカウントでログインするために利用されます(authorized_keysに書き込まれる)
- すでにSSH公開鍵が設定済みの場合、上書きせずに追記されます。削除したい場合、ゲストOS上で作業を行ってください
- APIのレスポンスは公開鍵の書き込みが終わるのを待つことなく戻ります
- 書き込み中のステータスはConfiguringとなり、書き終えて利用できる状態になるとステータスがAttached、またはNotAttachedに戻ります
- ゲストOSのSSHサーバは、初期状態でパスワード認証が利用できない設定になっているため、パスワードを設定してもリモートログインすることはできません
- 本APIは初期設定のためと、なんらかの理由でリモートログインできなくなったときの復旧用途での利用に留めて、必要なセットアップを終えた後は、rootアカウントでのリモートログインを無効にすることを推奨します
- このAPIを利用するには、システムストレージが接続された仮想サーバを停止しておく、またはシステムストレージを取り外しておく必要があります
- インスタントクローニングのクローン元となっているシステムストレージへの公開鍵の追加はできません
リクエストパラメータ
|
パラメータ |
必須 |
意味 |
値 |
URL |
GisServiceCode |
○ |
P2契約のサービスコード |
gis######## |
|
StorageServiceCode |
○ |
システムストレージのサービスコード |
iba########, ica######## |
ボディ |
PublicKey |
○ |
公開鍵 |
文字列。例: "ssh-rsa XXXXXXXXXXXXXXXXXXXX comment" |
レスポンス
フィールド |
タイプ |
意味 |
値 |
Current.ResourceStatus |
String |
設定後のストレージステータス
|
|
Previous.ResourceStatus |
String |
設定前のストレージステータス
|
|
エラーコード
- このAPIに関する個別エラーはありません。
- 共通エラーコードはエラーレスポンスを参照して下さい
サンプル
リクエストボディ
{
"PublicKey": "ssh-rsa XXXXXXXXXXXXXXXXXXXX comment"
}
レスポンス (JSON)
Json
{
"RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
"Current": {
"ResourceStatus": "Configuring"
},
"Previous": {
"ResourceStatus": "NotAttached"
}
}