機械翻訳について
  1. Oracle Java Cloud ServiceのREST API
  2. タスク
  3. SSHアクセス

問合せパラメータによるSSH鍵の説明の取得

get

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

指定した問合せパラメータに対する1つ以上の資格証明の説明を返します。
  • ?credname問合せパラメータを使用して、指定の資格証明名に対する結果を取得します。
  • ?serviceName問合せパラメータを使用して、指定のOracle Java Cloud Serviceインスタンスに対する結果を取得します。

次の事柄に注意してください。

  • デフォルトでは、1つの問合せに対して50の鍵が返されます。 ?limitRowCount問合せパラメータを使用して、ページ・サイズ(1つのリクエストに返される結果の数)を制御します。
  • ?offset問合せパラメータを使用して、該当する場合に追加の結果をフェッチします。 デフォルトでは、offsetは0 (ゼロ)です。

リクエスト

パス・パラメータ
identityDomainId
型: string
必須: true
Oracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID (Oracle Public Cloudの場合)。

Oracle Java Cloud Serviceインスタンスのテナント名(Oracle Cloud Machineの場合)。

問合せパラメータ
credname
型: string
一意の資格証明の名前。

注意: サポートされている資格証明名はvmspublickeyのみです。 これは、資格証明名が指定されない場合のデフォルトになります。

serviceName
型: string
Oracle Java Cloud Serviceインスタンスの名前。 サービス名が指定されない場合、リクエストは指定されたアイデンティティ・ドメインIDまたはテナント名のすべてのサービス・インスタンスを返します。
ヘッダー・パラメータ
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ステータス・コードの詳細は、「ステータス・コード」を参照してください。
本文
レスポンス本文には、1つ以上のSSH鍵(およびその説明)に関する一般情報が含まれます。
ルート・スキーマ: keydescquery-response
レスポンス本文には、1つ以上のSSH鍵(およびその説明)に関する一般情報が含まれます。

例

次の例に、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/credentials/crednames?credname=vmspublickey&serviceName=ExampleInstance"

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

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

HTTP/1.1 200 OK
Date: Tue, 30 Aug 2016 02:09:24 GMT
Transfer-Encoding: chunked
Content-Type: application/json

レスポンス本文の例

次に、指定の資格証明名とサービス名に対してJSON形式で返されるレスポンスの例を示します。

{
   "items":[
   {
      "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"
   }],
   "hasMore":false,
   "totalResults":1
}