View an SSH Key's Details
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/credentials/{credentialName}
Request
-
credentialName: string
The value
vmspublickey
. -
identityDomainId: string
Identity domain ID for the Database Classic Cloud Service account:
For a Cloud account with Identity Cloud Service: the identity service ID, which has the form
idcs-letters-and-numbers
. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.For a traditional cloud account: the name of the identity domain.
-
serviceId: string
Name of the Database Classic Cloud Service instance.
-
Authorization: string
Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
-
X-ID-TENANT-NAME: string
Identity domain ID for the Database Classic Cloud Service account:
For a Cloud account with Identity Cloud Service: the identity service ID, which has the form
idcs-letters-and-numbers
. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.For a traditional cloud account: the name of the identity domain.
Response
- application/json
200 Response
object
Response Body
-
componentType(optional):
string
The value
DB
. -
computeKeyName(optional):
string
The fully qualified name of the SSH Key object in Oracle Compute Cloud Service where the SSH public key value is stored.
-
credName(optional):
string
The value
vmspublickey
. -
credType(optional):
string
The value
SSH
. -
description(optional):
string
A description of the key.
-
identityDomain(optional):
string
The name of the identity domain for the Database Classic Cloud Service account.
-
lastUpdateMessage(optional):
string
The message returned from the last update of the SSH key. For example:
newly created
,updated by username
. -
lastUpdateStatus(optional):
string
Status of the last update of the SSH key.
-
lastUpdateTime(optional):
string
Date and time of the last update of the SSH key.
-
osUserName(optional):
string
The value
opc
. -
parentType(optional):
string
The value
SERVICE
. -
publicKey(optional):
string
The value of the SSH public key, with any slashes (
/
) it contains preceded by backslashes, as in\/
. -
serviceName(optional):
string
The name of the Database Classic Cloud Service instance.
-
serviceType(optional):
string
The value
DBaaS
.
Examples
The following example shows how to view detailed information about the SSH public key for a Database Classic Cloud Service instance by submitting a GET request on the REST endpoint using cURL.
This example uses a traditional cloud account, so the {identityDomainId}
path parameter and the X-ID-TENANT-NAME
header parameter are set to the account's domain name, which is usexample
. The service instance is db12c-xp-si2
and the Oracle Cloud user name of the user making the call is dbcsadmin
.
cURL Command
$ curl --include --request GET \
--user dbcsadmin:password \
--header "X-ID-TENANT-NAME:usexample" \
https://dbaas.oraclecloud.com/paas/api/v1.1/instancemgmt/usexample/services/dbaas/instances/db12c-xp-si2/credentials/vmspublickey
HTTP Status Code and Response Headers
HTTP/1.1 200 OK Date: date-and-time-stamp Server: Oracle-Application-Server-11g Content-Length: 929 X-ORACLE-DMS-ECID: id-string X-ORACLE-DMS-ECID: id-string X-Frame-Options: DENY Vary: Accept-Encoding,User-Agent Content-Language: en Content-Type: application/json
Response Body
{
"identityDomain":"usexample",
"serviceType":"DBaaS",
"serviceName":"db12c-xp-si2",
"credName":"vmspublickey",
"credType":"SSH",
"componentType":"DB",
"parentType":"SERVICE",
"lastUpdateTime":"2016-07-18T19:22:49.907+0000",
"lastUpdateStatus":"success",
"lastUpdateMessage":"newly created",
"osUserName":"opc",
"computeKeyName":"\/Compute-usexample\/dbcsadmin\/dbaas.db12c-xp-si2.DB.ora_user",
"publicKey":"public-key-value",
"description":"Service user ssh public key which can be used to access the service VM instances"
}