Jump to

• Request
• Response
• Examples

View All Service Instances

get

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

Return information about all MySQL Cloud Service instances.

Request

Path Parameters

• identityDomainId: string
  Name of the identity domain for the MySQL Cloud Service account.

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 ()

Root Schema : View All Instances Response

Type: object

Title: View All Instances Response

Root schema for the response body that contains information for all service instances.

Show Source

• services(optional): array All MySQL Cloud Service Instances
  Title: All MySQL Cloud Service Instances

  Array of JSON object elements, with one element for each MySQL Cloud Service instance in the identity domain.

{
    "title":"View All Instances Response",
    "type":"object",
    "description":"Root schema for the response body that contains information for all service instances.",
    "properties":{
        "services":{
            "title":"All MySQL Cloud Service Instances",
            "type":"array",
            "description":"Array of JSON object elements, with one element for each MySQL Cloud Service instance in the identity domain.",
            "items":{
                "$ref":"#/definitions/service-view-instance"
            }
        }
    }
}

Nested Schema : All MySQL Cloud Service Instances

Type: array

Title: All MySQL Cloud Service Instances

Array of JSON object elements, with one element for each MySQL Cloud Service instance in the identity domain.

Show Source

• [0]: object Service Instance Details
  Title: Service Instance Details

{
    "title":"All MySQL Cloud Service Instances",
    "type":"array",
    "description":"Array of JSON object elements, with one element for each MySQL Cloud Service instance in the identity domain.",
    "items":{
        "$ref":"#/definitions/service-view-instance"
    }
}

Nested Schema : Service Instance Details

Type: object

Title: Service Instance Details

Show Source

• activityLogs(optional): array Root Activity Log Schema
  Title: Root Activity Log Schema

  Activity log for the service instance.
• attributes(optional): array attributes
  Array of the service attributes. For example, MYSQL_PORT, CLOUD_STORAGE_CONTAINER, LOCAL_BACKUP_VOLUME_SIZE, etc.
• BACKUP_DESTINATION(optional): string
  Backup destination; either BOTH - Both Cloud Storage and Local Storage, or NONE - None.
• CLOUD_STORAGE_CONTAINER(optional): string
  Name of the Oracle Storage Cloud Service container used to provide storage for MySQL service instance backups.
• components(optional): array components
  Details for each service component.
• computeSiteName(optional): string
  The Oracle Cloud location housing the service instance.
• DATA_VOLUME_SIZE(optional): string
  Storage volume size for MySQL data.
• domainName(optional): string
  The identity domain housing the service instance.
• edition(optional): string
  The edition of MySQL Server. For example, EE.
• editionDisplayName(optional): string
  The display name of MySQL Server edition. For example, Enterprise Edition.
• LOCAL_BACKUP_VOLUME_MOUNT(optional): string
  The volume mount point for local backups.
• LOCAL_BACKUP_VOLUME_SIZE(optional): string
  Storage volume size for MySQL local backups.
• metaVersion(optional): string
  The release version of metadata service manager.
• meteringFrequency(optional): string
  The billing frequency of the service instance; either MONTHLY or HOURLY.
• meteringFrequencyDisplayName(optional): string
  The display name of the metering frequency; either Monthly or Hourly.
• MYSQL_PORT(optional): string
  The listener port for MySQL server.
• patching(optional): object Service Patching Details
  Title: Service Patching Details
• region(optional): string
  Region where the service instanced is provisioned.
• releaseVersion(optional): string
  The release version of MySQL Server. For example, 5.7.20.
• serviceId(optional): string
  ID of the Oracle MySQL Cloud Service instance.
• serviceLevel(optional): string
  The service level of the service instance. For example, PAAS for Oracle Cloud Service.
• serviceLevelDisplayName(optional): string
  The display name of the service level. For example, Oracle MySQL Cloud Service.
• serviceName(optional): string
  Name of the Oracle MySQL Cloud Service instance.
• serviceStateDisplayName(optional): string
  The display name of the service current state.
• serviceType(optional): string
  Type of the Oracle MySQL Cloud Service instance, such as MySQLCS.
• serviceVersion(optional): string
  The major version of MySQL Server. For example, 5.7.
• subscription(optional): string
  The subscription type of the service instance; either MONTHLY or HOURLY.
• totalSharedStorage(optional): string
  The total shared storage size; always 0 for MySQL Cloud Service.

