Jump to

• Request
• Response
• Examples

View All Backup Operations

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/APICS/instances/{serviceId}/backups

Returns a list of all available backup operations for an API Platform Cloud Service - Classic instance, including both scheduled and on-demand backups.

Note: ServiceID is the user specified name for the service and is not the ID that's autogenerated for the instance.

Request

Path Parameters

• identityDomainId: string
  Name of the identity domain for the API Platform Cloud Service - Classic account.
• serviceId: string
  Name of the API Platform Cloud Service - Classic instance.

  Note: ServiceID is the user specified name for the service and is not the ID that's autogenerated for the instance.

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.

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

• backupList(optional): array backupList Array
  Title: backupList Array

  Array of JSON object elements, with one element for each backup operation.

{
    "title":"Response Body",
    "type":"object",
    "description":"",
    "properties":{
        "backupList":{
            "title":"backupList Array",
            "type":"array",
            "description":"Array of JSON object elements, with one element for each backup operation.",
            "items":{
                "$ref":"#/definitions/view-all-backups-backupList-array-item"
            }
        }
    }
}

Nested Schema : backupList Array

Type: array

Title: backupList Array

Array of JSON object elements, with one element for each backup operation.

Show Source

• Array of: object backupList Array Item
  Title: backupList Array Item

{
    "title":"backupList Array",
    "type":"array",
    "description":"Array of JSON object elements, with one element for each backup operation.",
    "items":{
        "$ref":"#/definitions/view-all-backups-backupList-array-item"
    }
}

Nested Schema : backupList Array Item

Type: object

Title: backupList Array Item

Show Source

• backupCompleteDate(optional): string
  Date and time the backup completed. Applies to completed backups only.
• backupId(optional): string
  ID number of the backup operation.
• backupStartDate(optional): string
  Date and time the backup started.
• databaseIncluded(optional): boolean
  Indicates if the database associated with the service instance should also be backed up. This value should be false.
• dbTag(optional): string
  Tag that uniquely identifies the backup. Applies to completed backups only.
• deletedOnDate(optional): string
  Date and time that the backup deletion completed. This attribute is not valid for backups that are in progress or still available.
• expirationDate(optional): null
  Date and time the backup expires; null if the backup does not expire.
• full(optional): boolean
  true if this is a full backup; false if this is an incremental backup.
• href(optional): string
  Link to retrieve information about this backup.
• initiatedBy(optional): string
  Name of the user who initiated the backup.
• jobId(optional): string
  Job ID of the backup operation.
• local(optional): boolean
  Flag that specifies whether the backup is to be downloaded and stored locally in block storage on the Administration Server (true), or archived and stored remotely (false).

  On Oracle Public Cloud, the remote storage is the specified Oracle Storage Cloud Service container.

• localCopy(optional): boolean
  Flag that specifies whether the local copy of a backup is maintained for a backup that has been uploaded to remote storage.

  On Oracle Public Cloud, the remote storage is the specified Oracle Storage Cloud Service container.

• notes(optional): string
  Notes about the backup operation.
• serviceComponents(optional): array serviceComponents
  Groups service component details.
• size(optional): string
  Size of the backup, in MBs. For example: 1011.4MB (backup complete) or Unknown (backup in-progress).
• sizeInBytes(optional): integer
  Size, in bytes, of the backup.
• status(optional): string
  Status of the backup; one of IN PROGRESS, FAILED, or COMPLETED. Note that there is only one in-progress backup at any given time.
• storageContainer(optional): string
  Storage container instance containing the backup.

