1. REST API for MySQL Cloud Service
  2. Tasks
  3. Snapshots

View a Snapshot

get

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

Returns information about a storage snapshot of a MySQL Cloud Service instance.

Request

Path Parameters
Header Parameters

Response

Supported Media Types

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
Nested Schema : clonedServices Array
Type: array
Title: clonedServices Array
Array of JSON object elements, with one element for each service instance created from the snapshot.
Show Source
Nested Schema : clonedServices Array Item
Type: object
Title: clonedServices Array Item
Show Source

Examples

The following example shows how to view detailed information about a snapshot of a MySQL Cloud Service instance by submitting a GET request on the REST endpoint using cURL.

In this example, the identity domain is ExampleIdentityDomain and the Oracle Cloud user name and password are username and password. Detailed information is being requested for the snaptest snapshot of the mysql57?aas service instance.

cURL Command

curl --include --request GET \
--user username:password \
--header "X-ID-TENANT-NAME:ExampleIdentityDomain" \
https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/mysql57-aas/snapshots/snaptest

HTTP Status Code and Response Headers

HTTP/1.1 200 OK
Date: Wed, 26 Jul 2017 14:26:42 GMT
Server: Oracle-Application-Server-11g
Content-Length: 3021
Access-Control-Allow-Origin: *
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: 005LJ^we8pM2zGILIqG7yf0000Fq0000_7
X-ORACLE-DMS-ECID: 005LJ^we8pM2zGILIqG7yf0000Fq0000_7
Content-Language: en
X-Frame-Options: DENY
Vary: Accept-Encoding,User-Agent
Content-Type: application/json

Response Body

{
	"name": "snaptest",
	"description": "stringTest",
	"cloneCount": 0,
	"timestamp": "2017-07-26T12:40:22.273+0000",
	"cloneServices": [],
	"metadata": {
		"serviceVersion": "5.7",
		"releaseVersion": "5.7.18",
		"metaVersion": "17.3.3",
		"serviceLevel": "PAAS",
		"subscription": "HOURLY",
		"meteringFrequency": "HOURLY",
		"edition": "EE",
		"attributes": {
			"_domainSuffix": ".Compute-ExampleIdentityDomain.oraclecloud.com",
			"CLOUD_STORAGE_CONTAINER": "Storage-ExampleIdentityDomain\/MySQLBackup",
			"_tools_mount_": "\/u01\/app\/oracle\/tools",
			"LOCAL_BACKUP_VOLUME_MOUNT": "\/u01\/backup",
			"_loginfra_enabled_": "false",
			"LOCAL_BACKUP_VOLUME_SIZE": "50G",
			"_tools_root_": "\/u01\/app\/oracle\/tools\/MSCS",
			"_platform_tools_root_": "\/u01\/app\/oracle\/tools\/paas\/bin\/platform",
			"DATA_VOLUME_SIZE": "25G",
			"MYSQL_PORT": "3306",
			"provisionEngine": "Metadata_1_0",
			"BACKUP_FILE_PATH": "null",
			"BACKUP_DESTINATION": "BOTH",
			"USE_SSD": "false"
		},
		"credentials": {
			"CLOUD_STORAGE_CRED": "username"
		},
		"components": {
			"mysql": {
				"componentType": "mysql",
				"version": "5.7",
				"releaseVersion": "5.7.18",
				"instanceName": "mysql",
				"instanceRole": "NONE",
				"isKeyComponent": true,
				"attributes": {
					"MYSQL_COLLATION": "null",
					"shape": "oc3",
					"vmCounter": "1",
					"MASTER_SEC_LIST": "\/Compute-ExampleIdentityDomain\/user\/paas\/MySQLCS\/mysql57-aas\/mysql\/ora_nw",
					"MYSQL_CHARACTER_SET": "utf8mb4",
					"serverCounter": "1",
					"MYSQL_USERNAME": "root",
					"ADMIN_HOST_SEC_LIST": "\/Compute-ExampleIdentityDomain\/username\/paas\/MySQLCS\/mysql57-aas\/mysql\/ora_mys_infraadmin",
					"CONNECT_STRING": "ipaddress:3306\/mydatabase",
					"MYSQL_DBNAME": "mydatabase",
					"MYSQL_DBSTORAGE": "25",
					"MYSQL_ENTERPRISE_MONITOR": "No"
				},
				"credentials": {
					"MYSQL_CRED": "root",
					"MEM_AGENT_CRED": "null",
					"MEM_MANAGER_CRED": "null",
					"USER_BACKUPSTORAGE_CRED": "null"
				},
				"vmInstances": {
					"mysql57-aas-mysql-1": {
						"vmId": 134827,
						"vmIndex": 1,
						"hostName": "mysql57-aas-mysql-1",
						"label": "mysql57-aas mysql MYSQL_SERVER 1",
						"ipAddress": "ipaddress",
						"publicIpAddress": "ipaddress",
						"role": "MYSQL_SERVER",
						"shapeId": "oc3",
						"totalStorage": 179200,
						"isAdminNode": true,
						"attributes": {},
						"servers": {
							"MySQL": {
								"serverId": 64099,
								"serverName": "MySQL",
								"serverType": "MASTER",
								"attributes": {}
							}
						},
						"storageVolumes": {
							"boot": {
								"index": 1,
								"shared": false,
								"size": "26843545600",
								"properties": "\/oracle\/public\/storage\/default"
							},
							"common": {
								"index": 5,
								"shared": false,
								"size": "5368709120",
								"properties": "\/oracle\/public\/storage\/default"
							},
							"data": {
								"index": 3,
								"shared": false,
								"size": "26843545600",
								"mountpoint": "\/u01\/data",
								"device": "\/dev\/xvdd",
								"properties": "\/oracle\/public\/storage\/latency"
							},
							"bin": {
								"index": 2,
								"shared": false,
								"size": "10737418240",
								"mountpoint": "\/u01\/bin",
								"device": "\/dev\/xvdc",
								"properties": "\/oracle\/public\/storage\/default"
							},
							"MySQLlog": {
								"index": 4,
								"shared": false,
								"size": "64424509440",
								"mountpoint": "\/u01\/translog",
								"device": "\/dev\/xvde",
								"properties": "\/oracle\/public\/storage\/latency"
							},
							"backup": {
								"index": 6,
								"shared": false,
								"size": "53687091200",
								"mountpoint": "\/u01\/backup",
								"device": "\/dev\/xvdg",
								"properties": "\/oracle\/public\/storage\/default"
							}
						}
					}
				}
			}
		}
	},
	"status": "Succeeded",
	"opStatusMessage": "Snapshot Succeeded"
}