Oracle Java Cloud Service REST API

SSH鍵の説明の表示

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/credentials/crednames/{credentialName}

指定された資格証明名の資格証明の説明を返します。

注意: サポートされている資格証明名はvmspublickeyのみです。

リクエスト

パス・パラメータ

credentialName: 型: string

必須: true

SSH鍵と関連付けられた資格証明名。現在使用できる資格証明名はvmspublickeyのみです。
identityDomainId: 型: string

必須: true

Oracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID (Oracle Public Cloudの場合)。
Oracle Java Cloud Serviceインスタンスのテナント名(Oracle Cloud Machineの場合)。
serviceId: 型: string

必須: true

Oracle Java Cloud Serviceインスタンスの名前。

ヘッダー・パラメータ

X-ID-TENANT-NAME: 型: string

必須: true

Oracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID (Oracle Public Cloudの場合)。
Oracle Java Cloud Serviceインスタンスのテナント名(Oracle Cloud Machineの場合)。

レスポンス

サポートされているメディア・タイプ

application/json

200レスポンス

OK。返される可能性のあるその他のHTTPステータス・コードの詳細は、「ステータス・コード」を参照してください。

本文

レスポンス本文には、SSH鍵に関する情報、およびその説明が含まれます。

ルート・スキーマ: sshkeydesc-response

レスポンス本文には、SSH鍵に関する情報、およびその説明が含まれます。

プロパティ

canonicalUrl: 型: string

資格証明のキー値の問合せ先URL。
credName: 型: string

資格証明名。現在サポートされている資格証明名はvmspublickeyのみです。
credType: 型: string

資格証明のタイプ。サポートされる値はSSHのみです。
description: 型: string

指定した資格証明名の資格を証明する説明。
identityDomain: 型: string

Oracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID (Oracle Public Cloudの場合)。
Oracle Java Cloud Serviceインスタンスのテナント名(Oracle Cloud Machineの場合)。
serviceName: 型: string

Oracle Java Cloud Serviceインスタンスの名前。
serviceType: 型: string

クラウド・サービス・タイプ。有効な値はOracle Java Cloud Serviceに対してjaasです。

例

次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、指定した資格証明名に対するSSH公開鍵に関する情報を表示する方法を示しています。

注意:

現在サポートされている資格証明名はvmspublickeyのみです。
この例のコマンドでは、URL構造https://rest_server_url/resource-pathが使用されています。ここで、rest_server_urlはアイデンティティ・ドメインまたはテナント名を問い合せるためのOracle Public CloudまたはOracle Cloud MachineのRESTサーバーです。 Oracle Public CloudまたはOracle Cloud Machineに使用する適切なURL構造の詳細は、リクエストの送信を参照してください。

cURLコマンド

curl -i -X GET -u username:userPassword1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance/credentials/crednames/vmspublickey

レスポンス・ヘッダーの例

次にレスポンス・ヘッダーの例を示します。

HTTP/1.1 200 OK
Date: Tue, 19 Apr 2016 21:38:40 GMT
Transfer-Encoding: chunked
Content-Type: application/json

レスポンス本文の例

次の例では、JSON形式で返されるレスポンスを示しています。

{
   "identityDomain":"ExampleIdentityDomain",
   "serviceType":"jaas",
   "serviceName":"ExampleInstance",
   "credName":"vmspublickey",
   "credType":"SSH",
   "description":"Service user ssh public key which can be used to access the service VM instances",
   "canonicalUrl":"https:\/\/rest_server_url\/paas\/api\/v1.1\/instancemgmt\/ExampleIdentityDomain\/service\/jaas\/instances\/ExampleInstance\/credentials\/crednames\/vmspublickey"
}