View the SSH Key Value
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/credentials/{credentialName}
Note: vmspublickey
is the only supported credential name.
Request
-
credentialName: string
Credential name associated with the SSH public key. Currently, the only credential name you can use is
vmspublickey
. -
identityDomainId: string
Identity domain ID for the Oracle Java Cloud Service account.
-
serviceId: string
Name of the Oracle Java Cloud Service instance.
-
Authorization: string
Base64 encoded user name and password separated by a colon or OAuth access token obtained from Oracle Identity Cloud Service. See Authenticate.
-
X-ID-TENANT-NAME: string
Identity domain ID for the Oracle Java Cloud Service account.
Response
- application/json
200 Response
The response body contains details about the SSH public key value.
See Status Codes for information about other possible HTTP status codes.
object
-
componentType(optional):
string
Type of service component. Possible values include:
WLS
,OTD
,DB
. -
computeKeyName(optional):
string
Compute sshkey object key name.
-
credName(optional):
string
Credential name. Currently, the only supported credential name is
vmspublickey
. -
credType(optional):
string
Credential type. Only supported value is
SSH
. -
description(optional):
string
Credential description of the given credential name.
-
identityDomain(optional):
string
Identity domain ID for the Oracle Java Cloud Service account.
-
lastUpdateMessage(optional):
string
Message returned from the last SSH key update. For example:
newly created
,updated by username
. -
lastUpdateStatus(optional):
string
Status of the last SSH key update.
-
lastUpdateTime(optional):
string
Date and time the SSH key was last updated.
-
osUserName(optional):
string
Virtual machine OS user name. Only supported value is
opc
. -
parentType(optional):
string
Valid value is
SERVICE
. -
publicKey(optional):
string
Public key for the secure shell (SSH). This key is used for authentication when connecting to the Oracle Java Cloud Service instance using an SSH client.
-
serviceName(optional):
string
Name of the Oracle Java Cloud Service instance.
-
serviceType(optional):
string
Cloud service type. Valid value is
jaas
for Oracle Java Cloud Service.
Examples
The following example shows how to view the SSH public key value for the given credential name by submitting a GET request on the REST resource using cURL.
-
Currently, the only supported credential name is
vmspublickey
. -
The command in this example uses the URL structure
https://rest_server_url/resource-path
, whererest_server_url
is the REST server to contact for your identity domain (or Cloud Account). See Send Requests.
cURL Command
curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance/credentials/vmspublickey
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK
Date: Tue, 19 Apr 2016 21:46:27 GMT
Transfer-Encoding: chunked
Content-Type: application/json
Example of Response Body
The following example shows the response returned in JSON format.
{
"identityDomain":"ExampleIdentityDomain",
"serviceType":"JaaS",
"serviceName":"ExampleInstance",
"credName":"vmspublickey",
"credType":"SSH",
"componentType":"WLS",
"parentType":"SERVICE",
"lastUpdateTime":"2016-04-19T19:29:49.257+0000",
"lastUpdateStatus":"success",
"lastUpdateMessage":"newly created",
"osUserName":"opc",
"computeKeyName":"\/OPCWLS\/myuser\/jaas.ExampleInstance.wls.ora_user",
"publicKey":"ssh-rsa ZXZXB3NzaC1yc2EAAAABJQAAAQEAr57JqX\/vDab9T+WNxymhCIYSZhv9kVeUTtT0BhvW6WV2BQCvN1YfiHsSvAt25YoKBOYM999CPUClbIySfwQEpNhZVtw+mUlKd1SNP3ZMgSakHQG8gbtrVxPcpxdeTiYXlEYXetZv20g2PF9JRcN6lYsjS41fhotfytW4IsZ+Vf7PN44\/kpU\/W\/qPcePK6HlY+iLUKzN\/tBCenCBJgrRYj5FUQBf1Ujli4nl0mJ3HKC4pbZ4V0OoxL0Yt\/qRDUJOrUQilzapABzftzTstVAeaSAsp9tr+k8+MxsI37AvJwy1PvhWW4MU1x8y7gfJPsFfJ9lFH5T6PiZasBtpPWGEeeE== rsa-key-20133333",
"description":"Service user ssh public key which can be used to access the service VM instances"
}