{
    "title":"Service Instance Details",
    "type":"object",
    "properties":{
        "serviceId":{
            "type":"string",
            "description":"ID of the Oracle MySQL Cloud Service instance."
        },
        "serviceName":{
            "type":"string",
            "description":"Name of the Oracle MySQL Cloud Service instance."
        },
        "serviceType":{
            "type":"string",
            "description":"Type of the Oracle MySQL Cloud Service instance, such as <code>MySQLCS</code>."
        },
        "domainName":{
            "type":"string",
            "description":"The identity domain housing the service instance."
        },
        "serviceVersion":{
            "type":"string",
            "description":"The major version of MySQL Server. For example, <code>5.7</code>."
        },
        "region":{
            "type":"string",
            "description":"Region where the service instanced is provisioned."
        },
        "releaseVersion":{
            "type":"string",
            "description":"The release version of MySQL Server. For example, <code>5.7.20</code>."
        },
        "metaVersion":{
            "type":"string",
            "description":"The release version of metadata service manager."
        },
        "serviceLevel":{
            "type":"string",
            "description":"The service level of the service instance. For example, <code>PAAS</code> for Oracle Cloud Service."
        },
        "subscription":{
            "type":"string",
            "description":"The subscription type of the service instance; either <code>MONTHLY</code> or <code>HOURLY</code>."
        },
        "meteringFrequency":{
            "type":"string",
            "description":"The billing frequency of the service instance; either <code>MONTHLY</code> or <code>HOURLY</code>."
        },
        "edition":{
            "type":"string",
            "description":"The edition of MySQL Server. For example, <code>EE</code>."
        },
        "attributes":{
            "type":"array",
            "description":"Array of the service attributes. For example, <code>MYSQL_PORT</code>, <code>CLOUD_STORAGE_CONTAINER</code>, <code>LOCAL_BACKUP_VOLUME_SIZE</code>, etc.",
            "items":{
                "$ref":"#/definitions/service-attributes"
            }
        },
        "components":{
            "type":"array",
            "description":"Details for each service component.",
            "items":{
                "$ref":"#/definitions/service-view-components"
            }
        },
        "activityLogs":{
            "title":"Root Activity Log Schema",
            "description":"Activity log for the service instance.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/service-view-activity-log"
            }
        },
        "serviceLevelDisplayName":{
            "type":"string",
            "description":"The display name of the service level. For example, <code>Oracle MySQL Cloud Service</code>."
        },
        "editionDisplayName":{
            "type":"string",
            "description":"The display name of MySQL Server edition. For example, <code>Enterprise Edition</code>."
        },
        "meteringFrequencyDisplayName":{
            "type":"string",
            "description":"The display name of the metering frequency; either <code>Monthly</code> or <code>Hourly</code>."
        },
        "DATA_VOLUME_SIZE":{
            "type":"string",
            "description":"Storage volume size for MySQL data."
        },
        "MYSQL_PORT":{
            "type":"string",
            "description":"The listener port for MySQL server."
        },
        "BACKUP_DESTINATION":{
            "type":"string",
            "description":"Backup destination; either <code>BOTH</code> - Both Cloud Storage and Local Storage, or <code>NONE</code> - None."
        },
        "CLOUD_STORAGE_CONTAINER":{
            "type":"string",
            "description":"Name of the Oracle Storage Cloud Service container used to provide storage for MySQL service instance backups."
        },
        "LOCAL_BACKUP_VOLUME_MOUNT":{
            "type":"string",
            "description":"The volume mount point for local backups."
        },
        "LOCAL_BACKUP_VOLUME_SIZE":{
            "type":"string",
            "description":"Storage volume size for MySQL local backups."
        },
        "totalSharedStorage":{
            "type":"string",
            "description":"The total shared storage size; always <code>0</code> for MySQL Cloud Service."
        },
        "serviceStateDisplayName":{
            "type":"string",
            "description":"The display name of the service current state."
        },
        "computeSiteName":{
            "type":"string",
            "description":"The Oracle Cloud location housing the service instance."
        },
        "patching":{
            "$ref":"#/definitions/service-view-patching"
        }
    }
}

Nested Schema : Root Activity Log Schema

Type: array

Title: Root Activity Log Schema

Activity log for the service instance.

Show Source

• [0]: object Activity Log Details
  Title: Activity Log Details

  Activity logs of the operation.

{
    "title":"Root Activity Log Schema",
    "description":"Activity log for the service instance.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/service-view-activity-log"
    }
}

Nested Schema : attributes

Type: array

Array of the service attributes. For example, MYSQL_PORT, CLOUD_STORAGE_CONTAINER, LOCAL_BACKUP_VOLUME_SIZE, etc.

Show Source

• [0]: object Service Component Attribute Details
  Title: Service Component Attribute Details

{
    "type":"array",
    "description":"Array of the service attributes. For example, <code>MYSQL_PORT</code>, <code>CLOUD_STORAGE_CONTAINER</code>, <code>LOCAL_BACKUP_VOLUME_SIZE</code>, etc.",
    "items":{
        "$ref":"#/definitions/service-attributes"
    }
}

Nested Schema : components

Type: array

Details for each service component.

Show Source

• [0]: object Service Instance Component Details
  Title: Service Instance Component Details

{
    "type":"array",
    "description":"Details for each service component.",
    "items":{
        "$ref":"#/definitions/service-view-components"
    }
}

Nested Schema : Service Patching Details

Type: object

