Jump to

• Request
• Response
• Examples

View an SSH Key's Details

get

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

Returns detailed information about the SSH key for a MySQL Cloud Service instance.

Request

Path Parameters

• credentialName: string
  Credential name associated with the SSH public key. The only supported credential name is vmspublickey.
• identityDomainId: string
  Name of the identity domain for the MySQL Cloud Service account.
• serviceId: string
  The user-defined name of the Oracle MySQL Cloud Service instance.

Header Parameters

• X-ID-TENANT-NAME: string
  Name of the identity domain for the MySQL Cloud Service account.

Response

Supported Media Types

• application/json

200 Response

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

Body ()

The details of one SSH key.

Root Schema : ssh-get-key-details-response

Type: object

The details of one SSH key.

Show Source

• 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
  Credential name. The only supported credential name is vmspublickey.
• credType(optional): string
  Credential type. The only supported value is SSH.
• description(optional): string
  Credential description of the credential name.
• identityDomain(optional): string
  Identity domain ID for the Oracle MySQL Cloud Service account.
• lastUpdateMessage(optional): string
  Message returned from the last update for the SSH key. For example: newly created, updated by username.
• lastUpdateStatus(optional): string
  Status of the last update for the SSH key.
• lastUpdateTime(optional): string
  Date and time the SSH key was last updated. For example, 2017-09-21T18:10:09.006+0000.
• osUserName(optional): string
  Compute virtual machine OS user name. The only supported value is opc.
• parentType(optional): string
  The value SERVICE.
• publicKey(optional): string
  Public key for the secure shell (SSH). This key is used for authentication when connecting to the Oracle MySQL Cloud Service instance using an SSH client.
• serviceName(optional): string
  Name of the Oracle MySQL Cloud Service instance.
• serviceType(optional): string
  Cloud service type. This value is MySQLCS for Oracle MySQL Cloud Service.

{
    "description":"The details of one SSH key.",
    "properties":{
        "identityDomain":{
            "type":"string",
            "description":"Identity domain ID for the Oracle MySQL Cloud Service account."
        },
        "serviceType":{
            "type":"string",
            "description":"Cloud service type. This value is <code>MySQLCS</code> for Oracle MySQL Cloud Service."
        },
        "serviceName":{
            "type":"string",
            "description":"Name of the Oracle MySQL Cloud Service instance."
        },
        "credName":{
            "type":"string",
            "description":"Credential name. The only supported credential name is <code>vmspublickey</code>."
        },
        "credType":{
            "type":"string",
            "description":"Credential type. The only supported value is <code>SSH</code>."
        },
        "parentType":{
            "type":"string",
            "description":"The value <code>SERVICE</code>."
        },
        "lastUpdateTime":{
            "type":"string",
            "description":"Date and time the SSH key was last updated. For example, <code>2017-09-21T18:10:09.006+0000</code>."
        },
        "lastUpdateStatus":{
            "type":"string",
            "description":"Status of the last update for the SSH key."
        },
        "lastUpdateMessage":{
            "type":"string",
            "description":"Message returned from the last update for the SSH key. For example: <code>newly created</code>, <code>updated by <em>username</em></code>."
        },
        "osUserName":{
            "type":"string",
            "description":"Compute virtual machine OS user name. The only supported value is <code>opc</code>."
        },
        "computeKeyName":{
            "type":"string",
            "description":"The fully qualified name of the SSH Key object in Oracle Compute Cloud Service where the SSH public key value is stored."
        },
        "publicKey":{
            "type":"string",
            "description":"Public key for the secure shell (SSH). This key is used for authentication when connecting to the Oracle MySQL Cloud Service instance using an SSH client."
        },
        "description":{
            "type":"string",
            "description":"Credential description of the credential name."
        }
    }
}

Examples

The following example shows how to view detailed information about the public SSH key for a MySQL Cloud Service instance by submitting a GET request on the REST endpoint using cURL

Note: The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the Oracle Public Cloud or Oracle Cloud Machine REST server to contact for your identity domain or tenant name. See Send Requests for the appropriate URL structure to use on Oracle Public Cloud or Oracle Cloud Machine.

cURL Command

curl -i -X GET \
  -u "username:password" \
  -H "X-ID-TENANT-NAME: ExampleIdentityDomain" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/MyTestInstance/credentials/vmspublickey 

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Wed, 30 Nov 2016 23:22:30 GMT
Transfer-Encoding: chunked
Content-Type: application/json
X-ORACLE-DMS-ECID: 76-ed432b397b1-a636818230e98df0cbc08-3--6017c
X-Frame-Options: DENY
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
Access-Control-Allow-Headers: Content-Type, api_key, Authorization
Access-Control-Allow-Origin: *

Example of Response Body

The following shows an example of the response body in JSON format. In this example, a request was made to change a user's SSH key, and that request is still being processed.

{
    "identityDomain": "ExampleIdentityDomain",
    "serviceType": "MySQLCS",
    "serviceName": "MyTestInstance",
    "credName": "vmspublickey",
    "credType": "SSH",
    "parentType": "SERVICE",
    "lastUpdateTime": "2016-11-30T23:16:04.344+0000",
    "lastUpdateStatus": "INPROGRESS",
    "lastUpdateMessage": "Resetting user ssh public key in progress",
    "osUserName": "opc",
    "computeKeyName": "\/mysql\/foo\/paas.MySQLCS.MyTestInstance.ora_opc__vm_user_ssh_cred_",
    "publicKey": "ssh-rsa AAA...",
    "description": "Service user ssh public key which can be used to access the service VM instances"
}