{
    "title":"backupList Array Item",
    "type":"object",
    "properties":{
        "backupId":{
            "type":"string",
            "description":"ID number of the backup operation."
        },
        "jobId":{
            "type":"string",
            "description":"Job ID of the backup operation."
        },
        "backupStartDate":{
            "type":"string",
            "description":"Date and time the backup started."
        },
        "backupCompleteDate":{
            "type":"string",
            "description":"Date and time the backup completed. Applies to completed backups only."
        },
        "deletedOnDate":{
            "type":"string",
            "description":"Date and time that the backup deletion completed. This attribute is not valid for backups that are in progress or still available."
        },
        "expirationDate":{
            "type":"null",
            "description":"Date and time the backup expires; <code>null</code> if the backup does not expire."
        },
        "initiatedBy":{
            "type":"string",
            "description":"Name of the user who initiated the backup."
        },
        "full":{
            "type":"boolean",
            "description":"<code>true</code> if this is a full backup; <code>false</code> if this is an incremental backup."
        },
        "local":{
            "type":"boolean",
            "description":"Flag that specifies whether the backup is to be downloaded and stored locally in block storage on the Administration Server (<code>true</code>), or archived and stored remotely (<code>false</code>).<p>On Oracle Public Cloud, the remote storage is the specified Oracle Storage Cloud Service container."
        },
        "localCopy":{
            "type":"boolean",
            "description":"Flag that specifies whether the local copy of a backup is maintained for a backup that has been uploaded to remote storage.<p>On Oracle Public Cloud, the remote storage is the specified Oracle Storage Cloud Service container."
        },
        "databaseIncluded":{
            "type":"boolean",
            "description":"Indicates if the database associated with the service instance should also be backed up. This value should be <code>false</code>."
        },
        "size":{
            "type":"string",
            "description":"Size of the backup, in MBs. For example: <code>1011.4MB</code> (backup complete) or <code>Unknown</code> (backup in-progress)."
        },
        "sizeInBytes":{
            "type":"integer",
            "description":"Size, in bytes, of the backup."
        },
        "dbTag":{
            "type":"string",
            "description":"Tag that uniquely identifies the backup. Applies to completed backups only."
        },
        "status":{
            "type":"string",
            "description":"Status of the backup; one of <code>IN PROGRESS</code>, <code>FAILED</code>, or <code>COMPLETED</code>. Note that there is only one in-progress backup at any given time."
        },
        "storageContainer":{
            "type":"string",
            "description":"Storage container instance containing the backup."
        },
        "href":{
            "type":"string",
            "description":"Link to retrieve information about this backup."
        },
        "notes":{
            "type":"string",
            "description":"Notes about the backup operation."
        },
        "serviceComponents":{
            "type":"array",
            "description":"Groups service component details.",
            "items":{
                "type":"object",
                "properties":{
                    "type":{
                        "type":"string",
                        "description":"Service component type. Valid values are <code>JDK</code>, <code>OTD</code>, <code>OTD_JDK</code>, or <code>WLS</code>."
                    },
                    "version":{
                        "type":"string",
                        "description":"Software version of the specified component."
                    }
                }
            }
        }
    }
}

Nested Schema : serviceComponents

Type: array

Groups service component details.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"Groups service component details.",
    "items":{
        "type":"object",
        "properties":{
            "type":{
                "type":"string",
                "description":"Service component type. Valid values are <code>JDK</code>, <code>OTD</code>, <code>OTD_JDK</code>, or <code>WLS</code>."
            },
            "version":{
                "type":"string",
                "description":"Software version of the specified component."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• type(optional): string
  Service component type. Valid values are JDK, OTD, OTD_JDK, or WLS.
• version(optional): string
  Software version of the specified component.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Service component type. Valid values are <code>JDK</code>, <code>OTD</code>, <code>OTD_JDK</code>, or <code>WLS</code>."
        },
        "version":{
            "type":"string",
            "description":"Software version of the specified component."
        }
    }
}

Back to Top

Examples

The following example shows how to view all Oracle API Platform Cloud Service - Classic backups by submitting a GET request on the REST resource using cURL. For more information about cURL, see cURL Examples.

curl -i -X GET 
-u apicsadmin:password 
-H "Content-Type: application/json"
https://example.com:7103/paas/api/v1.1/instancemgmt/apics/services/APICS/instances/apics/backups

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Wed, 23 Nov 2016 11:06:47 GMT
Transfer-Encoding: chunked
Content-Type: application/json
X-ORACLE-DMS-ECID: 7077e58cc81a37d2:-4cd90f8:15878a7e3f0:-8000-0000000000005fb2
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 example shows the contents of the response body in JSON format, including detailed information about all service backups.

{
	"backups": [{
		"backupId": "1479898800355",
		"jobId": "26358",
		"backupStartDate": "2016-11-23T11:00:00.454+0000",
		"backupCompleteDate": "2016-11-23T11:04:34.559+0000",
		"expirationDate": null,
		"initiatedBy": "apicsadmin",
		"full": true,
		"local": false,
		"localCopy": true,
		"databaseIncluded": true,
		"size": "1.5MB",
		"sizeInBytes": 1604950,
		"dbTag": "JAAS20161123T110009",
		"status": "Completed",
		"storageContainer": "Storage-apics/APICSBackup",
		"href": "https://example.com:7103/paas/api/v1.1/instancemgmt/apics/services/APICS/instances/apics/backups/1479898800355",
		"notes": "On-demand full backup request.",
		"serviceComponents": [{
			"type": "JDK",
			"version": "1.8.0_102"
		}, {
			"type": "OTD",
			"version": "12.2.1.0.160719"
		}, {
			"type": "OTD_JDK",
			"version": "1.8.0_102"
		}, {
			"type": "WLS",
			"version": "12.2.1.0.160719"
		}]
	}]
}

Back to Top