Title: Service Patching Details

Show Source

• currentOperation(optional): object Service Patching Operation Details
  Title: Service Patching Operation Details
• totalAvailablePatches(optional): integer
  Total number of available patches.

{
    "title":"Service Patching Details",
    "type":"object",
    "properties":{
        "currentOperation":{
            "$ref":"#/definitions/service-view-current-operation"
        },
        "totalAvailablePatches":{
            "type":"integer",
            "description":"Total number of available patches."
        }
    }
}

Nested Schema : Activity Log Details

Type: object

Title: Activity Log Details

Activity logs of the operation.

Show Source

• activityLogId(optional): string
  The log ID of the operation.
• authDomain(optional): string
  Identity domain for the Oracle MySQL Cloud Service account.
• authUser(optional): string
  The authentication user.
• endDate(optional): string
  The date and time when the job ended.
• identityDomain(optional): string
  The identity domain hosting the instance.
• initiatedBy(optional): string
  The user making the request.
• jobId(optional): string
  The ID of the current job.
• messages(optional): array messages
  Log details of the operation.
• operationId(optional): string
  The corresponding ID of the operation.
• operationType(optional): string
  The type of the operation, such as CREATE_SERVICE.
• serviceId(optional): string
  The corresponding ID of the MySQL Cloud Service instance.
• serviceName(optional): string
  The name of the instance.
• serviceType(optional): string
  The service type of the instance.
• startDate(optional): string
  The date and time when the job started.
• status(optional): string

  Current status of the job; one of: In Progress, Succeeded, Failed.

• summaryMessage(optional): string
  The summary of the activity log.

{
    "title":"Activity Log Details",
    "description":"Activity logs of the operation.",
    "properties":{
        "activityLogId":{
            "type":"string",
            "description":"The log ID of the operation."
        },
        "serviceName":{
            "type":"string",
            "description":"The name of the instance."
        },
        "serviceType":{
            "type":"string",
            "description":"The service type of the instance."
        },
        "identityDomain":{
            "type":"string",
            "description":"The identity domain hosting the instance."
        },
        "serviceId":{
            "type":"string",
            "description":"The corresponding ID of the MySQL Cloud Service instance."
        },
        "jobId":{
            "type":"string",
            "description":"The ID of the current job."
        },
        "startDate":{
            "type":"string",
            "description":"The date and time when the job started."
        },
        "endDate":{
            "type":"string",
            "description":"The date and time when the job ended."
        },
        "status":{
            "type":"string",
            "description":"<p>Current status of the job; one of: <code>In Progress</code>, <code>Succeeded</code>, <code>Failed</code>.</p>"
        },
        "operationId":{
            "type":"string",
            "description":"The corresponding ID of the operation."
        },
        "operationType":{
            "type":"string",
            "description":"The type of the operation, such as <code>CREATE_SERVICE</code>."
        },
        "summaryMessage":{
            "type":"string",
            "description":"The summary of the activity log."
        },
        "authDomain":{
            "type":"string",
            "description":"Identity domain for the Oracle MySQL Cloud Service account."
        },
        "authUser":{
            "type":"string",
            "description":"The authentication user."
        },
        "initiatedBy":{
            "type":"string",
            "description":"The user making the request."
        },
        "messages":{
            "type":"array",
            "description":"Log details of the operation.",
            "items":{
                "$ref":"#/definitions/service-message-item"
            }
        }
    }
}

Nested Schema : messages

Type: array

Log details of the operation.

Show Source

• [0]: object Service Message Details
  Title: Service Message Details

  Details for a specific service message log.

{
    "type":"array",
    "description":"Log details of the operation.",
    "items":{
        "$ref":"#/definitions/service-message-item"
    }
}

Nested Schema : Service Message Details

Type: object

Title: Service Message Details

Details for a specific service message log.

Show Source

• activityDate(optional): string
  The date and time of the current activity.
• message(optional): string
  The message of the activity.

{
    "title":"Service Message Details",
    "description":"Details for a specific service message log.",
    "properties":{
        "activityDate":{
            "type":"string",
            "description":"The date and time of the current activity."
        },
        "message":{
            "type":"string",
            "description":"The message of the activity."
        }
    }
}

Nested Schema : Service Component Attribute Details

Type: object

Title: Service Component Attribute Details

Show Source

• displayName(optional): string
  Display name of the attribute.
• displayValue(optional): string
  Display value of the attribute.
• isKeyBinding(optional): boolean
  Indicates whether the attribute is key binding.
• type(optional): string
  Type of the attribute.
• value(optional): string
  Value of the attribute.

{
    "title":"Service Component Attribute Details",
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string",
            "description":"Display name of the attribute."
        },
        "type":{
            "type":"string",
            "description":"Type of the attribute."
        },
        "value":{
            "type":"string",
            "description":"Value of the attribute."
        },
        "displayValue":{
            "type":"string",
            "description":"Display value of the attribute."
        },
        "isKeyBinding":{
            "type":"boolean",
            "description":"Indicates whether the attribute is key binding."
        }
    }
}

