Jump to

• Request
• Response
• Examples

View the Summary for an SSH Key

get

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

Returns summary information about an SSH key. This API returns information relating to only one SSH key associated with the Exadata Cloud Service environment that supports the specified database deployment. Other keys may exist. To view summary information about all of the keys associated with the Exadata Cloud Service environment see View Summaries for Selected SSH Keys.

Request

Path Parameters

• credentialName: string
  The value vmspublickey.
• 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 format idcs-letters-and-numbers.

• serviceId: string
  Name of an existing Exadata Cloud Service database deployment.

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

  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 format idcs-letters-and-numbers.

  For more information, see Security, Authentication and Authorization.

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

• 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
  Name of the identity domain.
• serviceName(optional): string
  Name of the Exadata Cloud Service database deployment.
• serviceType(optional): string
  The value DBaaS.

{
    "title":"Response Body",
    "type":"object",
    "description":"",
    "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":"Name of the identity domain."
        },
        "serviceName":{
            "type":"string",
            "description":"Name of the Exadata Cloud Service database deployment."
        },
        "serviceType":{
            "type":"string",
            "description":"The value <code>DBaaS</code>."
        }
    }
}

Back to Top

Examples

The following example shows how to view summary information about an SSH key associated with an Exadata Cloud Service 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/crednames/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: 005KBGUbqgV6uHFpR05Eid0007dd0002MB
x-oracle-dms-ecid: 005KBGUbqgV6uHFpR05Eid0007dd0002MB
access-control-allow-origin: *
x-frame-options: DENY
content-type: application/json
vary: user-agent
date: Tue, 30 May 2017 01:57:01 GMT
content-length: 378

Response Body

{
	"identityDomain": "usexample",
	"serviceType": "dbaas",
	"serviceName": "db12c",
	"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\/services\/dbaas\/instances\/db12c\/credentials\/crednames\/vmspublickey"
}

Back to Top