View Details for Selected SSH Keys
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/credentials
By default, a single request returns a maximum of 50 keys. Use the limitRowCount
query parameter to control maximum number returned, and use the offset
query parameter to fetch additional results, if available.
Request
-
identityDomainId: string
The value depends on the type of Exadata Cloud Service 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 has the formatidcs-letters-and-numbers
.
-
limitRowCount(optional): string
The maximum number of keys to include in the response. If omitted, a maximum of 50 keys are included in the response.
-
offset(optional): string
The number of keys to skip before starting to collect keys for the response. If omitted, zero keys are skipped so that the response begins with the first key.
-
serviceName(optional): string
Name of an Exadata Cloud Service database deployment. Provide the name of an Exadata Cloud Service database deployment to limit output to keys associated with the corresponding Exadata Cloud Service environment. If you do not supply a deployment name, the output will show all of the SSH keys associated with all database deployments in the specified identity domain.
-
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 Service 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 has the formatidcs-letters-and-numbers
.
For more information, see Security, Authentication and Authorization.
Response
- application/json
200 Response
object
Response Body
-
hasMore(optional):
boolean
Indicates whether more keys are available to be requested, with the value
true
indicating that more are available. -
items(optional):
array items Array
Title:
items Array
Array of JSON objects, with one element for each key returned. -
totalResults(optional):
integer
Number of keys returned by this request.
array
items Array
-
Array of:
object items Array Item
Title:
items Array Item
object
items Array Item
-
componentType(optional):
string
The value
DB
. -
computeKeyName(optional):
string
The fully qualified name of the SSH Key.
-
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 Service database deployment.
-
serviceState(optional):
string
The status of the database deployment. For example,
RUNNING
. -
serviceType(optional):
string
The value
DBaaS
.
Examples
The following example shows how to view detailed information about SSH keys associated with Exadata Cloud Service 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
.
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/credentials
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: 005KBG42BW26uHFpR05Eid0007dd00006b x-oracle-dms-ecid: 005KBG42BW26uHFpR05Eid0007dd00006b access-control-allow-origin: * x-frame-options: DENY content-type: application/json vary: user-agent date: Tue, 30 May 2017 01:49:36 GMT content-length: 1719
Response Body
{ "items": [{ "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", "serviceState": "MAINTENANCE" }, { "identityDomain": "usexample", "serviceType": "DBaaS", "serviceName": "starter12c", "credName": "vmspublickey", "credType": "SSH", "componentType": "DB", "parentType": "SERVICE", "lastUpdateTime": "2017-05-10T23:26:04.253+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", "serviceState": "RUNNING" } ], "hasMore": false, "totalResults": 2 }