Nested Schema : Service Instance Component Details

Type: object

Title: Service Instance Component Details

Show Source

• adminHostName(optional): string
  The host name of the administration node. It is usually the instance itself.
• attributes(optional): array attributes
  Array of service component attributes, such as compute shape, connect string, etc.
• componentId(optional): string
  ID of the service component.
• creationDate(optional): string
  The date and time when the service instance was created.
• instanceName(optional): string
  The component name of the service instance. For example, mysql.
• instanceRole(optional): string
  The role of the service instance. It is None for Oracle MySQL Cloud Service.
• serviceId(optional): string
  ID of the Oracle MySQL Cloud Service instance.
• state(optional): string
  The current state of the component.
• storageVolumes(optional): array storageVolumes
  All storage volumes of the service instance.
• version(optional): string
  The version of the component. For example, 5.7.
• vmInstances(optional): array vmInstances
  VM instances details.

{
    "title":"Service Instance Component Details",
    "type":"object",
    "properties":{
        "serviceId":{
            "type":"string",
            "description":"ID of the Oracle MySQL Cloud Service instance."
        },
        "componentId":{
            "type":"string",
            "description":"ID of the service component."
        },
        "state":{
            "type":"string",
            "description":"The current state of the component."
        },
        "version":{
            "type":"string",
            "description":"The version of the component. For example, <code>5.7</code>."
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time when the service instance was created."
        },
        "instanceName":{
            "type":"string",
            "description":"The component name of the service instance. For example, <code>mysql</code>."
        },
        "instanceRole":{
            "type":"string",
            "description":"The role of the service instance. It is <code>None</code> for Oracle MySQL Cloud Service."
        },
        "attributes":{
            "type":"array",
            "description":"Array of service component attributes, such as compute shape, connect string, etc.",
            "items":{
                "$ref":"#/definitions/service-attributes"
            }
        },
        "vmInstances":{
            "type":"array",
            "description":"VM instances details.",
            "items":{
                "$ref":"#/definitions/service-vm-instance-details"
            }
        },
        "adminHostName":{
            "type":"string",
            "description":"The host name of the administration node. It is usually the instance itself."
        },
        "storageVolumes":{
            "type":"array",
            "description":"All storage volumes of the service instance.",
            "items":{
                "$ref":"#/definitions/service-view-storage-volume"
            }
        }
    }
}

Nested Schema : attributes

Type: array

Array of service component attributes, such as compute shape, connect string, etc.

Show Source

• [0]: object Service Component Attribute Details
  Title: Service Component Attribute Details

{
    "type":"array",
    "description":"Array of service component attributes, such as compute shape, connect string, etc.",
    "items":{
        "$ref":"#/definitions/service-attributes"
    }
}

Nested Schema : storageVolumes

Type: array

All storage volumes of the service instance.

Show Source

• [0]: object Storage Volume Details
  Title: Storage Volume Details

{
    "type":"array",
    "description":"All storage volumes of the service instance.",
    "items":{
        "$ref":"#/definitions/service-view-storage-volume"
    }
}

Nested Schema : vmInstances

Type: array

VM instances details.

Show Source

• [0]: object Virtual Machine (VM) Instance Details
  Title: Virtual Machine (VM) Instance Details

{
    "type":"array",
    "description":"VM instances details.",
    "items":{
        "$ref":"#/definitions/service-vm-instance-details"
    }
}

Nested Schema : Storage Volume Details

Type: object

Title: Storage Volume Details

Show Source

• name(optional): string
  Name of the storage volume.
• partitions(optional): string
  Number of partitions of the storage volume.
• size(optional): string
  Size of the storage volume.

{
    "title":"Storage Volume Details",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the storage volume."
        },
        "size":{
            "type":"string",
            "description":"Size of the storage volume."
        },
        "partitions":{
            "type":"string",
            "description":"Number of partitions of the storage volume."
        }
    }
}

Nested Schema : Virtual Machine (VM) Instance Details

Type: object

Title: Virtual Machine (VM) Instance Details

Show Source

• componentType(optional): string
  The type of the component. It is usually mysql for Oracle MySQL Cloud Service.
• creationDate(optional): string
  The date and time when the service instance was created.
• hostname(optional): string
  The host name of the compute node.
• ipAddress(optional): string
  The IP address of the compute node.
• isAdminNode(optional): boolean
  Indicates whether the compute node is an administration node.
• label(optional): string
  The label of the compute node.
• publicIpAddress(optional): string
  The IP address of the compute node.
• role(optional): string
  The role of the compute node. It is usually MYSQL_SERVER for Oracle MySQL Cloud Service.
• servers(optional): array servers
  Servers instance information.
• shapeId(optional): string
  The Oracle Compute Cloud shape of the compute node.
