View the Details for an SSH Key
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/credentials/{credentialName}
Request
-
credentialName: string
The value
vmspublickey
. -
identityDomainId: string
The value depends on the type of Exadata Cloud at Customer account that is used to make the request:
For a Traditional Cloud Account, specify the
Identity Domain Name
that is associated with the service.For a Cloud Account with Identity Cloud Service, specify the
Identity Service Id
that is associated with the service, which is a character string beginning withidcs-
.
-
serviceId: string
Name of an existing Exadata Cloud at Customer database deployment.
-
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
The value depends on the type of Exadata Cloud at Customer account that is used to make the request:
For a Traditional Cloud Account, specify the
Identity Domain Name
that is associated with the service.For a Cloud Account with Identity Cloud Service, specify the
Identity Service Id
that is associated with the service, which is a character string beginning withidcs-
.
For more information, see Security, Authentication and Authorization.
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.
-
credName(optional):
string
The value
vmspublickey
. -
credType(optional):
string
The value
SSH
. -
description(optional):
string
A description of the key.
-
identityDomain(optional):
string
Name of the identity domain.
-
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
Name of the Exadata Cloud at Customer database deployment.
-
serviceType(optional):
string
The value
DBaaS
.
Examples
The following example shows how to view detailed information about an SSH key associated with an Exadata Cloud at Customer database deployment by submitting a GET request on the REST endpoint using cURL.
In this example, the identity domain is usexample
, and the Oracle Cloud user name and password are serviceadmin
and Pa55_word
. The name of the database deployment is db12c
.
cURL Command
curl -i -X GET --cacert ~/cacert.pem -u serviceadmin:Pa55_word -H "X-ID-TENANT-NAME:usexample" https://dbaas.oraclecloud.com/paas/api/v1.1/instancemgmt/usexample/services/dbaas/instances/db12c/credentials/vmspublickey
HTTP Status Code and Response Headers
HTTP/2.0 200 server: Oracle-Application-Server-11g strict-transport-security: max-age=31536000;includeSubDomains content-language: en access-control-allow-headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME access-control-allow-methods: GET, POST, DELETE, PUT, OPTIONS, HEAD x-oracle-dms-ecid: 005KBGMcfQw6uHFpR05Eid0007dd0002LF x-oracle-dms-ecid: 005KBGMcfQw6uHFpR05Eid0007dd0002LF access-control-allow-origin: * x-frame-options: DENY content-type: application/json vary: user-agent date: Tue, 30 May 2017 01:54:48 GMT content-length: 807
Response Body
{ "identityDomain": "usexample", "serviceType": "DBaaS", "serviceName": "db12c", "credName": "vmspublickey", "credType": "SSH", "componentType": "DB", "parentType": "SERVICE", "lastUpdateTime": "2017-05-29T01:48:26.543+0000", "lastUpdateStatus": "success", "lastUpdateMessage": "newly created", "osUserName": "opc", "publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEA7QMRmWQuy09cQdrJd7h0VoWDIpNRmdRUHaCenu3RRRt2IGasAhLw7DI1yP9JXyJ9c2dKkteQXIB3FRYCAWj7T\/r4yPLbzrMEpcuANdBRhkQvwyqDEbNWsqoQoxRBRDTcYEObiJ4PvcH7bV1MR++OtqDg2qBT2f+KwVglH8MuyB7yg\/DGuP1j1Lwylwzy\/Iw+TzLaWP0l3woZGL7KIZWkkXKUx+nvqY8iEb\/4\/YqN9ZK4GGK7vLCrrICK3RTjDhclHg1s+64Bb0IqceZpY38xAI8EW\/4PNyv3Ag7IZEkiojOEd3znYexsZK3b78+VKWewOsffXqnVHrANAGzedLz\/ew== rsa-key-20160712", "description": "Service user ssh public key which can be used to access the service VM instances" }