Jump to

• Request
• Response
• Examples

Retrieve Details of a Backup Configuration

get

/backupservice/v1/configuration/{name}

This endpoint is not available on Oracle Cloud Machine.

Retrieves details of the specified backup configuration. You can use this request to verify whether the POST and PUT HTTP requests were completed successfully.

Required Role: To complete this task, you must have the Compute_Monitor or Compute_Operationsrole. If this role isn't assigned to you or you're not sure, then ask your system administrator to ensure that the role is assigned to you in Oracle Cloud My Services. See Modifying User Roles in Managing and Monitoring Oracle Cloud.

Request

Supported Media Types

• application/oracle-compute-v3+json
• application/json

Path Parameters

• name: string
  Pattern: [(^/$|^(/[\w@\.-]+)+$)]{1,255}

  Multi-part name of BackupConfiguration to get

Back to Top

Response

Supported Media Types

• application/oracle-compute-v3+json
• application/json

200 Response

Successful operation.

Body ()

Root Schema : BackupConfiguration

Type: object

Show Source

• backupRetentionCount(optional): integer(int32)
  How many backups to retain
• description(optional): string
  Description of this Backup Configuration
• enabled(optional): boolean
  Default Value: false

  When true, backups will automatically be generated based on the interval.
• interval(optional): object Interval
  There are two kinds of Intervals. Each Interval has its own JSON format. Your Interval field should look like one of the following:

  • "interval":{"Hourly":{"hourlyInterval":2}}
  • {"DailyWeekly":{"daysOfWeek":["MONDAY"],"timeOfDay":"03:15","userTimeZone":"America/Los_Angeles"}}

  Days of the week is any day of the week fully capitalized (MONDAY, TUESDAY, etc). The user time zone is any IANA user timezone. For example user time zones see List of IANA time zones.

• name(optional): string
  Pattern: (^/$|^(/[\w@\.-]+)+$)

  The multi-part name of the object. Object names can contain only alphanumeric characters, hyphens, underscores, @ and periods. Object names are case-sensitive.
• nextScheduledRun(optional): string(date-time)
  Scheduled time for next backup execution
• runAsUser(optional): string
  Pattern: (^/$|^(/[\w@\.-]+)+$)

  Any actions on this model will be performed as this user.
• tagId(optional): string(uuid)
  ID used to tag other cloud resources
• uri(optional): string(uri)
  Uniform Resource Identifier
• volumeUri(optional): string(uri)
  The complete URI of the storage volume that you want to backup.

{
    "type":"object",
    "properties":{
        "nextScheduledRun":{
            "type":"string",
            "description":"Scheduled time for next backup execution",
            "format":"date-time"
        },
        "name":{
            "pattern":"(^/$|^(/[\\w@\\.-]+)+$)",
            "type":"string",
            "description":"The multi-part name of the object. Object names can contain only alphanumeric characters, hyphens, underscores, @ and periods. Object names are case-sensitive."
        },
        "runAsUser":{
            "pattern":"(^/$|^(/[\\w@\\.-]+)+$)",
            "type":"string",
            "description":"Any actions on this model will be performed as this user."
        },
        "description":{
            "type":"string",
            "description":"Description of this Backup Configuration"
        },
        "interval":{
            "description":"Backup scheduler interval",
            "$ref":"#/definitions/Interval"
        },
        "enabled":{
            "default":false,
            "type":"boolean",
            "description":"When true, backups will automatically be generated based on the interval."
        },
        "backupRetentionCount":{
            "type":"integer",
            "description":"How many backups to retain",
            "format":"int32"
        },
        "uri":{
            "type":"string",
            "description":"Uniform Resource Identifier",
            "format":"uri"
        },
        "tagId":{
            "type":"string",
            "description":"ID used to tag other cloud resources",
            "format":"uuid"
        },
        "volumeUri":{
            "type":"string",
            "description":"The complete URI of the storage volume that you want to backup.",
            "format":"uri"
        }
    }
}

Nested Schema : Interval

Type: object

