Jump to

• Request
• Response
• Examples

View Selected SSH Keys' Summaries

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/credentials/crednames

Returns summary information about SSH keys for one or more Database Classic Cloud Service instances as determined by query parameters you provide.

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

Path Parameters

• 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.

Query Parameters

• 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.

Header Parameters

• 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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK. See Status Codes for information about other possible HTTP status codes.

Body ()

Root Schema : Response Body

Type: object

Title: Response Body

Show Source

• 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.

{
    "title":"Response Body",
    "type":"object",
    "description":"",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more keys are available to be requested, with the value <code>true</code> indicating that more are available."
        },
        "items":{
            "title":"items Array",
            "type":"array",
            "description":"Array of JSON objects, with one element for each key returned.",
            "items":{
                "$ref":"#/definitions/view-summaries-selected-items-array-item"
            }
        },
        "totalResults":{
            "type":"integer",
            "description":"Number of keys returned by this request."
        }
    }
}

Nested Schema : items Array

Type: array

Title: items Array

Array of JSON objects, with one element for each key returned.

Show Source

• Array of: object items Array Item
  Title: items Array Item

{
    "title":"items Array",
    "type":"array",
    "description":"Array of JSON objects, with one element for each key returned.",
    "items":{
        "$ref":"#/definitions/view-summaries-selected-items-array-item"
    }
}

Nested Schema : items Array Item

Type: object

Title: items Array Item

Show Source

• canonicalUrl(optional): string
  URL to query the credential key value.
• 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.
• serviceName(optional): string
  The name of the Database Classic Cloud Service instance.
• serviceType(optional): string
  The value DBaaS.

{
    "title":"items Array Item",
    "type":"object",
    "properties":{
        "canonicalUrl":{
            "type":"string",
            "description":"URL to query the credential key value."
        },
        "credName":{
            "type":"string",
            "description":"The value <code>vmspublickey</code>."
        },
        "credType":{
            "type":"string",
            "description":"The value <code>SSH</code>."
        },
        "description":{
            "type":"string",
            "description":"A description of the key."
        },
        "identityDomain":{
            "type":"string",
            "description":"The name of the identity domain for the Database Classic Cloud Service account."
        },
        "serviceName":{
            "type":"string",
            "description":"The name of the Database Classic Cloud Service instance."
        },
        "serviceType":{
            "type":"string",
            "description":"The value <code>DBaaS</code>."
        }
    }
}

Back to Top

Examples

The following example shows how to view summary 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/crednames

HTTP Status Code and Response Headers

HTTP/1.1 200 OK
Date: date-and-time-stamp
Server: Oracle-Application-Server-11g
Content-Length: 1268
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",
      "description":"Service user ssh public key which can be used to access the service VM instances",
      "canonicalUrl":"https:\/\/dbaas.oraclecloud.com:443\/paas\/api\/v1.1\/instancemgmt\/usexample\/service\/dbaas\/instances\/db12c-xp-si\/credentials\/crednames\/vmspublickey"
    },
    {
      "identityDomain":"usexample",
      "serviceType":"dbaas",
      "serviceName":"db12c-xp-rac",
      "credName":"vmspublickey",
      "credType":"SSH",
      "description":"Service user ssh public key which can be used to access the service VM instances",
      "canonicalUrl":"https:\/\/dbaas.oraclecloud.com:443\/paas\/api\/v1.1\/instancemgmt\/usexample\/service\/dbaas\/instances\/db12c-xp-rac\/credentials\/crednames\/vmspublickey"
    },
    {
      "identityDomain":"usexample",
      "serviceType":"dbaas",
      "serviceName":"db12c-xp-si2",
      "credName":"vmspublickey",
      "credType":"SSH",
      "description":"Service user ssh public key which can be used to access the service VM instances",
      "canonicalUrl":"https:\/\/dbaas.oraclecloud.com:443\/paas\/api\/v1.1\/instancemgmt\/usexample\/service\/dbaas\/instances\/db12c-xp-si2\/credentials\/crednames\/vmspublickey"
    }
  ],
  "hasMore":false,
  "totalResults":3
}

Back to Top