• state(optional): string
  The current state of the compute node. Valid values are:

  • Ready: Fully operational
  • Starting: Being created or initialized
  • Stopping: Being stopped
  • Error: Has some error condition(s)
• storageVolumes(optional): array storageVolumes
  All storage volumes of the service instance.
• totalStorage(optional): integer
  The size in GB of the total storage allocated to the compute node, including data volume, backup volume, and MySQL log volume.
• usageType(optional): string
  The usage type of the compute node. It is usually MYSQL_SERVER for Oracle MySQL Cloud Service.
• vmId(optional): string
  The ID of the compute node.
• vmStateDisplayName(optional): string
  The display name of the current state of the compute node.

{
    "title":"Virtual Machine (VM) Instance Details",
    "type":"object",
    "properties":{
        "vmId":{
            "type":"string",
            "description":"The ID of the compute node."
        },
        "hostname":{
            "type":"string",
            "description":"The host name of the compute node."
        },
        "label":{
            "type":"string",
            "description":"The label of the compute node."
        },
        "ipAddress":{
            "type":"string",
            "description":"The IP address of the compute node."
        },
        "publicIpAddress":{
            "type":"string",
            "description":"The IP address of the compute node."
        },
        "usageType":{
            "type":"string",
            "description":"The usage type of the compute node. It is usually <code>MYSQL_SERVER</code> for Oracle MySQL Cloud Service."
        },
        "role":{
            "type":"string",
            "description":"The role of the compute node. It is usually <code>MYSQL_SERVER</code> for Oracle MySQL Cloud Service."
        },
        "componentType":{
            "type":"string",
            "description":"The type of the component. It is usually <code>mysql</code> for Oracle MySQL Cloud Service."
        },
        "state":{
            "type":"string",
            "description":"The current state of the compute node. Valid values are: <ul><li><code>Ready</code>: Fully operational</li><li><code>Starting</code>: Being created or initialized</li><li><code>Stopping</code>: Being stopped</li><li><code>Error</code>: Has some error condition(s)</li></uL>"
        },
        "shapeId":{
            "type":"string",
            "description":"The Oracle Compute Cloud shape of the compute node."
        },
        "totalStorage":{
            "type":"integer",
            "description":"The size in GB of the total storage allocated to the compute node, including data volume, backup volume, and MySQL log volume."
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time when the service instance was created."
        },
        "isAdminNode":{
            "type":"boolean",
            "description":"Indicates whether the compute node is an administration node."
        },
        "servers":{
            "type":"array",
            "description":"Servers instance information.",
            "items":{
                "$ref":"#/definitions/service-vm-instance-server-info"
            }
        },
        "storageVolumes":{
            "type":"array",
            "description":"All storage volumes of the service instance.",
            "items":{
                "$ref":"#/definitions/service-view-storage-volume"
            }
        },
        "vmStateDisplayName":{
            "type":"string",
            "description":"The display name of the current state of the compute node."
        }
    }
}

Nested Schema : servers

Type: array

Servers instance information.

Show Source

• [0]: object Server Instance Details
  Title: Server Instance Details

{
    "type":"array",
    "description":"Servers instance information.",
    "items":{
        "$ref":"#/definitions/service-vm-instance-server-info"
    }
}

Nested Schema : storageVolumes

Type: array

All storage volumes of the service instance.

Show Source

• [0]: object Storage Volume Details
  Title: Storage Volume Details

{
    "type":"array",
    "description":"All storage volumes of the service instance.",
    "items":{
        "$ref":"#/definitions/service-view-storage-volume"
    }
}

Nested Schema : Server Instance Details

Type: object

Title: Server Instance Details

Show Source

• creationDate(optional): string
  Date and time when the server was created.
• serverId(optional): integer
  ID of the server.
• serverName(optional): string
  Name of the server.
• serverRole(optional): string
  Role of the server.
• serverStateDisplayName(optional): string
  Display name of the server.
• serverType(optional): string
  Type of the server, such as MASTER.
• state(optional): string
  Current state of the server.

{
    "title":"Server Instance Details",
    "type":"object",
    "properties":{
        "serverId":{
            "type":"integer",
            "description":"ID of the server."
        },
        "serverName":{
            "type":"string",
            "description":"Name of the server."
        },
        "serverType":{
            "type":"string",
            "description":"Type of the server, such as <code>MASTER</code>."
        },
        "serverRole":{
            "type":"string",
            "description":"Role of the server."
        },
        "state":{
            "type":"string",
            "description":"Current state of the server."
        },
        "creationDate":{
            "type":"string",
            "description":"Date and time when the server was created."
        },
        "serverStateDisplayName":{
            "type":"string",
            "description":"Display name of the server."
        }
    }
}

Nested Schema : Service Patching Operation Details

Type: object

Title: Service Patching Operation Details

Show Source

• operation(optional): string
  Current patching operation.

