View Selected SSH Keys' Details
/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
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.
-
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 a Database Classic Cloud Service instance. The response is limited to SSH keys for this service instance. If omitted, SSH keys for all Database Classic Cloud Service instances in the identity domain are returned.
-
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
-
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 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.
-
serviceState(optional):
string
The status of the service instance. For example,
RUNNING
. -
serviceType(optional):
string
The value
DBaaS
.
Examples
The following example shows how to view detailed information about the SSH public keys for all Database Classic Cloud Service instances in the identity domain 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 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/credentials
HTTP Status Code and Response Headers
HTTP/1.1 200 OK Date: date-and-time-stamp Server: Oracle-Application-Server-11g Content-Length: 2903 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
{ "items":[ { "identityDomain":"usexample", "serviceType":"DBaaS", "serviceName":"db12c-xp-si", "credName":"vmspublickey", "credType":"SSH", "componentType":"DB", "parentType":"SERVICE", "lastUpdateTime":"2016-06-21T17:02:55.937+0000", "lastUpdateStatus":"success", "lastUpdateMessage":"newly created", "osUserName":"opc", "computeKeyName":"\/Compute-usexample\/dbcsadmin\/dbaas.db12c-xp-si.DB.ora_user", "publicKey":"public-key-value", "description":"Service user ssh public key which can be used to access the service VM instances", "serviceState":"RUNNING" }, { "identityDomain":"usexample", "serviceType":"DBaaS", "serviceName":"db12c-xp-rac", "credName":"vmspublickey", "credType":"SSH", "componentType":"DB", "parentType":"SERVICE", "lastUpdateTime":"2016-06-28T23:52:45.633+0000", "lastUpdateStatus":"success", "lastUpdateMessage":"newly created", "osUserName":"opc", "computeKeyName":"\/Compute-usexample\/dbcsadmin\/dbaas.db12c-xp-rac.DB.ora_user", "publicKey":"public-key-value", "description":"Service user ssh public key which can be used to access the service VM instances", "serviceState":"RUNNING" }, { "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", "serviceState":"RUNNING" } ], "hasMore":false, "totalResults":3 }