There are two kinds of Intervals. Each Interval has its own JSON format. Your Interval field should look like one of the following:

• "interval":{"Hourly":{"hourlyInterval":2}}
• {"DailyWeekly":{"daysOfWeek":["MONDAY"],"timeOfDay":"03:15","userTimeZone":"America/Los_Angeles"}}

Days of the week is any day of the week fully capitalized (MONDAY, TUESDAY, etc). The user time zone is any IANA user timezone. For example user time zones see List of IANA time zones.

Match One

Show Source

{
    "x-oneOf-instructions":"Provide one of the valid object representations documented here.  For more information about oneOf see http://json-schema.org/latest/json-schema-validation.html#anchor88",
    "type":"object",
    "description":"There are two kinds of Intervals. Each Interval has its own JSON format. Your Interval field should look like one of the following:<p><ul><li><code>\"interval\":{\"Hourly\":{\"hourlyInterval\":2}}</code></li><li><code>{\"DailyWeekly\":{\"daysOfWeek\":[\"MONDAY\"],\"timeOfDay\":\"03:15\",\"userTimeZone\":\"America/Los_Angeles\"}}</code></li></ul><p>Days of the week is any day of the week fully capitalized (MONDAY, TUESDAY, etc). The user time zone is any IANA user timezone.  For example user time zones see <a href=\"https://en.wikipedia.org/wiki/IANA_time_zone_database\">List of IANA time zones</a>.",
    "x-oneOf":{
        "oneOf":[
            {
                "type":"object",
                "properties":{
                    "DailyWeekly":{
                        "allOf":[
                            {
                                "$ref":"#/definitions/DailyWeeklyInterval"
                            },
                            {
                                "type":"object",
                                "properties":{
                                }
                            }
                        ]
                    }
                }
            },
            {
                "type":"object",
                "properties":{
                    "Hourly":{
                        "allOf":[
                            {
                                "$ref":"#/definitions/HourlyInterval"
                            },
                            {
                                "type":"object",
                                "properties":{
                                }
                            }
                        ]
                    }
                }
            }
        ]
    }
}

401 Response

Unauthorized or backup configuration does not exist.

404 Response

The URL does not refer to a valid resource.

500 Response

The server encountered an error handling this request.

Back to Top

Examples

cURL Command

The following example shows how to retrieve details of a backup configuration by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

Enter the command on a single line. Line breaks are used in this example for readability.

curl -X GET 
     -H "Cookie: $COMPUTE_COOKIE"
     -H "Accept: application/oracle-compute-v3+json"
        https://api-z999.compute.us0.oraclecloud.com/backupservice/v1/configuration/Compute-acme/[e-mail]/backupConfigVol1

• COMPUTE_COOKIE is the name of the variable in which you stored the authentication cookie earlier. For information about retrieving the authentication cookie and storing it in a variable, see Authentication.

• api-z999.compute.us0.oraclecloud.com is an example REST endpoint URL. Change this value to the REST endpoint URL of your Compute Classic site. For information about finding out REST endpoint URL for your site, see Send Requests.

• acme and [e-mail] are example values. Replace acme with the identity domain ID of your Compute Classic account, and [e-mail] with your user name.

Example of Response Body

The following example shows the response body in JSON format.

{
  "uri": "https://api-z999.compute.us0.oraclecloud.com:443/backupservice/v1/configuration/Compute-acme/[e-mail]/backupConfigVol1",
  "runAsUser": "/Compute-acme/[e-mail]",
  "name": "/Compute-acme/[e-mail]/backupConfigVol1",
  "enabled": false,
  "backupRetentionCount": 2,
  "nextScheduledRun": "2016-07-19T04:09:50.386Z",
  "interval": {
    "Hourly": {
      "hourlyInterval": 1
    }
  },
  "volumeUri": "http://api-z999.compute.us0.oraclecloud.com/storage/volume/Compute-acme/[e-mail]/vol1",
  "description": null,
  "tagId": "6eb99f96-b465-4db5-860a-25a6ae7b766f"
}

Back to Top