{
    "title":"Service Patching Operation Details",
    "type":"object",
    "properties":{
        "operation":{
            "type":"string",
            "description":"Current patching operation."
        }
    }
}

Examples

The following example shows how to view information about all MySQL Cloud Service instances 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" \
   https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
"pragma": "no-cache",
"date": "Thu, 08 Mar 2018 14:15:29 GMT",
"x-tryit-proxy-response": "true",
"vary": "Accept-Encoding,User-Agent",
"server": "Oracle-Application-Server-11g",
"x-frame-options": "DENY",
"x-oracle-dms-ecid": "005PiTEmdJE4ioW_Pxk3yd0002UT001Gk8, 005PiTEmdJE4ioW_Pxk3yd0002UT001Gk8",
"content-language": "en",
"content-encoding": "gzip",
"cache-control": "no-cache",
"connection": "Keep-Alive",
"strict-transport-security": "max-age=31536000;includeSubDomains",
"content-type": "application/json",
"keep-alive": "timeout=5, max=500",
"content-length": "3363"

Example of Response Body

The following shows an example of the response body in JSON format where the identity domain has a single MySQL Cloud Service instance named MyTestInstance.

		  
{
  "services": {
    "ExampleInstance": {
      "serviceId": 558125,
      "serviceUuid": "4AB6C53C75A3410FAA793702405EC485",
      "serviceLogicalUuid": "16F8B200374C4D12BC0C182A37F9821F",
      "serviceName": "ExampleInstance",
      "serviceType": "MySQLCS",
      "domainName": "ExampleIdentityDomain",
      "serviceVersion": "5.7",
      "releaseVersion": "5.7.20",
      "baseReleaseVersion": "5.7.20",
      "metaVersion": "18.1.4-180118",
      "serviceDescription": "My example instance.",
      "serviceLevel": "PAAS",
      "subscription": "HOURLY",
      "meteringFrequency": "HOURLY",
      "edition": "EE",
      "totalSSDStorage": 0,
      "storageContainer": "Storage-ExampleIdentityDomain/MySQLCS",
      "state": "READY",
      "serviceStateDisplayName": "Ready",
      "clone": false,
      "creator": "yourusename",
      "creationDate": "2018-03-08T13:22:59.881+0000",
      "serviceEntitlementId": "585262429",
      "isBYOL": false,
      "isSharedManaged": false,
      "isNonSharedmanaged": false,
      "isDefaultManaged": false,
      "isManaged": false,
      "isOAuthForStorageConfigured": false,
      "iaasProvider": "NIMBULA",
      "keyComponentInstance": "mysql",
      "adminHostName": "exampleinstance-mysql-1",
      "attributes": {
        "BACKUP_FILE_PATH": {
          "displayName": "Source Backup File",
          "type": "STRING",
          "value": "",
          "displayValue": "",
          "isKeyBinding": false
        },
        "MYSQL_PORT": {
          "displayName": "MySQL Port",
          "type": "INTEGER",
          "value": "3306",
          "displayValue": "3306",
          "isKeyBinding": true
        },
        "USE_SSD": {
          "displayName": "Use High Performance Storage",
          "type": "BOOLEAN",
          "value": "false",
          "displayValue": "false",
          "isKeyBinding": false
        },
        "CLOUD_STORAGE_CONTAINER": {
          "displayName": "Cloud Storage Container",
          "type": "STRING",
          "value": "Storage-StorageIdentityDomain/MySQLCS",
          "displayValue": "Storage-StorageIdentityDomain/MySQLCS",
          "isKeyBinding": false
        },
        "BACKUP_DESTINATION": {
          "displayName": "Backup Destination",
          "type": "STRING",
          "value": "NONE",
          "displayValue": "None",
          "isKeyBinding": false
        }
      },
      "tags": {
        "items": [],
        "totalResults": 0,
        "hasMore": false
      },
      "components": {
        "mysql": {
          "serviceId": 558125,
          "componentId": 613292,
          "state": "READY",
          "componentStateDisplayName": "Ready",
          "version": "5.7",
          "componentType": "mysql",
          "creationDate": "2018-03-08T13:22:59.000+0000",
          "instanceName": "mysql",
          "instanceRole": "PRIMARY",
          "isKeyComponent": true,
          "attributes": {
            "MYSQL_CHARACTER_SET": {
              "displayName": "Server Character Set",
              "type": "STRING",
              "value": "utf8mb4",
              "displayValue": "utf8mb4",
              "isKeyBinding": false
            },
            "MYSQL_USERNAME": {
              "displayName": "Administration Username",
              "type": "STRING",
              "value": "root",
              "displayValue": "root",
              "isKeyBinding": false
            },
            "MYSQL_COLLATION": {
              "displayName": "Server Collation",
              "type": "STRING",
              "value": "",
              "displayValue": "",
              "isKeyBinding": false
            },
            "MYSQL_DBNAME": {
              "displayName": "Database Schema Name",
              "type": "STRING",
              "value": "mydatabase",
              "displayValue": "mydatabase",
              "isKeyBinding": false
            },
            "shape": {
              "displayName": "Compute Shape",
              "type": "SHAPE",
              "value": "oc3",
              "displayValue": "oc3",
              "isKeyBinding": false
            },
            "MYSQL_TIMEZONE": {
              "displayName": "Timezone",
              "type": "STRING",
              "value": "SYSTEM",
              "displayValue": "SYSTEM",
              "isKeyBinding": false
            },
            "MYSQL_DBSTORAGE": {
              "displayName": "Usable Database Storage (GB)",
              "type": "INTEGER",
              "value": "25",
              "displayValue": "25",
              "isKeyBinding": false
            },
            "MYSQL_ENTERPRISE_MONITOR": {
              "displayName": "Configure MySQL Enterprise Monitor",
              "type": "STRING",
              "value": "No",
              "displayValue": "No",
              "isKeyBinding": false
            },
            "CONNECT_STRING": {
              "displayName": "Connect Descriptor",
              "type": "STRING",
              "value": "203.0.113.11:3306/mydatabase",
              "displayValue": "203.0.113.11:3306/mydatabase",
              "isKeyBinding": true
            }
          },
          "vmInstances": {
            "exampleinstance-mysql-1": {
              "vmId": 749988,
              "id": 749988,
              "uuid": "DAFEB05114FE4581A796FC29260EC0E5",
              "hostName": "exampleinstance-mysql-1",
              "label": "ExampleInstance mysql MYSQL_SERVER 1",
              "ipAddress": "203.0.113.11",
              "publicIpAddress": "203.0.113.11",
              "usageType": "MYSQL_SERVER",
              "role": "MYSQL_SERVER",
              "componentType": "mysql",
              "state": "READY",
              "vmStateDisplayName": "Ready",
              "shapeId": "oc3",
              "totalStorage": 128000,
              "creationDate": "2018-03-08T13:22:59.000+0000",
              "isAdminNode": true,
              "servers": {
                "MySQL": {
                  "serverId": 345158,
                  "serverName": "MySQL",
                  "serverType": "MASTER",
                  "serverRole": "MYSQLCS_ROLE",
                  "state": "READY",
                  "serverStateDisplayName": "Ready",
                  "creationDate": "2018-03-08T13:22:59.000+0000",
                  "isPermanent": false
                }
              },
              "storageVolumes": {
                "data": {
                  "name": "data",
                  "size": "25GB",
                  "partitions": "1",
                  "displayName": "Data Storage",
                  "isUserVisible": true
                },
                "tools": {
                  "name": "tools",
                  "size": "5GB",
                  "partitions": "1",
                  "isUserVisible": false
                },
                "boot": {
                  "name": "boot",
                  "size": "25GB",
                  "partitions": "1",
                  "isUserVisible": false
                },
                "bin": {
                  "name": "bin",
                  "size": "10GB",
                  "partitions": "1",
                  "isUserVisible": false
                },
                "MySQLlog": {
                  "name": "MySQLlog",
                  "size": "60GB",
                  "partitions": "1",
                  "displayName": "Redo and Binary Log Storage",
                  "isUserVisible": true
                }
              }
            }
          },
          "adminHostName": "exampleinstance-mysql-1",
          "storageVolumes": {
            "data": {
              "name": "data",
              "size": "25G",
              "mount": "/u01/data"
            },
            "tools": {
              "name": "tools",
              "size": "5G",
              "mount": "/u01/app/oracle/tools"
            },
            "boot": {
              "name": "boot",
              "size": "25G",
              "mount": "/"
            },
            "bin": {
              "name": "bin",
              "size": "10G",
              "mount": "/u01/bin"
            },
            "MySQLlog": {
              "name": "MySQLlog",
              "size": "60G",
              "mount": "/u01/translog"
            }
          },
          "hosts": {
            "userHosts": {
              "exampleinstance-mysql-1": {
                "vmId": 749988,
                "id": 749988,
                "uuid": "DAFEB05114FE4581A796FC29260EC0E5",
                "hostName": "exampleinstance-mysql-1",
                "label": "ExampleInstance mysql MYSQL_SERVER 1",
                "ipAddress": "203.0.113.11",
                "publicIpAddress": "203.0.113.11",
                "usageType": "MYSQL_SERVER",
                "role": "MYSQL_SERVER",
                "componentType": "mysql",
                "state": "READY",
                "vmStateDisplayName": "Ready",
                "shapeId": "oc3",
                "totalStorage": 128000,
                "creationDate": "2018-03-08T13:22:59.000+0000",
                "isAdminNode": true,
                "servers": {
                  "MySQL": {
                    "serverId": 345158,
                    "serverName": "MySQL",
                    "serverType": "MASTER",
                    "serverRole": "MYSQLCS_ROLE",
                    "state": "READY",
                    "serverStateDisplayName": "Ready",
                    "creationDate": "2018-03-08T13:22:59.000+0000"
                  }
                },
                "storageVolumes": {
                  "data": {
                    "name": "data",
                    "size": "25GB",
                    "partitions": "1"
                  },
                  "tools": {
                    "name": "tools",
                    "size": "5GB",
                    "partitions": "1"
                  },
                  "boot": {
                    "name": "boot",
                    "size": "25GB",
                    "partitions": "1"
                  },
                  "bin": {
                    "name": "bin",
                    "size": "10GB",
                    "partitions": "1"
                  },
                  "MySQLlog": {
                    "name": "MySQLlog",
                    "size": "60GB",
                    "partitions": "1"
                  }
                }
              }
            }
          },
          "paasServers": {},
          "clusters": {},
          "displayName": "MySQL Component"
        }
      },
      "activityLogs": [
        {
          "activityLogId": 14794614,
          "serviceName": "ExampleInstance",
          "serviceType": "mysqlcs",
          "identityDomain": "ExampleIdentityDomain",
          "serviceId": 558125,
          "jobId": 22570625,
          "startDate": "2018-03-08T13:23:00.611+0000",
          "endDate": "2018-03-08T13:32:12.481+0000",
          "status": "SUCCEED",
          "operationId": 558125,
          "operationType": "CREATE_SERVICE",
          "summaryMessage": "CREATE_SERVICE",
          "authDomain": "ExampleIdentityDomain",
          "authUser": "yourusername",
          "initiatedBy": "USER",
          "messages": [
            {
              "activityDate": "2018-03-08T13:23:00.611+0000",
              "message": "Activity Submitted"
            },
            {
              "activityDate": "2018-03-08T13:23:00.652+0000",
              "message": "Activity Started"
            },
            {
              "activityDate": "2018-03-08T13:23:00.798+0000",
              "message": "Started operation to create service [ExampleInstance] in identity domain [ExampleIdentityDomain]."
            },
            {
              "activityDate": "2018-03-08T13:23:00.990+0000",
              "message": "Creating service [ExampleInstance] resources [exampleinstance-mysql-1]."
            },
            {
              "activityDate": "2018-03-08T13:29:19.943+0000",
              "message": "Completed creating service [ExampleInstance] in domain [ExampleIdentityDomain]."
            },
            {
              "activityDate": "2018-03-08T13:29:23.615+0000",
              "message": "Completed operation to establish security on VMs for component [mysql]"
            },
            {
              "activityDate": "2018-03-08T13:29:23.615+0000",
              "message": "Started operation to establish security on VMs for component [mysql]."
            },
            {
              "activityDate": "2018-03-08T13:29:24.134+0000",
              "message": "Started operation to check provisioning status on the VMs for [mysql]"
            },
            {
              "activityDate": "2018-03-08T13:31:35.101+0000",
              "message": "Provisioning Succeeded on hosts: exampleinstance-mysql-1"
            },
            {
              "activityDate": "2018-03-08T13:31:35.404+0000",
              "message": "Provisioning of [mysql] succeeded."
            },
            {
              "activityDate": "2018-03-08T13:31:35.543+0000",
              "message": "Started service reachability check operation for [mysql]."
            },
            {
              "activityDate": "2018-03-08T13:31:41.112+0000",
              "message": "Successfully completed service reachability check for [mysql]"
            },
            {
              "activityDate": "2018-03-08T13:31:41.112+0000",
              "message": "Successfully validated that exampleinstance-mysql-1 returned astatus of 200 on retry 1, waited 0seconds;"
            },
            {
              "activityDate": "2018-03-08T13:31:41.417+0000",
              "message": "Service reachability check of [mysql] succeeded."
            },
            {
              "activityDate": "2018-03-08T13:31:41.417+0000",
              "message": "Service reachability check of all components completed."
            },
            {
              "activityDate": "2018-03-08T13:32:12.463+0000",
              "message": "Activity Ended"
            },
            {
              "activityDate": "2018-03-08T13:32:12.481+0000",
              "message": "Activity Ended"
            }
          ]
        }
      ],
      "layeringMode": "None",
      "serviceLevelDisplayName": "Oracle MySQL Cloud Service",
      "editionDisplayName": "Enterprise Edition",
      "meteringFrequencyDisplayName": "Hourly",
      "BACKUP_FILE_PATH": "null",
      "DATA_VOLUME_SIZE": "25G",
      "USE_SSD": "false",
      "provisionEngine": "Metadata_1_0",
      "MYSQL_PORT": "3306",
      "CLOUD_STORAGE_CONTAINER": "Storage-StorageIdentityDomain/MySQLCS",
      "BACKUP_DESTINATION": "NONE",
      "totalSharedStorage": 0,
      "region": "uscom-east-1",
      "patching": {
        "currentOperation": {
          "operation": "NONE"
        },
        "totalAvailablePatches": 0
      }
    }
  }
}