問合せパラメータによるSSH鍵の説明の取得
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/credentials/crednames
?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
- canonicalUrl
-
型:
string
資格証明のキー値の問合せ先URL。 - credName
-
型:
string
資格証明名。 現在サポートされている資格証明名はvmspublickey
のみです。 - credType
-
型:
string
資格証明のタイプ。 サポートされる値はSSH
のみです。 - description
-
型:
string
指定した資格証明名の資格を証明する説明。 - hasMore
-
型:
boolean
問合せから返されるリストが完全(false
)または一部(true
)かを示すフラグ。リストが一部のみの場合、
offset
問合せパラメータを使用して追加の結果をフェッチします。 デフォルトでは、offset
は0 (ゼロ)、limitRowCount
は50です。 - identityDomain
-
型:
string
Oracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID (Oracle Public Cloudの場合)。Oracle Java Cloud Serviceインスタンスのテナント名(Oracle Cloud Machineの場合)。
- items
-
型:
string
問合せで返された資格証明の詳細説明をグループ化します。 - serviceName
-
型:
string
Oracle Java Cloud Serviceインスタンスの名前。 - serviceType
-
型:
string
クラウド・サービス・タイプ。 有効な値はOracle Java Cloud Serviceに対してjaas
です。 - totalResults
-
型:
integer
問合せで返される結果の数。
例
次の例に、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 }