Jump to

• Request
• Response
• Examples

View an SSH Key's Summary

get

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

Returns summary 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.

Query Parameters

• limitRowCount(optional): string
  The maximum number of SSH keys to include in the response. If omitted, a maximum of 50 keys are included in the response.
• offset(optional): string
  The number of SSH 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.

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-key-description-item

Type: object

The details of one SSH key.

Show Source

• canonicalUrl(optional): string
  URL to query the SSH key value.
• 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.
• 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>."
        },
        "description":{
            "type":"string",
            "description":"Credential description of the credential name."
        },
        "canonicalUrl":{
            "type":"string",
            "description":"URL to query the SSH key value."
        }
    }
}

Examples

The following example shows how to view summary information about the SSH public 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.

The only valid {credentialName} value is vmspublickey

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/crednames/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:23:27 GMT
Transfer-Encoding: chunked
Content-Type: application/json
X-ORACLE-DMS-ECID: c38b-706d66ce303b8-02-22713d6-89087e409d38b2-
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.

{
    "identityDomain": "ExampleIdentityDomain",
    "serviceType": "MySQLCS",
    "serviceName": "MyTestInstance",
    "credName": "vmspublickey",
    "credType": "SSH",
    "description": "Service user ssh public key which can be used to access the service VM instances",
    "canonicalUrl": "https:\/\/rest_server_url\/\/paas\/api\/v1.1\/instancemgmt\/ExampleIdentityDomain\/service\/MySQLCS\/instances\/MyTestInstance\/credentials\/crednames\/vmspublickey"
}