SSH鍵の管理

SSH鍵を使用することによって、インスタンスへのログイン・プロセスを自動化できます。

トピック:

公開SSH鍵の追加

APIを使用すると、新しい公開SSH鍵をインポートし、それをユーザーに関連付けられます。

メソッド

POST

RESTリソース

/sshkey

URI

https://api_endpoint/sshkey/

リクエスト本文のパラメータ

パラメータ	説明
name	SSH鍵の名前。オブジェクト名には、英数字、ハイフン、およびピリオドのみを使用できます。オブジェクト名は大文字と小文字が区別されます。
key	SSH公開鍵値
enabled	(オプション)SSH鍵を有効または無効にするかを指定します。デフォルト値は`True`です
osuser	(オプション)この鍵が割り当てられるオペレーティング・システム・ユーザー。このオプションを指定しない場合、VMに鍵がインストールされません。

URIの例

https://api.oc.example.com/sshkey/

リクエスト本文の例

{
        "osuser": "oracle", 
        "enabled": true,
        "key": "ssh-rsa AA16hLNo4kWmYslf....leo@t410....",
        "name": "/mytenant/public/oracle_key1"
}

レスポンス本文の例

{
        "osuser": "oracle", 
        "enabled": true, 
        "uri": "https://api/sshkey/mytenant/public/oracle_key1", 
        "key": "ssh-rsa AA16hLNo4kWmYslf....leo@t410....", 
        "name": "/mytenant/public/oracle_key1"
}

SSH鍵の削除

このAPIを使用すると、特定のSSH鍵を削除できます。

メソッド

DELETE

RESTリソース

/sshkey/name

URI

https://api_endpoint/sshkey/name

URIパラメータ

パラメータ	説明
name	削除するSSH鍵の名前

URIの例

https://api.oc.example.com/sshkey/mytenant/public/key1

SSH鍵の更新

このAPIを使用すると、鍵、使用可能なフィールドおよびosuserフィールドを特定のSSH鍵に対して更新/上書きできます。

メソッド

PUT

RESTリソース

/sshkey/name

URI

https://api_endpoint/sshkey/name

URIパラメータ

パラメータ	説明
name	SSH鍵の名前

リクエスト本文のパラメータ

パラメータ	説明
key	(オプション) SSH公開鍵の値を含むファイルの名前
enabled	(オプション)鍵を有効または無効にするかを指定します。デフォルト値は`True`です
osuser	(オプション)この鍵が割り当てられるOSユーザー

URIの例

https://api.oc.example.com/sshkey/mytenant/public/myuser

リクエスト本文の例

{
        "osuser": "myuser"
        "enabled": true,
        "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA0ibAEmysI4o1zf...",
        "name": "/mytenant/public/myuser"
}

レスポンス本文の例

{
        "osuser": "myuser"
        "enabled": true,
        "uri": "https://api.oc.example.com/sshkey/mytenant/public/myuser",
        "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA0ibAEmysI4o1zfb4dOJIyaN67pya8A...",
        "name": "/mytenant/public/myuser"
}

SSH鍵の詳細の取得

SSH鍵の詳細を取得するには、REST APIを使用します。

トピック:

SSH鍵の検出

このAPIを使用すると、特定のコンテナおよびサブコンテナ内のSSH鍵を検出できます。

注意:

検出APIコールは、指定されたコンテナ内のオブジェクトの名前を表示しますが、オブジェクトの詳細は表示しません。オブジェクトの名前をリストするには、Acceptヘッダーをapplication/oracle-compute-v3+directory+jsonに設定します。その他の目的では、Acceptヘッダーをapplication/oracle-compute-v3+jsonに設定する必要があります。

メソッド

GET

RESTリソース

/sshkey/container/

URI

https://api_endpoint/sshkey/container/

URIパラメータ

パラメータ	説明
container	SSH鍵の階層名前空間

URIの例

https://api.oc.example.com/sshkey/mytenant/public/

レスポンス・データの例

{
  "result": [
    "/mytenant/public/adminkey",
    "/mytenant/public/permkey",
    "/mytenant/public/tempkey"
  ]
}

SSH鍵の取得

このAPIを使用すると、特定のSSH鍵の情報を取得できます。

メソッド

GET

RESTリソース

/sshkey/name

URI

https://api_endpoint/sshkey/name

URIパラメータ

パラメータ	説明
name	情報を取得したSSH鍵の名前

URIの例

https://api.oc.example.com/sshkey/mytenant/public/oracle_key1

レスポンス・データの例

{
        "osuser": "oracle", 
        "enabled": true, 
        "uri": "https://api/sshkey/mytenant/public/oracle_key1", 
        "key": "ssh-rsa AAAAB3LNo4kWmYslf...leo@t410.....", 
        "name": "/mytenant/public/oracle_key1"
}

SSH鍵のリスト

このAPIを使用すると、特定のコンテナおよびサブコンテナ内のSSH鍵情報をリストできます。

メソッド

GET

RESTリソース

/sshkey/container/

URI

https://api_endpoint/sshkey/container/

URIパラメータ

パラメータ	説明
container	SSH鍵の階層名前空間

URIの例

https://api.oc.example.com/sshkey/mytenant/public/myuser

レスポンス・データの例

{
        "osuser": "myuser",
        "enabled": true,
        "uri": "https://api.oc.example.com/sshkey/mytenant/public/myuser",
        "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA0ibAEmysI4o1zfb4dOJIyaN67pya8A...AWS",
        "name": "/mytenant/public/myuser"
}